diff --git a/samtranslator/schema/schema.json b/samtranslator/schema/schema.json index b3ee5a0b6..d88cd188e 100644 --- a/samtranslator/schema/schema.json +++ b/samtranslator/schema/schema.json @@ -58,7 +58,7 @@ "type": "string" }, "TemplateArn": { - "markdownDescription": "Specifies a custom configuration template to use when issuing a certificate\\. If this parameter is not provided, ACM Private CA defaults to the `EndEntityCertificate/V1` template\\. For more information about ACM Private CA templates, see [Using Templates](https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a custom configuration template to use when issuing a certificate\\. If this parameter is not provided, AWS Private CA defaults to the `EndEntityCertificate/V1` template\\. For more information about AWS Private CA templates, see [Using Templates](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TemplateArn", "type": "string" }, @@ -69,7 +69,7 @@ }, "ValidityNotBefore": { "$ref": "#/definitions/AWS::ACMPCA::Certificate.Validity", - "markdownDescription": "Information describing the start of the validity period of the certificate\\. This parameter sets the \u201cNot Before\" date for the certificate\\. \nBy default, when issuing a certificate, ACM Private CA sets the \"Not Before\" date to the issuance time minus 60 minutes\\. This compensates for clock inconsistencies across computer systems\\. The `ValidityNotBefore` parameter can be used to customize the \u201cNot Before\u201d value\\. \nUnlike the `Validity` parameter, the `ValidityNotBefore` parameter is optional\\. \nThe `ValidityNotBefore` value is expressed as an explicit date and time, using the `Validity` type value `ABSOLUTE`\\. \n*Required*: No \n*Type*: [Validity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Information describing the start of the validity period of the certificate\\. This parameter sets the \u201cNot Before\" date for the certificate\\. \nBy default, when issuing a certificate, AWS Private CA sets the \"Not Before\" date to the issuance time minus 60 minutes\\. This compensates for clock inconsistencies across computer systems\\. The `ValidityNotBefore` parameter can be used to customize the \u201cNot Before\u201d value\\. \nUnlike the `Validity` parameter, the `ValidityNotBefore` parameter is optional\\. \nThe `ValidityNotBefore` value is expressed as an explicit date and time, using the `Validity` type value `ABSOLUTE`\\. \n*Required*: No \n*Type*: [Validity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ValidityNotBefore" } }, @@ -122,9 +122,13 @@ "additionalProperties": false, "properties": { "ObjectIdentifier": { + "markdownDescription": "Specifies the object identifier \\(OID\\) of the attribute type of the relative distinguished name \\(RDN\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ObjectIdentifier", "type": "string" }, "Value": { + "markdownDescription": "Specifies the attribute value of relative distinguished name \\(RDN\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "string" } }, @@ -138,12 +142,18 @@ "additionalProperties": false, "properties": { "Critical": { + "markdownDescription": "Specifies the critical flag of the X\\.509 extension\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Critical", "type": "boolean" }, "ObjectIdentifier": { + "markdownDescription": "Specifies the object identifier \\(OID\\) of the X\\.509 extension\\. For more information, see the [Global OID reference database\\.](https://oidref.com/2.5.29) \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ObjectIdentifier", "type": "string" }, "Value": { + "markdownDescription": "Specifies the base64\\-encoded value of the X\\.509 extension\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4096` \n*Pattern*: `^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "string" } }, @@ -182,7 +192,7 @@ "type": "string" }, "ExtendedKeyUsageType": { - "markdownDescription": "Specifies a standard `ExtendedKeyUsage` as defined as in [RFC 5280](https://tools.ietf.org/html/rfc5280#section-4.2.1.12)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CERTIFICATE_TRANSPARENCY | CLIENT_AUTH | CODE_SIGNING | DOCUMENT_SIGNING | EMAIL_PROTECTION | OCSP_SIGNING | SERVER_AUTH | SMART_CARD_LOGIN | TIME_STAMPING` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a standard `ExtendedKeyUsage` as defined as in [RFC 5280](https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CERTIFICATE_TRANSPARENCY | CLIENT_AUTH | CODE_SIGNING | DOCUMENT_SIGNING | EMAIL_PROTECTION | OCSP_SIGNING | SERVER_AUTH | SMART_CARD_LOGIN | TIME_STAMPING` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ExtendedKeyUsageType", "type": "string" } @@ -204,6 +214,8 @@ "items": { "$ref": "#/definitions/AWS::ACMPCA::Certificate.CustomExtension" }, + "markdownDescription": "Contains a sequence of one or more X\\.509 extensions, each of which consists of an object identifier \\(OID\\), a base64\\-encoded value, and the critical flag\\. For more information, see the [Global OID reference database\\.](https://oidref.com/2.5.29) \n*Required*: No \n*Type*: List of [CustomExtension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CustomExtensions", "type": "array" }, "ExtendedKeyUsage": { @@ -216,7 +228,7 @@ }, "KeyUsage": { "$ref": "#/definitions/AWS::ACMPCA::Certificate.KeyUsage", - "markdownDescription": "Defines one or more purposes for which the key contained in the certificate can be used\\. Default value for each option is false\\. \n*Required*: No \n*Type*: [KeyUsage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Defines one or more purposes for which the key contained in the certificate can be used\\. Default value for each option is false\\. \n*Required*: No \n*Type*: [KeyUsage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeyUsage" }, "SubjectAlternativeNames": { @@ -264,7 +276,7 @@ "type": "string" }, "Rfc822Name": { - "markdownDescription": "Represents `GeneralName` as an [RFC 822](https://tools.ietf.org/html/rfc822) email address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Represents `GeneralName` as an [RFC 822](https://datatracker.ietf.org/doc/html/rfc822) email address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Rfc822Name", "type": "string" }, @@ -359,7 +371,7 @@ "items": { "$ref": "#/definitions/AWS::ACMPCA::Certificate.PolicyQualifierInfo" }, - "markdownDescription": "Modifies the given `CertPolicyId` with a qualifier\\. ACM Private CA supports the certification practice statement \\(CPS\\) qualifier\\. \n*Required*: No \n*Type*: List of [PolicyQualifierInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Modifies the given `CertPolicyId` with a qualifier\\. AWS Private CA supports the certification practice statement \\(CPS\\) qualifier\\. \n*Required*: No \n*Type*: List of [PolicyQualifierInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PolicyQualifiers", "type": "array" } @@ -379,7 +391,7 @@ }, "Qualifier": { "$ref": "#/definitions/AWS::ACMPCA::Certificate.Qualifier", - "markdownDescription": "Defines the qualifier type\\. ACM Private CA supports the use of a URI for a CPS qualifier in this field\\. \n*Required*: Yes \n*Type*: [Qualifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-qualifier.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Defines the qualifier type\\. AWS Private CA supports the use of a URI for a CPS qualifier in this field\\. \n*Required*: Yes \n*Type*: [Qualifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-qualifier.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Qualifier" } }, @@ -420,6 +432,8 @@ "items": { "$ref": "#/definitions/AWS::ACMPCA::Certificate.CustomAttribute" }, + "markdownDescription": "Contains a sequence of one or more X\\.500 relative distinguished names \\(RDNs\\), each of which consists of an object identifier \\(OID\\) and a value\\. For more information, see NIST\u2019s definition of [Object Identifier \\(OID\\)](https://csrc.nist.gov/glossary/term/Object_Identifier)\\. \nCustom attributes cannot be used in combination with standard attributes\\.\n*Required*: No \n*Type*: List of [CustomAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customattribute.html) \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CustomAttributes", "type": "array" }, "DistinguishedNameQualifier": { @@ -448,7 +462,7 @@ "type": "string" }, "Organization": { - "markdownDescription": "Legal name of the organization with which the certificate subject is affiliated\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Legal name of the organization with which the certificate subject is affiliated\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Organization", "type": "string" }, @@ -551,13 +565,13 @@ "type": "string" }, "KeyStorageSecurityStandard": { - "markdownDescription": "Specifies a cryptographic key management compliance standard used for handling CA keys\\. \nDefault: FIPS\\_140\\_2\\_LEVEL\\_3\\_OR\\_HIGHER \nNote: `FIPS_140_2_LEVEL_3_OR_HIGHER` is not supported in Region ap\\-northeast\\-3\\. When creating a CA in the ap\\-northeast\\-3, you must provide `FIPS_140_2_LEVEL_2_OR_HIGHER` as the argument for `KeyStorageSecurityStandard`\\. Failure to do this results in an `InvalidArgsException` with the message, \"A certificate authority cannot be created in this region with the specified security standard\\.\" \n*Required*: No \n*Type*: String \n*Allowed values*: `FIPS_140_2_LEVEL_2_OR_HIGHER | FIPS_140_2_LEVEL_3_OR_HIGHER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a cryptographic key management compliance standard used for handling CA keys\\. \nDefault: FIPS\\_140\\_2\\_LEVEL\\_3\\_OR\\_HIGHER \n *Note:* `FIPS_140_2_LEVEL_3_OR_HIGHER` is not supported in the following Regions: \n+ ap\\-northeast\\-3\n+ ap\\-southeast\\-3\nWhen creating a CA in these Regions, you must provide `FIPS_140_2_LEVEL_2_OR_HIGHER` as the argument for `KeyStorageSecurityStandard`\\. Failure to do this results in an `InvalidArgsException` with the message, \"A certificate authority cannot be created in this region with the specified security standard\\.\" \n*Required*: No \n*Type*: String \n*Allowed values*: `FIPS_140_2_LEVEL_2_OR_HIGHER | FIPS_140_2_LEVEL_3_OR_HIGHER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeyStorageSecurityStandard", "type": "string" }, "RevocationConfiguration": { "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.RevocationConfiguration", - "markdownDescription": "Information about the certificate revocation list \\(CRL\\) created and maintained by your private CA\\. Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions\\. Your certificate authority can create and maintain a certificate revocation list \\(CRL\\)\\. A CRL contains information about certificates that have been revoked\\. \n*Required*: No \n*Type*: [RevocationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Certificate revocation information used by the [CreateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) and [UpdateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) actions\\. Your private certificate authority \\(CA\\) can configure Online Certificate Status Protocol \\(OCSP\\) support and/or maintain a certificate revocation list \\(CRL\\)\\. OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA\\. For more information, see [RevokeCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html) in the *AWS Private CA API Reference* and [Setting up a certificate revocation method](https://docs.aws.amazon.com/privateca/latest/userguide/revocation-setup.html) in the *AWS Private CA User Guide*\\. \nThe following requirements apply to revocation configurations\\. \n+ A configuration disabling CRLs or OCSP must contain only the `Enabled=False` parameter, and will fail if other parameters such as `CustomCname` or `ExpirationInDays` are included\\.\n+ In a CRL configuration, the `S3BucketName` parameter must conform to the [Amazon S3 bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html)\\.\n+ A configuration containing a custom Canonical Name \\(CNAME\\) parameter for CRLs or OCSP must conform to [RFC2396](https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in a CNAME\\. \n+ In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as \"http://\" or \"https://\"\\.\n*Required*: No \n*Type*: [RevocationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RevocationConfiguration" }, "SigningAlgorithm": { @@ -584,6 +598,8 @@ "type": "string" }, "UsageMode": { + "markdownDescription": "Specifies whether the CA issues general\\-purpose certificates that typically require a revocation mechanism, or short\\-lived certificates that may optionally omit revocation because they expire quickly\\. Short\\-lived certificate validity is limited to seven days\\. \nThe default value is GENERAL\\_PURPOSE\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GENERAL_PURPOSE | SHORT_LIVED_CERTIFICATE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "UsageMode", "type": "string" } }, @@ -656,7 +672,7 @@ "additionalProperties": false, "properties": { "CustomCname": { - "markdownDescription": "Name inserted into the certificate **CRL Distribution Points** extension that enables the use of an alias for the CRL distribution point\\. Use this value if you don't want the name of your S3 bucket to be public\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Name inserted into the certificate **CRL Distribution Points** extension that enables the use of an alias for the CRL distribution point\\. Use this value if you don't want the name of your S3 bucket to be public\\. \nThe content of a Canonical Name \\(CNAME\\) record must conform to [RFC2396](https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in URIs\\. Additionally, the value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\"\\.\n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Pattern*: `^[-a-zA-Z0-9;/?:@&=+$,%_.!~*()']*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomCname", "type": "string" }, @@ -671,12 +687,12 @@ "type": "number" }, "S3BucketName": { - "markdownDescription": "Name of the S3 bucket that contains the CRL\\. If you do not provide a value for the **CustomCname** argument, the name of your S3 bucket is placed into the **CRL Distribution Points** extension of the issued certificate\\. You can change the name of your bucket by calling the [UpdateCertificateAuthority](https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html) operation\\. You must specify a [bucket policy](https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-policies) that allows ACM Private CA to write the CRL to your bucket\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Name of the S3 bucket that contains the CRL\\. If you do not provide a value for the **CustomCname** argument, the name of your S3 bucket is placed into the **CRL Distribution Points** extension of the issued certificate\\. You can change the name of your bucket by calling the [UpdateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) operation\\. You must specify a [bucket policy](https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-policies) that allows AWS Private CA to write the CRL to your bucket\\. \nThe `S3BucketName` parameter must conform to the [S3 bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html)\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `^[-a-zA-Z0-9._/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3BucketName", "type": "string" }, "S3ObjectAcl": { - "markdownDescription": "Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket\\. If you choose PUBLIC\\_READ, the CRL will be accessible over the public internet\\. If you choose BUCKET\\_OWNER\\_FULL\\_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access\\. \nIf no value is specified, the default is PUBLIC\\_READ\\. \nThis default can cause CA creation to fail in some circumstances\\. If you have enabled the Block Public Access \\(BPA\\) feature in your S3 account, then you must specify the value of this parameter as `BUCKET_OWNER_FULL_CONTROL`, and not doing so results in an error\\. If you have disabled BPA in S3, then you can specify either `BUCKET_OWNER_FULL_CONTROL` or `PUBLIC_READ` as the value\\.\nFor more information, see [Blocking public access to the S3 bucket](https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-bpa)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket\\. If you choose PUBLIC\\_READ, the CRL will be accessible over the public internet\\. If you choose BUCKET\\_OWNER\\_FULL\\_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access\\. \nIf no value is specified, the default is PUBLIC\\_READ\\. \n*Note:* This default can cause CA creation to fail in some circumstances\\. If you have have enabled the Block Public Access \\(BPA\\) feature in your S3 account, then you must specify the value of this parameter as `BUCKET_OWNER_FULL_CONTROL`, and not doing so results in an error\\. If you have disabled BPA in S3, then you can specify either `BUCKET_OWNER_FULL_CONTROL` or `PUBLIC_READ` as the value\\. \nFor more information, see [Blocking public access to the S3 bucket](https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-bpa)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3ObjectAcl", "type": "string" } @@ -695,7 +711,7 @@ "items": { "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.AccessDescription" }, - "markdownDescription": "For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy\\. For more information, see [Subject Information Access](https://tools.ietf.org/html/rfc5280#section-4.2.2.2) in RFC 5280\\. \n*Required*: No \n*Type*: List of [AccessDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy\\. For more information, see [Subject Information Access](https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2) in RFC 5280\\. \n*Required*: No \n*Type*: List of [AccessDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SubjectInformationAccess", "type": "array" } @@ -706,9 +722,13 @@ "additionalProperties": false, "properties": { "ObjectIdentifier": { + "markdownDescription": "Specifies the object identifier \\(OID\\) of the attribute type of the relative distinguished name \\(RDN\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ObjectIdentifier", "type": "string" }, "Value": { + "markdownDescription": "Specifies the attribute value of relative distinguished name \\(RDN\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "string" } }, @@ -772,7 +792,7 @@ "type": "string" }, "Rfc822Name": { - "markdownDescription": "Represents `GeneralName` as an [RFC 822](https://tools.ietf.org/html/rfc822) email address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Represents `GeneralName` as an [RFC 822](https://datatracker.ietf.org/doc/html/rfc822) email address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Rfc822Name", "type": "string" }, @@ -844,7 +864,7 @@ "type": "boolean" }, "OcspCustomCname": { - "markdownDescription": "By default, ACM Private CA injects an Amazon domain into certificates being validated by the Online Certificate Status Protocol \\(OCSP\\)\\. A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain\\. \nNote: The value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\"\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "By default, AWS Private CA injects an Amazon domain into certificates being validated by the Online Certificate Status Protocol \\(OCSP\\)\\. A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain\\. \nThe content of a Canonical Name \\(CNAME\\) record must conform to [RFC2396](https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in URIs\\. Additionally, the value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\"\\.\n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Pattern*: `^[-a-zA-Z0-9;/?:@&=+$,%_.!~*()']*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OcspCustomCname", "type": "string" } @@ -904,6 +924,8 @@ "items": { "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.CustomAttribute" }, + "markdownDescription": "Contains a sequence of one or more X\\.500 relative distinguished names \\(RDNs\\), each of which consists of an object identifier \\(OID\\) and a value\\. For more information, see NIST\u2019s definition of [Object Identifier \\(OID\\)](https://csrc.nist.gov/glossary/term/Object_Identifier)\\. \nCustom attributes cannot be used in combination with standard attributes\\.\n*Required*: No \n*Type*: List of [CustomAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-customattribute.html) \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CustomAttributes", "type": "array" }, "DistinguishedNameQualifier": { @@ -1272,7 +1294,9 @@ "type": "string" }, "LoggingConfiguration": { - "$ref": "#/definitions/AWS::APS::Workspace.LoggingConfiguration" + "$ref": "#/definitions/AWS::APS::Workspace.LoggingConfiguration", + "markdownDescription": "The LoggingConfiguration attribute is used to set the logging configuration for the workspace\\. \n*Required*: No \n*Type*: [LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-loggingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LoggingConfiguration" }, "Tags": { "items": { @@ -1309,6 +1333,8 @@ "additionalProperties": false, "properties": { "LogGroupArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the CloudWatch log group the logs are emitted to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogGroupArn", "type": "string" } }, @@ -2098,7 +2124,7 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "Personal Access token for 3rd party source control system for an Amplify app, used to create webhook and read\\-only deploy key\\. Token is not stored\\. \n*Length Constraints:* Minimum length of 1\\. Maximum length of 255\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The personal access token for a GitHub repository for an Amplify app\\. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App\\. The token is not stored\\. \nUse `AccessToken` for GitHub repositories only\\. To authorize access to a repository provider such as Bitbucket or CodeCommit, use `OauthToken`\\. \nYou must specify either `AccessToken` or `OauthToken` when you create a new app\\. \nExisting Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD\\. However, we strongly recommend that you migrate these apps to use the GitHub App\\. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* \\. \n*Length Constraints:* Minimum length of 1\\. Maximum length of 255\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, @@ -2136,7 +2162,7 @@ "type": "string" }, "EnableBranchAutoDeletion": { - "markdownDescription": "Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableBranchAutoDeletion", "type": "boolean" }, @@ -2159,11 +2185,13 @@ "type": "string" }, "OauthToken": { - "markdownDescription": "The OAuth token for a third\\-party source control system for an Amplify app\\. The OAuth token is used to create a webhook and a read\\-only deploy key\\. The OAuth token is not stored\\. \n*Length Constraints:* Maximum length of 1000\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The OAuth token for a third\\-party source control system for an Amplify app\\. The OAuth token is used to create a webhook and a read\\-only deploy key using SSH cloning\\. The OAuth token is not stored\\. \nUse `OauthToken` for repository providers other than GitHub, such as Bitbucket or CodeCommit\\. To authorize access to GitHub as your repository provider, use `AccessToken`\\. \nYou must specify either `OauthToken` or `AccessToken` when you create a new app\\. \nExisting Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD\\. However, we strongly recommend that you migrate these apps to use the GitHub App\\. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* \\. \n*Length Constraints:* Maximum length of 1000\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OauthToken", "type": "string" }, "Platform": { + "markdownDescription": "The platform for the Amplify app\\. For a static app, set the platform type to `WEB`\\. For a dynamic server\\-side rendered \\(SSR\\) app, set the platform type to `WEB_COMPUTE`\\. For an app requiring Amplify Hosting's original SSR support only, set the platform type to `WEB_DYNAMIC`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Platform", "type": "string" }, "Repository": { @@ -2243,7 +2271,7 @@ "type": "boolean" }, "EnablePullRequestPreview": { - "markdownDescription": "Sets whether pull request previews are enabled for each branch that Amplify Console automatically creates for your app\\. Amplify Console creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch\\. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch\\. \nTo provide backend support for your preview, the Amplify Console automatically provisions a temporary backend environment that it deletes when the pull request is closed\\. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property\\. \nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Console User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app\\. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch\\. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch\\. \nTo provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed\\. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property\\. \nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnablePullRequestPreview", "type": "boolean" }, @@ -2256,10 +2284,12 @@ "type": "array" }, "Framework": { + "markdownDescription": "The framework for the autocreated branch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Framework", "type": "string" }, "PullRequestEnvironmentName": { - "markdownDescription": "If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews\\. For example, you could specify an environment named `prod`, `test`, or `dev` that you initialized with the Amplify CLI\\. \nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true`\\. \nIf you don't specify an environment, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment\\. Amplify Console deletes this environment when the pull request is closed\\. \nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Console User Guide*\\. \n*Length Constraints:* Maximum length of 20\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews\\. For example, you could specify an environment named `prod`, `test`, or `dev` that you initialized with the Amplify CLI\\. \nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true`\\. \nIf you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment\\. Amplify deletes this environment when the pull request is closed\\. \nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide*\\. \n*Length Constraints:* Maximum length of 20\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PullRequestEnvironmentName", "type": "string" }, @@ -2413,7 +2443,7 @@ "type": "boolean" }, "EnablePullRequestPreview": { - "markdownDescription": "Sets whether the Amplify Console creates a preview for each pull request that is made for this branch\\. If this property is enabled, the Amplify Console deploys your app to a unique preview URL after each pull request is opened\\. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch\\. \nTo provide backend support for your preview, the Amplify Console automatically provisions a temporary backend environment that it deletes when the pull request is closed\\. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property\\. \nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Console User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch\\. If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened\\. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch\\. \nTo provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed\\. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property\\. \nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnablePullRequestPreview", "type": "boolean" }, @@ -2426,10 +2456,12 @@ "type": "array" }, "Framework": { + "markdownDescription": "The framework for the branch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Framework", "type": "string" }, "PullRequestEnvironmentName": { - "markdownDescription": "If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews\\. For example, you could specify an environment named `prod`, `test`, or `dev` that you initialized with the Amplify CLI and mapped to this branch\\. \nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true`\\. \nIf you don't specify an environment, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment\\. Amplify Console deletes this environment when the pull request is closed\\. \nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Console User Guide*\\. \n*Length Constraints:* Maximum length of 20\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews\\. For example, you could specify an environment named `prod`, `test`, or `dev` that you initialized with the Amplify CLI and mapped to this branch\\. \nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true`\\. \nIf you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment\\. Amplify Hosting deletes this environment when the pull request is closed\\. \nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide*\\. \n*Length Constraints:* Maximum length of 20\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PullRequestEnvironmentName", "type": "string" }, @@ -2675,6 +2707,8 @@ "additionalProperties": false, "properties": { "AppId": { + "markdownDescription": "The unique ID of the Amplify app associated with the component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppId", "type": "string" }, "BindingProperties": { @@ -2713,6 +2747,8 @@ "type": "string" }, "EnvironmentName": { + "markdownDescription": "The name of the backend environment that is a part of the Amplify app\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnvironmentName", "type": "string" }, "Events": { @@ -2732,7 +2768,7 @@ "type": "string" }, "Overrides": { - "markdownDescription": "Describes the component's properties that can be overriden in a customized instance of the component\\. You can't specify `tags` as a valid property for `overrides`\\. \n*Required*: Yes \n*Type*: Map of [ComponentOverridesValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentoverridesvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Describes the component's properties that can be overriden in a customized instance of the component\\. You can't specify `tags` as a valid property for `overrides`\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Overrides", "type": "object" }, @@ -2818,7 +2854,7 @@ }, "Fields": { "additionalProperties": false, - "markdownDescription": "A dictionary of key\\-value pairs mapping Amplify Studio properties to fields in a data model\\. Use when the action performs an operation on an Amplify DataStore model\\. \n*Required*: No \n*Type*: [ComponentProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A dictionary of key\\-value pairs mapping Amplify Studio properties to fields in a data model\\. Use when the action performs an operation on an Amplify DataStore model\\. \n*Required*: No \n*Type*: Map of [ComponentProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Component.ComponentProperty" @@ -2948,7 +2984,7 @@ }, "Events": { "additionalProperties": false, - "markdownDescription": "Describes the events that can be raised on the child component\\. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components\\. \n*Required*: No \n*Type*: [ComponentEvents](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevents.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Describes the events that can be raised on the child component\\. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components\\. \n*Required*: No \n*Type*: Map of [ComponentEvent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Component.ComponentEvent" @@ -2964,7 +3000,7 @@ }, "Properties": { "additionalProperties": false, - "markdownDescription": "Describes the properties of the child component\\. You can't specify `tags` as a valid property for `properties`\\. \n*Required*: Yes \n*Type*: [ComponentProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Describes the properties of the child component\\. You can't specify `tags` as a valid property for `properties`\\. \n*Required*: Yes \n*Type*: Map of [ComponentProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Component.ComponentProperty" @@ -3083,7 +3119,7 @@ }, "Bindings": { "additionalProperties": false, - "markdownDescription": "The information to bind the component property to form data\\. \n*Required*: No \n*Type*: [FormBindings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-formbindings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The information to bind the component property to form data\\. \n*Required*: No \n*Type*: Map of [FormBindingElement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-formbindingelement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Component.FormBindingElement" @@ -3186,13 +3222,13 @@ "additionalProperties": false, "properties": { "Overrides": { - "markdownDescription": "The properties of the component variant that can be overriden when customizing an instance of the component\\. You can't specify `tags` as a valid property for `overrides`\\. \n*Required*: No \n*Type*: [ComponentOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentoverrides.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties of the component variant that can be overriden when customizing an instance of the component\\. You can't specify `tags` as a valid property for `overrides`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Overrides", "type": "object" }, "VariantValues": { "additionalProperties": true, - "markdownDescription": "The combination of variants that comprise this variant\\. \n*Required*: No \n*Type*: [ComponentVariantValues](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentvariantvalues.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The combination of variants that comprise this variant\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -3208,9 +3244,13 @@ "additionalProperties": false, "properties": { "Element": { + "markdownDescription": "The name of the component to retrieve a value from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Element", "type": "string" }, "Property": { + "markdownDescription": "The property to retrieve a value from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Property", "type": "string" } }, @@ -3339,54 +3379,76 @@ "additionalProperties": false, "properties": { "AppId": { + "markdownDescription": "The unique ID of the Amplify app associated with the form\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppId", "type": "string" }, "Cta": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormCTA" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormCTA", + "markdownDescription": "Stores the call to action configuration for the form\\. \n*Required*: No \n*Type*: [FormCTA](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cta" }, "DataType": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormDataTypeConfig" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormDataTypeConfig", + "markdownDescription": "The type of data source to use to create the form\\. \n*Required*: Yes \n*Type*: [FormDataTypeConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formdatatypeconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType" }, "EnvironmentName": { + "markdownDescription": "The name of the backend environment that is a part of the Amplify app\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnvironmentName", "type": "string" }, "Fields": { "additionalProperties": false, + "markdownDescription": "Stores the information about the form's fields\\. \n*Required*: Yes \n*Type*: Map of [FieldConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldConfig" } }, + "title": "Fields", "type": "object" }, "FormActionType": { + "markdownDescription": "The operation to perform on the specified form\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FormActionType", "type": "string" }, "Name": { + "markdownDescription": "The name of the form\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "SchemaVersion": { + "markdownDescription": "The schema version of the form when it was imported\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SchemaVersion", "type": "string" }, "SectionalElements": { "additionalProperties": false, + "markdownDescription": "Stores the visual helper elements for the form that are not associated with any data\\. \n*Required*: Yes \n*Type*: Map of [SectionalElement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.SectionalElement" } }, + "title": "SectionalElements", "type": "object" }, "Style": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyle" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyle", + "markdownDescription": "Stores the configuration for the form's style\\. \n*Required*: Yes \n*Type*: [FormStyle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyle.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Style" }, "Tags": { "additionalProperties": true, + "markdownDescription": "One or more key\\-value pairs to use when tagging the form\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -3426,21 +3488,31 @@ "additionalProperties": false, "properties": { "Excluded": { + "markdownDescription": "Specifies whether to hide a field\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Excluded", "type": "boolean" }, "InputType": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldInputConfig" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldInputConfig", + "markdownDescription": "Describes the configuration for the default input value to display for a field\\. \n*Required*: No \n*Type*: [FieldInputConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputType" }, "Label": { + "markdownDescription": "The label for the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Label", "type": "string" }, "Position": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldPosition" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldPosition", + "markdownDescription": "Specifies the field position\\. \n*Required*: No \n*Type*: [FieldPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Position" }, "Validations": { "items": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldValidationConfiguration" }, + "markdownDescription": "The validations to perform on the value in the field\\. \n*Required*: No \n*Type*: List of [FieldValidationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Validations", "type": "array" } }, @@ -3450,49 +3522,79 @@ "additionalProperties": false, "properties": { "DefaultChecked": { + "markdownDescription": "Specifies whether a field has a default value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultChecked", "type": "boolean" }, "DefaultCountryCode": { + "markdownDescription": "The default country code for a phone number\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultCountryCode", "type": "string" }, "DefaultValue": { + "markdownDescription": "The default value for the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultValue", "type": "string" }, "DescriptiveText": { + "markdownDescription": "The text to display to describe the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DescriptiveText", "type": "string" }, "IsArray": { + "markdownDescription": "Specifies whether to render the field as an array\\. This property is ignored if the `dataSourceType` for the form is a Data Store\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsArray", "type": "boolean" }, "MaxValue": { + "markdownDescription": "The maximum value to display for the field\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxValue", "type": "number" }, "MinValue": { + "markdownDescription": "The minimum value to display for the field\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MinValue", "type": "number" }, "Name": { + "markdownDescription": "The name of the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Placeholder": { + "markdownDescription": "The text to display as a placeholder for the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Placeholder", "type": "string" }, "ReadOnly": { + "markdownDescription": "Specifies a read only field\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReadOnly", "type": "boolean" }, "Required": { + "markdownDescription": "Specifies a field that requires input\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Required", "type": "boolean" }, "Step": { + "markdownDescription": "The stepping increment for a numeric value in a field\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Step", "type": "number" }, "Type": { + "markdownDescription": "The input type for the field\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "Value": { + "markdownDescription": "The value for the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" }, "ValueMappings": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.ValueMappings" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.ValueMappings", + "markdownDescription": "The information to use to customize the input fields with data at runtime\\. \n*Required*: No \n*Type*: [ValueMappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemappings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ValueMappings" } }, "required": [ @@ -3504,12 +3606,18 @@ "additionalProperties": false, "properties": { "Below": { + "markdownDescription": "The field position is below the field specified by the string\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Below", "type": "string" }, "Fixed": { + "markdownDescription": "The field position is fixed and doesn't change in relation to other fields\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Fixed", "type": "string" }, "RightOf": { + "markdownDescription": "The field position is to the right of the field specified by the string\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RightOf", "type": "string" } }, @@ -3522,18 +3630,26 @@ "items": { "type": "number" }, + "markdownDescription": "The validation to perform on a number value\\. \n*Required*: No \n*Type*: List of Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NumValues", "type": "array" }, "StrValues": { "items": { "type": "string" }, + "markdownDescription": "The validation to perform on a string value\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StrValues", "type": "array" }, "Type": { + "markdownDescription": "The validation to perform on an object type\\.`` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "ValidationMessage": { + "markdownDescription": "The validation message to display\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ValidationMessage", "type": "string" } }, @@ -3546,13 +3662,19 @@ "additionalProperties": false, "properties": { "Children": { + "markdownDescription": "Describes the button's properties\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Children", "type": "string" }, "Excluded": { + "markdownDescription": "Specifies whether the button is visible on the form\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Excluded", "type": "boolean" }, "Position": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldPosition" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldPosition", + "markdownDescription": "The position of the button\\. \n*Required*: No \n*Type*: [FieldPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Position" } }, "type": "object" @@ -3561,16 +3683,24 @@ "additionalProperties": false, "properties": { "Cancel": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormButton" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormButton", + "markdownDescription": "Displays a cancel button\\. \n*Required*: No \n*Type*: [FormButton](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cancel" }, "Clear": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormButton" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormButton", + "markdownDescription": "Displays a clear button\\. \n*Required*: No \n*Type*: [FormButton](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Clear" }, "Position": { + "markdownDescription": "The position of the button\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Position", "type": "string" }, "Submit": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormButton" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormButton", + "markdownDescription": "Displays a submit button\\. \n*Required*: No \n*Type*: [FormButton](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Submit" } }, "type": "object" @@ -3579,9 +3709,13 @@ "additionalProperties": false, "properties": { "DataSourceType": { + "markdownDescription": "The data source type, either an Amplify DataStore model or a custom data type\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSourceType", "type": "string" }, "DataTypeName": { + "markdownDescription": "The unique name of the data type you are using as the data source for the form\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataTypeName", "type": "string" } }, @@ -3595,6 +3729,8 @@ "additionalProperties": false, "properties": { "Value": { + "markdownDescription": "The value to assign to the input field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -3604,13 +3740,19 @@ "additionalProperties": false, "properties": { "HorizontalGap": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyleConfig" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyleConfig", + "markdownDescription": "The spacing for the horizontal gap\\. \n*Required*: No \n*Type*: [FormStyleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HorizontalGap" }, "OuterPadding": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyleConfig" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyleConfig", + "markdownDescription": "The size of the outer padding for the form\\. \n*Required*: No \n*Type*: [FormStyleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OuterPadding" }, "VerticalGap": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyleConfig" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyleConfig", + "markdownDescription": "The spacing for the vertical gap\\. \n*Required*: No \n*Type*: [FormStyleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VerticalGap" } }, "type": "object" @@ -3619,9 +3761,13 @@ "additionalProperties": false, "properties": { "TokenReference": { + "markdownDescription": "A reference to a design token to use to bind the form's style properties to an existing theme\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TokenReference", "type": "string" }, "Value": { + "markdownDescription": "The value of the style setting\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -3631,21 +3777,33 @@ "additionalProperties": false, "properties": { "Excluded": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Excluded", "type": "boolean" }, "Level": { + "markdownDescription": "Specifies the size of the font for a `Heading` sectional element\\. Valid values are `1 | 2 | 3 | 4 | 5 | 6`\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Level", "type": "number" }, "Orientation": { + "markdownDescription": "Specifies the orientation for a `Divider` sectional element\\. Valid values are `horizontal` or `vertical`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Orientation", "type": "string" }, "Position": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldPosition" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldPosition", + "markdownDescription": "Specifies the position of the text in a field for a `Text` sectional element\\. \n*Required*: No \n*Type*: [FieldPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Position" }, "Text": { + "markdownDescription": "The text for a `Text` sectional element\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Text", "type": "string" }, "Type": { + "markdownDescription": "The type of sectional element\\. Valid values are `Heading`, `Text`, and `Divider`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -3658,10 +3816,14 @@ "additionalProperties": false, "properties": { "DisplayValue": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormInputValueProperty" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormInputValueProperty", + "markdownDescription": "The value to display for the complex object\\. \n*Required*: No \n*Type*: [FormInputValueProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DisplayValue" }, "Value": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormInputValueProperty" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormInputValueProperty", + "markdownDescription": "The complex object\\. \n*Required*: Yes \n*Type*: [FormInputValueProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value" } }, "required": [ @@ -3676,6 +3838,8 @@ "items": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.ValueMapping" }, + "markdownDescription": "The value and display value pairs\\. \n*Required*: Yes \n*Type*: List of [ValueMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemapping.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Values", "type": "array" } }, @@ -3720,9 +3884,13 @@ "additionalProperties": false, "properties": { "AppId": { + "markdownDescription": "The unique ID for the Amplify app associated with the theme\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppId", "type": "string" }, "EnvironmentName": { + "markdownDescription": "The name of the backend environment that is a part of the Amplify app\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnvironmentName", "type": "string" }, "Name": { @@ -3856,7 +4024,7 @@ "additionalProperties": false, "properties": { "CloudWatchRoleArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an IAM role that has write access to CloudWatch Logs in your account\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN of an Amazon CloudWatch role for the current Account\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchRoleArn", "type": "string" } @@ -3919,22 +4087,22 @@ "additionalProperties": false, "properties": { "CustomerId": { - "markdownDescription": "An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomerId", "type": "string" }, "Description": { - "markdownDescription": "A description of the purpose of the API key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the ApiKey\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "Enabled": { - "markdownDescription": "Indicates whether the API key can be used by clients\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the ApiKey can be used by callers\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, "GenerateDistinctId": { - "markdownDescription": "Specifies whether the key identifier is distinct from the created API key value\\. This parameter is deprecated and should not be used\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies whether \\(`true`\\) or not \\(`false`\\) the key identifier is distinct from the created API key value\\. This parameter is deprecated and should not be used\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "GenerateDistinctId", "type": "boolean" }, @@ -3947,7 +4115,7 @@ "items": { "$ref": "#/definitions/AWS::ApiGateway::ApiKey.StageKey" }, - "markdownDescription": "A list of stages to associate with this API key\\. \n*Required*: No \n*Type*: List of [StageKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "DEPRECATED FOR USAGE PLANS \\- Specifies stages associated with the API key\\. \n*Required*: No \n*Type*: List of [StageKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StageKeys", "type": "array" }, @@ -3955,12 +4123,12 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the API key\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key\\-value map of strings\\. The valid character set is \\[a\\-zA\\-Z\\+\\-=\\.\\_:/\\]\\. The tag key can be up to 128 characters and must not start with `aws:`\\. The tag value can be up to 256 characters\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, "Value": { - "markdownDescription": "The value of the API key\\. Must be at least 20 characters long\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a value of the API key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Value", "type": "string" } @@ -3991,12 +4159,12 @@ "additionalProperties": false, "properties": { "RestApiId": { - "markdownDescription": "The ID of a `RestApi` resource that includes the stage with which you want to associate the API key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RestApiId", "type": "string" }, "StageName": { - "markdownDescription": "The name of the stage with which to associate the API key\\. The stage must be included in the `RestApi` resource that you specified in the `RestApiId` property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The stage name associated with the stage key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StageName", "type": "string" } @@ -4039,32 +4207,32 @@ "additionalProperties": false, "properties": { "AuthType": { - "markdownDescription": "An optional customer\\-defined field that's used in OpenApi imports and exports without functional impact\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Optional customer\\-defined field, used in OpenAPI imports and exports without functional impact\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthType", "type": "string" }, "AuthorizerCredentials": { - "markdownDescription": "The credentials that are required for the authorizer\\. To specify an IAM role that API Gateway assumes, specify the role's Amazon Resource Name \\(ARN\\)\\. To use resource\\-based permissions on the Lambda function, specify null\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer\\. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name \\(ARN\\)\\. To use resource\\-based permissions on the Lambda function, specify null\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizerCredentials", "type": "string" }, "AuthorizerResultTtlInSeconds": { - "markdownDescription": "The time\\-to\\-live \\(TTL\\) period, in seconds, that specifies how long API Gateway caches authorizer results\\. If you specify a value greater than 0, API Gateway caches the authorizer responses\\. By default, API Gateway sets this property to 300\\. The maximum value is 3600, or 1 hour\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The TTL in seconds of cached authorizer results\\. If it equals 0, authorization caching is disabled\\. If it is greater than 0, API Gateway will cache authorizer responses\\. If this field is not set, the default value is 300\\. The maximum value is 3600, or 1 hour\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizerResultTtlInSeconds", "type": "number" }, "AuthorizerUri": { - "markdownDescription": "The authorizer's Uniform Resource Identifier \\(URI\\)\\. If you specify `TOKEN` for the authorizer's `Type` property, specify a Lambda function URI that has the form `arn:aws:apigateway:region:lambda:path/path`\\. The path usually has the form /2015\\-03\\-31/functions/*LambdaFunctionARN*/invocations\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the authorizer's Uniform Resource Identifier \\(URI\\)\\. For `TOKEN` or `REQUEST` authorizers, this must be a well\\-formed Lambda function URI, for example, `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations`\\. In general, the URI has this form `arn:aws:apigateway:{region}:lambda:path/{service_api}`, where `{region}` is the same as the region hosting the Lambda function, `path` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial `/`\\. For Lambda functions, this is usually of the form `/2015-03-31/functions/[FunctionARN]/invocations`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizerUri", "type": "string" }, "IdentitySource": { - "markdownDescription": "The source of the identity in an incoming request\\. \nIf you specify `TOKEN` or `COGNITO_USER_POOLS` for the `Type` property, this property is required\\. Specify a header mapping expression using the form `method.request.header.name`, where *name* is the name of a custom authorization header that clients submit as part of their requests\\. \nIf you specify `REQUEST` for the `Type` property, this property is required when authorization caching is enabled\\. Specify a comma\\-separated string of one or more mapping expressions of the specified request parameter using the form `method.request.parameter.name`\\. For supported parameter types, see [Configure Lambda Authorizer Using the API Gateway Console](https://docs.aws.amazon.com/apigateway/latest/developerguide/configure-api-gateway-lambda-authorization-with-console.html) in the *API Gateway Developer Guide*\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identity source for which authorization is requested\\. For a `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client\\. For example, if the token header name is `Auth`, the header mapping expression is `method.request.header.Auth`\\. For the `REQUEST` authorizer, this is required when authorization caching is enabled\\. The value is a comma\\-separated string of one or more mapping expressions of the specified request parameters\\. For example, if an `Auth` header, a `Name` query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`\\. These parameters will be used to derive the authorization caching key and to perform runtime validation of the `REQUEST` authorizer by verifying all of the identity\\-related request parameters are present, not null and non\\-empty\\. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function\\. The valid value is a string of comma\\-separated mapping expressions of the specified request parameters\\. When the authorization caching is not enabled, this property is optional\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdentitySource", "type": "string" }, "IdentityValidationExpression": { - "markdownDescription": "A validation expression for the incoming identity\\. If you specify `TOKEN` for the authorizer's `Type` property, specify a regular expression\\. API Gateway uses the expression to attempt to match the incoming client token, and proceeds if the token matches\\. If the token doesn't match, API Gateway responds with a 401 \\(unauthorized request\\) error code\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A validation expression for the incoming identity token\\. For `TOKEN` authorizers, this value is a regular expression\\. For `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud` field of the incoming token from the client against the specified regular expression\\. It will invoke the authorizer's Lambda function when there is a match\\. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function\\. The validation expression does not apply to the `REQUEST` authorizer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdentityValidationExpression", "type": "string" }, @@ -4077,17 +4245,17 @@ "items": { "type": "string" }, - "markdownDescription": "A list of the Amazon Cognito user pool Amazon Resource Names \\(ARNs\\) to associate with this authorizer\\. Required if you specify `COGNITO_USER_POOLS` as the authorizer `Type`\\. For more information, see [Use Amazon Cognito User Pools](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html#apigateway-enable-cognito-user-pool) in the *API Gateway Developer Guide*\\. \n*Required*: Conditional \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer\\. Each element is of this format: `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}`\\. For a `TOKEN` or `REQUEST` authorizer, this is not defined\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProviderARNs", "type": "array" }, "RestApiId": { - "markdownDescription": "The ID of the `RestApi` resource that API Gateway creates the authorizer in\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" }, "Type": { - "markdownDescription": "The type of authorizer\\. Valid values include: \n+ `TOKEN`: A custom authorizer that uses a Lambda function\\.\n+ `COGNITO_USER_POOLS`: An authorizer that uses Amazon Cognito user pools\\.\n+ `REQUEST`: An authorizer that uses a Lambda function using incoming request parameters\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The authorizer type\\. Valid values are `TOKEN` for a Lambda function using a single authorization token submitted in a custom header, `REQUEST` for a Lambda function using incoming request parameters, and `COGNITO_USER_POOLS` for using an Amazon Cognito user pool\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" } @@ -4156,27 +4324,27 @@ "additionalProperties": false, "properties": { "BasePath": { - "markdownDescription": "The base path name that callers of the API must provide in the URL after the domain name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The base path name that callers of the API must provide as part of the URL after the domain name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "BasePath", "type": "string" }, "DomainName": { - "markdownDescription": "The `DomainName` of an [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The domain name of the BasePathMapping resource to be described\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DomainName", "type": "string" }, "Id": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Id", "type": "string" }, "RestApiId": { - "markdownDescription": "The ID of the API\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RestApiId", "type": "string" }, "Stage": { - "markdownDescription": "The name of the API's stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the associated stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Stage", "type": "string" } @@ -4243,7 +4411,7 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "A description of the client certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the client certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -4251,7 +4419,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the client certificate\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -4315,26 +4483,26 @@ "properties": { "DeploymentCanarySettings": { "$ref": "#/definitions/AWS::ApiGateway::Deployment.DeploymentCanarySettings", - "markdownDescription": "Specifies settings for the canary deployment\\. \n*Required*: No \n*Type*: [DeploymentCanarySettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The input configuration for a canary deployment\\. \n*Required*: No \n*Type*: [DeploymentCanarySettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DeploymentCanarySettings" }, "Description": { - "markdownDescription": "A description of the purpose of the API Gateway deployment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description for the Deployment resource to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "RestApiId": { - "markdownDescription": "The ID of the `RestApi` resource to deploy\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" }, "StageDescription": { "$ref": "#/definitions/AWS::ApiGateway::Deployment.StageDescription", - "markdownDescription": "Configures the stage that API Gateway creates with this deployment\\. \n*Required*: No \n*Type*: [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the Stage resource for the Deployment resource to create\\. \n*Required*: No \n*Type*: [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StageDescription" }, "StageName": { - "markdownDescription": "A name for the stage that API Gateway creates with this deployment\\. Use only alphanumeric characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the Stage resource for the Deployment resource to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StageName", "type": "string" } @@ -4374,7 +4542,7 @@ "type": "string" }, "Format": { - "markdownDescription": "A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference)\\. The format must include at least `$context.requestId`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A single line format of the access logs of data, as specified by selected $context variables\\. The format must include at least `$context.requestId`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Format", "type": "string" } @@ -4401,7 +4569,7 @@ "type": "object" }, "UseStageCache": { - "markdownDescription": "Whether the canary deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UseStageCache", "type": "boolean" } @@ -4412,13 +4580,13 @@ "additionalProperties": false, "properties": { "PercentTraffic": { - "markdownDescription": "The percentage \\(0\\-100\\) of traffic diverted to a canary deployment\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The percentage \\(0\\.0\\-100\\.0\\) of traffic routed to the canary deployment\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PercentTraffic", "type": "number" }, "StageVariableOverrides": { "additionalProperties": true, - "markdownDescription": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary\\. These stage variables are represented as a string\\-to\\-string map between stage variable names and their values\\. \nDuplicates are not allowed\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A stage variable overrides used for the canary release deployment\\. They can override existing stage variables or add new stage variables for the canary release deployment\\. These stage variables are represented as a string\\-to\\-string map between stage variable names and their values\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -4428,7 +4596,7 @@ "type": "object" }, "UseStageCache": { - "markdownDescription": "Whether the canary deployment uses the stage cache\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A Boolean flag to indicate whether the canary release deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "UseStageCache", "type": "boolean" } @@ -4439,22 +4607,22 @@ "additionalProperties": false, "properties": { "CacheDataEncrypted": { - "markdownDescription": "Indicates whether the cached responses are encrypted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the cached responses are encrypted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheDataEncrypted", "type": "boolean" }, "CacheTtlInSeconds": { - "markdownDescription": "The time\\-to\\-live \\(TTL\\) period, in seconds, that specifies how long API Gateway caches responses\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the time to live \\(TTL\\), in seconds, for cached responses\\. The higher the TTL, the longer the response will be cached\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheTtlInSeconds", "type": "number" }, "CachingEnabled": { - "markdownDescription": "Indicates whether responses are cached and returned for requests\\. You must enable a cache cluster on the stage to cache responses\\. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether responses should be cached and returned for requests\\. A cache cluster must be enabled on the stage for responses to be cached\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CachingEnabled", "type": "boolean" }, "DataTraceEnabled": { - "markdownDescription": "Indicates whether data trace logging is enabled for methods in the stage\\. API Gateway pushes these logs to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataTraceEnabled", "type": "boolean" }, @@ -4464,12 +4632,12 @@ "type": "string" }, "LoggingLevel": { - "markdownDescription": "The logging level for this method\\. For valid values, see the `loggingLevel` property of the [Stage](https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the *Amazon API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs\\. Valid values are `OFF`, `ERROR`, and `INFO`\\. Choose `ERROR` to write only error\\-level entries to CloudWatch Logs, or choose `INFO` to include all `ERROR` events as well as extra informational events\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoggingLevel", "type": "string" }, "MetricsEnabled": { - "markdownDescription": "Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether Amazon CloudWatch metrics are enabled for this method\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricsEnabled", "type": "boolean" }, @@ -4479,12 +4647,12 @@ "type": "string" }, "ThrottlingBurstLimit": { - "markdownDescription": "The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account\\. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the throttling burst limit\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThrottlingBurstLimit", "type": "number" }, "ThrottlingRateLimit": { - "markdownDescription": "The number of steady\\-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account\\. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the throttling rate limit\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThrottlingRateLimit", "type": "number" } @@ -4500,12 +4668,12 @@ "title": "AccessLogSetting" }, "CacheClusterEnabled": { - "markdownDescription": "Indicates whether cache clustering is enabled for the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether a cache cluster is enabled for the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheClusterEnabled", "type": "boolean" }, "CacheClusterSize": { - "markdownDescription": "The size of the stage's cache cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The size of the stage's cache cluster\\. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheClusterSize", "type": "string" }, @@ -4550,7 +4718,7 @@ "type": "string" }, "LoggingLevel": { - "markdownDescription": "The logging level for this method\\. For valid values, see the `loggingLevel` property of the [Stage](https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the *Amazon API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The logging level for this method\\. For valid values, see the `loggingLevel` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoggingLevel", "type": "string" }, @@ -4641,16 +4809,16 @@ "properties": { "Location": { "$ref": "#/definitions/AWS::ApiGateway::DocumentationPart.Location", - "markdownDescription": "The location of the API entity that the documentation applies to\\. \n*Required*: Yes \n*Type*: [Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The location of the targeted API entity of the to\\-be\\-created documentation part\\. \n*Required*: Yes \n*Type*: [Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Location" }, "Properties": { - "markdownDescription": "The documentation content map of the targeted API entity\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The new documentation content map of the targeted API entity\\. Enclosed key\\-value pairs are API\\-specific, but only OpenAPI\\-compliant key\\-value pairs can be exported and, hence, published\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Properties", "type": "string" }, "RestApiId": { - "markdownDescription": "The identifier of the targeted API entity\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" } @@ -4687,27 +4855,27 @@ "additionalProperties": false, "properties": { "Method": { - "markdownDescription": "The HTTP verb of a method\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The HTTP verb of a method\\. It is a valid field for the API entity types of `METHOD`, `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`\\. The default value is `*` for any method\\. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other `location` attributes, the child entity's `method` attribute must match that of the parent entity exactly\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Method", "type": "string" }, "Name": { - "markdownDescription": "The name of the targeted API entity\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the targeted API entity\\. It is a valid and required field for the API entity types of `AUTHORIZER`, `MODEL`, `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY` and `RESPONSE_HEADER`\\. It is an invalid field for any other entity type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, "Path": { - "markdownDescription": "The URL path of the target\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The URL path of the target\\. It is a valid field for the API entity types of `RESOURCE`, `METHOD`, `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`\\. The default value is `/` for the root resource\\. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other `location` attributes, the child entity's `path` attribute must match that of the parent entity as a prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Path", "type": "string" }, "StatusCode": { - "markdownDescription": "The HTTP status code of a response\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The HTTP status code of a response\\. It is a valid field for the API entity types of `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`\\. The default value is `*` for any status code\\. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other `location` attributes, the child entity's `statusCode` attribute must match that of the parent entity exactly\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^([1-5]\\d\\d|\\*|\\s*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StatusCode", "type": "string" }, "Type": { - "markdownDescription": "The type of API entity that the documentation content applies to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of API entity to which the documentation content applies\\. Valid values are `API`, `AUTHORIZER`, `MODEL`, `RESOURCE`, `METHOD`, `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`\\. Content inheritance does not apply to any entity of the `API`, `AUTHORIZER`, `METHOD`, `MODEL`, `REQUEST_BODY`, or `RESOURCE` type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `API | AUTHORIZER | METHOD | MODEL | PATH_PARAMETER | QUERY_PARAMETER | REQUEST_BODY | REQUEST_HEADER | RESOURCE | RESPONSE | RESPONSE_BODY | RESPONSE_HEADER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -4750,17 +4918,17 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "The description of the API documentation snapshot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description about the new documentation snapshot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "DocumentationVersion": { - "markdownDescription": "The version identifier of the API documentation snapshot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The version identifier of the to\\-be\\-updated documentation version\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DocumentationVersion", "type": "string" }, "RestApiId": { - "markdownDescription": "The identifier of the API\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" } @@ -4828,23 +4996,23 @@ "additionalProperties": false, "properties": { "CertificateArn": { - "markdownDescription": "The reference to an AWS\\-managed certificate for use by the edge\\-optimized endpoint for this domain name\\. AWS Certificate Manager is the only supported source\\. For requirements and additional information about setting up certificates, see [Get Certificates Ready in AWS Certificate Manager](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html#how-to-custom-domains-prerequisites) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The reference to an AWS\\-managed certificate that will be used by edge\\-optimized endpoint for this domain name\\. AWS Certificate Manager is the only supported source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CertificateArn", "type": "string" }, "DomainName": { - "markdownDescription": "The custom domain name for your API\\. Uppercase letters are not supported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The custom domain name as an API host name, for example, `my-api.example.com`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DomainName", "type": "string" }, "EndpointConfiguration": { "$ref": "#/definitions/AWS::ApiGateway::DomainName.EndpointConfiguration", - "markdownDescription": "A list of the endpoint types of the domain name\\. \n*Required*: No \n*Type*: [EndpointConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The endpoint configuration of this DomainName showing the endpoint types of the domain name\\. \n*Required*: No \n*Type*: [EndpointConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EndpointConfiguration" }, "MutualTlsAuthentication": { "$ref": "#/definitions/AWS::ApiGateway::DomainName.MutualTlsAuthentication", - "markdownDescription": "The mutual TLS authentication configuration for a custom domain name\\. \n*Required*: No \n*Type*: [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The mutual TLS authentication configuration for a custom domain name\\. If specified, API Gateway performs two\\-way authentication between the client and the server\\. Clients must present a trusted certificate to access your API\\. \n*Required*: No \n*Type*: [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MutualTlsAuthentication" }, "OwnershipVerificationCertificateArn": { @@ -4853,12 +5021,12 @@ "type": "string" }, "RegionalCertificateArn": { - "markdownDescription": "The reference to an AWS\\-managed certificate for use by the regional endpoint for the domain name\\. AWS Certificate Manager is the only supported source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The reference to an AWS\\-managed certificate that will be used for validating the regional domain name\\. AWS Certificate Manager is the only supported source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RegionalCertificateArn", "type": "string" }, "SecurityPolicy": { - "markdownDescription": "The Transport Layer Security \\(TLS\\) version \\+ cipher suite for this domain name\\. \nValid values include `TLS_1_0` and `TLS_1_2`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Transport Layer Security \\(TLS\\) version \\+ cipher suite for this DomainName\\. The valid values are `TLS_1_0` and `TLS_1_2`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `TLS_1_0 | TLS_1_2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecurityPolicy", "type": "string" }, @@ -4866,7 +5034,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the domain name\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -4900,7 +5068,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of endpoint types of an API or its custom domain name\\. For an edge\\-optimized API and its custom domain name, the endpoint type is `EDGE`\\. For a regional API and its custom domain name, the endpoint type is `REGIONAL`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of endpoint types of an API \\(RestApi\\) or its custom domain name \\(DomainName\\)\\. For an edge\\-optimized API and its custom domain name, the endpoint type is `\"EDGE\"`\\. For a regional API and its custom domain name, the endpoint type is `REGIONAL`\\. For a private API, the endpoint type is `PRIVATE`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Types", "type": "array" } @@ -4911,7 +5079,7 @@ "additionalProperties": false, "properties": { "TruststoreUri": { - "markdownDescription": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, `s3://bucket-name/key-name`\\. The truststore can contain certificates from public or private certificate authorities\\. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version\\. To update the truststore, you must have permissions to access the S3 object\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example `s3://bucket-name/key-name`\\. The truststore can contain certificates from public or private certificate authorities\\. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version\\. To update the truststore, you must have permissions to access the S3 object\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TruststoreUri", "type": "string" }, @@ -4960,7 +5128,7 @@ "properties": { "ResponseParameters": { "additionalProperties": true, - "markdownDescription": "The response parameters \\(paths, query strings, and headers\\) for the response\\. Duplicates not allowed\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Response parameters \\(paths, query strings and headers\\) of the GatewayResponse as a string\\-to\\-string map of key\\-value pairs\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -4971,7 +5139,7 @@ }, "ResponseTemplates": { "additionalProperties": true, - "markdownDescription": "The response templates for the response\\. Duplicates not allowed\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Response templates of the GatewayResponse as a string\\-to\\-string map of key\\-value pairs\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -4981,17 +5149,17 @@ "type": "object" }, "ResponseType": { - "markdownDescription": "The response type\\. For valid values, see [GatewayResponse](https://docs.aws.amazon.com/apigateway/api-reference/resource/gateway-response/) in the *API Gateway API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The response type of the associated GatewayResponse\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ACCESS_DENIED | API_CONFIGURATION_ERROR | AUTHORIZER_CONFIGURATION_ERROR | AUTHORIZER_FAILURE | BAD_REQUEST_BODY | BAD_REQUEST_PARAMETERS | DEFAULT_4XX | DEFAULT_5XX | EXPIRED_TOKEN | INTEGRATION_FAILURE | INTEGRATION_TIMEOUT | INVALID_API_KEY | INVALID_SIGNATURE | MISSING_AUTHENTICATION_TOKEN | QUOTA_EXCEEDED | REQUEST_TOO_LARGE | RESOURCE_NOT_FOUND | THROTTLED | UNAUTHORIZED | UNSUPPORTED_MEDIA_TYPE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResponseType", "type": "string" }, "RestApiId": { - "markdownDescription": "The identifier of the API\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" }, "StatusCode": { - "markdownDescription": "The HTTP status code for the response\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The HTTP status code for this GatewayResponse\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StatusCode", "type": "string" } @@ -5059,7 +5227,7 @@ "additionalProperties": false, "properties": { "ApiKeyRequired": { - "markdownDescription": "Indicates whether the method requires clients to submit a valid API key\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A boolean flag specifying whether a valid ApiKey is required to invoke this method\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiKeyRequired", "type": "boolean" }, @@ -5067,46 +5235,46 @@ "items": { "type": "string" }, - "markdownDescription": "A list of authorization scopes configured on the method\\. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation\\. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request\\. The method invocation is authorized if any method scopes match a claimed scope in the access token\\. Otherwise, the invocation is not authorized\\. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of authorization scopes configured on the method\\. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation\\. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request\\. The method invocation is authorized if any method scopes matches a claimed scope in the access token\\. Otherwise, the invocation is not authorized\\. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizationScopes", "type": "array" }, "AuthorizationType": { - "markdownDescription": "The method's authorization type\\. This parameter is required\\. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/api-reference/resource/method/) in the *API Gateway API Reference*\\. \nIf you specify the `AuthorizerId` property, specify `CUSTOM` or `COGNITO_USER_POOLS` for this property\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The method's authorization type\\. This parameter is required\\. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*\\. \nIf you specify the `AuthorizerId` property, specify `CUSTOM` or `COGNITO_USER_POOLS` for this property\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizationType", "type": "string" }, "AuthorizerId": { - "markdownDescription": "The identifier of the [authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html) to use on this method\\. If you specify this property, specify `CUSTOM` or `COGNITO_USER_POOLS` for the `AuthorizationType` property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of an Authorizer to use on this method\\. The `authorizationType` must be `CUSTOM`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizerId", "type": "string" }, "HttpMethod": { - "markdownDescription": "The HTTP method that clients use to call this method\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The method's HTTP verb\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HttpMethod", "type": "string" }, "Integration": { "$ref": "#/definitions/AWS::ApiGateway::Method.Integration", - "markdownDescription": "The backend system that the method calls when it receives a request\\. \n*Required*: No \n*Type*: [Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Represents an `HTTP`, `HTTP_PROXY`, `AWS`, `AWS_PROXY`, or Mock integration\\. \n*Required*: No \n*Type*: [Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Integration" }, "MethodResponses": { "items": { "$ref": "#/definitions/AWS::ApiGateway::Method.MethodResponse" }, - "markdownDescription": "The responses that can be sent to the client who calls the method\\. \n*Required*: No \n*Type*: List of [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Gets a method response associated with a given HTTP status code\\. \n*Required*: No \n*Type*: List of [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MethodResponses", "type": "array" }, "OperationName": { - "markdownDescription": "A friendly operation name for the method\\. For example, you can assign the `OperationName` of `ListPets` for the `GET /pets` method\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A human\\-friendly operation identifier for the method\\. For example, you can assign the `operationName` of `ListPets` for the `GET /pets` method in the `PetStore` example\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OperationName", "type": "string" }, "RequestModels": { "additionalProperties": true, - "markdownDescription": "The resources that are used for the request's content type\\. Specify request models as key\\-value pairs \\(string\\-to\\-string mapping\\), with a content type as the key and a `Model` resource name as the value\\. To use the same model regardless of the content type, specify `$default` as the key\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A key\\-value map specifying data schemas, represented by Model resources, \\(as the mapped value\\) of the request payloads of given content types \\(as the mapping key\\)\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5117,7 +5285,7 @@ }, "RequestParameters": { "additionalProperties": true, - "markdownDescription": "The request parameters that API Gateway accepts\\. Specify request parameters as key\\-value pairs \\(string\\-to\\-Boolean mapping\\), with a source as the key and a Boolean as the value\\. The Boolean specifies whether a parameter is required\\. A source must match the format `method.request.location.name`, where the location is querystring, path, or header, and *name* is a valid, unique parameter name\\. \n*Required*: No \n*Type*: Map of Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A key\\-value map defining required or optional method request parameters that can be accepted by API Gateway\\. A key is a method request parameter name matching the pattern of `method.request.{location}.{name}`, where `location` is `querystring`, `path`, or `header` and `name` is a valid and unique parameter name\\. The value associated with the key is a Boolean flag indicating whether the parameter is required \\(`true`\\) or optional \\(`false`\\)\\. The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates\\. \n*Required*: No \n*Type*: Map of Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "boolean" @@ -5127,17 +5295,17 @@ "type": "object" }, "RequestValidatorId": { - "markdownDescription": "The ID of the associated request validator\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of a RequestValidator for request validation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RequestValidatorId", "type": "string" }, "ResourceId": { - "markdownDescription": "The ID of an API Gateway [resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html)\\. For root resource methods, specify the `RestApi` root resource ID, such as `{ \"Fn::GetAtt\": [\"MyRestApi\", \"RootResourceId\"] }`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Resource identifier for the MethodResponse resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceId", "type": "string" }, "RestApiId": { - "markdownDescription": "The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which API Gateway creates the method\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RestApiId", "type": "string" } @@ -5177,37 +5345,37 @@ "items": { "type": "string" }, - "markdownDescription": "A list of request parameters whose values API Gateway caches\\. For cases where the integration type allows for RequestParameters to be set, these parameters must also be specified in [RequestParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters) to be supported in `CacheKeyParameters`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of request parameters whose values API Gateway caches\\. To be valid values for `cacheKeyParameters`, these parameters must also be specified for Method `requestParameters`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheKeyParameters", "type": "array" }, "CacheNamespace": { - "markdownDescription": "An API\\-specific tag group of related cached parameters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a group of related cached parameters\\. By default, API Gateway uses the resource ID as the `cacheNamespace`\\. You can specify the same `cacheNamespace` across resources to return the same cached data for requests to different resources\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheNamespace", "type": "string" }, "ConnectionId": { - "markdownDescription": "The ID of the `VpcLink` used for the integration when `connectionType=VPC_LINK`, otherwise undefined\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectionId", "type": "string" }, "ConnectionType": { - "markdownDescription": "The type of the network connection to the integration endpoint\\. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC\\. The default value is `INTERNET`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of the network connection to the integration endpoint\\. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC\\. The default value is `INTERNET`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `INTERNET | VPC_LINK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectionType", "type": "string" }, "ContentHandling": { - "markdownDescription": "Specifies how to handle request payload content type conversions\\. Valid values are: \n+ `CONVERT_TO_BINARY`: Converts a request payload from a base64\\-encoded string to a binary blob\\.\n+ `CONVERT_TO_TEXT`: Converts a request payload from a binary blob to a base64\\-encoded string\\.\nIf this property isn't defined, the request payload is passed through from the method request to the integration request without modification, provided that the `PassthroughBehaviors` property is configured to support payload pass\\-through\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how to handle request payload content type conversions\\. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors: \nIf this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the `passthroughBehavior` is configured to support payload pass\\-through\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CONVERT_TO_BINARY | CONVERT_TO_TEXT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContentHandling", "type": "string" }, "Credentials": { - "markdownDescription": "The credentials that are required for the integration\\. To specify an AWS Identity and Access Management \\(IAM\\) role that API Gateway assumes, specify the role's Amazon Resource Name \\(ARN\\)\\. To require that the caller's identity be passed through from the request, specify arn:aws:iam::\\*:user/\\*\\. \nTo use resource\\-based permissions on the AWS Lambda \\(Lambda\\) function, don't specify this property\\. Use the [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) resource to permit API Gateway to call the function\\. For more information, see [Allow Amazon API Gateway to Invoke a Lambda Function](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html#access-control-resource-based-example-apigateway-invoke-function) in the *AWS Lambda Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the credentials required for the integration, if any\\. For AWS integrations, three options are available\\. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name \\(ARN\\)\\. To require that the caller's identity be passed through from the request, specify the string `arn:aws:iam::\\*:user/\\*`\\. To use resource\\-based permissions on supported AWS services, specify null\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Credentials", "type": "string" }, "IntegrationHttpMethod": { - "markdownDescription": "The integration's HTTP method type\\. \nFor the `Type` property, if you specify `MOCK`, this property is optional\\. For all other types, you must specify this property\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the integration's HTTP method type\\. For the Type property, if you specify `MOCK`, this property is optional\\. For Lambda integrations, you must set the integration method to `POST`\\. For all other types, you must specify this property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IntegrationHttpMethod", "type": "string" }, @@ -5215,18 +5383,18 @@ "items": { "$ref": "#/definitions/AWS::ApiGateway::Method.IntegrationResponse" }, - "markdownDescription": "The response that API Gateway provides after a method's backend completes processing a request\\. API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses\\. For example, you can map the backend status codes to codes that you define\\. \n*Required*: No \n*Type*: List of [IntegrationResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the integration's responses\\. \n*Required*: No \n*Type*: List of [IntegrationResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IntegrationResponses", "type": "array" }, "PassthroughBehavior": { - "markdownDescription": "Indicates when API Gateway passes requests to the targeted backend\\. This behavior depends on the request's `Content-Type` header and whether you defined a mapping template for it\\. \nFor more information and valid values, see the [passthroughBehavior](https://docs.aws.amazon.com/apigateway/api-reference/link-relation/integration-put/#passthroughBehavior) field in the *API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation\\. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in `requestTemplates`\\. The valid value is one of the following: `WHEN_NO_MATCH`: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request\\. `WHEN_NO_TEMPLATES`: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request\\. If a template is defined when this option is selected, the method request of an unmapped content\\-type will be rejected with an HTTP 415 Unsupported Media Type response\\. `NEVER`: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PassthroughBehavior", "type": "string" }, "RequestParameters": { "additionalProperties": true, - "markdownDescription": "The request parameters that API Gateway sends with the backend request\\. Specify request parameters as key\\-value pairs \\(string\\-to\\-string mappings\\), with a destination as the key and a source as the value\\. \nSpecify the destination by using the following pattern `integration.request.location.name`, where *location* is query string, path, or header, and *name* is a valid, unique parameter name\\. \nThe source must be an existing method request parameter or a static value\\. You must enclose static values in single quotation marks and pre\\-encode these values based on their destination in the request\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A key\\-value map specifying request parameters that are passed from the method request to the back end\\. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre\\-encoded as required by the back end\\. The method request parameter value must match the pattern of `method.request.{location}.{name}`, where `location` is `querystring`, `path`, or `header` and `name` must be a valid and unique method request parameter name\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5237,7 +5405,7 @@ }, "RequestTemplates": { "additionalProperties": true, - "markdownDescription": "A map of Apache Velocity templates that are applied on the request payload\\. The template that API Gateway uses is based on the value of the `Content-Type` header that's sent by the client\\. The content type value is the key, and the template is the value \\(specified as a string\\), such as the following snippet: \n`\"application/json\": \"{\\n \\\"statusCode\\\": 200\\n}\"` \nFor more information about templates, see [API Gateway Mapping Template and Access Logging Variable Reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content\\-Type header sent by the client\\. The content type value is the key in this map, and the template \\(as a String\\) is the value\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5252,12 +5420,12 @@ "type": "number" }, "Type": { - "markdownDescription": "The type of backend that your method is running, such as `HTTP` or `MOCK`\\. For all of the valid values, see the [type](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#type) property for the `Integration` resource in the *Amazon API Gateway REST API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies an API method integration type\\. The valid value is one of the following: \nFor the HTTP and HTTP proxy integrations, each integration can specify a protocol \\(`http/https`\\), port and path\\. Standard 80 and 443 ports are supported as well as custom ports above 1024\\. An HTTP or HTTP proxy integration with a `connectionType` of `VPC_LINK` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AWS | AWS_PROXY | HTTP | HTTP_PROXY | MOCK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" }, "Uri": { - "markdownDescription": "The Uniform Resource Identifier \\(URI\\) for the integration\\. \nIf you specify `HTTP` for the `Type` property, specify the API endpoint URL\\. \nIf you specify `MOCK` for the `Type` property, don't specify this property\\. \nIf you specify `AWS` for the `Type` property, specify an AWS service that follows this form: arn:aws:apigateway:*region*:*subdomain*\\.*service\\|service*:*path\\|action*/*service\\_api*\\. For example, a Lambda function URI follows this form: arn:aws:apigateway:*region*:lambda:path/*path*\\. The path is usually in the form /2015\\-03\\-31/functions/*LambdaFunctionARN*/invocations\\. For more information, see the `uri` property of the [Integration](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/) resource in the Amazon API Gateway REST API Reference\\. \nIf you specified `HTTP` or `AWS` for the `Type` property, you must specify this property\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies Uniform Resource Identifier \\(URI\\) of the integration endpoint\\. \nFor `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully formed, encoded HTTP\\(S\\) URL according to the RFC\\-3986 specification for standard integrations\\. If `connectionType` is `VPC_LINK` specify the Network Load Balancer DNS name\\. For `AWS` or `AWS_PROXY` integrations, the URI is of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}`\\. Here, \\{Region\\} is the API Gateway region \\(e\\.g\\., us\\-east\\-1\\); \\{service\\} is the name of the integrated AWS service \\(e\\.g\\., s3\\); and \\{subdomain\\} is a designated subdomain supported by certain AWS service for fast host\\-name lookup\\. action can be used for an AWS service action\\-based API, using an Action=\\{name\\}&\\{p1\\}=\\{v1\\}&p2=\\{v2\\}\\.\\.\\. query string\\. The ensuing \\{service\\_api\\} refers to a supported action \\{name\\} plus any required input parameters\\. Alternatively, path can be used for an AWS service path\\-based API\\. The ensuing service\\_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable\\. For example, for integration with the S3 API of GetObject, the uri can be either `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}` or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Uri", "type": "string" } @@ -5268,13 +5436,13 @@ "additionalProperties": false, "properties": { "ContentHandling": { - "markdownDescription": "Specifies how to handle request payload content type conversions\\. Valid values are: \n+ `CONVERT_TO_BINARY`: Converts a request payload from a base64\\-encoded string to a binary blob\\.\n+ `CONVERT_TO_TEXT`: Converts a request payload from a binary blob to a base64\\-encoded string\\.\nIf this property isn't defined, the request payload is passed through from the method request to the integration request without modification\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how to handle response payload content type conversions\\. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors: \nIf this property is not defined, the response payload will be passed through from the integration response to the method response without modification\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CONVERT_TO_BINARY | CONVERT_TO_TEXT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContentHandling", "type": "string" }, "ResponseParameters": { "additionalProperties": true, - "markdownDescription": "The response parameters from the backend response that API Gateway sends to the method response\\. Specify response parameters as key\\-value pairs \\([string\\-to\\-string mappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html)\\)\\. \nUse the destination as the key and the source as the value: \n+ The destination must be an existing response parameter in the [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) property\\.\n+ The source must be an existing method request parameter or a static value\\. You must enclose static values in single quotation marks and pre\\-encode these values based on the destination specified in the request\\.\nFor more information about templates, see [API Gateway Mapping Template and Access Logging Variable Reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A key\\-value map specifying response parameters that are passed to the method response from the back end\\. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body\\. The mapping key must match the pattern of `method.response.header.{name}`, where `name` is a valid and unique header name\\. The mapped non\\-static value must match the pattern of `integration.response.header.{name}` or `integration.response.body.{JSON-expression}`, where `name` is a valid and unique response header name and `JSON-expression` is a valid JSON expression without the `$` prefix\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5285,7 +5453,7 @@ }, "ResponseTemplates": { "additionalProperties": true, - "markdownDescription": "The templates that are used to transform the integration response body\\. Specify templates as key\\-value pairs \\(string\\-to\\-string mappings\\), with a content type as the key and a template as the value\\. For more information, see [API Gateway Mapping Template and Access Logging Variable Reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the templates used to transform the integration response body\\. Response templates are represented as a key/value map, with a content\\-type as the key and a template as the value\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5295,12 +5463,12 @@ "type": "object" }, "SelectionPattern": { - "markdownDescription": "A [regular expression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-regexes.html) that specifies which error strings or status codes from the backend map to the integration response\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the regular expression \\(regex\\) pattern used to choose an integration response based on the response from the back end\\. For example, if the success response returns nothing and the error response returns some string, you could use the `.+` regex to match error response\\. However, make sure that the error response does not contain any newline \\(`\\n`\\) character in such cases\\. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched\\. For all other HTTP and AWS back ends, the HTTP status code is matched\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SelectionPattern", "type": "string" }, "StatusCode": { - "markdownDescription": "The status code that API Gateway uses to map the integration response to a [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) status code\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the status code that is used to map the integration response to an existing MethodResponse\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StatusCode", "type": "string" } @@ -5315,7 +5483,7 @@ "properties": { "ResponseModels": { "additionalProperties": true, - "markdownDescription": "The resources used for the response's content type\\. Specify response models as key\\-value pairs \\(string\\-to\\-string maps\\), with a content type as the key and a [Model](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html) resource name as the value\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the Model resources used for the response's content\\-type\\. Response models are represented as a key/value map, with a content\\-type as the key and a Model name as the value\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5326,7 +5494,7 @@ }, "ResponseParameters": { "additionalProperties": true, - "markdownDescription": "Response parameters that API Gateway sends to the client that called a method\\. Specify response parameters as key\\-value pairs \\(string\\-to\\-Boolean maps\\), with a destination as the key and a Boolean as the value\\. Specify the destination using the following pattern: `method.response.header.name`, where *name* is a valid, unique header name\\. The Boolean specifies whether a parameter is required\\. \n*Required*: No \n*Type*: Map of Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A key\\-value map specifying required or optional response parameters that API Gateway can send back to the caller\\. A key defines a method response header and the value specifies whether the associated method response header is required or not\\. The expression of the key must match the pattern `method.response.header.{name}`, where `name` is a valid and unique header name\\. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse\\. The integration response data that can be mapped include an integration response header expressed in `integration.response.header.{name}`, a static value enclosed within a pair of single quotes \\(e\\.g\\., `'application/json'`\\), or a JSON expression from the back\\-end response payload in the form of `integration.response.body.{JSON-expression}`, where `JSON-expression` is a valid JSON expression without the `$` prefix\\.\\) \n*Required*: No \n*Type*: Map of Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "boolean" @@ -5336,7 +5504,7 @@ "type": "object" }, "StatusCode": { - "markdownDescription": "The method response's status code, which you map to an [IntegrationResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The method response's status code\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StatusCode", "type": "string" } @@ -5382,12 +5550,12 @@ "additionalProperties": false, "properties": { "ContentType": { - "markdownDescription": "The content type for the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The content\\-type for the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ContentType", "type": "string" }, "Description": { - "markdownDescription": "A description that identifies this model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -5397,12 +5565,12 @@ "type": "string" }, "RestApiId": { - "markdownDescription": "The ID of a REST API with which to associate this model\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" }, "Schema": { - "markdownDescription": "The schema to use to transform data to one or more output formats\\. Specify null \\(`{}`\\) if you don't want to specify a schema\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The schema for the model\\. For `application/json` models, this should be JSON schema draft 4 model\\. Do not include \"\\\\\\*/\" characters in the description of any properties because such \"\\\\\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Schema", "type": "object" } @@ -5469,22 +5637,22 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of this request validator\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of this RequestValidator \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, "RestApiId": { - "markdownDescription": "The identifier of the targeted API entity\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" }, "ValidateRequestBody": { - "markdownDescription": "Indicates whether to validate the request body according to the configured schema for the targeted API and method\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A Boolean flag to indicate whether to validate a request body according to the configured Model schema\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ValidateRequestBody", "type": "boolean" }, "ValidateRequestParameters": { - "markdownDescription": "Indicates whether to validate request parameters\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A Boolean flag to indicate whether to validate request parameters \\(`true`\\) or not \\(`false`\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ValidateRequestParameters", "type": "boolean" } @@ -5551,17 +5719,17 @@ "additionalProperties": false, "properties": { "ParentId": { - "markdownDescription": "If you want to create a child resource, the ID of the parent resource\\. For resources without a parent, specify the `RestApi` root resource ID, such as `{ \"Fn::GetAtt\": [\"MyRestApi\", \"RootResourceId\"] }`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The parent resource's identifier\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ParentId", "type": "string" }, "PathPart": { - "markdownDescription": "A path name for the resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The last path segment for this resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PathPart", "type": "string" }, "RestApiId": { - "markdownDescription": "The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which you want to create this resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" } @@ -5637,7 +5805,7 @@ "additionalProperties": false, "properties": { "ApiKeySourceType": { - "markdownDescription": "The source of the API key for metering requests according to a usage plan\\. Valid values are: \n+ `HEADER` to read the API key from the `X-API-Key` header of a request\\.\n+ `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a Lambda authorizer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The source of the API key for metering requests according to a usage plan\\. Valid values are: `HEADER` to read the API key from the `X-API-Key` header of a request\\. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiKeySourceType", "type": "string" }, @@ -5645,7 +5813,7 @@ "items": { "type": "string" }, - "markdownDescription": "The list of binary media types that are supported by the `RestApi` resource\\. Use `~1` instead of `/` in the media types, for example `image~1png` or `application~1octet-stream`\\. By default, `RestApi` supports only UTF\\-8\\-encoded text payloads\\. Duplicates are not allowed\\. For more information, see [Enable Support for Binary Payloads in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The list of binary media types supported by the RestApi\\. By default, the RestApi supports only UTF\\-8\\-encoded text payloads\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BinaryMediaTypes", "type": "array" }, @@ -5660,17 +5828,17 @@ "title": "BodyS3Location" }, "CloneFrom": { - "markdownDescription": "The ID of the `RestApi` resource that you want to clone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of the RestApi that you want to clone from\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloneFrom", "type": "string" }, "Description": { - "markdownDescription": "A description of the `RestApi` resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the RestApi\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "DisableExecuteApiEndpoint": { - "markdownDescription": "Specifies whether clients can invoke your API by using the default `execute-api` endpoint\\. By default, clients can invoke your API with the default https://\\{api\\_id\\}\\.execute\\-api\\.\\{region\\}\\.amazonaws\\.com endpoint\\. To require that clients use a custom domain name to invoke your API, disable the default endpoint\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether clients can invoke your API by using the default `execute-api` endpoint\\. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint\\. To require that clients use a custom domain name to invoke your API, disable the default endpoint \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DisableExecuteApiEndpoint", "type": "boolean" }, @@ -5680,7 +5848,7 @@ "title": "EndpointConfiguration" }, "FailOnWarnings": { - "markdownDescription": "Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the `RestApi` resource\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A query parameter to indicate whether to rollback the API update \\(`true`\\) or not \\(`false`\\) when a warning is encountered\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailOnWarnings", "type": "boolean" }, @@ -5695,13 +5863,13 @@ "type": "string" }, "Name": { - "markdownDescription": "A name for the `RestApi` resource\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the RestApi\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Parameters": { "additionalProperties": true, - "markdownDescription": "Custom header parameters for the request\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Custom header parameters as part of the request\\. For example, to exclude DocumentationParts from an imported API, set `ignore=documentation` as a `parameters` value, as in the AWS CLI command of `aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'`\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5719,7 +5887,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the API\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key\\-value map of strings\\. The valid character set is \\[a\\-zA\\-Z\\+\\-=\\.\\_:/\\]\\. The tag key can be up to 128 characters and must not start with `aws:`\\. The tag value can be up to 256 characters\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -5753,7 +5921,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of endpoint types of an API or its custom domain name\\. Valid values include: \n+ `EDGE`: For an edge\\-optimized API and its custom domain name\\.\n+ `REGIONAL`: For a regional API and its custom domain name\\.\n+ `PRIVATE`: For a private API\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of endpoint types of an API \\(RestApi\\) or its custom domain name \\(DomainName\\)\\. For an edge\\-optimized API and its custom domain name, the endpoint type is `\"EDGE\"`\\. For a regional API and its custom domain name, the endpoint type is `REGIONAL`\\. For a private API, the endpoint type is `PRIVATE`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Types", "type": "array" }, @@ -5761,7 +5929,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of VPC endpoint IDs of an API \\([AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html)\\) against which to create Route53 ALIASes\\. It is only supported for `PRIVATE` endpoint type\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of VpcEndpointIds of an API \\(RestApi\\) against which to create Route53 ALIASes\\. It is only supported for `PRIVATE` endpoint type\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VpcEndpointIds", "type": "array" } @@ -5831,41 +5999,41 @@ "properties": { "AccessLogSetting": { "$ref": "#/definitions/AWS::ApiGateway::Stage.AccessLogSetting", - "markdownDescription": "Specifies settings for logging access in this stage\\. \n*Required*: No \n*Type*: [AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Access log settings, including the access log format and access log destination ARN\\. \n*Required*: No \n*Type*: [AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessLogSetting" }, "CacheClusterEnabled": { - "markdownDescription": "Indicates whether cache clustering is enabled for the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether a cache cluster is enabled for the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheClusterEnabled", "type": "boolean" }, "CacheClusterSize": { - "markdownDescription": "The stage's cache cluster size\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The stage's cache capacity in GB\\. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `0.5 | 1.6 | 118 | 13.5 | 237 | 28.4 | 58.2 | 6.1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheClusterSize", "type": "string" }, "CanarySetting": { "$ref": "#/definitions/AWS::ApiGateway::Stage.CanarySetting", - "markdownDescription": "Specifies settings for the canary deployment in this stage\\. \n*Required*: No \n*Type*: [CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings for the canary deployment in this stage\\. \n*Required*: No \n*Type*: [CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CanarySetting" }, "ClientCertificateId": { - "markdownDescription": "The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of a client certificate for an API stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientCertificateId", "type": "string" }, "DeploymentId": { - "markdownDescription": "The ID of the deployment that the stage is associated with\\. This parameter is required to create a stage\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of the Deployment that the stage points to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeploymentId", "type": "string" }, "Description": { - "markdownDescription": "A description of the stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The stage's description\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "DocumentationVersion": { - "markdownDescription": "The version ID of the API documentation snapshot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the associated API documentation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DocumentationVersion", "type": "string" }, @@ -5873,17 +6041,17 @@ "items": { "$ref": "#/definitions/AWS::ApiGateway::Stage.MethodSetting" }, - "markdownDescription": "Settings for all methods in the stage\\. \n*Required*: No \n*Type*: List of [MethodSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A map that defines the method settings for a Stage resource\\. Keys \\(designated as `/{method_setting_key` below\\) are method paths defined as `{resource_path}/{http_method}` for an individual method override, or `/\\*/\\*` for overriding all methods in the stage\\. \n*Required*: No \n*Type*: List of [MethodSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MethodSettings", "type": "array" }, "RestApiId": { - "markdownDescription": "The ID of the `RestApi` resource that you're deploying with this stage\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" }, "StageName": { - "markdownDescription": "The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier \\(URI\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the stage is the first path segment in the Uniform Resource Identifier \\(URI\\) of a call to API Gateway\\. Stage names can only contain alphanumeric characters, hyphens, and underscores\\. Maximum length is 128 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StageName", "type": "string" }, @@ -5891,12 +6059,12 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the stage\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, "TracingEnabled": { - "markdownDescription": "Specifies whether active X\\-Ray tracing is enabled for this stage\\. \nFor more information, see [Trace API Gateway API Execution with AWS X\\-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether active tracing with X\\-ray is enabled for the Stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TracingEnabled", "type": "boolean" }, @@ -5958,18 +6126,18 @@ "additionalProperties": false, "properties": { "DeploymentId": { - "markdownDescription": "The identifier of the deployment that the stage points to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of the canary deployment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeploymentId", "type": "string" }, "PercentTraffic": { - "markdownDescription": "The percentage \\(0\\-100\\) of traffic diverted to a canary deployment\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The percent \\(0\\-100\\) of traffic diverted to a canary deployment\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PercentTraffic", "type": "number" }, "StageVariableOverrides": { "additionalProperties": true, - "markdownDescription": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary\\. These stage variables are represented as a string\\-to\\-string map between stage variable names and their values\\. \nDuplicates are not allowed\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary\\. These stage variables are represented as a string\\-to\\-string map between stage variable names and their values\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5979,7 +6147,7 @@ "type": "object" }, "UseStageCache": { - "markdownDescription": "Whether the canary deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UseStageCache", "type": "boolean" } @@ -5990,22 +6158,22 @@ "additionalProperties": false, "properties": { "CacheDataEncrypted": { - "markdownDescription": "Indicates whether the cached responses are encrypted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the cached responses are encrypted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheDataEncrypted", "type": "boolean" }, "CacheTtlInSeconds": { - "markdownDescription": "The time\\-to\\-live \\(TTL\\) period, in seconds, that specifies how long API Gateway caches responses\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the time to live \\(TTL\\), in seconds, for cached responses\\. The higher the TTL, the longer the response will be cached\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheTtlInSeconds", "type": "number" }, "CachingEnabled": { - "markdownDescription": "Indicates whether responses are cached and returned for requests\\. You must enable a cache cluster on the stage to cache responses\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether responses should be cached and returned for requests\\. A cache cluster must be enabled on the stage for responses to be cached\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CachingEnabled", "type": "boolean" }, "DataTraceEnabled": { - "markdownDescription": "Indicates whether data trace logging is enabled for methods in the stage\\. API Gateway pushes these logs to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataTraceEnabled", "type": "boolean" }, @@ -6015,12 +6183,12 @@ "type": "string" }, "LoggingLevel": { - "markdownDescription": "The logging level for this method\\. For valid values, see the `loggingLevel` property of the [Stage](https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the *Amazon API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs\\. Valid values are `OFF`, `ERROR`, and `INFO`\\. Choose `ERROR` to write only error\\-level entries to CloudWatch Logs, or choose `INFO` to include all `ERROR` events as well as extra informational events\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoggingLevel", "type": "string" }, "MetricsEnabled": { - "markdownDescription": "Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether Amazon CloudWatch metrics are enabled for this method\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricsEnabled", "type": "boolean" }, @@ -6030,12 +6198,12 @@ "type": "string" }, "ThrottlingBurstLimit": { - "markdownDescription": "The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account\\. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the throttling burst limit\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThrottlingBurstLimit", "type": "number" }, "ThrottlingRateLimit": { - "markdownDescription": "The number of steady\\-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account\\. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the throttling rate limit\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThrottlingRateLimit", "type": "number" } @@ -6081,35 +6249,35 @@ "items": { "$ref": "#/definitions/AWS::ApiGateway::UsagePlan.ApiStage" }, - "markdownDescription": "The API stages to associate with this usage plan\\. \n*Required*: No \n*Type*: List of [ApiStage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The associated API stages of a usage plan\\. \n*Required*: No \n*Type*: List of [ApiStage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiStages", "type": "array" }, "Description": { - "markdownDescription": "A description of the usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of a usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "Quota": { "$ref": "#/definitions/AWS::ApiGateway::UsagePlan.QuotaSettings", - "markdownDescription": "Configures the number of requests that users can make within a given interval\\. \n*Required*: No \n*Type*: [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The target maximum number of permitted requests per a given unit time interval\\. \n*Required*: No \n*Type*: [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Quota" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the usage plan\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, "Throttle": { "$ref": "#/definitions/AWS::ApiGateway::UsagePlan.ThrottleSettings", - "markdownDescription": "Configures the overall request rate \\(average requests per second\\) and burst capacity\\. \n*Required*: No \n*Type*: [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A map containing method level throttling information for API stage in a usage plan\\. \n*Required*: No \n*Type*: [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Throttle" }, "UsagePlanName": { - "markdownDescription": "A name for the usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of a usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UsagePlanName", "type": "string" } @@ -6140,18 +6308,18 @@ "additionalProperties": false, "properties": { "ApiId": { - "markdownDescription": "The ID of an API that is in the specified `Stage` property that you want to associate with the usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "API Id of the associated API stage in a usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiId", "type": "string" }, "Stage": { - "markdownDescription": "The name of the stage to associate with the usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "API stage name of the associated API stage in a usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Stage", "type": "string" }, "Throttle": { "additionalProperties": false, - "markdownDescription": "Map containing method\\-level throttling information for an API stage in a usage plan\\. The key for the map is the path and method for which to configure custom throttling, for example, \"/pets/GET\"\\. \nDuplicates are not allowed\\. \n*Required*: No \n*Type*: Map of [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Map containing method level throttling information for API stage in a usage plan\\. \n*Required*: No \n*Type*: Map of [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::ApiGateway::UsagePlan.ThrottleSettings" @@ -6172,12 +6340,12 @@ "type": "number" }, "Offset": { - "markdownDescription": "The day that a time period starts\\. For example, with a time period of `WEEK`, an offset of `0` starts on Sunday, and an offset of `1` starts on Monday\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of requests subtracted from the given limit in the initial time period\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Offset", "type": "number" }, "Period": { - "markdownDescription": "The time period for which the target maximum limit of requests applies, such as `DAY` or `WEEK`\\. For valid values, see the period property for the [UsagePlan](https://docs.aws.amazon.com/apigateway/api-reference/resource/usage-plan) resource in the *Amazon API Gateway REST API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The time period in which the limit applies\\. Valid values are \"DAY\", \"WEEK\" or \"MONTH\"\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAY | MONTH | WEEK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Period", "type": "string" } @@ -6188,12 +6356,12 @@ "additionalProperties": false, "properties": { "BurstLimit": { - "markdownDescription": "The API target request burst rate limit\\. This allows more requests through for a period of time than the target rate limit\\. For more information about request throttling, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The API target request burst rate limit\\. This allows more requests through for a period of time than the target rate limit\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BurstLimit", "type": "number" }, "RateLimit": { - "markdownDescription": "The API target request steady\\-state rate limit\\. For more information about request throttling, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The API target request rate limit\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RateLimit", "type": "number" } @@ -6236,17 +6404,17 @@ "additionalProperties": false, "properties": { "KeyId": { - "markdownDescription": "The ID of the usage plan key\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Id of the UsagePlanKey resource to be deleted\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeyId", "type": "string" }, "KeyType": { - "markdownDescription": "The type of usage plan key\\. Currently, the only valid key type is `API_KEY`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of a UsagePlanKey resource for a plan customer\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeyType", "type": "string" }, "UsagePlanId": { - "markdownDescription": "The ID of the usage plan\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Id of the UsagePlan resource representing the usage plan containing the to\\-be\\-deleted UsagePlanKey resource representing a plan customer\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "UsagePlanId", "type": "string" } @@ -6315,12 +6483,12 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "A description of the VPC link\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the VPC link\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "Name": { - "markdownDescription": "A name for the VPC link\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name used to label and identify the VPC link\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -6336,7 +6504,7 @@ "items": { "type": "string" }, - "markdownDescription": "The ARN of network load balancer of the VPC targeted by the VPC link\\. The network load balancer must be owned by the same AWS account of the API owner\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the network load balancer of the VPC targeted by the VPC link\\. The network load balancer must be owned by the same AWS account of the API owner\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TargetArns", "type": "array" } @@ -6482,7 +6650,7 @@ }, "Tags": { "additionalProperties": true, - "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -6859,7 +7027,7 @@ "additionalProperties": false, "properties": { "ApiId": { - "markdownDescription": "The identifier of the API\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The identifier of the API\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiId", "type": "string" }, @@ -7229,7 +7397,7 @@ "type": "string" }, "OwnershipVerificationCertificateArn": { - "markdownDescription": "The ARN of the public certificate issued by ACM to validate ownership of your custom domain\\. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon resource name \\(ARN\\) for the public certificate issued by AWS Certificate Manager\\. This ARN is used to validate custom domain ownership\\. It's required only if you configure mutual TLS and use either an ACM\\-imported or a private CA certificate ARN as the regionalCertificateArn\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OwnershipVerificationCertificateArn", "type": "string" }, @@ -7877,20 +8045,6 @@ ], "type": "object" }, - "AWS::ApiGatewayV2::RouteResponse.ParameterConstraints": { - "additionalProperties": false, - "properties": { - "Required": { - "markdownDescription": "Specifies whether the parameter is required\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "title": "Required", - "type": "boolean" - } - }, - "required": [ - "Required" - ], - "type": "object" - }, "AWS::ApiGatewayV2::Stage": { "additionalProperties": false, "properties": { @@ -8119,7 +8273,7 @@ }, "Tags": { "additionalProperties": true, - "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -8298,12 +8452,12 @@ "type": "string" }, "LocationUri": { - "markdownDescription": "A URI to locate the configuration\\. You can specify the AWS AppConfig hosted configuration store, Systems Manager \\(SSM\\) document, an SSM Parameter Store parameter, or an Amazon S3 object\\. For the hosted configuration store and for feature flags, specify `hosted`\\. For an SSM document, specify either the document name in the format `ssm-document://` or the Amazon Resource Name \\(ARN\\)\\. For a parameter, specify either the parameter name in the format `ssm-parameter://` or the ARN\\. For an Amazon S3 object, specify the URI in the following format: `s3:/// `\\. Here is an example: `s3://my-bucket/my-app/us-east-1/my-config.json` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A URI to locate the configuration\\. You can specify the following: \n+ For the AWS AppConfig hosted configuration store and for feature flags, specify `hosted`\\.\n+ For an AWS Systems Manager Parameter Store parameter, specify either the parameter name in the format `ssm-parameter://` or the ARN\\.\n+ For an AWS Secrets Manager secret, specify the URI in the following format: `secrets-manager`://\\.\n+ For an Amazon S3 object, specify the URI in the following format: `s3:/// `\\. Here is an example: `s3://my-bucket/my-app/us-east-1/my-config.json` \n+ For an SSM document, specify either the document name in the format `ssm-document://` or the Amazon Resource Name \\(ARN\\)\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "LocationUri", "type": "string" }, "Name": { - "markdownDescription": "A name for the configuration profile\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A name for the configuration profile\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -8440,7 +8594,7 @@ "type": "string" }, "ConfigurationVersion": { - "markdownDescription": "The configuration version to deploy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The configuration version to deploy\\. If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ConfigurationVersion", "type": "string" }, @@ -8460,13 +8614,15 @@ "type": "string" }, "KmsKeyIdentifier": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyIdentifier", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/AWS::AppConfig::Deployment.Tags" }, - "markdownDescription": "Metadata to assign to the deployment\\. Tags help organize and categorize your AWS AppConfig resources\\. Each tag consists of a key and an optional value, both of which you define\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html) of [Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Metadata to assign to the deployment\\. Tags help organize and categorize your AWS AppConfig resources\\. Each tag consists of a key and an optional value, both of which you define\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html) of [Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Tags", "type": "array" } @@ -8563,7 +8719,7 @@ "type": "string" }, "FinalBakeTimeInMinutes": { - "markdownDescription": "The amount of time AWS AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Maximum*: `1440` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete\\. If an alarm is triggered during this time, AWS AppConfig rolls back the deployment\\. You must configure permissions for AWS AppConfig to roll back based on CloudWatch alarms\\. For more information, see [Configuring permissions for rollback based on Amazon CloudWatch alarms](https://docs.aws.amazon.com/appconfig/latest/userguide/getting-started-with-appconfig-cloudwatch-alarms-permissions.html) in the * AWS AppConfig User Guide*\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Maximum*: `1440` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FinalBakeTimeInMinutes", "type": "number" }, @@ -8898,15 +9054,23 @@ "additionalProperties": false, "properties": { "ConnectorLabel": { + "markdownDescription": "The label used for registering the connector\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9][\\w!@#.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConnectorLabel", "type": "string" }, "ConnectorProvisioningConfig": { - "$ref": "#/definitions/AWS::AppFlow::Connector.ConnectorProvisioningConfig" + "$ref": "#/definitions/AWS::AppFlow::Connector.ConnectorProvisioningConfig", + "markdownDescription": "The configuration required for registering the connector\\. \n*Required*: Yes \n*Type*: [ConnectorProvisioningConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connector-connectorprovisioningconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectorProvisioningConfig" }, "ConnectorProvisioningType": { + "markdownDescription": "The provisioning type used to register the connector\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `LAMBDA` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectorProvisioningType", "type": "string" }, "Description": { + "markdownDescription": "A description of the connector entity field\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `[\\s\\w/!@#+=.-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" } }, @@ -8941,7 +9105,9 @@ "additionalProperties": false, "properties": { "Lambda": { - "$ref": "#/definitions/AWS::AppFlow::Connector.LambdaConnectorProvisioningConfig" + "$ref": "#/definitions/AWS::AppFlow::Connector.LambdaConnectorProvisioningConfig", + "markdownDescription": "Contains information about the configuration of the lambda which is being registered as the connector\\. \n*Required*: No \n*Type*: [LambdaConnectorProvisioningConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connector-lambdaconnectorprovisioningconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Lambda" } }, "type": "object" @@ -8950,6 +9116,8 @@ "additionalProperties": false, "properties": { "LambdaArn": { + "markdownDescription": "Lambda ARN of the connector being registered\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `arn:aws:.*:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LambdaArn", "type": "string" } }, @@ -8999,6 +9167,8 @@ "type": "string" }, "ConnectorLabel": { + "markdownDescription": "The label for the connector profile being created\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9][\\w!@#.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectorLabel", "type": "string" }, "ConnectorProfileConfig": { @@ -9012,7 +9182,7 @@ "type": "string" }, "ConnectorType": { - "markdownDescription": "The type of connector, such as Salesforce, Amplitude, and so on\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Amplitude | CustomConnector | CustomerProfiles | Datadog | Dynatrace | EventBridge | Googleanalytics | Honeycode | Infornexus | LookoutMetrics | Marketo | Redshift | S3 | Salesforce | SAPOData | Servicenow | Singular | Slack | Snowflake | Trendmicro | Upsolver | Veeva | Zendesk` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of connector, such as Salesforce, Amplitude, and so on\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Amplitude | CustomConnector | CustomerProfiles | Datadog | Dynatrace | EventBridge | Googleanalytics | Honeycode | Infornexus | LookoutMetrics | Marketo | Pardot | Redshift | S3 | Salesforce | SAPOData | Servicenow | Singular | Slack | Snowflake | Trendmicro | Upsolver | Veeva | Zendesk` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ConnectorType", "type": "string" }, @@ -9074,9 +9244,13 @@ "additionalProperties": false, "properties": { "ApiKey": { + "markdownDescription": "The API key required for API key authentication\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApiKey", "type": "string" }, "ApiSecretKey": { + "markdownDescription": "The API secret key required for API key authentication\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApiSecretKey", "type": "string" } }, @@ -9089,9 +9263,13 @@ "additionalProperties": false, "properties": { "Password": { + "markdownDescription": "The password to use to connect to a resource\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Password", "type": "string" }, "Username": { + "markdownDescription": "The username to use to connect to a resource\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Username", "type": "string" } }, @@ -9105,7 +9283,7 @@ "additionalProperties": false, "properties": { "AuthCode": { - "markdownDescription": "The code provided by the connector when it has been authenticated via the connected app\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The code provided by the connector when it has been authenticated via the connected app\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthCode", "type": "string" }, @@ -9122,7 +9300,7 @@ "properties": { "ConnectorProfileCredentials": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorProfileCredentials", - "markdownDescription": "The connector\\-specific credentials required by each connector\\. \n*Required*: Yes \n*Type*: [ConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The connector\\-specific credentials required by each connector\\. \n*Required*: No \n*Type*: [ConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectorProfileCredentials" }, "ConnectorProfileProperties": { @@ -9142,7 +9320,9 @@ "title": "Amplitude" }, "CustomConnector": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.CustomConnectorProfileCredentials" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.CustomConnectorProfileCredentials", + "markdownDescription": "The connector\\-specific profile credentials that are required when using the custom connector\\. \n*Required*: No \n*Type*: [CustomConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomConnector" }, "Datadog": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.DatadogConnectorProfileCredentials", @@ -9170,7 +9350,9 @@ "title": "Marketo" }, "Pardot": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.PardotConnectorProfileCredentials" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.PardotConnectorProfileCredentials", + "markdownDescription": "The connector\\-specific credentials required when using Salesforce Pardot\\. \n*Required*: No \n*Type*: [PardotConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pardot" }, "Redshift": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.RedshiftConnectorProfileCredentials", @@ -9179,7 +9361,7 @@ }, "SAPOData": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.SAPODataConnectorProfileCredentials", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SAPODataConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The connector\\-specific profile credentials required when using SAPOData\\. \n*Required*: No \n*Type*: [SAPODataConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SAPOData" }, "Salesforce": { @@ -9229,7 +9411,9 @@ "additionalProperties": false, "properties": { "CustomConnector": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.CustomConnectorProfileProperties" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.CustomConnectorProfileProperties", + "markdownDescription": "The properties required by the custom connector\\. \n*Required*: No \n*Type*: [CustomConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomConnector" }, "Datadog": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.DatadogConnectorProfileProperties", @@ -9252,7 +9436,9 @@ "title": "Marketo" }, "Pardot": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.PardotConnectorProfileProperties" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.PardotConnectorProfileProperties", + "markdownDescription": "The connector\\-specific properties required by Salesforce Pardot\\. \n*Required*: No \n*Type*: [PardotConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pardot" }, "Redshift": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.RedshiftConnectorProfileProperties", @@ -9261,7 +9447,7 @@ }, "SAPOData": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.SAPODataConnectorProfileProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SAPODataConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The connector\\-specific profile properties required when using SAPOData\\. \n*Required*: No \n*Type*: [SAPODataConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SAPOData" }, "Salesforce": { @@ -9302,14 +9488,18 @@ "properties": { "CredentialsMap": { "additionalProperties": true, + "markdownDescription": "A map that holds custom authentication credentials\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "CredentialsMap", "type": "object" }, "CustomAuthenticationType": { + "markdownDescription": "The custom authentication type that the connector uses\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomAuthenticationType", "type": "string" } }, @@ -9322,19 +9512,29 @@ "additionalProperties": false, "properties": { "ApiKey": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ApiKeyCredentials" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ApiKeyCredentials", + "markdownDescription": "The API keys required for the authentication of the user\\. \n*Required*: No \n*Type*: [ApiKeyCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-apikeycredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApiKey" }, "AuthenticationType": { + "markdownDescription": "The authentication type that the custom connector uses for authenticating while creating a connector profile\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `APIKEY | BASIC | CUSTOM | OAUTH2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AuthenticationType", "type": "string" }, "Basic": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.BasicAuthCredentials" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.BasicAuthCredentials", + "markdownDescription": "The basic credentials that are required for the authentication of the user\\. \n*Required*: No \n*Type*: [BasicAuthCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-basicauthcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Basic" }, "Custom": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.CustomAuthCredentials" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.CustomAuthCredentials", + "markdownDescription": "If the connector uses the custom authentication mechanism, this holds the required credentials\\. \n*Required*: No \n*Type*: [CustomAuthCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customauthcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Custom" }, "Oauth2": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.OAuth2Credentials" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.OAuth2Credentials", + "markdownDescription": "The OAuth 2\\.0 credentials required for the authentication of the user\\. \n*Required*: No \n*Type*: [OAuth2Credentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Oauth2" } }, "required": [ @@ -9346,15 +9546,19 @@ "additionalProperties": false, "properties": { "OAuth2Properties": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.OAuth2Properties" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.OAuth2Properties", + "markdownDescription": "The OAuth 2\\.0 properties required for OAuth 2\\.0 authentication\\. \n*Required*: No \n*Type*: [OAuth2Properties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2properties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OAuth2Properties" }, "ProfileProperties": { "additionalProperties": true, + "markdownDescription": "A map of properties that are required to create a profile for the custom connector\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "ProfileProperties", "type": "object" } }, @@ -9426,7 +9630,7 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "The credentials used to access protected Google Analytics resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to access protected Google Analytics resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, @@ -9446,7 +9650,7 @@ "title": "ConnectorOAuthRequest" }, "RefreshToken": { - "markdownDescription": "The credentials used to acquire new access tokens\\. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to acquire new access tokens\\. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RefreshToken", "type": "string" } @@ -9507,7 +9711,7 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "The credentials used to access protected Marketo resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to access protected Marketo resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, @@ -9551,18 +9755,28 @@ "additionalProperties": false, "properties": { "AccessToken": { + "markdownDescription": "The access token used to access the connector on your behalf\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessToken", "type": "string" }, "ClientId": { + "markdownDescription": "The identifier for the desired client\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientId", "type": "string" }, "ClientSecret": { + "markdownDescription": "The client secret used by the OAuth client to authenticate to the authorization server\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientSecret", "type": "string" }, "OAuthRequest": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OAuthRequest" }, "RefreshToken": { + "markdownDescription": "The refresh token used to refresh an expired access token\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RefreshToken", "type": "string" } }, @@ -9572,18 +9786,24 @@ "additionalProperties": false, "properties": { "OAuth2GrantType": { + "markdownDescription": "The OAuth 2\\.0 grant type used by connector for OAuth 2\\.0 authentication\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AUTHORIZATION_CODE | CLIENT_CREDENTIALS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OAuth2GrantType", "type": "string" }, "TokenUrl": { + "markdownDescription": "The token URL required for OAuth 2\\.0 authentication\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TokenUrl", "type": "string" }, "TokenUrlCustomProperties": { "additionalProperties": true, + "markdownDescription": "Associates your token URL with a map of properties that you define\\. Use this parameter to provide any additional details that the connector requires to authenticate your request\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "TokenUrlCustomProperties", "type": "object" } }, @@ -9593,18 +9813,28 @@ "additionalProperties": false, "properties": { "AccessToken": { + "markdownDescription": "The access token used to access protected SAPOData resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessToken", "type": "string" }, "ClientId": { + "markdownDescription": "The identifier for the desired client\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientId", "type": "string" }, "ClientSecret": { + "markdownDescription": "The client secret used by the OAuth client to authenticate to the authorization server\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientSecret", "type": "string" }, "ConnectorOAuthRequest": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectorOAuthRequest" }, "RefreshToken": { + "markdownDescription": "The refresh token used to refresh expired access token\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RefreshToken", "type": "string" } }, @@ -9614,7 +9844,7 @@ "additionalProperties": false, "properties": { "AuthCodeUrl": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthCodeUrl", "type": "string" }, @@ -9622,12 +9852,12 @@ "items": { "type": "string" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The OAuth scopes required for OAuth type authentication\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OAuthScopes", "type": "array" }, "TokenUrl": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TokenUrl", "type": "string" } @@ -9638,15 +9868,23 @@ "additionalProperties": false, "properties": { "AccessToken": { + "markdownDescription": "The credentials used to access protected Salesforce Pardot resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessToken", "type": "string" }, "ClientCredentialsArn": { + "markdownDescription": "The secret manager ARN, which contains the client ID and client secret of the connected app\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:aws:secretsmanager:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientCredentialsArn", "type": "string" }, "ConnectorOAuthRequest": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectorOAuthRequest" }, "RefreshToken": { + "markdownDescription": "The credentials used to acquire new access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RefreshToken", "type": "string" } }, @@ -9656,12 +9894,18 @@ "additionalProperties": false, "properties": { "BusinessUnitId": { + "markdownDescription": "The business unit id of Salesforce Pardot instance\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `18` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BusinessUnitId", "type": "string" }, "InstanceUrl": { + "markdownDescription": "The location of the Salesforce Pardot resource\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InstanceUrl", "type": "string" }, "IsSandboxEnvironment": { + "markdownDescription": "Indicates whether the connector profile applies to a sandbox or production environment\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsSandboxEnvironment", "type": "boolean" } }, @@ -9674,12 +9918,12 @@ "additionalProperties": false, "properties": { "Password": { - "markdownDescription": "The password that corresponds to the user name\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The password that corresponds to the user name\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Password", "type": "string" }, "Username": { - "markdownDescription": "The name of the user\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the user\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Username", "type": "string" } @@ -9700,28 +9944,38 @@ "type": "string" }, "ClusterIdentifier": { + "markdownDescription": "The unique ID that's assigned to an Amazon Redshift cluster\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClusterIdentifier", "type": "string" }, "DataApiRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API\\. For more information, and for the polices that you attach to this role, see [Allow Amazon AppFlow to access Amazon Redshift databases with the Data API](https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#access-redshift)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `arn:aws:iam:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataApiRoleArn", "type": "string" }, "DatabaseName": { + "markdownDescription": "The name of an Amazon Redshift database\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DatabaseName", "type": "string" }, "DatabaseUrl": { - "markdownDescription": "The JDBC URL of the Amazon Redshift cluster\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The JDBC URL of the Amazon Redshift cluster\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DatabaseUrl", "type": "string" }, "IsRedshiftServerless": { + "markdownDescription": "Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsRedshiftServerless", "type": "boolean" }, "RoleArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IAM role\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `arn:aws:iam:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of IAM role that grants Amazon Redshift read\\-only access to Amazon S3\\. For more information, and for the polices that you attach to this role, see [Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3](https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#redshift-access-s3)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `arn:aws:iam:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RoleArn", "type": "string" }, "WorkgroupName": { + "markdownDescription": "The name of an Amazon Redshift workgroup\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WorkgroupName", "type": "string" } }, @@ -9736,12 +9990,12 @@ "properties": { "BasicAuthCredentials": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.BasicAuthCredentials", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The SAPOData basic authentication credentials\\. \n*Required*: No \n*Type*: [BasicAuthCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-basicauthcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BasicAuthCredentials" }, "OAuthCredentials": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.OAuthCredentials", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The SAPOData OAuth type authentication credentials\\. \n*Required*: No \n*Type*: [OAuthCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OAuthCredentials" } }, @@ -9751,37 +10005,37 @@ "additionalProperties": false, "properties": { "ApplicationHostUrl": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The location of the SAPOData resource\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApplicationHostUrl", "type": "string" }, "ApplicationServicePath": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The application path to catalog service\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApplicationServicePath", "type": "string" }, "ClientNumber": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The client number for the client creating the connection\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `3` \n*Pattern*: `^\\d{3}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientNumber", "type": "string" }, "LogonLanguage": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The logon language of SAPOData instance\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2` \n*Pattern*: `^[a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogonLanguage", "type": "string" }, "OAuthProperties": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.OAuthProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [OAuthProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The SAPOData OAuth properties required for OAuth type authentication\\. \n*Required*: No \n*Type*: [OAuthProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OAuthProperties" }, "PortNumber": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The port number of the SAPOData instance\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PortNumber", "type": "number" }, "PrivateLinkServiceName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The SAPOData Private Link service name to be used for private data transfers\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `^$|com.amazonaws.vpce.[\\w/!:@#.\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PrivateLinkServiceName", "type": "string" } @@ -9792,7 +10046,7 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "The credentials used to access protected Salesforce resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to access protected Salesforce resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, @@ -9807,7 +10061,7 @@ "title": "ConnectorOAuthRequest" }, "RefreshToken": { - "markdownDescription": "The credentials used to acquire new access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to acquire new access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RefreshToken", "type": "string" } @@ -9882,7 +10136,7 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "The credentials used to access protected Slack resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to access protected Slack resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, @@ -10040,7 +10294,7 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "The credentials used to access protected Zendesk resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to access protected Zendesk resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, @@ -10139,7 +10393,9 @@ "type": "string" }, "MetadataCatalogConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.MetadataCatalogConfig" + "$ref": "#/definitions/AWS::AppFlow::Flow.MetadataCatalogConfig", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [MetadataCatalogConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-metadatacatalogconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetadataCatalogConfig" }, "SourceFlowConfig": { "$ref": "#/definitions/AWS::AppFlow::Flow.SourceFlowConfig", @@ -10207,6 +10463,8 @@ "type": "string" }, "TargetFileSize": { + "markdownDescription": "The desired file size, in MB, for each output file that Amazon AppFlow writes to the flow destination\\. For each file, Amazon AppFlow attempts to achieve the size that you specify\\. The actual file sizes might differ from this target based on the number and size of the records that each file contains\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetFileSize", "type": "number" } }, @@ -10235,6 +10493,8 @@ "type": "string" }, "CustomConnector": { + "markdownDescription": "Operators supported by the custom connector\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomConnector", "type": "string" }, "Datadog": { @@ -10263,6 +10523,8 @@ "type": "string" }, "Pardot": { + "markdownDescription": "The operation to be performed on the provided Salesforce Pardot source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | DIVISION | EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pardot", "type": "string" }, "S3": { @@ -10271,7 +10533,7 @@ "type": "string" }, "SAPOData": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided SAPOData source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SAPOData", "type": "string" }, @@ -10318,26 +10580,36 @@ "properties": { "CustomProperties": { "additionalProperties": true, + "markdownDescription": "The custom properties that are specific to the connector when it's used as a destination in the flow\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "CustomProperties", "type": "object" }, "EntityName": { + "markdownDescription": "The entity specified in the custom connector as a destination in the flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EntityName", "type": "string" }, "ErrorHandlingConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig" + "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig", + "markdownDescription": "The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ErrorHandlingConfig" }, "IdFieldNames": { "items": { "type": "string" }, + "markdownDescription": "The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete, or upsert\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IdFieldNames", "type": "array" }, "WriteOperationType": { + "markdownDescription": "Specifies the type of write operation to be performed in the custom connector when it's used as destination\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DELETE | INSERT | UPDATE | UPSERT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WriteOperationType", "type": "string" } }, @@ -10351,14 +10623,18 @@ "properties": { "CustomProperties": { "additionalProperties": true, + "markdownDescription": "Custom properties that are required to use the custom connector as a source\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "CustomProperties", "type": "object" }, "EntityName": { + "markdownDescription": "The entity specified in the custom connector as a source in the flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EntityName", "type": "string" } }, @@ -10385,7 +10661,9 @@ "additionalProperties": false, "properties": { "CustomConnector": { - "$ref": "#/definitions/AWS::AppFlow::Flow.CustomConnectorDestinationProperties" + "$ref": "#/definitions/AWS::AppFlow::Flow.CustomConnectorDestinationProperties", + "markdownDescription": "The properties that are required to query the custom Connector\\. \n*Required*: No \n*Type*: [CustomConnectorDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectordestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomConnector" }, "EventBridge": { "$ref": "#/definitions/AWS::AppFlow::Flow.EventBridgeDestinationProperties", @@ -10434,7 +10712,7 @@ }, "Zendesk": { "$ref": "#/definitions/AWS::AppFlow::Flow.ZendeskDestinationProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ZendeskDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties required to query Zendesk\\. \n*Required*: No \n*Type*: [ZendeskDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Zendesk" } }, @@ -10444,6 +10722,8 @@ "additionalProperties": false, "properties": { "ApiVersion": { + "markdownDescription": "The API version that the destination connector uses\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApiVersion", "type": "string" }, "ConnectorProfileName": { @@ -10526,12 +10806,18 @@ "additionalProperties": false, "properties": { "DatabaseName": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DatabaseName", "type": "string" }, "RoleArn": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "TablePrefix": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TablePrefix", "type": "string" } }, @@ -10597,7 +10883,7 @@ "properties": { "ErrorHandlingConfig": { "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The settings that determine how Amazon AppFlow handles an error when placing data in the destination\\. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure\\. `ErrorHandlingConfig` is a part of the destination connector details\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ErrorHandlingConfig" }, "Object": { @@ -10629,7 +10915,9 @@ "additionalProperties": false, "properties": { "GlueDataCatalog": { - "$ref": "#/definitions/AWS::AppFlow::Flow.GlueDataCatalog" + "$ref": "#/definitions/AWS::AppFlow::Flow.GlueDataCatalog", + "markdownDescription": "Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the AWS Glue Data Catalog\\. \n*Required*: No \n*Type*: [GlueDataCatalog](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-gluedatacatalog.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GlueDataCatalog" } }, "type": "object" @@ -10638,6 +10926,8 @@ "additionalProperties": false, "properties": { "Object": { + "markdownDescription": "The object specified in the Salesforce Pardot flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Object", "type": "string" } }, @@ -10653,10 +10943,12 @@ "items": { "type": "string" }, + "markdownDescription": "Specifies whether the destination file path includes either or both of the following elements: \nEXECUTION\\_ID \nThe ID that Amazon AppFlow assigns to the flow run\\. \nSCHEMA\\_VERSION \nThe version number of your data schema\\. Amazon AppFlow assigns this version number\\. The version number increases by one when you change any of the following settings in your flow configuration: \n+ Source\\-to\\-destination field mappings\n+ Field data types\n+ Partition keys\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PathPrefixHierarchy", "type": "array" }, "PrefixFormat": { - "markdownDescription": "Determines the level of granularity that's included in the prefix\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAY | HOUR | MINUTE | MONTH | YEAR` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the level of granularity for the date and time that's included in the prefix\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAY | HOUR | MINUTE | MONTH | YEAR` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PrefixFormat", "type": "string" }, @@ -10726,7 +11018,7 @@ "additionalProperties": false, "properties": { "S3InputFileType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The file type that Amazon AppFlow gets from your Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CSV | JSON` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3InputFileType", "type": "string" } @@ -10752,6 +11044,8 @@ "title": "PrefixConfig" }, "PreserveSourceDataTyping": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PreserveSourceDataTyping", "type": "boolean" } }, @@ -10772,7 +11066,7 @@ }, "S3InputFormatConfig": { "$ref": "#/definitions/AWS::AppFlow::Flow.S3InputFormatConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [S3InputFormatConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3inputformatconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When you use Amazon S3 as the source, the configuration format that you provide the flow input data\\. \n*Required*: No \n*Type*: [S3InputFormatConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3inputformatconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3InputFormatConfig" } }, @@ -10787,14 +11081,14 @@ "properties": { "ErrorHandlingConfig": { "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The settings that determine how Amazon AppFlow handles an error when placing data in the destination\\. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure\\. `ErrorHandlingConfig` is a part of the destination connector details\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ErrorHandlingConfig" }, "IdFieldNames": { "items": { "type": "string" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of field names that can be used as an ID field when performing a write operation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdFieldNames", "type": "array" }, @@ -10809,7 +11103,7 @@ "title": "SuccessResponseHandlingConfig" }, "WriteOperationType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The possible write operations in the destination connector\\. When this value is not provided, this defaults to the `INSERT` operation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WriteOperationType", "type": "string" } @@ -10823,7 +11117,7 @@ "additionalProperties": false, "properties": { "ObjectPath": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object path specified in the SAPOData flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ObjectPath", "type": "string" } @@ -10837,6 +11131,8 @@ "additionalProperties": false, "properties": { "DataTransferApi": { + "markdownDescription": "Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce\\. \nAUTOMATIC \nThe default\\. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to Salesforce\\. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API\\. If your flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2\\.0\\. \nEach of these Salesforce APIs structures data differently\\. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next\\. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2\\.0 on the next day to transfer 1,100 records\\. For each of these flow runs, the respective Salesforce API formats the data differently\\. Some of the differences include how dates are formatted and null values are represented\\. Also, Bulk API 2\\.0 doesn't transfer Salesforce compound fields\\. \nBy choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output\\. \nBULKV2 \nAmazon AppFlow uses only Salesforce Bulk API 2\\.0\\. This API runs asynchronous data transfers, and it's optimal for large sets of data\\. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers\\. \nNote that Bulk API 2\\.0 does not transfer Salesforce compound fields\\. \nREST\\_SYNC \nAmazon AppFlow uses only Salesforce REST API\\. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2\\.0\\. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | BULKV2 | REST_SYNC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataTransferApi", "type": "string" }, "ErrorHandlingConfig": { @@ -10872,6 +11168,8 @@ "additionalProperties": false, "properties": { "DataTransferApi": { + "markdownDescription": "Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce\\. \nAUTOMATIC \nThe default\\. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from Salesforce\\. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API\\. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2\\.0\\. \nEach of these Salesforce APIs structures data differently\\. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next\\. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2\\.0 on the next day to transfer 1,100,000 records\\. For each of these flow runs, the respective Salesforce API formats the data differently\\. Some of the differences include how dates are formatted and null values are represented\\. Also, Bulk API 2\\.0 doesn't transfer Salesforce compound fields\\. \nBy choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output\\. \nBULKV2 \nAmazon AppFlow uses only Salesforce Bulk API 2\\.0\\. This API runs asynchronous data transfers, and it's optimal for large sets of data\\. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers\\. \nNote that Bulk API 2\\.0 does not transfer Salesforce compound fields\\. \nREST\\_SYNC \nAmazon AppFlow uses only Salesforce REST API\\. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2\\.0\\. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | BULKV2 | REST_SYNC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataTransferApi", "type": "string" }, "EnableDynamicFieldUpdate": { @@ -10904,18 +11202,22 @@ "type": "string" }, "FirstExecutionFrom": { + "markdownDescription": "Specifies the date range for the records to import from the connector in the first flow run\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FirstExecutionFrom", "type": "number" }, "FlowErrorDeactivationThreshold": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FlowErrorDeactivationThreshold", "type": "number" }, "ScheduleEndTime": { - "markdownDescription": "Specifies the scheduled end time for a schedule\\-triggered flow\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The time at which the scheduled flow ends\\. The time is formatted as a timestamp that follows the ISO 8601 standard, such as `2022-04-27T13:00:00-07:00`\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleEndTime", "type": "number" }, "ScheduleExpression": { - "markdownDescription": "The scheduling expression that determines the rate at which the scheduled flow will run, for example: `rate(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/5minutes.html)`\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The scheduling expression that determines the rate at which the schedule will run, for example `rate(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/5minutes.html)`\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleExpression", "type": "string" }, @@ -10925,12 +11227,12 @@ "type": "number" }, "ScheduleStartTime": { - "markdownDescription": "Specifies the scheduled start time for a schedule\\-triggered flow\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The time at which the scheduled flow starts\\. The time is formatted as a timestamp that follows the ISO 8601 standard, such as `2022-04-26T13:00:00-07:00`\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleStartTime", "type": "number" }, "TimeZone": { - "markdownDescription": "Specifies the time zone used when referring to the date and time of a scheduled\\-triggered flow, such as `America/New_York`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the time zone used when referring to the dates and times of a scheduled flow, such as `America/New_York`\\. This time zone is only a descriptive label\\. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow\\. \nIf you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps\\. For example, the UTC offsets for the `America/New_York` timezone are `-04:00` EDT and `-05:00 EST`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeZone", "type": "string" } @@ -11021,7 +11323,9 @@ "title": "Amplitude" }, "CustomConnector": { - "$ref": "#/definitions/AWS::AppFlow::Flow.CustomConnectorSourceProperties" + "$ref": "#/definitions/AWS::AppFlow::Flow.CustomConnectorSourceProperties", + "markdownDescription": "The properties that are applied when the custom connector is being used as a source\\. \n*Required*: No \n*Type*: [CustomConnectorSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectorsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomConnector" }, "Datadog": { "$ref": "#/definitions/AWS::AppFlow::Flow.DatadogSourceProperties", @@ -11049,7 +11353,9 @@ "title": "Marketo" }, "Pardot": { - "$ref": "#/definitions/AWS::AppFlow::Flow.PardotSourceProperties" + "$ref": "#/definitions/AWS::AppFlow::Flow.PardotSourceProperties", + "markdownDescription": "Specifies the information that is required for querying Salesforce Pardot\\. \n*Required*: No \n*Type*: [PardotSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-pardotsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pardot" }, "S3": { "$ref": "#/definitions/AWS::AppFlow::Flow.S3SourceProperties", @@ -11058,7 +11364,7 @@ }, "SAPOData": { "$ref": "#/definitions/AWS::AppFlow::Flow.SAPODataSourceProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SAPODataSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatasourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties that are applied when using SAPOData as a flow source\\. \n*Required*: No \n*Type*: [SAPODataSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatasourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SAPOData" }, "Salesforce": { @@ -11103,6 +11409,8 @@ "additionalProperties": false, "properties": { "ApiVersion": { + "markdownDescription": "The API version of the connector when it's used as a source in the flow\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApiVersion", "type": "string" }, "ConnectorProfileName": { @@ -11282,7 +11590,7 @@ }, "PrefixConfig": { "$ref": "#/definitions/AWS::AppFlow::Flow.PrefixConfig", - "markdownDescription": "Determines the prefix that Amazon AppFlow applies to the destination folder name\\. You can name your destination folders according to the flow frequency and date\\. \n*Required*: Yes \n*Type*: [PrefixConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-prefixconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination\\. \n*Required*: Yes \n*Type*: [PrefixConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-prefixconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PrefixConfig" } }, @@ -11295,22 +11603,22 @@ "additionalProperties": false, "properties": { "DocumentType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The document type specified in the Veeva document extract flow\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\s\\w_-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DocumentType", "type": "string" }, "IncludeAllVersions": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Boolean value to include All Versions of files in Veeva document extract flow\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeAllVersions", "type": "boolean" }, "IncludeRenditions": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Boolean value to include file renditions in Veeva document extract flow\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeRenditions", "type": "boolean" }, "IncludeSourceFiles": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Boolean value to include source files in Veeva document extract flow\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeSourceFiles", "type": "boolean" }, @@ -11330,24 +11638,24 @@ "properties": { "ErrorHandlingConfig": { "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The settings that determine how Amazon AppFlow handles an error when placing data in the destination\\. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure\\. `ErrorHandlingConfig` is a part of the destination connector details\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ErrorHandlingConfig" }, "IdFieldNames": { "items": { "type": "string" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of field names that can be used as an ID field when performing a write operation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdFieldNames", "type": "array" }, "Object": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object specified in the Zendesk flow destination\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Object", "type": "string" }, "WriteOperationType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The possible write operations in the destination connector\\. When this value is not provided, this defaults to the `INSERT` operation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WriteOperationType", "type": "string" } @@ -11860,6 +12168,8 @@ "additionalProperties": false, "properties": { "Port": { + "markdownDescription": "The port number of the gateway route target\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "VirtualService": { @@ -11943,6 +12253,8 @@ "type": "array" }, "Port": { + "markdownDescription": "The gateway route port to be matched on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "ServiceName": { @@ -12109,6 +12421,8 @@ "title": "Path" }, "Port": { + "markdownDescription": "The port number to match on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "Prefix": { @@ -12301,7 +12615,7 @@ "additionalProperties": false, "properties": { "Type": { - "markdownDescription": "The egress filter type\\. By default, the type is `DROP_ALL`, which allows egress only from virtual nodes to other defined resources in the service mesh \\(and any traffic to `*.amazonaws.com` for AWS API calls\\)\\. You can set the egress filter type to `ALLOW_ALL` to allow egress to any endpoint inside or outside of the service mesh\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALLOW_ALL | DROP_ALL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The egress filter type\\. By default, the type is `DROP_ALL`, which allows egress only from virtual nodes to other defined resources in the service mesh \\(and any traffic to `*.amazonaws.com` for AWS API calls\\)\\. You can set the egress filter type to `ALLOW_ALL` to allow egress to any endpoint inside or outside of the service mesh\\. \nIf you specify any backends on a virtual node when using `ALLOW_ALL`, you must specifiy all egress for that virtual node as backends\\. Otherwise, `ALLOW_ALL` will no longer work for that virtual node\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALLOW_ALL | DROP_ALL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" } @@ -12315,6 +12629,8 @@ "additionalProperties": false, "properties": { "IpPreference": { + "markdownDescription": "The IP version to use to control traffic within the mesh\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IPv4_ONLY | IPv4_PREFERRED | IPv6_ONLY | IPv6_PREFERRED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IpPreference", "type": "string" } }, @@ -12329,7 +12645,9 @@ "title": "EgressFilter" }, "ServiceDiscovery": { - "$ref": "#/definitions/AWS::AppMesh::Mesh.MeshServiceDiscovery" + "$ref": "#/definitions/AWS::AppMesh::Mesh.MeshServiceDiscovery", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [MeshServiceDiscovery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshservicediscovery.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceDiscovery" } }, "type": "object" @@ -12559,6 +12877,8 @@ "type": "string" }, "Port": { + "markdownDescription": "The port number to match on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "ServiceName": { @@ -12827,6 +13147,8 @@ "title": "Path" }, "Port": { + "markdownDescription": "The port number to match on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "Prefix": { @@ -12945,7 +13267,9 @@ "title": "Action" }, "Match": { - "$ref": "#/definitions/AWS::AppMesh::Route.TcpRouteMatch" + "$ref": "#/definitions/AWS::AppMesh::Route.TcpRouteMatch", + "markdownDescription": "An object that represents the criteria for determining a request match\\. \n*Required*: No \n*Type*: [TcpRouteMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproutematch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Match" }, "Timeout": { "$ref": "#/definitions/AWS::AppMesh::Route.TcpTimeout", @@ -12979,6 +13303,8 @@ "additionalProperties": false, "properties": { "Port": { + "markdownDescription": "The port number to match on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" } }, @@ -12999,6 +13325,8 @@ "additionalProperties": false, "properties": { "Port": { + "markdownDescription": "The targeted port of the weighted object\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "VirtualNode": { @@ -13113,9 +13441,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The specified key for the JSON\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "The specified value for the JSON\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -13132,9 +13464,13 @@ "items": { "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.JsonFormatRef" }, + "markdownDescription": "The logging format for JSON\\. \n*Required*: No \n*Type*: List of [JsonFormatRef](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-jsonformatref.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Json", "type": "array" }, "Text": { + "markdownDescription": "The logging format for text\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Text", "type": "string" } }, @@ -13274,7 +13610,9 @@ "additionalProperties": false, "properties": { "Format": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.LoggingFormat" + "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.LoggingFormat", + "markdownDescription": "The specified format for the virtual gateway access logs\\. It can be either `json_format` or `text_format`\\. \n*Required*: No \n*Type*: [LoggingFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-loggingformat.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Format" }, "Path": { "markdownDescription": "The file path to write access logs to\\. You can use `/dev/stdout` to send access logs to standard out and configure your Envoy container to use a log driver, such as `awslogs`, to export the access logs to a log storage service such as Amazon CloudWatch Logs\\. You can also specify a path in the Envoy container's file system to write the files to disk\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13583,7 +13921,7 @@ "items": { "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayListener" }, - "markdownDescription": "The listeners that the mesh endpoint is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: Yes \n*Type*: List of [VirtualGatewayListener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistener.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The listeners that the mesh endpoint is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: Yes \n*Type*: List of [VirtualGatewayListener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistener.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Listeners", "type": "array" }, @@ -13817,6 +14155,8 @@ "type": "array" }, "IpPreference": { + "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IPv4_ONLY | IPv4_PREFERRED | IPv6_ONLY | IPv6_PREFERRED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IpPreference", "type": "string" }, "NamespaceName": { @@ -13926,6 +14266,8 @@ "type": "string" }, "IpPreference": { + "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IPv4_ONLY | IPv4_PREFERRED | IPv6_ONLY | IPv6_PREFERRED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IpPreference", "type": "string" }, "ResponseType": { @@ -13963,7 +14305,9 @@ "additionalProperties": false, "properties": { "Format": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.LoggingFormat" + "$ref": "#/definitions/AWS::AppMesh::VirtualNode.LoggingFormat", + "markdownDescription": "The specified format for the logs\\. The format is either `json_format` or `text_format`\\. \n*Required*: No \n*Type*: [LoggingFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-loggingformat.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Format" }, "Path": { "markdownDescription": "The file path to write access logs to\\. You can use `/dev/stdout` to send access logs to standard out and configure your Envoy container to use a log driver, such as `awslogs`, to export the access logs to a log storage service such as Amazon CloudWatch Logs\\. You can also specify a path in the Envoy container's file system to write the files to disk\\. \nThe Envoy process must have write permissions to the path that you specify here\\. Otherwise, Envoy fails to bootstrap properly\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -14060,9 +14404,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The specified key for the JSON\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "The specified value for the JSON\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -14284,9 +14632,13 @@ "items": { "$ref": "#/definitions/AWS::AppMesh::VirtualNode.JsonFormatRef" }, + "markdownDescription": "The logging format for JSON\\. \n*Required*: No \n*Type*: List of [JsonFormatRef](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-jsonformatref.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Json", "type": "array" }, "Text": { + "markdownDescription": "The logging format for text\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Text", "type": "string" } }, @@ -14404,7 +14756,7 @@ "properties": { "SubjectAlternativeNames": { "$ref": "#/definitions/AWS::AppMesh::VirtualNode.SubjectAlternativeNames", - "markdownDescription": "A reference to an object that represents the SANs for a Transport Layer Security \\(TLS\\) validation context\\. \n*Required*: No \n*Type*: [SubjectAlternativeNames](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-subjectalternativenames.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A reference to an object that represents the SANs for a Transport Layer Security \\(TLS\\) validation context\\. If you don't specify SANs on the *terminating* mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate\\. If you don't specify SANs on the *originating* mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration\\. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name\\. \n*Required*: No \n*Type*: [SubjectAlternativeNames](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-subjectalternativenames.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SubjectAlternativeNames" }, "Trust": { @@ -14569,7 +14921,7 @@ "items": { "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Backend" }, - "markdownDescription": "The backends that the virtual node is expected to send outbound traffic to\\. \n*Required*: No \n*Type*: List of [Backend](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backend.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The backends that the virtual node is expected to send outbound traffic to\\. \nApp Mesh doesn't validate the existence of those virtual services specified in backends\\. This is to prevent a cyclic dependency between virtual nodes and virtual services creation\\. Make sure the virtual service name is correct\\. The virtual service can be created afterwards if it doesn't already exist\\. \n*Required*: No \n*Type*: List of [Backend](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backend.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Backends", "type": "array" }, @@ -14577,7 +14929,7 @@ "items": { "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Listener" }, - "markdownDescription": "The listener that the virtual node is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: No \n*Type*: List of [Listener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The listener that the virtual node is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: No \n*Type*: List of [Listener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Listeners", "type": "array" }, @@ -14617,7 +14969,7 @@ "title": "ClientPolicy" }, "VirtualServiceName": { - "markdownDescription": "The name of the virtual service that is acting as a virtual node backend\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the virtual service that is acting as a virtual node backend\\. \nApp Mesh doesn't validate the existence of those virtual services specified in backends\\. This is to prevent a cyclic dependency between virtual nodes and virtual services creation\\. Make sure the virtual service name is correct\\. The virtual service can be created afterwards if it doesn't already exist\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VirtualServiceName", "type": "string" } @@ -14759,7 +15111,7 @@ "items": { "$ref": "#/definitions/AWS::AppMesh::VirtualRouter.VirtualRouterListener" }, - "markdownDescription": "The listeners that the virtual router is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: Yes \n*Type*: List of [VirtualRouterListener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The listeners that the virtual router is expected to receive inbound traffic from\\. \n*Required*: Yes \n*Type*: List of [VirtualRouterListener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Listeners", "type": "array" } @@ -14952,16 +15304,22 @@ "additionalProperties": false, "properties": { "ObservabilityConfigurationName": { + "markdownDescription": "A name for the observability configuration\\. When you use it for the first time in an AWS Region, App Runner creates revision number `1` of this name\\. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration\\. \nThe name `DefaultConfiguration` is reserved\\. You can't use it to create a new observability configuration, and you can't create a revision of it\\. \nWhen you want to use your own observability configuration for your App Runner service, *create a configuration with a different name*, and then provide it when you create or update your service\\.\nIf you don't specify a name, AWS CloudFormation generates a name for your observability configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `32` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ObservabilityConfigurationName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of metadata items that you can associate with your observability configuration resource\\. A tag is a key\\-value pair\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Tags", "type": "array" }, "TraceConfiguration": { - "$ref": "#/definitions/AWS::AppRunner::ObservabilityConfiguration.TraceConfiguration" + "$ref": "#/definitions/AWS::AppRunner::ObservabilityConfiguration.TraceConfiguration", + "markdownDescription": "The configuration of the tracing feature within this observability configuration\\. If you don't specify it, App Runner doesn't enable tracing\\. \n*Required*: No \n*Type*: [TraceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-observabilityconfiguration-traceconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TraceConfiguration" } }, "type": "object" @@ -14990,6 +15348,8 @@ "additionalProperties": false, "properties": { "Vendor": { + "markdownDescription": "The implementation provider chosen for tracing App Runner services\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AWSXRAY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Vendor", "type": "string" } }, @@ -15034,7 +15394,7 @@ "additionalProperties": false, "properties": { "AutoScalingConfigurationArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service\\. If not provided, App Runner associates the latest revision of a default auto scaling configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an App Runner automatic scaling configuration resource that you want to associate with your service\\. If not provided, App Runner associates the latest revision of a default auto scaling configuration\\. \nSpecify an ARN with a name and a revision number to associate that revision\\. For example: `arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3` \nSpecify just the name to associate the latest revision\\. For example: `arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability` \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutoScalingConfigurationArn", "type": "string" }, @@ -15050,7 +15410,7 @@ }, "InstanceConfiguration": { "$ref": "#/definitions/AWS::AppRunner::Service.InstanceConfiguration", - "markdownDescription": "The runtime configuration of instances \\(scaling units\\) of the App Runner service\\. \n*Required*: No \n*Type*: [InstanceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The runtime configuration of instances \\(scaling units\\) of your service\\. \n*Required*: No \n*Type*: [InstanceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InstanceConfiguration" }, "NetworkConfiguration": { @@ -15059,10 +15419,12 @@ "title": "NetworkConfiguration" }, "ObservabilityConfiguration": { - "$ref": "#/definitions/AWS::AppRunner::Service.ServiceObservabilityConfiguration" + "$ref": "#/definitions/AWS::AppRunner::Service.ServiceObservabilityConfiguration", + "markdownDescription": "The observability configuration of your service\\. \n*Required*: No \n*Type*: [ServiceObservabilityConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObservabilityConfiguration" }, "ServiceName": { - "markdownDescription": "A name for the App Runner service\\. It must be unique across all the running App Runner services in your AWS account in the AWS Region\\. \nIf you don't specify a name, AWS CloudFormation generates a name for your Service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `40` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9-_]{3,39}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A name for the App Runner service\\. It must be unique across all the running App Runner services in your AWS account in the AWS Region\\. \nIf you don't specify a name, AWS CloudFormation generates a name for your service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `40` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9-_]{3,39}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ServiceName", "type": "string" }, @@ -15145,7 +15507,7 @@ "additionalProperties": false, "properties": { "BuildCommand": { - "markdownDescription": "The command App Runner runs to build your application\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The command App Runner runs to build your application\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[^\\x0a\\x0d]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BuildCommand", "type": "string" }, @@ -15155,7 +15517,7 @@ "type": "string" }, "Runtime": { - "markdownDescription": "A runtime environment type for building and running an App Runner service\\. It represents a programming language runtime\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CORRETTO_11 | CORRETTO_8 | NODEJS_12 | NODEJS_14 | PYTHON_3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A runtime environment type for building and running an App Runner service\\. It represents a programming language runtime\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CORRETTO_11 | CORRETTO_8 | DOTNET_6 | GO_1 | NODEJS_12 | NODEJS_14 | NODEJS_16 | PHP_81 | PYTHON_3 | RUBY_31` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Runtime", "type": "string" }, @@ -15163,18 +15525,20 @@ "items": { "$ref": "#/definitions/AWS::AppRunner::Service.KeyValuePair" }, + "markdownDescription": "An array of key\\-value pairs representing the secrets and parameters that get referenced to your service as an environment variable\\. The supported values are either the full Amazon Resource Name \\(ARN\\) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store\\. \n+ If the AWS Systems Manager Parameter Store parameter exists in the same AWS Region as the service that you're launching, you can use either the full ARN or name of the secret\\. If the parameter exists in a different Region, then the full ARN must be specified\\. \n+ Currently, cross account referencing of AWS Systems Manager Parameter Store parameter is not supported\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RuntimeEnvironmentSecrets", "type": "array" }, "RuntimeEnvironmentVariables": { "items": { "$ref": "#/definitions/AWS::AppRunner::Service.KeyValuePair" }, - "markdownDescription": "The environment variables that are available to your running App Runner service\\. An array of key\\-value pairs\\. Keys with a prefix of `AWSAPPRUNNER` are reserved for system use and aren't valid\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The environment variables that are available to your running AWS App Runner service\\. An array of key\\-value pairs\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RuntimeEnvironmentVariables", "type": "array" }, "StartCommand": { - "markdownDescription": "The command App Runner runs to start your application\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The command App Runner runs to start your application\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[^\\x0a\\x0d]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartCommand", "type": "string" } @@ -15189,7 +15553,7 @@ "properties": { "CodeConfiguration": { "$ref": "#/definitions/AWS::AppRunner::Service.CodeConfiguration", - "markdownDescription": "Configuration for building and running the service from a source code repository\\. \n*Required*: No \n*Type*: [CodeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configuration for building and running the service from a source code repository\\. \n `CodeConfiguration` is required only for `CreateService` request\\.\n*Required*: No \n*Type*: [CodeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CodeConfiguration" }, "RepositoryUrl": { @@ -15290,18 +15654,20 @@ "items": { "$ref": "#/definitions/AWS::AppRunner::Service.KeyValuePair" }, + "markdownDescription": "An array of key\\-value pairs representing the secrets and parameters that get referenced to your service as an environment variable\\. The supported values are either the full Amazon Resource Name \\(ARN\\) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store\\. \n+ If the AWS Systems Manager Parameter Store parameter exists in the same AWS Region as the service that you're launching, you can use either the full ARN or name of the secret\\. If the parameter exists in a different Region, then the full ARN must be specified\\. \n+ Currently, cross account referencing of AWS Systems Manager Parameter Store parameter is not supported\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RuntimeEnvironmentSecrets", "type": "array" }, "RuntimeEnvironmentVariables": { "items": { "$ref": "#/definitions/AWS::AppRunner::Service.KeyValuePair" }, - "markdownDescription": "Environment variables that are available to your running App Runner service\\. An array of key\\-value pairs\\. Keys with a prefix of `AWSAPPRUNNER` are reserved for system use and aren't valid\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Environment variables that are available to your running App Runner service\\. An array of key\\-value pairs\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RuntimeEnvironmentVariables", "type": "array" }, "StartCommand": { - "markdownDescription": "An optional command that App Runner runs to start the application in the source image\\. If specified, this command overrides the Docker image\u2019s default start command\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `51200` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional command that App Runner runs to start the application in the source image\\. If specified, this command overrides the Docker image\u2019s default start command\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[^\\x0a\\x0d]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartCommand", "type": "string" } @@ -15337,6 +15703,8 @@ "additionalProperties": false, "properties": { "IsPubliclyAccessible": { + "markdownDescription": "Specifies whether your App Runner service is publicly accessible\\. To make the service publicly accessible set it to `True`\\. To make the service privately accessible, from only within an Amazon VPC set it to `False`\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsPubliclyAccessible", "type": "boolean" } }, @@ -15387,11 +15755,13 @@ "properties": { "EgressConfiguration": { "$ref": "#/definitions/AWS::AppRunner::Service.EgressConfiguration", - "markdownDescription": "Network configuration settings for outbound message traffic\\. \n*Required*: Yes \n*Type*: [EgressConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Network configuration settings for outbound message traffic\\. \n*Required*: No \n*Type*: [EgressConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EgressConfiguration" }, "IngressConfiguration": { - "$ref": "#/definitions/AWS::AppRunner::Service.IngressConfiguration" + "$ref": "#/definitions/AWS::AppRunner::Service.IngressConfiguration", + "markdownDescription": "Network configuration settings for inbound message traffic\\. \n*Required*: No \n*Type*: [IngressConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-ingressconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IngressConfiguration" } }, "type": "object" @@ -15400,9 +15770,13 @@ "additionalProperties": false, "properties": { "ObservabilityConfigurationArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the observability configuration that is associated with the service\\. Specified only when `ObservabilityEnabled` is `true`\\. \nSpecify an ARN with a name and a revision number to associate that revision\\. For example: `arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3` \nSpecify just the name to associate the latest revision\\. For example: `arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing` \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObservabilityConfigurationArn", "type": "string" }, "ObservabilityEnabled": { + "markdownDescription": "When `true`, an observability configuration resource is associated with the service, and an `ObservabilityConfigurationArn` is specified\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObservabilityEnabled", "type": "boolean" } }, @@ -15504,7 +15878,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC\\. Specify IDs of subnets of a single Amazon VPC\\. App Runner determines the Amazon VPC from the subnets you specify\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC\\. Specify IDs of subnets of a single Amazon VPC\\. App Runner determines the Amazon VPC from the subnets you specify\\. \n App Runner currently only provides support for IPv4\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Subnets", "type": "array" }, @@ -15584,18 +15958,26 @@ "additionalProperties": false, "properties": { "IngressVpcConfiguration": { - "$ref": "#/definitions/AWS::AppRunner::VpcIngressConnection.IngressVpcConfiguration" + "$ref": "#/definitions/AWS::AppRunner::VpcIngressConnection.IngressVpcConfiguration", + "markdownDescription": "Specifications for the customer\u2019s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource\\. \n*Required*: Yes \n*Type*: [IngressVpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-vpcingressconnection-ingressvpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IngressVpcConfiguration" }, "ServiceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for this App Runner service that is used to create the VPC Ingress Connection resource\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ServiceArn", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An optional list of metadata items that you can associate with the VPC Ingress Connection resource\\. A tag is a key\\-value pair\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Tags", "type": "array" }, "VpcIngressConnectionName": { + "markdownDescription": "The customer\\-provided VPC Ingress Connection name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `40` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9\\-_]{3,39}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VpcIngressConnectionName", "type": "string" } }, @@ -15630,9 +16012,13 @@ "additionalProperties": false, "properties": { "VpcEndpointId": { + "markdownDescription": "The ID of the VPC endpoint that your App Runner service connects to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `51200` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcEndpointId", "type": "string" }, "VpcId": { + "markdownDescription": "The ID of the VPC that is used for the VPC endpoint\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `51200` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcId", "type": "string" } }, @@ -16137,7 +16523,9 @@ "additionalProperties": false, "properties": { "CertificateBasedAuthProperties": { - "$ref": "#/definitions/AWS::AppStream::DirectoryConfig.CertificateBasedAuthProperties" + "$ref": "#/definitions/AWS::AppStream::DirectoryConfig.CertificateBasedAuthProperties", + "markdownDescription": "The certificate\\-based authentication properties used to authenticate SAML 2\\.0 Identity Provider \\(IdP\\) user identities to Active Directory domain\\-joined streaming instances\\. \n*Required*: No \n*Type*: [CertificateBasedAuthProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-certificatebasedauthproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertificateBasedAuthProperties" }, "DirectoryName": { "markdownDescription": "The fully qualified name of the directory \\(for example, corp\\.example\\.com\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -16190,9 +16578,13 @@ "additionalProperties": false, "properties": { "CertificateAuthorityArn": { + "markdownDescription": "The ARN of the AWS Certificate Manager Private CA resource\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^arn:aws(?:\\-cn|\\-iso\\-b|\\-iso|\\-us\\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\\\-]{0,1023}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertificateAuthorityArn", "type": "string" }, "Status": { + "markdownDescription": "The status of the certificate\\-based authentication properties\\. Fallback is turned on by default when certificate\\-based authentication is **Enabled**\\. Fallback allows users to log in using their AD domain password if certificate\\-based authentication is unsuccessful, or to unlock a desktop lock screen\\. **Enabled\\_no\\_directory\\_login\\_fallback** enables certificate\\-based authentication, but does not allow users to log in using their AD domain password\\. Users will be disconnected to re\\-authenticate using certificates\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED | ENABLED_NO_DIRECTORY_LOGIN_FALLBACK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" } }, @@ -16447,7 +16839,9 @@ "type": "string" }, "SessionScriptS3Location": { - "$ref": "#/definitions/AWS::AppStream::Fleet.S3Location" + "$ref": "#/definitions/AWS::AppStream::Fleet.S3Location", + "markdownDescription": "The S3 location of the session scripts configuration zip file\\. This only applies to Elastic fleets\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionScriptS3Location" }, "StreamView": { "markdownDescription": "The AppStream 2\\.0 view that is displayed to your users when they stream from the fleet\\. When `APP` is specified, only the windows of applications opened by users display\\. When `DESKTOP` is specified, the standard desktop that is provided by the operating system displays\\. \nThe default value is `APP`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `APP | DESKTOP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -16537,9 +16931,13 @@ "additionalProperties": false, "properties": { "S3Bucket": { + "markdownDescription": "The S3 bucket of the S3 object\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `^[0-9a-z\\.\\-]*(?/ is the final portion of the load balancer ARN\n+ targetgroup// is the final portion of the target group ARN\\.\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation\\. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1023` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceLabel", "type": "string" } @@ -21803,7 +22243,7 @@ "items": { "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy.PredictiveScalingMetricSpecification" }, - "markdownDescription": "An array that contains information about the metrics and target utilization to use for predictive scaling\\. \nAdding more than one predictive scaling metric specification to the array is currently not supported\\.\n*Required*: Yes \n*Type*: List of [PredictiveScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This structure includes the metrics and target utilization to use for predictive scaling\\. \nThis is an array, but we currently only support a single metric specification\\. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric\\. \n*Required*: Yes \n*Type*: List of [PredictiveScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricSpecifications", "type": "array" }, @@ -21894,17 +22334,17 @@ }, "PredefinedLoadMetricSpecification": { "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy.PredictiveScalingPredefinedLoadMetric", - "markdownDescription": "The load metric specification\\. \nIf you specify `PredefinedMetricPairSpecification`, don't specify this property\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedLoadMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The predefined load metric specification\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedLoadMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PredefinedLoadMetricSpecification" }, "PredefinedMetricPairSpecification": { "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy.PredictiveScalingPredefinedMetricPair", - "markdownDescription": "The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use\\. \nWith predictive scaling, you must specify either a metric pair, or a load metric and a scaling metric individually\\. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy\\. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric\\.\n*Required*: No \n*Type*: [PredictiveScalingPredefinedMetricPair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedMetricPair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PredefinedMetricPairSpecification" }, "PredefinedScalingMetricSpecification": { "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy.PredictiveScalingPredefinedScalingMetric", - "markdownDescription": "The scaling metric specification\\. \nIf you specify `PredefinedMetricPairSpecification`, don't specify this property\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedScalingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The predefined scaling metric specification\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedScalingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PredefinedScalingMetricSpecification" }, "TargetValue": { @@ -21946,7 +22386,7 @@ "type": "string" }, "ResourceLabel": { - "markdownDescription": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group\\. You can't specify a resource label unless the target group is attached to the Auto Scaling group\\. \nYou create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash \\(/\\)\\. The format of the resource label is: \n `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff`\\. \nWhere: \n+ app// is the final portion of the load balancer ARN\n+ targetgroup// is the final portion of the target group ARN\\.\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation\\. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group\\. You can't specify a resource label unless the target group is attached to the Auto Scaling group\\. \nYou create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash \\(/\\)\\. The format of the resource label is: \n `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff`\\. \nWhere: \n+ app// is the final portion of the load balancer ARN\n+ targetgroup// is the final portion of the target group ARN\\.\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation\\. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1023` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceLabel", "type": "string" } @@ -21984,12 +22424,12 @@ "type": "number" }, "MetricIntervalUpperBound": { - "markdownDescription": "The upper bound for the difference between the alarm threshold and the CloudWatch metric\\. If the metric value is above the breach threshold, the upper bound is exclusive \\(the metric must be less than the threshold plus the upper bound\\)\\. Otherwise, it is inclusive \\(the metric must be less than or equal to the threshold plus the upper bound\\)\\. A null value indicates positive infinity\\. \n*Required*: Conditional \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The upper bound for the difference between the alarm threshold and the CloudWatch metric\\. If the metric value is above the breach threshold, the upper bound is exclusive \\(the metric must be less than the threshold plus the upper bound\\)\\. Otherwise, it is inclusive \\(the metric must be less than or equal to the threshold plus the upper bound\\)\\. A null value indicates positive infinity\\. \nThe upper bound must be greater than the lower bound\\. \n*Required*: Conditional \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricIntervalUpperBound", "type": "number" }, "ScalingAdjustment": { - "markdownDescription": "The amount by which to scale\\. The adjustment is based on the value that you specified in the `AdjustmentType` property \\(either an absolute number or a percentage\\)\\. A positive value adds to the current capacity and a negative number subtracts from the current capacity\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount by which to scale, based on the specified adjustment type\\. A positive value adds to the current capacity while a negative number removes from the current capacity\\. \nThe amount by which to scale\\. The adjustment is based on the value that you specified in the `AdjustmentType` property \\(either an absolute number or a percentage\\)\\. A positive value adds to the current capacity and a negative number subtracts from the current capacity\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScalingAdjustment", "type": "number" } @@ -22018,7 +22458,7 @@ "title": "PredefinedMetricSpecification" }, "TargetValue": { - "markdownDescription": "The target value for the metric\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The target value for the metric\\. \nSome metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue\\. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one\\-minute interval\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TargetValue", "type": "number" } @@ -22069,7 +22509,7 @@ "type": "string" }, "DesiredCapacity": { - "markdownDescription": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain\\. It can scale beyond this capacity if you add more scaling conditions\\. \nYou must specify at least one of the following properties: `MaxSize`, `MinSize`, or `DesiredCapacity`\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain\\. It can scale beyond this capacity if you add more scaling conditions\\. \nYou must specify at least one of the following properties: `MaxSize`, `MinSize`, or `DesiredCapacity`\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DesiredCapacity", "type": "number" }, @@ -22079,27 +22519,27 @@ "type": "string" }, "MaxSize": { - "markdownDescription": "The maximum size of the Auto Scaling group\\. \nYou must specify at least one of the following properties: `MaxSize`, `MinSize`, or `DesiredCapacity`\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum size of the Auto Scaling group\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxSize", "type": "number" }, "MinSize": { - "markdownDescription": "The minimum size of the Auto Scaling group\\. \nYou must specify at least one of the following properties: `MaxSize`, `MinSize`, or `DesiredCapacity`\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The minimum size of the Auto Scaling group\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MinSize", "type": "number" }, "Recurrence": { - "markdownDescription": "The recurring schedule for this action\\. This format consists of five fields separated by white spaces: \\[Minute\\] \\[Hour\\] \\[Day\\_of\\_Month\\] \\[Month\\_of\\_Year\\] \\[Day\\_of\\_Week\\]\\. For more information about this format, see [Crontab](http://crontab.org)\\. \nWhen `StartTime` and `EndTime` are specified with `Recurrence`, they form the boundaries of when the recurring action starts and stops\\. \nCron expressions use Universal Coordinated Time \\(UTC\\) by default\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The recurring schedule for this action\\. This format consists of five fields separated by white spaces: \\[Minute\\] \\[Hour\\] \\[Day\\_of\\_Month\\] \\[Month\\_of\\_Year\\] \\[Day\\_of\\_Week\\]\\. The value must be in quotes \\(for example, `\"30 0 1 1,6,12 *\"`\\)\\. For more information about this format, see [Crontab](http://crontab.org)\\. \nWhen `StartTime` and `EndTime` are specified with `Recurrence`, they form the boundaries of when the recurring action starts and stops\\. \nCron expressions use Universal Coordinated Time \\(UTC\\) by default\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Recurrence", "type": "string" }, "StartTime": { - "markdownDescription": "The date and time for this action to start, in YYYY\\-MM\\-DDThh:mm:ssZ format in UTC/GMT only\\. For example, `\"2021-06-01T00:00:00Z\"`\\. \nIf you specify `Recurrence` and `StartTime`, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The date and time for this action to start, in YYYY\\-MM\\-DDThh:mm:ssZ format in UTC/GMT only and in quotes \\(for example, `\"2021-06-01T00:00:00Z\"`\\)\\. \nIf you specify `Recurrence` and `StartTime`, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartTime", "type": "string" }, "TimeZone": { - "markdownDescription": "Specifies the time zone for a cron expression\\. If a time zone is not provided, UTC is used by default\\. \nValid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database \\(such as `Etc/GMT+9` or `Pacific/Tahiti`\\)\\. For more information, see [https://en\\.wikipedia\\.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the time zone for a cron expression\\. If a time zone is not provided, UTC is used by default\\. \nValid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database \\(such as `Etc/GMT+9` or `Pacific/Tahiti`\\)\\. For more information, see [https://en\\.wikipedia\\.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeZone", "type": "string" } @@ -22166,7 +22606,7 @@ "additionalProperties": false, "properties": { "AutoScalingGroupName": { - "markdownDescription": "The name of the Auto Scaling group\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the Auto Scaling group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AutoScalingGroupName", "type": "string" }, @@ -22369,12 +22809,12 @@ "items": { "$ref": "#/definitions/AWS::AutoScalingPlans::ScalingPlan.MetricDimension" }, - "markdownDescription": "The dimensions of the metric\\. \nConditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification\\. \n*Required*: No \n*Type*: List of [MetricDimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The dimensions of the metric\\. \nConditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy\\. \n*Required*: No \n*Type*: List of [MetricDimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Dimensions", "type": "array" }, "MetricName": { - "markdownDescription": "The name of the metric\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the metric\\. To get the exact metric name, namespace, and dimensions, inspect the [Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricName", "type": "string" }, @@ -22389,7 +22829,7 @@ "type": "string" }, "Unit": { - "markdownDescription": "The unit of the metric\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unit of the metric\\. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Unit", "type": "string" } @@ -22789,7 +23229,7 @@ "type": "string" }, "StartWindowMinutes": { - "markdownDescription": "An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully\\. \nIf this value is included, it must be at least 60 minutes to avoid errors\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartWindowMinutes", "type": "number" }, @@ -22918,7 +23358,7 @@ "properties": { "Conditions": { "$ref": "#/definitions/AWS::Backup::BackupSelection.Conditions", - "markdownDescription": "A list of conditions that you define to assign resources to your backup plans using tags\\. For example, `\"StringEquals\": {\"Department\": \"accounting\"`\\. Condition operators are case sensitive\\. \n`Conditions` differs from `ListOfTags` as follows: \n+ When you specify more than one condition, you only assign the resources that match ALL conditions \\(using AND logic\\)\\.\n+ `Conditions` supports `StringEquals`, `StringLike`, `StringNotEquals`, and `StringNotLike`\\. `ListOfTags` only supports `StringEquals`\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of conditions that you define to assign resources to your backup plans using tags\\. For example, `\"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\", \"ConditionValue\": \"true\" },`\\. Condition operators are case sensitive\\. \n`Conditions` differs from `ListOfTags` as follows: \n+ When you specify more than one condition, you only assign the resources that match ALL conditions \\(using AND logic\\)\\.\n+ `Conditions` supports `StringEquals`, `StringLike`, `StringNotEquals`, and `StringNotLike`\\. `ListOfTags` only supports `StringEquals`\\.\n*Required*: No \n*Type*: [Conditions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Conditions" }, "IamRoleArn": { @@ -22930,7 +23370,7 @@ "items": { "$ref": "#/definitions/AWS::Backup::BackupSelection.ConditionResourceType" }, - "markdownDescription": "An array of conditions used to specify a set of resources to assign to a backup plan; for example, `\"STRINGEQUALS\": {\"Department\":\"accounting\"`\\. \n*Required*: No \n*Type*: List of [ConditionResourceType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of conditions that you define to assign resources to your backup plans using tags\\. For example, `\"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\", \"ConditionValue\": \"true\" },`\\. Condition operators are case sensitive\\. \n`ListOfTags` differs from `Conditions` as follows: \n+ When you specify more than one condition, you assign all resources that match AT LEAST ONE condition \\(using OR logic\\)\\.\n+ `ListOfTags` only supports `StringEquals`\\. `Conditions` supports `StringEquals`, `StringLike`, `StringNotEquals`, and `StringNotLike`\\. \n*Required*: No \n*Type*: List of [ConditionResourceType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ListOfTags", "type": "array" }, @@ -22966,9 +23406,13 @@ "additionalProperties": false, "properties": { "ConditionKey": { + "markdownDescription": "The key in a key\\-value pair\\. For example, in the tag `Department: Accounting`, `Department` is the key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConditionKey", "type": "string" }, "ConditionValue": { + "markdownDescription": "The value in a key\\-value pair\\. For example, in the tag `Department: Accounting`, `Accounting` is the value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConditionValue", "type": "string" } }, @@ -23007,24 +23451,32 @@ "items": { "$ref": "#/definitions/AWS::Backup::BackupSelection.ConditionParameter" }, + "markdownDescription": "Filters the values of your tagged resources for only those resources that you tagged with the same value\\. Also called \"exact matching\\.\" \n*Required*: No \n*Type*: List of [ConditionParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StringEquals", "type": "array" }, "StringLike": { "items": { "$ref": "#/definitions/AWS::Backup::BackupSelection.ConditionParameter" }, + "markdownDescription": "Filters the values of your tagged resources for matching tag values with the use of a wildcard character \\(\\*\\) anywhere in the string\\. For example, \"prod\\*\" or \"\\*rod\\*\" matches the tag value \"production\"\\. \n*Required*: No \n*Type*: List of [ConditionParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StringLike", "type": "array" }, "StringNotEquals": { "items": { "$ref": "#/definitions/AWS::Backup::BackupSelection.ConditionParameter" }, + "markdownDescription": "Filters the values of your tagged resources for only those resources that you tagged that do not have the same value\\. Also called \"negated matching\\.\" \n*Required*: No \n*Type*: List of [ConditionParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StringNotEquals", "type": "array" }, "StringNotLike": { "items": { "$ref": "#/definitions/AWS::Backup::BackupSelection.ConditionParameter" }, + "markdownDescription": "Filters the values of your tagged resources for non\\-matching tag values with the use of a wildcard character \\(\\*\\) anywhere in the string\\. \n*Required*: No \n*Type*: List of [ConditionParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StringNotLike", "type": "array" } }, @@ -23132,17 +23584,17 @@ "additionalProperties": false, "properties": { "ChangeableForDays": { - "markdownDescription": "The AWS Backup Vault Lock configuration that specifies the number of days before the lock date\\. For example, setting `ChangeableForDays` to 30 on Jan\\. 1, 2022 at 8pm UTC will set the lock date to Jan\\. 31, 2022 at 8pm UTC\\. \nAWS Backup enforces a 72\\-hour cooling\\-off period before Vault Lock takes effect and becomes immutable\\. Therefore, you must set `ChangeableForDays` to 3 or greater\\. \nBefore the lock date, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration`\\. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted\\. \nIf this parameter is not specified, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration` at any time\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS Backup Vault Lock configuration that specifies the number of days before the lock date\\. For example, setting `ChangeableForDays` to 30 on Jan\\. 1, 2022 at 8pm UTC will set the lock date to Jan\\. 31, 2022 at 8pm UTC\\. \nAWS Backup enforces a 72\\-hour cooling\\-off period before Vault Lock takes effect and becomes immutable\\. Therefore, you must set `ChangeableForDays` to 3 or greater\\. \nBefore the lock date, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration`\\. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted\\. \nIf this parameter is not specified, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration` at any time\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ChangeableForDays", "type": "number" }, "MaxRetentionDays": { - "markdownDescription": "The AWS Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points\\. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years \\(1460 days\\)\\. \nIf this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault\\. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period\\. \nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period\\. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault\\. Recovery points already saved in the vault prior to Vault Lock are not affected\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points\\. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years \\(1460 days\\)\\. \nIf this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault\\. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period\\. \nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period\\. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault\\. Recovery points already saved in the vault prior to Vault Lock are not affected\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxRetentionDays", "type": "number" }, "MinRetentionDays": { - "markdownDescription": "The AWS Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points\\. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years \\(2555 days\\)\\. \nIf this parameter is not specified, Vault Lock will not enforce a minimum retention period\\. \nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period\\. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault\\. Recovery points already saved in the vault prior to Vault Lock are not affected\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points\\. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years \\(2555 days\\)\\. \nIf this parameter is not specified, Vault Lock will not enforce a minimum retention period\\. \nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period\\. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault\\. Recovery points already saved in the vault prior to Vault Lock are not affected\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MinRetentionDays", "type": "number" } @@ -23290,18 +23742,24 @@ "items": { "type": "string" }, + "markdownDescription": "The ID of the only AWS resource that you want your control scope to contain\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ComplianceResourceIds", "type": "array" }, "ComplianceResourceTypes": { "items": { "type": "string" }, + "markdownDescription": "Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ComplianceResourceTypes", "type": "array" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tag key\\-value pair applied to those AWS resources that you want to trigger an evaluation for a rule\\. A maximum of one key\\-value pair can be provided\\. The tag value is optional, but it cannot be an empty string\\. The structure to assign a tag is: `[{\"Key\":\"string\",\"Value\":\"string\"}]`\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -23325,7 +23783,7 @@ }, "ControlScope": { "$ref": "#/definitions/AWS::Backup::Framework.ControlScope", - "markdownDescription": "The scope of a control\\. The control scope defines what the control will evaluate\\. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans\\. For more information, see `ControlScope`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The scope of a control\\. The control scope defines what the control will evaluate\\. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans\\. For more information, see [`ControlScope`\\.](aws-backup/latest/devguide/API_ControlScope.html) \n*Required*: No \n*Type*: [ControlScope](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlscope.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ControlScope" } }, @@ -23371,7 +23829,7 @@ "properties": { "ReportDeliveryChannel": { "$ref": "#/definitions/AWS::Backup::ReportPlan.ReportDeliveryChannel", - "markdownDescription": "Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports\\. \n*Required*: Yes \n*Type*: [ReportDeliveryChannel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportdeliverychannel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReportDeliveryChannel" }, "ReportPlanDescription": { @@ -23394,7 +23852,7 @@ }, "ReportSetting": { "$ref": "#/definitions/AWS::Backup::ReportPlan.ReportSetting", - "markdownDescription": "Identifies the report template for the report\\. Reports are built using a report template\\. The report templates are: \n `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT` \nIf the report template is `RESOURCE_COMPLIANCE_REPORT` or `CONTROL_COMPLIANCE_REPORT`, this API resource also describes the report coverage by AWS Regions and frameworks\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Identifies the report template for the report\\. Reports are built using a report template\\. The report templates are: \n `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT` \nIf the report template is `RESOURCE_COMPLIANCE_REPORT` or `CONTROL_COMPLIANCE_REPORT`, this API resource also describes the report coverage by AWS Regions and frameworks\\. \n*Required*: Yes \n*Type*: [ReportSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReportSetting" } }, @@ -23432,12 +23890,18 @@ "items": { "type": "string" }, + "markdownDescription": "A list of the format of your reports: `CSV`, `JSON`, or both\\. If not specified, the default format is `CSV`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Formats", "type": "array" }, "S3BucketName": { + "markdownDescription": "The unique name of the S3 bucket that receives your reports\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3BucketName", "type": "string" }, "S3KeyPrefix": { + "markdownDescription": "The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3\\. The prefix is this part of the following path: s3://your\\-bucket\\-name/`prefix`/Backup/us\\-west\\-2/year/month/day/report\\-name\\. If not specified, there is no prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3KeyPrefix", "type": "string" } }, @@ -23453,27 +23917,37 @@ "items": { "type": "string" }, + "markdownDescription": "These are the accounts to be included in the report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Accounts", "type": "array" }, "FrameworkArns": { "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Names \\(ARNs\\) of the frameworks a report covers\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FrameworkArns", "type": "array" }, "OrganizationUnits": { "items": { "type": "string" }, + "markdownDescription": "These are the Organizational Units to be included in the report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationUnits", "type": "array" }, "Regions": { "items": { "type": "string" }, + "markdownDescription": "These are the Regions to be included in the report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Regions", "type": "array" }, "ReportTemplate": { + "markdownDescription": "Identifies the report template for the report\\. Reports are built using a report template\\. The report templates are: \n `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReportTemplate", "type": "string" } }, @@ -23543,7 +24017,7 @@ "type": "string" }, "State": { - "markdownDescription": "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\\. \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\\. \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\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \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\\. \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\\. \nCompute environments in a `DISABLED` state may continue to incur billing charges\\. To prevent additional charges, turn off and then delete the compute environment\\. For more information, see [State](https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state) in the * AWS Batch User Guide*\\.\nWhen an instance is idle, the instance scales down to the `minvCpus` value\\. However, the instance size doesn't change\\. For example, consider a `c5.8xlarge` instance with a `minvCpus` value of `4` and a `desiredvCpus` value of `36`\\. This instance doesn't scale down to a `c5.large` instance\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "State", "type": "string" }, @@ -23614,7 +24088,7 @@ "type": "number" }, "DesiredvCpus": { - "markdownDescription": "The desired number of Amazon EC2 vCPUS in the compute environment\\. AWS Batch modifies this value between the minimum and maximum values based on job queue demand\\. \nThis parameter isn't applicable to jobs that are running on Fargate resources\\. Don't specify it\\.\n AWS Batch doesn't support changing the desired number of vCPUs of an existing compute environment\\. Don't specify this parameter for compute environments using Amazon EKS clusters\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The desired number of Amazon EC2 vCPUS in the compute environment\\. AWS Batch modifies this value between the minimum and maximum values based on job queue demand\\. \nThis parameter isn't applicable to jobs that are running on Fargate resources\\. Don't specify it\\.\n AWS Batch doesn't support changing the desired number of vCPUs of an existing compute environment\\. Don't specify this parameter for compute environments using Amazon EKS clusters\\.\nWhen you update the `desiredvCpus` setting, the value must be between the `minvCpus` and `maxvCpus` values\\. \nAdditionally, the updated `desiredvCpus` value must be greater than or equal to the current `desiredvCpus` value\\. For more information, see [test](https://docs.aws.amazon.com/batch/latest/userguide/error-desired-vcpus-update.html) in the * AWS Batch User Guide*\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DesiredvCpus", "type": "number" }, @@ -25030,7 +25504,7 @@ "title": "ComputationPreference" }, "Description": { - "markdownDescription": "The billing group description\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the billing group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -25048,6 +25522,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -25211,7 +25687,7 @@ "additionalProperties": false, "properties": { "ExclusiveEndBillingPeriod": { - "markdownDescription": "The inclusive end billing period that defines a billing period range where a custom line is applied\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The exclusive end billing period that defines a billing period range where a custom line is applied\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ExclusiveEndBillingPeriod", "type": "string" }, @@ -25407,6 +25883,8 @@ "additionalProperties": false, "properties": { "BillingEntity": { + "markdownDescription": "The seller of services provided by AWS, their affiliates, or third\\-party providers selling services via AWS Marketplace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BillingEntity", "type": "string" }, "Description": { @@ -25415,7 +25893,7 @@ "type": "string" }, "ModifierPercentage": { - "markdownDescription": "A percentage modifier applied on the public pricing rates\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A percentage modifier applied on the public pricing rates\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ModifierPercentage", "type": "number" }, @@ -25425,6 +25903,8 @@ "type": "string" }, "Operation": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Operation", "type": "string" }, "Scope": { @@ -25446,7 +25926,9 @@ "type": "array" }, "Tiering": { - "$ref": "#/definitions/AWS::BillingConductor::PricingRule.Tiering" + "$ref": "#/definitions/AWS::BillingConductor::PricingRule.Tiering", + "markdownDescription": "The set of tiering configurations for the pricing rule\\. \n*Required*: No \n*Type*: [Tiering](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-pricingrule-tiering.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tiering" }, "Type": { "markdownDescription": "The type of pricing rule\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -25454,6 +25936,8 @@ "type": "string" }, "UsageType": { + "markdownDescription": "Usage Type is the unit that each service uses to measure the usage of a specific type of resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "UsageType", "type": "string" } }, @@ -25489,6 +25973,8 @@ "additionalProperties": false, "properties": { "Activated": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Activated", "type": "boolean" } }, @@ -25501,7 +25987,9 @@ "additionalProperties": false, "properties": { "FreeTier": { - "$ref": "#/definitions/AWS::BillingConductor::PricingRule.FreeTier" + "$ref": "#/definitions/AWS::BillingConductor::PricingRule.FreeTier", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [FreeTier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-pricingrule-freetier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FreeTier" } }, "type": "object" @@ -25585,10 +26073,14 @@ "additionalProperties": false, "properties": { "AutoAdjustType": { + "markdownDescription": "The string that defines whether your budget auto\\-adjusts based on historical or forecasted data\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FORECAST | HISTORICAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoAdjustType", "type": "string" }, "HistoricalOptions": { - "$ref": "#/definitions/AWS::Budgets::Budget.HistoricalOptions" + "$ref": "#/definitions/AWS::Budgets::Budget.HistoricalOptions", + "markdownDescription": "The parameters that define or describe the historical data that your auto\\-adjusting budget is based on\\. \n*Required*: No \n*Type*: [HistoricalOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-historicaloptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HistoricalOptions" } }, "required": [ @@ -25600,7 +26092,9 @@ "additionalProperties": false, "properties": { "AutoAdjustData": { - "$ref": "#/definitions/AWS::Budgets::Budget.AutoAdjustData" + "$ref": "#/definitions/AWS::Budgets::Budget.AutoAdjustData", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AutoAdjustData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-autoadjustdata.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AutoAdjustData" }, "BudgetLimit": { "$ref": "#/definitions/AWS::Budgets::Budget.Spend", @@ -25618,7 +26112,7 @@ "type": "string" }, "CostFilters": { - "markdownDescription": "The cost filters, such as `Region`, `Service`, `member account`, `Tag`, or `Cost Category`, that are applied to a budget\\. \n AWS Budgets supports the following services as a `Service` filter for RI budgets: \n+ Amazon EC2\n+ Amazon Redshift\n+ Amazon Relational Database Service\n+ Amazon ElastiCache\n+ Amazon OpenSearch Service \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The cost filters, such as `Region`, `Service`, `member account`, `Tag`, or `Cost Category`, that are applied to a budget\\. \n AWS Budgets supports the following services as a `Service` filter for RI budgets: \n+ Amazon EC2\n+ Amazon Redshift\n+ Amazon Relational Database Service\n+ Amazon ElastiCache\n+ Amazon OpenSearch Service\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CostFilters", "type": "object" }, @@ -25714,6 +26208,8 @@ "additionalProperties": false, "properties": { "BudgetAdjustmentPeriod": { + "markdownDescription": "The number of budget periods included in the moving\\-average calculation that determines your auto\\-adjusted budget amount\\. The maximum value depends on the `TimeUnit` granularity of the budget: \n+ For the `DAILY` granularity, the maximum value is `60`\\.\n+ For the `MONTHLY` granularity, the maximum value is `12`\\.\n+ For the `QUARTERLY` granularity, the maximum value is `4`\\.\n+ For the `ANNUALLY` granularity, the maximum value is `1`\\.\n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `60` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BudgetAdjustmentPeriod", "type": "number" } }, @@ -26153,6 +26649,8 @@ "items": { "$ref": "#/definitions/AWS::CE::AnomalyMonitor.ResourceTag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ResourceTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalymonitor-resourcetag.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceTags", "type": "array" } }, @@ -26187,9 +26685,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The key that's associated with the tag\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "The value that's associated with the tag\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "string" } }, @@ -26235,7 +26737,7 @@ "additionalProperties": false, "properties": { "Frequency": { - "markdownDescription": "The frequency that anomaly reports are sent over email\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAILY | IMMEDIATE | WEEKLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The frequency that anomaly notifications are sent\\. Notifications are sent either over email \\(for DAILY and WEEKLY frequencies\\) or SNS \\(for IMMEDIATE frequency\\)\\. For more information, see [Creating an Amazon SNS topic for anomaly notifications](https://docs.aws.amazon.com/cost-management/latest/userguide/ad-SNS.html)\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAILY | IMMEDIATE | WEEKLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Frequency", "type": "string" }, @@ -26251,6 +26753,8 @@ "items": { "$ref": "#/definitions/AWS::CE::AnomalySubscription.ResourceTag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ResourceTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalysubscription-resourcetag.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceTags", "type": "array" }, "Subscribers": { @@ -26267,11 +26771,13 @@ "type": "string" }, "Threshold": { - "markdownDescription": "The dollar value that triggers a notification if the threshold is exceeded\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "\\(deprecated\\) \nAn absolute dollar value that must be exceeded by the anomaly's total impact \\(see [Impact](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) for more details\\) for an anomaly notification to be generated\\. \nThis field has been deprecated\\. To specify a threshold, use ThresholdExpression\\. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression\\. \nOne of Threshold or ThresholdExpression is required for `AWS::CE::AnomalySubscription`\\. You cannot specify both\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Threshold", "type": "number" }, "ThresholdExpression": { + "markdownDescription": "An [Expression](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) object in JSON string format used to specify the anomalies that you want to generate alerts for\\. This supports dimensions and nested expressions\\. The supported dimensions are `ANOMALY_TOTAL_IMPACT_ABSOLUTE` and `ANOMALY_TOTAL_IMPACT_PERCENTAGE`, corresponding to an anomaly\u2019s TotalImpact and TotalImpactPercentage, respectively \\(see [Impact](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) for more details\\)\\. The supported nested expression types are `AND` and `OR`\\. The match option `GREATER_THAN_OR_EQUAL` is required\\. Values must be numbers between 0 and 10,000,000,000 in string format\\. \nOne of Threshold or ThresholdExpression is required for `AWS::CE::AnomalySubscription`\\. You cannot specify both\\. \nFor further information, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalysubscription.html#aws-resource-ce-anomalysubscription--examples) section of this page\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ThresholdExpression", "type": "string" } }, @@ -26308,9 +26814,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The key that's associated with the tag\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "The value that's associated with the tag\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "string" } }, @@ -26473,7 +26983,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of manifests that you want Amazon Web Services to create for this report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of manifests that you want AWS to create for this report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdditionalArtifacts", "type": "array" }, @@ -26481,7 +26991,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AdditionalSchemaElements", "type": "array" }, @@ -26501,7 +27011,7 @@ "type": "string" }, "RefreshClosedReports": { - "markdownDescription": "Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months\\. These charges can include refunds, credits, or support fees\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months\\. These charges can include refunds, credits, or support fees\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RefreshClosedReports", "type": "boolean" }, @@ -26511,7 +27021,7 @@ "type": "string" }, "ReportVersioning": { - "markdownDescription": "Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CREATE_NEW_REPORT | OVERWRITE_REPORT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CREATE_NEW_REPORT | OVERWRITE_REPORT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ReportVersioning", "type": "string" }, @@ -26808,12 +27318,12 @@ "additionalProperties": false, "properties": { "ColumnName": { - "markdownDescription": "The name of the column\\. For more information, see [Identifiers](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.elements.identifier) in the *Amazon Keyspaces Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the column\\. For more information, see [Identifiers](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.elements.identifier) in the *Amazon Keyspaces Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "ColumnName", "type": "string" }, "ColumnType": { - "markdownDescription": "The data type of the column\\. For more information, see [Data types](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) in the *Amazon Keyspaces Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The data type of the column\\. For more information, see [Data types](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) in the *Amazon Keyspaces Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "ColumnType", "type": "string" } @@ -26977,7 +27487,7 @@ "additionalProperties": false, "properties": { "CertificateAuthorityArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the private certificate authority \\(CA\\) that will be used to issue the certificate\\. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate\\. For more information about private CAs, see the [AWS Certificate Manager Private Certificate Authority \\(PCA\\)](https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaWelcome.html) user guide\\. The ARN must have the following form: \n `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012` \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the private certificate authority \\(CA\\) that will be used to issue the certificate\\. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate\\. For more information about private CAs, see the [AWS Private Certificate Authority](https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html) user guide\\. The ARN must have the following form: \n `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012` \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:acm-pca:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CertificateAuthorityArn", "type": "string" }, @@ -27115,12 +27625,12 @@ "items": { "type": "string" }, - "markdownDescription": "The list of IAM policy ARNs that are applied as channel guardrails\\. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set\\. Currently, only 1 IAM policy is supported\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The list of IAM policy ARNs that are applied as channel guardrails\\. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "GuardrailPolicies", "type": "array" }, "IamRoleArn": { - "markdownDescription": "The ARN of the IAM role that defines the permissions for AWS Chatbot\\. \nThis is a user\\-definworked role that AWS Chatbot will assume\\. This is not the service\\-linked role\\. For more information, see [IAM Policies for AWS Chatbot](https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN of the IAM role that defines the permissions for AWS Chatbot\\. \nThis is a user\\-defined role that AWS Chatbot will assume\\. This is not the service\\-linked role\\. For more information, see [IAM Policies for AWS Chatbot](https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IamRoleArn", "type": "string" }, @@ -27218,7 +27728,7 @@ "additionalProperties": false, "properties": { "AutomaticStopTimeMinutes": { - "markdownDescription": "The number of minutes until the running instance is shut down after the environment was last used\\. \n*Required*: No \n*Type*: Integer \n*Maximum*: `20160` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The number of minutes until the running instance is shut down after the environment was last used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `20160` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AutomaticStopTimeMinutes", "type": "number" }, @@ -27506,7 +28016,7 @@ "type": "string" }, "TypeArn": { - "markdownDescription": "The Amazon Resource Number \\(ARN\\) for the hook to set `Configuration` for\\. \nYou must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Number \\(ARN\\) for the hook to set `Configuration` for\\. \nYou must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TypeArn", "type": "string" }, @@ -28190,7 +28700,7 @@ "additionalProperties": false, "properties": { "LogGroupName": { - "markdownDescription": "The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon CloudWatch logs group to which CloudFormation sends error logging information when invoking the type's handlers\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "LogGroupName", "type": "string" }, @@ -28371,7 +28881,7 @@ }, "ManagedExecution": { "$ref": "#/definitions/AWS::CloudFormation::StackSet.ManagedExecution", - "markdownDescription": "Describes whether StackSets performs non\\-conflicting operations concurrently and queues conflicting operations\\. \nWhen active, StackSets performs non\\-conflicting operations concurrently and queues conflicting operations\\. After conflicting operations finish, StackSets starts queued operations in request order\\. \nIf there are already running or queued operations, StackSets queues all incoming operations even if they are non\\-conflicting\\. \nYou can't modify your stack set's execution configuration while there are running or queued operations for that stack set\\.\nWhen inactive \\(default\\), StackSets performs one operation at a time in request order\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Describes whether StackSets performs non\\-conflicting operations concurrently and queues conflicting operations\\. \nWhen active, StackSets performs non\\-conflicting operations concurrently and queues conflicting operations\\. After conflicting operations finish, StackSets starts queued operations in request order\\. \nIf there are already running or queued operations, StackSets queues all incoming operations even if they are non\\-conflicting\\. \nYou can't modify your stack set's execution configuration while there are running or queued operations for that stack set\\.\nWhen inactive \\(default\\), StackSets performs one operation at a time in request order\\. \n*Required*: No \n*Type*: [ManagedExecution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-managedexecution.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ManagedExecution" }, "OperationPreferences": { @@ -28471,6 +28981,8 @@ "additionalProperties": false, "properties": { "AccountFilterType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccountFilterType", "type": "string" }, "Accounts": { @@ -28496,6 +29008,8 @@ "additionalProperties": false, "properties": { "Active": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Active", "type": "boolean" } }, @@ -28924,7 +29438,7 @@ "type": "string" }, "DefaultTTL": { - "markdownDescription": "The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated\\. CloudFront uses this value as the object\u2019s time to live \\(TTL\\) only when the origin does *not* send `Cache-Control` or `Expires` headers with the object\\. For more information, see [Managing How Long Content Stays in an Edge Cache \\(Expiration\\)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\. \nThe default value for this field is 86400 seconds \\(one day\\)\\. If the value of `MinTTL` is more than 86400 seconds, then the default value for this field is the same as the value of `MinTTL`\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated\\. CloudFront uses this value as the object's time to live \\(TTL\\) only when the origin does *not* send `Cache-Control` or `Expires` headers with the object\\. For more information, see [Managing How Long Content Stays in an Edge Cache \\(Expiration\\)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\. \nThe default value for this field is 86400 seconds \\(one day\\)\\. If the value of `MinTTL` is more than 86400 seconds, then the default value for this field is the same as the value of `MinTTL`\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DefaultTTL", "type": "number" }, @@ -29011,12 +29525,12 @@ "title": "CookiesConfig" }, "EnableAcceptEncodingBrotli": { - "markdownDescription": "A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin\\. \nThis field is related to the `EnableAcceptEncodingGzip` field\\. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following: \n+ Normalizes the value of the viewer\u2019s `Accept-Encoding` header\n+ Includes the normalized header in the cache key\n+ Includes the normalized header in the request to the origin, if a request is necessary\nFor more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*\\. \nIf you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy\\. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect\\. \nIf both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request\\. By default, it\u2019s not included in the cache key and it\u2019s not included in origin requests\\. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin\\. \nThis field is related to the `EnableAcceptEncodingGzip` field\\. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following: \n+ Normalizes the value of the viewer's `Accept-Encoding` header\n+ Includes the normalized header in the cache key\n+ Includes the normalized header in the request to the origin, if a request is necessary\nFor more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*\\. \nIf you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy\\. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect\\. \nIf both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request\\. By default, it's not included in the cache key and it's not included in origin requests\\. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableAcceptEncodingBrotli", "type": "boolean" }, "EnableAcceptEncodingGzip": { - "markdownDescription": "A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin\\. \nThis field is related to the `EnableAcceptEncodingBrotli` field\\. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following: \n+ Normalizes the value of the viewer\u2019s `Accept-Encoding` header\n+ Includes the normalized header in the cache key\n+ Includes the normalized header in the request to the origin, if a request is necessary\nFor more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*\\. \nIf you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy\\. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect\\. \nIf both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request\\. By default, it\u2019s not included in the cache key and it\u2019s not included in origin requests\\. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin\\. \nThis field is related to the `EnableAcceptEncodingBrotli` field\\. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following: \n+ Normalizes the value of the viewer's `Accept-Encoding` header\n+ Includes the normalized header in the cache key\n+ Includes the normalized header in the request to the origin, if a request is necessary\nFor more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*\\. \nIf you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy\\. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect\\. \nIf both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request\\. By default, it's not included in the cache key and it's not included in origin requests\\. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableAcceptEncodingGzip", "type": "boolean" }, @@ -29178,7 +29692,9 @@ "additionalProperties": false, "properties": { "ContinuousDeploymentPolicyConfig": { - "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.ContinuousDeploymentPolicyConfig" + "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.ContinuousDeploymentPolicyConfig", + "markdownDescription": "Contains the configuration for a continuous deployment policy\\. \n*Required*: Yes \n*Type*: [ContinuousDeploymentPolicyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContinuousDeploymentPolicyConfig" } }, "required": [ @@ -29211,16 +29727,22 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "A Boolean that indicates whether this continuous deployment policy is enabled \\(in effect\\)\\. When this value is `true`, this policy is enabled and in effect\\. When this value is `false`, this policy is not enabled and has no effect\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "StagingDistributionDnsNames": { "items": { "type": "string" }, + "markdownDescription": "The CloudFront domain name of the staging distribution\\. For example: `d111111abcdef8.cloudfront.net`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StagingDistributionDnsNames", "type": "array" }, "TrafficConfig": { - "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.TrafficConfig" + "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.TrafficConfig", + "markdownDescription": "Contains the parameters for routing production traffic from your primary to staging distributions\\. \n*Required*: No \n*Type*: [TrafficConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrafficConfig" } }, "required": [ @@ -29233,9 +29755,13 @@ "additionalProperties": false, "properties": { "IdleTTL": { + "markdownDescription": "The amount of time after which you want sessions to cease if no requests are received\\. Allowed values are 300\u20133600 seconds \\(5\u201360 minutes\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IdleTTL", "type": "number" }, "MaximumTTL": { + "markdownDescription": "The maximum amount of time to consider requests from the viewer as being part of the same session\\. Allowed values are 300\u20133600 seconds \\(5\u201360 minutes\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumTTL", "type": "number" } }, @@ -29249,9 +29775,13 @@ "additionalProperties": false, "properties": { "Header": { + "markdownDescription": "The request header name that you want CloudFront to send to your staging distribution\\. The header must contain the prefix `aws-cf-cd-`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Header", "type": "string" }, "Value": { + "markdownDescription": "The request header value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -29265,9 +29795,13 @@ "additionalProperties": false, "properties": { "SessionStickinessConfig": { - "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.SessionStickinessConfig" + "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.SessionStickinessConfig", + "markdownDescription": "Session stickiness provides the ability to define multiple requests from a single viewer as a single session\\. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution\\. Define the session duration using TTL values\\. \n*Required*: No \n*Type*: [SessionStickinessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionStickinessConfig" }, "Weight": { + "markdownDescription": "The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and \\.15\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Weight", "type": "number" } }, @@ -29280,12 +29814,18 @@ "additionalProperties": false, "properties": { "SingleHeaderConfig": { - "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.SingleHeaderConfig" + "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.SingleHeaderConfig", + "markdownDescription": "Determines which HTTP requests are sent to the staging distribution\\. \n*Required*: No \n*Type*: [SingleHeaderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SingleHeaderConfig" }, "SingleWeightConfig": { - "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.SingleWeightConfig" + "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.SingleWeightConfig", + "markdownDescription": "Contains the percentage of traffic to send to the staging distribution\\. \n*Required*: No \n*Type*: [SingleWeightConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleweightconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SingleWeightConfig" }, "Type": { + "markdownDescription": "The type of traffic configuration\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SingleHeader | SingleWeight` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -29331,7 +29871,7 @@ "properties": { "DistributionConfig": { "$ref": "#/definitions/AWS::CloudFront::Distribution.DistributionConfig", - "markdownDescription": "The current configuration information for the distribution\\. Send a `GET` request to the `/CloudFront API version/distribution ID/config` resource\\. \n*Required*: Yes \n*Type*: [DistributionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The distribution's configuration\\. \n*Required*: Yes \n*Type*: [DistributionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DistributionConfig" }, "Tags": { @@ -29389,7 +29929,7 @@ "items": { "type": "string" }, - "markdownDescription": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods\\. There are two choices: \n+ CloudFront caches responses to `GET` and `HEAD` requests\\.\n+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` requests\\.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward Access\\-Control\\-Request\\-Method, Access\\-Control\\-Request\\-Headers, and Origin headers for the responses to be cached correctly\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods\\. There are two choices: \n+ CloudFront caches responses to `GET` and `HEAD` requests\\.\n+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` requests\\.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward Access\\-Control\\-Request\\-Method, Access\\-Control\\-Request\\-Headers, and Origin headers for the responses to be cached correctly\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CachedMethods", "type": "array" }, @@ -29460,7 +30000,7 @@ "type": "string" }, "SmoothStreaming": { - "markdownDescription": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior\\. If so, specify `true`; if not, specify `false`\\. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior\\. If so, specify `true`; if not, specify `false`\\. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SmoothStreaming", "type": "boolean" }, @@ -29481,12 +30021,12 @@ "items": { "type": "string" }, - "markdownDescription": "We recommend using `TrustedKeyGroups` instead of `TrustedSigners`\\.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer\u2019s AWS account\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "We recommend using `TrustedKeyGroups` instead of `TrustedSigners`\\.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS account\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TrustedSigners", "type": "array" }, "ViewerProtocolPolicy": { - "markdownDescription": "The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`\\. You can specify the following options: \n+ `allow-all`: Viewers can use HTTP or HTTPS\\.\n+ `redirect-to-https`: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 \\(Moved Permanently\\) to the viewer along with the HTTPS URL\\. The viewer then resubmits the request using the new URL\\. \n+ `https-only`: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 \\(Forbidden\\)\\. \nFor more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*\\. \nThe only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object\\. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects\u2019 cache because cached objects are protocol agnostic\\. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously\\. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `allow-all | https-only | redirect-to-https` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`\\. You can specify the following options: \n+ `allow-all`: Viewers can use HTTP or HTTPS\\.\n+ `redirect-to-https`: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 \\(Moved Permanently\\) to the viewer along with the HTTPS URL\\. The viewer then resubmits the request using the new URL\\.\n+ `https-only`: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 \\(Forbidden\\)\\.\nFor more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*\\. \nThe only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object\\. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic\\. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously\\. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `allow-all | https-only | redirect-to-https` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ViewerProtocolPolicy", "type": "string" } @@ -29539,7 +30079,7 @@ "type": "number" }, "ResponsePagePath": { - "markdownDescription": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by `ErrorCode`, for example, `/4xx-errors/403-forbidden.html`\\. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: \n+ The value of `PathPattern` matches the path to your custom error messages\\. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named `/4xx-errors`\\. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, `/4xx-errors/*`\\. \n+ The value of `TargetOriginId` specifies the value of the `ID` element for the origin that contains your custom error pages\\.\nIf you specify a value for `ResponsePagePath`, you must also specify a value for `ResponseCode`\\. \nWe recommend that you store custom error pages in an Amazon S3 bucket\\. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by `ErrorCode`, for example, `/4xx-errors/403-forbidden.html`\\. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: \n+ The value of `PathPattern` matches the path to your custom error messages\\. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named `/4xx-errors`\\. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, `/4xx-errors/*`\\.\n+ The value of `TargetOriginId` specifies the value of the `ID` element for the origin that contains your custom error pages\\.\nIf you specify a value for `ResponsePagePath`, you must also specify a value for `ResponseCode`\\. \nWe recommend that you store custom error pages in an Amazon S3 bucket\\. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResponsePagePath", "type": "string" } @@ -29563,7 +30103,7 @@ "type": "number" }, "OriginKeepaliveTimeout": { - "markdownDescription": "Specifies how long, in seconds, CloudFront persists its connection to the origin\\. The minimum timeout is 1 second, the maximum is 60 seconds, and the default \\(if you don\u2019t specify otherwise\\) is 5 seconds\\. \nFor more information, see [Origin Keep\\-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how long, in seconds, CloudFront persists its connection to the origin\\. The minimum timeout is 1 second, the maximum is 60 seconds, and the default \\(if you don't specify otherwise\\) is 5 seconds\\. \nFor more information, see [Origin Keep\\-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OriginKeepaliveTimeout", "type": "number" }, @@ -29573,7 +30113,7 @@ "type": "string" }, "OriginReadTimeout": { - "markdownDescription": "Specifies how long, in seconds, CloudFront waits for a response from the origin\\. This is also known as the *origin response timeout*\\. The minimum timeout is 1 second, the maximum is 60 seconds, and the default \\(if you don\u2019t specify otherwise\\) is 30 seconds\\. \nFor more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how long, in seconds, CloudFront waits for a response from the origin\\. This is also known as the *origin response timeout*\\. The minimum timeout is 1 second, the maximum is 60 seconds, and the default \\(if you don't specify otherwise\\) is 30 seconds\\. \nFor more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OriginReadTimeout", "type": "number" }, @@ -29611,7 +30151,7 @@ "items": { "type": "string" }, - "markdownDescription": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods\\. There are two choices: \n+ CloudFront caches responses to `GET` and `HEAD` requests\\.\n+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` requests\\.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward Access\\-Control\\-Request\\-Method, Access\\-Control\\-Request\\-Headers, and Origin headers for the responses to be cached correctly\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods\\. There are two choices: \n+ CloudFront caches responses to `GET` and `HEAD` requests\\.\n+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` requests\\.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward Access\\-Control\\-Request\\-Method, Access\\-Control\\-Request\\-Headers, and Origin headers for the responses to be cached correctly\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CachedMethods", "type": "array" }, @@ -29677,7 +30217,7 @@ "type": "string" }, "SmoothStreaming": { - "markdownDescription": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior\\. If so, specify `true`; if not, specify `false`\\. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior\\. If so, specify `true`; if not, specify `false`\\. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SmoothStreaming", "type": "boolean" }, @@ -29698,12 +30238,12 @@ "items": { "type": "string" }, - "markdownDescription": "We recommend using `TrustedKeyGroups` instead of `TrustedSigners`\\.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer\u2019s AWS account\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "We recommend using `TrustedKeyGroups` instead of `TrustedSigners`\\.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS account\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TrustedSigners", "type": "array" }, "ViewerProtocolPolicy": { - "markdownDescription": "The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`\\. You can specify the following options: \n+ `allow-all`: Viewers can use HTTP or HTTPS\\.\n+ `redirect-to-https`: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 \\(Moved Permanently\\) to the viewer along with the HTTPS URL\\. The viewer then resubmits the request using the new URL\\.\n+ `https-only`: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 \\(Forbidden\\)\\.\nFor more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*\\. \nThe only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object\\. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects\u2019 cache because cached objects are protocol agnostic\\. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously\\. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `allow-all | https-only | redirect-to-https` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`\\. You can specify the following options: \n+ `allow-all`: Viewers can use HTTP or HTTPS\\.\n+ `redirect-to-https`: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 \\(Moved Permanently\\) to the viewer along with the HTTPS URL\\. The viewer then resubmits the request using the new URL\\.\n+ `https-only`: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 \\(Forbidden\\)\\.\nFor more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*\\. \nThe only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object\\. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic\\. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously\\. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `allow-all | https-only | redirect-to-https` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ViewerProtocolPolicy", "type": "string" } @@ -29729,7 +30269,7 @@ "items": { "type": "string" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CNAMEs", "type": "array" }, @@ -29737,16 +30277,18 @@ "items": { "$ref": "#/definitions/AWS::CloudFront::Distribution.CacheBehavior" }, - "markdownDescription": "A complex type that contains zero or more `CacheBehavior` elements\\. \n*Required*: No \n*Type*: List of [CacheBehavior](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains zero or more `CacheBehavior` elements\\. \n*Required*: No \n*Type*: List of [CacheBehavior](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheBehaviors", "type": "array" }, "Comment": { - "markdownDescription": "An optional comment to describe the distribution\\. The comment cannot be longer than 128 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A comment to describe the distribution\\. The comment cannot be longer than 128 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Comment", "type": "string" }, "ContinuousDeploymentPolicyId": { + "markdownDescription": "The identifier of a continuous deployment policy\\. For more information, see `CreateContinuousDeploymentPolicy`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContinuousDeploymentPolicyId", "type": "string" }, "CustomErrorResponses": { @@ -29759,16 +30301,16 @@ }, "CustomOrigin": { "$ref": "#/definitions/AWS::CloudFront::Distribution.LegacyCustomOrigin", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [LegacyCustomOrigin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacycustomorigin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [LegacyCustomOrigin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacycustomorigin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomOrigin" }, "DefaultCacheBehavior": { "$ref": "#/definitions/AWS::CloudFront::Distribution.DefaultCacheBehavior", - "markdownDescription": "A complex type that describes the default cache behavior if you don't specify a `CacheBehavior` element or if files don't match any of the values of `PathPattern` in `CacheBehavior` elements\\. You must create exactly one default cache behavior\\. \n*Required*: No \n*Type*: [DefaultCacheBehavior](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that describes the default cache behavior if you don't specify a `CacheBehavior` element or if files don't match any of the values of `PathPattern` in `CacheBehavior` elements\\. You must create exactly one default cache behavior\\. \n*Required*: Yes \n*Type*: [DefaultCacheBehavior](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DefaultCacheBehavior" }, "DefaultRootObject": { - "markdownDescription": "The object that you want CloudFront to request from your origin \\(for example, `index.html`\\) when a viewer requests the root URL for your distribution \\(`http://www.example.com`\\) instead of an object in your distribution \\(`http://www.example.com/product-description.html`\\)\\. Specifying a default root object avoids exposing the contents of your distribution\\. \nSpecify only the object name, for example, `index.html`\\. Don't add a `/` before the object name\\. \nIf you don't want to specify a default root object when you create a distribution, include an empty `DefaultRootObject` element\\. \nTo delete the default root object from an existing distribution, update the distribution configuration and include an empty `DefaultRootObject` element\\. \nTo replace the default root object, update the distribution configuration and specify the new object\\. \nFor more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object that you want CloudFront to request from your origin \\(for example, `index.html`\\) when a viewer requests the root URL for your distribution \\(`https://www.example.com`\\) instead of an object in your distribution \\(`https://www.example.com/product-description.html`\\)\\. Specifying a default root object avoids exposing the contents of your distribution\\. \nSpecify only the object name, for example, `index.html`\\. Don't add a `/` before the object name\\. \nIf you don't want to specify a default root object when you create a distribution, include an empty `DefaultRootObject` element\\. \nTo delete the default root object from an existing distribution, update the distribution configuration and include an empty `DefaultRootObject` element\\. \nTo replace the default root object, update the distribution configuration and specify the new object\\. \nFor more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DefaultRootObject", "type": "string" }, @@ -29778,12 +30320,12 @@ "type": "boolean" }, "HttpVersion": { - "markdownDescription": "\\(Optional\\) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront\\. The default value for new web distributions is `http1.1`\\. \nFor viewers and CloudFront to use HTTP/2, viewers must support TLS 1\\.2 or later, and must support server name identification \\(SNI\\)\\. \nIn general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency\\. You can improve performance by optimizing for HTTP/2\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `http1.1 | http2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "\\(Optional\\) Specify the maximum HTTP version\\(s\\) that you want viewers to use to communicate with CloudFront\\. The default value for new distributions is `http1.1`\\. \nFor viewers and CloudFront to use HTTP/2, viewers must support TLSv1\\.2 or later, and must support Server Name Indication \\(SNI\\)\\. \nFor viewers and CloudFront to use HTTP/3, viewers must support TLSv1\\.3 and Server Name Indication \\(SNI\\)\\. CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection\\. For more information about connection migration, see [Connection Migration](https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000\\. For more information about supported TLSv1\\.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `http1.1 | http2 | http2and3 | http3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HttpVersion", "type": "string" }, "IPV6Enabled": { - "markdownDescription": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify `true`\\. If you specify `false`, CloudFront responds to IPv6 DNS requests with the DNS response code `NOERROR` and with no IP addresses\\. This allows viewers to submit a second request, for an IPv4 address for your distribution\\. \nIn general, you should enable IPv6 if you have users on IPv6 networks who want to access your content\\. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the `IpAddress` parameter to restrict the IP addresses that can access your content, don't enable IPv6\\. If you want to restrict access to some content by IP address and not restrict access to other content \\(or restrict access but not by IP address\\), you can create two distributions\\. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*\\. \nIf you're using an Amazon Route\u00a053 AWS Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: \n+ You enable IPv6 for the distribution\n+ You're using alternate domain names in the URLs for your objects\nFor more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the * Amazon Route\u00a053 AWS Integration Developer Guide*\\. \nIf you created a CNAME resource record set, either with Amazon Route\u00a053 AWS Integration or with another DNS service, you don't need to make any changes\\. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify `true`\\. If you specify `false`, CloudFront responds to IPv6 DNS requests with the DNS response code `NOERROR` and with no IP addresses\\. This allows viewers to submit a second request, for an IPv4 address for your distribution\\. \nIn general, you should enable IPv6 if you have users on IPv6 networks who want to access your content\\. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the `IpAddress` parameter to restrict the IP addresses that can access your content, don't enable IPv6\\. If you want to restrict access to some content by IP address and not restrict access to other content \\(or restrict access but not by IP address\\), you can create two distributions\\. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*\\. \nIf you're using an Amazon Route\u00a053 AWS Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: \n+ You enable IPv6 for the distribution\n+ You're using alternate domain names in the URLs for your objects\nFor more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the * Amazon Route\u00a053 AWS Integration Developer Guide*\\. \nIf you created a CNAME resource record set, either with Amazon Route\u00a053 AWS Integration or with another DNS service, you don't need to make any changes\\. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IPV6Enabled", "type": "boolean" }, @@ -29801,7 +30343,7 @@ "items": { "$ref": "#/definitions/AWS::CloudFront::Distribution.Origin" }, - "markdownDescription": "A complex type that contains information about origins for this distribution\\. \n*Required*: No \n*Type*: List of [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains information about origins for this distribution\\. \n*Required*: No \n*Type*: List of [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Origins", "type": "array" }, @@ -29817,19 +30359,21 @@ }, "S3Origin": { "$ref": "#/definitions/AWS::CloudFront::Distribution.LegacyS3Origin", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [LegacyS3Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacys3origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [LegacyS3Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacys3origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3Origin" }, "Staging": { + "markdownDescription": "A Boolean that indicates whether this is a staging distribution\\. When this value is `true`, this is a staging distribution\\. When this value is `false`, this is not a staging distribution\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Staging", "type": "boolean" }, "ViewerCertificate": { "$ref": "#/definitions/AWS::CloudFront::Distribution.ViewerCertificate", - "markdownDescription": "A complex type that determines the distribution\u2019s SSL/TLS configuration for communicating with viewers\\. \n*Required*: No \n*Type*: [ViewerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers\\. \n*Required*: No \n*Type*: [ViewerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ViewerCertificate" }, "WebACLId": { - "markdownDescription": "A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution\\. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example `arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a`\\. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example `473e64fd-f30b-4765-81a0-62ad96dd167a`\\. \n AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content\\. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code \\(Forbidden\\)\\. You can also configure CloudFront to return a custom error page when a request is blocked\\. For more information about AWS WAF, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution\\. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example `arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a`\\. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example `473e64fd-f30b-4765-81a0-62ad96dd167a`\\. \n AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content\\. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code \\(Forbidden\\)\\. You can also configure CloudFront to return a custom error page when a request is blocked\\. For more information about AWS WAF, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WebACLId", "type": "string" } @@ -29917,7 +30461,7 @@ "additionalProperties": false, "properties": { "EventType": { - "markdownDescription": "Specifies the event type that triggers a Lambda@Edge function invocation\\. You can specify the following values: \n+ `viewer-request`: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache\\. \n+ `origin-request`: The function executes only when CloudFront sends a request to your origin\\. When the requested object is in the edge cache, the function doesn't execute\\.\n+ `origin-response`: The function executes after CloudFront receives a response from the origin and before it caches the object in the response\\. When the requested object is in the edge cache, the function doesn't execute\\.\n+ `viewer-response`: The function executes before CloudFront returns the requested object to the viewer\\. The function executes regardless of whether the object was already in the edge cache\\.", + "markdownDescription": "Specifies the event type that triggers a Lambda@Edge function invocation\\. You can specify the following values: \n+ `viewer-request`: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache\\.\n+ `origin-request`: The function executes only when CloudFront sends a request to your origin\\. When the requested object is in the edge cache, the function doesn't execute\\.\n+ `origin-response`: The function executes after CloudFront receives a response from the origin and before it caches the object in the response\\. When the requested object is in the edge cache, the function doesn't execute\\.\n+ `viewer-response`: The function executes before CloudFront returns the requested object to the viewer\\. The function executes regardless of whether the object was already in the edge cache\\.", "title": "EventType", "type": "string" }, @@ -29938,22 +30482,22 @@ "additionalProperties": false, "properties": { "DNSName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DNSName", "type": "string" }, "HTTPPort": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HTTPPort", "type": "number" }, "HTTPSPort": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HTTPSPort", "type": "number" }, "OriginProtocolPolicy": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OriginProtocolPolicy", "type": "string" }, @@ -29961,7 +30505,7 @@ "items": { "type": "string" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OriginSSLProtocols", "type": "array" } @@ -29977,12 +30521,12 @@ "additionalProperties": false, "properties": { "DNSName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DNSName", "type": "string" }, "OriginAccessIdentity": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OriginAccessIdentity", "type": "string" } @@ -30020,12 +30564,12 @@ "additionalProperties": false, "properties": { "ConnectionAttempts": { - "markdownDescription": "The number of times that CloudFront attempts to connect to the origin\\. The minimum number is 1, the maximum is 3, and the default \\(if you don\u2019t specify otherwise\\) is 3\\. \nFor a custom origin \\(including an Amazon S3 bucket that\u2019s configured with static website hosting\\), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout)\\. \nFor more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of times that CloudFront attempts to connect to the origin\\. The minimum number is 1, the maximum is 3, and the default \\(if you don't specify otherwise\\) is 3\\. \nFor a custom origin \\(including an Amazon S3 bucket that's configured with static website hosting\\), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout)\\. \nFor more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectionAttempts", "type": "number" }, "ConnectionTimeout": { - "markdownDescription": "The number of seconds that CloudFront waits when trying to establish a connection to the origin\\. The minimum timeout is 1 second, the maximum is 10 seconds, and the default \\(if you don\u2019t specify otherwise\\) is 10 seconds\\. \nFor more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of seconds that CloudFront waits when trying to establish a connection to the origin\\. The minimum timeout is 1 second, the maximum is 10 seconds, and the default \\(if you don't specify otherwise\\) is 10 seconds\\. \nFor more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectionTimeout", "type": "number" }, @@ -30045,6 +30589,8 @@ "type": "string" }, "OriginAccessControlId": { + "markdownDescription": "The unique identifier of an origin access control for this origin\\. \nFor more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OriginAccessControlId", "type": "string" }, "OriginCustomHeaders": { @@ -30200,7 +30746,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "A flag that specifies whether Origin Shield is enabled\\. \nWhen it\u2019s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin\\. When it\u2019s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A flag that specifies whether Origin Shield is enabled\\. \nWhen it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin\\. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, @@ -30230,7 +30776,7 @@ "additionalProperties": false, "properties": { "OriginAccessIdentity": { - "markdownDescription": "The CloudFront origin access identity to associate with the origin\\. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront\\. The format of the value is: \norigin\\-access\\-identity/cloudfront/*ID\\-of\\-origin\\-access\\-identity* \nwhere ` ID-of-origin-access-identity ` is the value that CloudFront returned in the `ID` element when you created the origin access identity\\. \nIf you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty `OriginAccessIdentity` element\\. \nIf you want to use origin access control rather than origin access identity, specify an empty String for the `OriginAccessIdentity` element\\. \nTo delete the origin access identity from an existing distribution, update the distribution configuration and include an empty `OriginAccessIdentity` element\\. \nTo replace the origin access identity, update the distribution configuration and specify the new origin access identity\\. \nFor more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The CloudFront origin access identity to associate with the origin\\. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront\\. The format of the value is: \norigin\\-access\\-identity/cloudfront/*ID\\-of\\-origin\\-access\\-identity* \nwhere ` ID-of-origin-access-identity ` is the value that CloudFront returned in the `ID` element when you created the origin access identity\\. \nIf you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty `OriginAccessIdentity` element\\. \nTo delete the origin access identity from an existing distribution, update the distribution configuration and include an empty `OriginAccessIdentity` element\\. \nTo replace the origin access identity, update the distribution configuration and specify the new origin access identity\\. \nFor more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OriginAccessIdentity", "type": "string" } @@ -30279,12 +30825,12 @@ "type": "string" }, "MinimumProtocolVersion": { - "markdownDescription": "If the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\), specify the security policy that you want CloudFront to use for HTTPS connections with viewers\\. The security policy determines two settings: \n+ The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers\\.\n+ The ciphers that CloudFront can use to encrypt the content that it returns to viewers\\.\nFor more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*\\. \nOn the CloudFront console, this setting is called **Security Policy**\\.\nWhen you\u2019re using SNI only \\(you set `SSLSupportMethod` to `sni-only`\\), you must specify `TLSv1` or higher\\. \\(In CloudFormation, the field name is `SslSupportMethod`\\. Note the different capitalization\\.\\) \nIf the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net` \\(you set `CloudFrontDefaultCertificate` to `true`\\), CloudFront automatically sets the security policy to `TLSv1` regardless of the value that you set here\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `SSLv3 | TLSv1 | TLSv1.1_2016 | TLSv1.2_2018 | TLSv1.2_2019 | TLSv1.2_2021 | TLSv1_2016` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\), specify the security policy that you want CloudFront to use for HTTPS connections with viewers\\. The security policy determines two settings: \n+ The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers\\.\n+ The ciphers that CloudFront can use to encrypt the content that it returns to viewers\\.\nFor more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*\\. \nOn the CloudFront console, this setting is called **Security Policy**\\.\nWhen you're using SNI only \\(you set `SSLSupportMethod` to `sni-only`\\), you must specify `TLSv1` or higher\\. \\(In CloudFormation, the field name is `SslSupportMethod`\\. Note the different capitalization\\.\\) \nIf the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net` \\(you set `CloudFrontDefaultCertificate` to `true`\\), CloudFront automatically sets the security policy to `TLSv1` regardless of the value that you set here\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `SSLv3 | TLSv1 | TLSv1.1_2016 | TLSv1.2_2018 | TLSv1.2_2019 | TLSv1.2_2021 | TLSv1_2016` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MinimumProtocolVersion", "type": "string" }, "SslSupportMethod": { - "markdownDescription": "In CloudFormation, this field name is `SslSupportMethod`\\. Note the different capitalization\\.\nIf the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\), specify which viewers the distribution accepts HTTPS connections from\\. \n+ `sni-only` \u2013 The distribution accepts HTTPS connections from only viewers that support [server name indication \\(SNI\\)](https://en.wikipedia.org/wiki/Server_Name_Indication)\\. This is recommended\\. Most browsers and clients support SNI\\.\n+ `vip` \u2013 The distribution accepts HTTPS connections from all viewers including those that don\u2019t support SNI\\. This is not recommended, and results in additional monthly charges from CloudFront\\.\n+ `static-ip` \\- Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team\\. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [AWS Support Center](https://console.aws.amazon.com/support/home)\\.\nIf the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net`, don\u2019t set a value for this field\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `sni-only | static-ip | vip` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "In CloudFormation, this field name is `SslSupportMethod`\\. Note the different capitalization\\.\nIf the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\), specify which viewers the distribution accepts HTTPS connections from\\. \n+ `sni-only` \u2013 The distribution accepts HTTPS connections from only viewers that support [server name indication \\(SNI\\)](https://en.wikipedia.org/wiki/Server_Name_Indication)\\. This is recommended\\. Most browsers and clients support SNI\\.\n+ `vip` \u2013 The distribution accepts HTTPS connections from all viewers including those that don't support SNI\\. This is not recommended, and results in additional monthly charges from CloudFront\\.\n+ `static-ip` \\- Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team\\. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [AWS Support Center](https://console.aws.amazon.com/support/home)\\.\nIf the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net`, don't set a value for this field\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `sni-only | static-ip | vip` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SslSupportMethod", "type": "string" } @@ -30342,10 +30888,12 @@ "title": "FunctionConfig" }, "FunctionMetadata": { - "$ref": "#/definitions/AWS::CloudFront::Function.FunctionMetadata" + "$ref": "#/definitions/AWS::CloudFront::Function.FunctionMetadata", + "markdownDescription": "Contains metadata about a CloudFront function\\. \n*Required*: No \n*Type*: [FunctionMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-function-functionmetadata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FunctionMetadata" }, "Name": { - "markdownDescription": "A name to identify the function\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9-_]{1,64}$`", + "markdownDescription": "A name to identify the function\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9-_]{1,64}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" } @@ -30387,7 +30935,7 @@ "type": "string" }, "Runtime": { - "markdownDescription": "The function\u2019s runtime environment\\. The only valid value is `cloudfront-js-1.0`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `cloudfront-js-1.0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The function's runtime environment\\. The only valid value is `cloudfront-js-1.0`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `cloudfront-js-1.0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Runtime", "type": "string" } @@ -30540,10 +31088,14 @@ "additionalProperties": false, "properties": { "DistributionId": { + "markdownDescription": "The ID of the distribution that you are enabling metrics for\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DistributionId", "type": "string" }, "MonitoringSubscription": { - "$ref": "#/definitions/AWS::CloudFront::MonitoringSubscription.MonitoringSubscription" + "$ref": "#/definitions/AWS::CloudFront::MonitoringSubscription.MonitoringSubscription", + "markdownDescription": "A subscription configuration for additional CloudWatch metrics\\. \n*Required*: Yes \n*Type*: [MonitoringSubscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-monitoringsubscription-monitoringsubscription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MonitoringSubscription" } }, "required": [ @@ -30577,7 +31129,9 @@ "additionalProperties": false, "properties": { "RealtimeMetricsSubscriptionConfig": { - "$ref": "#/definitions/AWS::CloudFront::MonitoringSubscription.RealtimeMetricsSubscriptionConfig" + "$ref": "#/definitions/AWS::CloudFront::MonitoringSubscription.RealtimeMetricsSubscriptionConfig", + "markdownDescription": "A subscription configuration for additional CloudWatch metrics\\. \n*Required*: No \n*Type*: [RealtimeMetricsSubscriptionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RealtimeMetricsSubscriptionConfig" } }, "type": "object" @@ -30586,6 +31140,8 @@ "additionalProperties": false, "properties": { "RealtimeMetricsSubscriptionStatus": { + "markdownDescription": "A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Disabled | Enabled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RealtimeMetricsSubscriptionStatus", "type": "string" } }, @@ -30630,7 +31186,9 @@ "additionalProperties": false, "properties": { "OriginAccessControlConfig": { - "$ref": "#/definitions/AWS::CloudFront::OriginAccessControl.OriginAccessControlConfig" + "$ref": "#/definitions/AWS::CloudFront::OriginAccessControl.OriginAccessControlConfig", + "markdownDescription": "The origin access control\\. \n*Required*: Yes \n*Type*: [OriginAccessControlConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OriginAccessControlConfig" } }, "required": [ @@ -30663,18 +31221,28 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description of the origin access control\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A name to identify the origin access control\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "OriginAccessControlOriginType": { + "markdownDescription": "The type of origin that this origin access control is for\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `mediastore | s3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OriginAccessControlOriginType", "type": "string" }, "SigningBehavior": { + "markdownDescription": "Specifies which requests CloudFront signs \\(adds authentication information to\\)\\. Specify `always` for the most common use case\\. For more information, see [origin access control advanced settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings) in the *Amazon CloudFront Developer Guide*\\. \nThis field can have one of the following values: \n+ `always` \u2013 CloudFront signs all origin requests, overwriting the `Authorization` header from the viewer request if one exists\\.\n+ `never` \u2013 CloudFront doesn't sign any origin requests\\. This value turns off origin access control for all origins in all distributions that use this origin access control\\.\n+ `no-override` \u2013 If the viewer request doesn't contain the `Authorization` header, then CloudFront signs the origin request\\. If the viewer request contains the `Authorization` header, then CloudFront doesn't sign the origin request and instead passes along the `Authorization` header from the viewer request\\. **WARNING: To pass along the `Authorization` header from the viewer request, you *must* add the `Authorization` header to a [cache policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html) for all cache behaviors that use origins associated with this origin access control\\.** \n*Required*: Yes \n*Type*: String \n*Allowed values*: `always | never | no-override` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SigningBehavior", "type": "string" }, "SigningProtocol": { + "markdownDescription": "The signing protocol of the origin access control, which determines how CloudFront signs \\(authenticates\\) requests\\. The only valid value is `sigv4`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `sigv4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SigningProtocol", "type": "string" } }, @@ -30927,7 +31495,7 @@ "additionalProperties": false, "properties": { "CallerReference": { - "markdownDescription": "A string included in the request to help make sure that the request can\u2019t be replayed\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string included in the request to help make sure that the request can't be replayed\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CallerReference", "type": "string" }, @@ -31122,7 +31690,7 @@ "properties": { "ResponseHeadersPolicyConfig": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.ResponseHeadersPolicyConfig", - "markdownDescription": "A response headers policy configuration\\. \nA response headers policy contains information about a set of HTTP response headers and their values\\. CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match a cache behavior that\u2019s associated with the policy\\. \n*Required*: Yes \n*Type*: [ResponseHeadersPolicyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A response headers policy configuration\\. \n*Required*: Yes \n*Type*: [ResponseHeadersPolicyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResponseHeadersPolicyConfig" } }, @@ -31349,7 +31917,7 @@ "additionalProperties": false, "properties": { "FrameOption": { - "markdownDescription": "The value of the `X-Frame-Options` HTTP response header\\. Valid values are `DENY` and `SAMEORIGIN`\\. \nFor more information about these values, see [X\\-Frame\\-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DENY | SAMEORIGIN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value of the `X-Frame-Options` HTTP response header\\. Valid values are `DENY` and `SAMEORIGIN`\\. \nFor more information about these values, see [X\\-Frame\\-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DENY | SAMEORIGIN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FrameOption", "type": "string" }, @@ -31389,6 +31957,8 @@ "additionalProperties": false, "properties": { "Header": { + "markdownDescription": "The HTTP header name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Header", "type": "string" } }, @@ -31404,6 +31974,8 @@ "items": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.RemoveHeader" }, + "markdownDescription": "The list of HTTP header names\\. \n*Required*: Yes \n*Type*: List of [RemoveHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-removeheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Items", "type": "array" } }, @@ -31436,7 +32008,9 @@ "type": "string" }, "RemoveHeadersConfig": { - "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.RemoveHeadersConfig" + "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.RemoveHeadersConfig", + "markdownDescription": "A configuration for a set of HTTP headers to remove from the HTTP response\\. \n*Required*: No \n*Type*: [RemoveHeadersConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-removeheadersconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RemoveHeadersConfig" }, "SecurityHeadersConfig": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.SecurityHeadersConfig", @@ -31444,7 +32018,9 @@ "title": "SecurityHeadersConfig" }, "ServerTimingHeadersConfig": { - "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.ServerTimingHeadersConfig" + "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.ServerTimingHeadersConfig", + "markdownDescription": "A configuration for enabling the `Server-Timing` header in HTTP responses sent from CloudFront\\. \n*Required*: No \n*Type*: [ServerTimingHeadersConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerTimingHeadersConfig" } }, "required": [ @@ -31467,22 +32043,22 @@ }, "FrameOptions": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.FrameOptions", - "markdownDescription": "Determines whether CloudFront includes the `X-Frame-Options` HTTP response header and the header\u2019s value\\. \nFor more information about the `X-Frame-Options` HTTP response header, see [X\\-Frame\\-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [FrameOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-frameoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether CloudFront includes the `X-Frame-Options` HTTP response header and the header's value\\. \nFor more information about the `X-Frame-Options` HTTP response header, see [X\\-Frame\\-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [FrameOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-frameoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FrameOptions" }, "ReferrerPolicy": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.ReferrerPolicy", - "markdownDescription": "Determines whether CloudFront includes the `Referrer-Policy` HTTP response header and the header\u2019s value\\. \nFor more information about the `Referrer-Policy` HTTP response header, see [Referrer\\-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [ReferrerPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-referrerpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether CloudFront includes the `Referrer-Policy` HTTP response header and the header's value\\. \nFor more information about the `Referrer-Policy` HTTP response header, see [Referrer\\-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [ReferrerPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-referrerpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReferrerPolicy" }, "StrictTransportSecurity": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.StrictTransportSecurity", - "markdownDescription": "Determines whether CloudFront includes the `Strict-Transport-Security` HTTP response header and the header\u2019s value\\. \nFor more information about the `Strict-Transport-Security` HTTP response header, see [Strict\\-Transport\\-Security](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [StrictTransportSecurity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether CloudFront includes the `Strict-Transport-Security` HTTP response header and the header's value\\. \nFor more information about the `Strict-Transport-Security` HTTP response header, see [Strict\\-Transport\\-Security](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [StrictTransportSecurity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StrictTransportSecurity" }, "XSSProtection": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.XSSProtection", - "markdownDescription": "Determines whether CloudFront includes the `X-XSS-Protection` HTTP response header and the header\u2019s value\\. \nFor more information about the `X-XSS-Protection` HTTP response header, see [X\\-XSS\\-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [XSSProtection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-xssprotection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether CloudFront includes the `X-XSS-Protection` HTTP response header and the header's value\\. \nFor more information about the `X-XSS-Protection` HTTP response header, see [X\\-XSS\\-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [XSSProtection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-xssprotection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "XSSProtection" } }, @@ -31492,9 +32068,13 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "A Boolean that determines whether CloudFront adds the `Server-Timing` header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "SamplingRate": { + "markdownDescription": "A number 0\u2013100 \\(inclusive\\) that specifies the percentage of responses that you want CloudFront to add the `Server-Timing` header to\\. When you set the sampling rate to 100, CloudFront adds the `Server-Timing` header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to\\. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior\\. You can set the sampling rate to any number 0\u2013100 with up to four decimal places\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SamplingRate", "type": "number" } }, @@ -31648,7 +32228,7 @@ "type": "string" }, "Enabled": { - "markdownDescription": "Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket\\. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify `false` for `Enabled`, and specify `empty Bucket` and `Prefix` elements\\. If you specify `false` for `Enabled` but you specify values for `Bucket` and `Prefix`, the values are automatically deleted\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket\\. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify `false` for `Enabled`, and specify `empty Bucket` and `Prefix` elements\\. If you specify `false` for `Enabled` but you specify values for `Bucket` and `Prefix`, the values are automatically deleted\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, @@ -31669,7 +32249,7 @@ "additionalProperties": false, "properties": { "DomainName": { - "markdownDescription": "The DNS name of the Amazon S3 origin\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The DNS name of the Amazon S3 origin\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DomainName", "type": "string" }, @@ -31692,12 +32272,12 @@ "items": { "type": "string" }, - "markdownDescription": "A complex type that contains information about CNAMEs \\(alternate domain names\\), if any, for this streaming distribution\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains information about CNAMEs \\(alternate domain names\\), if any, for this streaming distribution\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Aliases", "type": "array" }, "Comment": { - "markdownDescription": "Any comments you want to include about the streaming distribution\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Any comments you want to include about the streaming distribution\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Comment", "type": "string" }, @@ -31708,22 +32288,22 @@ }, "Logging": { "$ref": "#/definitions/AWS::CloudFront::StreamingDistribution.Logging", - "markdownDescription": "A complex type that controls whether access logs are written for the streaming distribution\\. \n*Required*: No \n*Type*: [Logging](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that controls whether access logs are written for the streaming distribution\\. \n*Required*: No \n*Type*: [Logging](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Logging" }, "PriceClass": { - "markdownDescription": "A complex type that contains information about price class for this streaming distribution\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PriceClass_100 | PriceClass_200 | PriceClass_All` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains information about price class for this streaming distribution\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PriceClass_100 | PriceClass_200 | PriceClass_All` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PriceClass", "type": "string" }, "S3Origin": { "$ref": "#/definitions/AWS::CloudFront::StreamingDistribution.S3Origin", - "markdownDescription": "A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution\\. \n*Required*: Yes \n*Type*: [S3Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution\\. \n*Required*: Yes \n*Type*: [S3Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3Origin" }, "TrustedSigners": { "$ref": "#/definitions/AWS::CloudFront::StreamingDistribution.TrustedSigners", - "markdownDescription": "A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content\\. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element\\. For more information, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: Yes \n*Type*: [TrustedSigners](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content\\. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element\\. For more information, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: Yes \n*Type*: [TrustedSigners](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TrustedSigners" } }, @@ -31796,18 +32376,26 @@ "items": { "$ref": "#/definitions/AWS::CloudTrail::Channel.Destination" }, + "markdownDescription": "One or more event data stores to which events arriving through a channel will be logged\\. \n*Required*: No \n*Type*: List of [Destination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Destinations", "type": "array" }, "Name": { + "markdownDescription": "The name of the channel\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9._\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Source": { + "markdownDescription": "The name of the partner or external event source\\. You cannot change this name after you create the channel\\. A maximum of one channel is allowed per source\\. \n A source can be either `Custom` for all valid non\\-AWS events, or the name of a partner event source\\. For information about the source names for available partners, see [Additional information about integration partners](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-integration.html#cloudtrail-lake-partner-information) in the CloudTrail User Guide\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Source", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -31837,9 +32425,13 @@ "additionalProperties": false, "properties": { "Location": { + "markdownDescription": "For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel\\. For service\\-linked channels, the location is the name of the AWS service\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `1024` \n*Pattern*: `^[a-zA-Z0-9._/\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Location", "type": "string" }, "Type": { + "markdownDescription": "The type of destination for events arriving from a channel\\. For channels used for a CloudTrail Lake integration, the value is `EventDataStore`\\. For service\\-linked channels, the value is `AWS_SERVICE`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AWS_SERVICE | EVENT_DATA_STORE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -31888,30 +32480,46 @@ "items": { "$ref": "#/definitions/AWS::CloudTrail::EventDataStore.AdvancedEventSelector" }, + "markdownDescription": "The advanced event selectors to use to select the events for the data store\\. You can configure up to five advanced event selectors for each event data store\\. \n For more information about how to use advanced event selectors to log CloudTrail events, see [Log events by using advanced event selectors](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced) in the CloudTrail User Guide\\. \nFor more information about how to use advanced event selectors to include AWS Config configuration items in your event data store, see [Create an event data store for AWS Config configuration items](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-eds-config) in the CloudTrail User Guide\\. \nFor more information about how to use advanced event selectors to include non\\-AWS events in your event data store, see [Create an integration to log events from outside AWS](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-integration) in the CloudTrail User Guide\\. \n*Required*: No \n*Type*: List of [AdvancedEventSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdvancedEventSelectors", "type": "array" }, "KmsKeyId": { + "markdownDescription": "Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail\\. The value can be an alias name prefixed by `alias/`, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier\\. \nDisabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key\\. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed\\. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store\\.\nCloudTrail also supports AWS KMS multi\\-Region keys\\. For more information about multi\\-Region keys, see [Using multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the * AWS Key Management Service Developer Guide*\\. \nExamples: \n+ `alias/MyAliasName` \n+ `arn:aws:kms:us-east-2:123456789012:alias/MyAliasName` \n+ `arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012` \n+ `12345678-1234-1234-1234-123456789012` \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `350` \n*Pattern*: `^[a-zA-Z0-9._/\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "MultiRegionEnabled": { + "markdownDescription": "Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MultiRegionEnabled", "type": "boolean" }, "Name": { + "markdownDescription": "The name of the event data store\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9._\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "OrganizationEnabled": { + "markdownDescription": "Specifies whether an event data store collects events logged for an organization in AWS Organizations\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationEnabled", "type": "boolean" }, "RetentionPeriod": { + "markdownDescription": "The retention period of the event data store, in days\\. You can set a retention period of up to 2557 days, the equivalent of seven years\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `7` \n*Maximum*: `2557` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetentionPeriod", "type": "number" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TerminationProtectionEnabled": { + "markdownDescription": "Specifies whether termination protection is enabled for the event data store\\. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TerminationProtectionEnabled", "type": "boolean" } }, @@ -31944,9 +32552,13 @@ "items": { "$ref": "#/definitions/AWS::CloudTrail::EventDataStore.AdvancedFieldSelector" }, + "markdownDescription": "Contains all selector statements in an advanced event selector\\. \n*Required*: Yes \n*Type*: List of [AdvancedFieldSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FieldSelectors", "type": "array" }, "Name": { + "markdownDescription": "An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\"\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1000` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -31962,39 +32574,53 @@ "items": { "type": "string" }, + "markdownDescription": "An operator that includes events that match the last few characters of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndsWith", "type": "array" }, "Equals": { "items": { "type": "string" }, + "markdownDescription": "An operator that includes events that match the exact value of the event record field specified as the value of `Field`\\. This is the only valid operator that you can use with the `readOnly`, `eventCategory`, and `resources.type` fields\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Equals", "type": "array" }, "Field": { + "markdownDescription": "A field in a CloudTrail event record on which to filter events to be logged\\. For event data stores for AWS Config configuration items, Audit Manager evidence, or non\\-AWS events, the field is used only for selecting events as filtering is not supported\\. \n For CloudTrail event records, supported fields include `readOnly`, `eventCategory`, `eventSource` \\(for management events\\), `eventName`, `resources.type`, and `resources.ARN`\\. \n For event data stores for AWS Config configuration items, Audit Manager evidence, or non\\-AWS events, the only supported field is `eventCategory`\\. \n+ ** `readOnly` ** \\- Optional\\. Can be set to `Equals` a value of `true` or `false`\\. If you do not add this field, CloudTrail logs both `read` and `write` events\\. A value of `true` logs only `read` events\\. A value of `false` logs only `write` events\\.\n+ ** `eventSource` ** \\- For filtering management events only\\. This can be set only to `NotEquals` `kms.amazonaws.com`\\.\n+ ** `eventName` ** \\- Can use any operator\\. You can use it to \ufb01lter in or \ufb01lter out any data event logged to CloudTrail, such as `PutBucket` or `GetSnapshotBlock`\\. You can have multiple values for this \ufb01eld, separated by commas\\.\n+ ** `eventCategory` ** \\- This is required and must be set to `Equals`\\. \n + For CloudTrail event records, the value must be `Management` or `Data`\\. \n + For AWS Config configuration items, the value must be `ConfigurationItem`\\. \n + For Audit Manager evidence, the value must be `Evidence`\\. \n + For non\\-AWS events, the value must be `ActivityAuditLog`\\. \n+ ** `resources.type` ** \\- This \ufb01eld is required for CloudTrail data events\\. `resources.type` can only use the `Equals` operator, and the value can be one of the following:\n + `AWS::DynamoDB::Table` \n + `AWS::Lambda::Function` \n + `AWS::S3::Object` \n + `AWS::CloudTrail::Channel` \n + `AWS::Cognito::IdentityPool` \n + `AWS::DynamoDB::Stream` \n + `AWS::EC2::Snapshot` \n + `AWS::FinSpace::Environment` \n + `AWS::Glue::Table` \n + `AWS::KendraRanking::ExecutionPlan` \n + `AWS::ManagedBlockchain::Node` \n + `AWS::SageMaker::ExperimentTrialComponent` \n + `AWS::SageMaker::FeatureGroup` \n + `AWS::S3::AccessPoint` \n + `AWS::S3ObjectLambda::AccessPoint` \n + `AWS::S3Outposts::Object`", + "title": "Field", "type": "string" }, "NotEndsWith": { "items": { "type": "string" }, + "markdownDescription": "An operator that excludes events that match the last few characters of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotEndsWith", "type": "array" }, "NotEquals": { "items": { "type": "string" }, + "markdownDescription": "An operator that excludes events that match the exact value of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotEquals", "type": "array" }, "NotStartsWith": { "items": { "type": "string" }, + "markdownDescription": "An operator that excludes events that match the first few characters of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotStartsWith", "type": "array" }, "StartsWith": { "items": { "type": "string" }, + "markdownDescription": "An operator that includes events that match the first few characters of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StartsWith", "type": "array" } }, @@ -32039,9 +32665,13 @@ "additionalProperties": false, "properties": { "ResourceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the CloudTrail channel attached to the resource\\-based policy\\. The following is the format of a resource ARN: `arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._/\\-:]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceArn", "type": "string" }, "ResourcePolicy": { + "markdownDescription": "A JSON\\-formatted string for an AWS resource\\-based policy\\. \nThe following are requirements for the resource policy: \n+ Contains only one action: cloudtrail\\-data:PutAuditEvents \n+ Contains at least one statement\\. The policy can have a maximum of 20 statements\\. \n+ Each statement contains at least one principal\\. A statement can have a maximum of 50 principals\\. \n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourcePolicy", "type": "object" } }, @@ -32108,12 +32738,12 @@ "additionalProperties": false, "properties": { "CloudWatchLogsLogGroupArn": { - "markdownDescription": "Specifies a log group name using an Amazon Resource Name \\(ARN\\), a unique identifier that represents the log group to which CloudTrail logs are delivered\\. Not required unless you specify `CloudWatchLogsRoleArn`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a log group name using an Amazon Resource Name \\(ARN\\), a unique identifier that represents the log group to which CloudTrail logs are delivered\\. You must use a log group that exists in your account\\. \nNot required unless you specify `CloudWatchLogsRoleArn`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchLogsLogGroupArn", "type": "string" }, "CloudWatchLogsRoleArn": { - "markdownDescription": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group\\. You must use a role that exists in your account\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchLogsRoleArn", "type": "string" }, @@ -32126,7 +32756,7 @@ "items": { "$ref": "#/definitions/AWS::CloudTrail::Trail.EventSelector" }, - "markdownDescription": "Use event selectors to further specify the management and data event settings for your trail\\. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events\\. When an event occurs in your account, CloudTrail evaluates the event selector for all trails\\. For each trail, if the event matches any event selector, the trail processes and logs the event\\. If the event doesn't match any event selector, the trail doesn't log the event\\. \nYou can configure up to five event selectors for a trail\\. \nYou cannot apply both event selectors and advanced event selectors to a trail\\. \n*Required*: No \n*Type*: List of [EventSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Use event selectors to further specify the management and data event settings for your trail\\. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events\\. When an event occurs in your account, CloudTrail evaluates the event selector for all trails\\. For each trail, if the event matches any event selector, the trail processes and logs the event\\. If the event doesn't match any event selector, the trail doesn't log the event\\. \nYou can configure up to five event selectors for a trail\\. \n*Required*: No \n*Type*: List of [EventSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventSelectors", "type": "array" }, @@ -32139,7 +32769,7 @@ "items": { "$ref": "#/definitions/AWS::CloudTrail::Trail.InsightSelector" }, - "markdownDescription": "Specifies whether a trail has insight types specified in an `InsightSelector` list\\. \n*Required*: No \n*Type*: List of [InsightSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-insightselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A JSON string that contains the insight types you want to log on a trail\\. `ApiCallRateInsight` and `ApiErrorRateInsight` are valid insight types\\. \n*Required*: No \n*Type*: List of [InsightSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-insightselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InsightSelectors", "type": "array" }, @@ -32154,7 +32784,7 @@ "type": "boolean" }, "IsOrganizationTrail": { - "markdownDescription": "Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account\\. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the management account for an organization in AWS Organizations\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account\\. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the management account or delegated administrator account for an organization in AWS Organizations\\. If the trail is not an organization trail and this is set to `true`, the trail will be created in all AWS accounts that belong to the organization\\. If the trail is an organization trail and this is set to `false`, the trail will remain in the current AWS account but be deleted from all member accounts in the organization\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsOrganizationTrail", "type": "boolean" }, @@ -32223,7 +32853,7 @@ "additionalProperties": false, "properties": { "Type": { - "markdownDescription": "The resource type in which you want to log data events\\. You can specify the following *basic* event selector resource types: \n+ `AWS::S3::Object` \n+ `AWS::Lambda::Function` \n+ `AWS::DynamoDB::Table` \nThe following resource types are also availble through *advanced* event selectors\\. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors\\. For more information, see [AdvancedFieldSelector:Field](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedFieldSelector.html#awscloudtrail-Type-AdvancedFieldSelector-Field)\\. \n+ `AWS::S3Outposts::Object` \n+ `AWS::ManagedBlockchain::Node` \n+ `AWS::S3ObjectLambda::AccessPoint` \n+ `AWS::EC2::Snapshot` \n+ `AWS::S3::AccessPoint` \n+ `AWS::DynamoDB::Stream` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The resource type in which you want to log data events\\. You can specify the following *basic* event selector resource types: \n+ `AWS::S3::Object` \n+ `AWS::Lambda::Function` \n+ `AWS::DynamoDB::Table` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" }, @@ -32231,7 +32861,7 @@ "items": { "type": "string" }, - "markdownDescription": "An array of Amazon Resource Name \\(ARN\\) strings or partial ARN strings for the specified objects\\. \n+ To log data events for all objects in all S3 buckets in your AWS account, specify the prefix as `arn:aws:s3:::`\\.\n**Note** \nThis also enables logging of data event activity performed by any user or role in your AWS account, even if that activity is performed on a bucket that belongs to another AWS account\\.\n+ To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as `arn:aws:s3:::bucket-1/`\\. The trail logs data events for all objects in this S3 bucket\\.\n+ To log data events for specific objects, specify the S3 bucket and object prefix such as `arn:aws:s3:::bucket-1/example-images`\\. The trail logs data events for objects in this S3 bucket that match the prefix\\.\n+ To log data events for all Lambda functions in your AWS account, specify the prefix as `arn:aws:lambda`\\.\n**Note** \nThis also enables logging of `Invoke` activity performed by any user or role in your AWS account, even if that activity is performed on a function that belongs to another AWS account\\. \n+ To log data events for a specific Lambda function, specify the function ARN\\.\n**Note** \nLambda function ARNs are exact\\. For example, if you specify a function ARN *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld*, data events will only be logged for *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld*\\. They will not be logged for *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld2*\\.\n+ To log data events for all DynamoDB tables in your AWS account, specify the prefix as `arn:aws:dynamodb`\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of Amazon Resource Name \\(ARN\\) strings or partial ARN strings for the specified objects\\. \n+ To log data events for all objects in all S3 buckets in your AWS account, specify the prefix as `arn:aws:s3`\\.\n**Note** \nThis also enables logging of data event activity performed by any user or role in your AWS account, even if that activity is performed on a bucket that belongs to another AWS account\\.\n+ To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as `arn:aws:s3:::bucket-1/`\\. The trail logs data events for all objects in this S3 bucket\\. \n+ To log data events for specific objects, specify the S3 bucket and object prefix such as `arn:aws:s3:::bucket-1/example-images`\\. The trail logs data events for objects in this S3 bucket that match the prefix\\.\n+ To log data events for all Lambda functions in your AWS account, specify the prefix as `arn:aws:lambda`\\.\n**Note** \nThis also enables logging of `Invoke` activity performed by any user or role in your AWS account, even if that activity is performed on a function that belongs to another AWS account\\. \n+ To log data events for a specific Lambda function, specify the function ARN\\.\n**Note** \nLambda function ARNs are exact\\. For example, if you specify a function ARN *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld*, data events will only be logged for *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld*\\. They will not be logged for *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld2*\\.\n+ To log data events for all DynamoDB tables in your AWS account, specify the prefix as `arn:aws:dynamodb`\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -32248,7 +32878,7 @@ "items": { "$ref": "#/definitions/AWS::CloudTrail::Trail.DataResource" }, - "markdownDescription": "CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions\\. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail\\. This limit does not apply if you configure resource logging for all data events\\. \nFor more information, see [Data Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-data-events) and [Limits in AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) in the *AWS CloudTrail User Guide*\\. \n*Required*: Conditional \n*Type*: List of [DataResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "In AWS CloudFormation, CloudTrail supports data event logging for Amazon S3 objects, Amazon DynamoDB tables, and AWS Lambda functions\\. Currently, advanced event selectors for data events are not supported in AWS CloudFormation templates\\. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail\\. This limit does not apply if you configure resource logging for all data events\\. \nFor more information, see [Logging data events for trails](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) and [Limits in AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) in the *AWS CloudTrail User Guide*\\. \n*Required*: Conditional \n*Type*: List of [DataResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataResources", "type": "array" }, @@ -32261,7 +32891,7 @@ "type": "array" }, "IncludeManagementEvents": { - "markdownDescription": "Specify if you want your event selector to include management events for your trail\\. \n For more information, see [Management Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-management-events) in the * AWS CloudTrail User Guide*\\. \nBy default, the value is `true`\\. \nThe first copy of management events is free\\. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region\\. For more information about CloudTrail pricing, see [AWS CloudTrail Pricing](http://aws.amazon.com/cloudtrail/pricing/)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify if you want your event selector to include management events for your trail\\. \n For more information, see [Management Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) in the * AWS CloudTrail User Guide*\\. \nBy default, the value is `true`\\. \nThe first copy of management events is free\\. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region\\. For more information about CloudTrail pricing, see [AWS CloudTrail Pricing](http://aws.amazon.com/cloudtrail/pricing/)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeManagementEvents", "type": "boolean" }, @@ -32356,7 +32986,7 @@ "items": { "$ref": "#/definitions/AWS::CloudWatch::Alarm.Dimension" }, - "markdownDescription": "The dimensions for the metric associated with the alarm\\. For an alarm based on a math expression, you can't specify `Dimensions`\\. Instead, you use `Metrics`\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The dimensions for the metric associated with the alarm\\. For an alarm based on a math expression, you can't specify `Dimensions`\\. Instead, you use `Metrics`\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html) \n*Maximum*: `30` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Dimensions", "type": "array" }, @@ -32371,7 +33001,7 @@ "type": "number" }, "ExtendedStatistic": { - "markdownDescription": "The percentile statistic for the metric associated with the alarm\\. Specify a value between p0\\.0 and p100\\. \nFor an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both\\. \nFor an alarm based on a math expression, you can't specify `ExtendedStatistic`\\. Instead, you use `Metrics`\\. \n*Required*: No \n*Type*: String \n*Pattern*: `p(\\d{1,2}(\\.\\d{0,2})?|100)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The percentile statistic for the metric associated with the alarm\\. Specify a value between p0\\.0 and p100\\. \nFor an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both\\. \nFor an alarm based on a math expression, you can't specify `ExtendedStatistic`\\. Instead, you use `Metrics`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExtendedStatistic", "type": "string" }, @@ -32476,7 +33106,7 @@ "type": "string" }, "Value": { - "markdownDescription": "The value for the dimension, from 1\u2013255 characters in length\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value for the dimension, from 1\u2013255 characters in length\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -32494,7 +33124,7 @@ "items": { "$ref": "#/definitions/AWS::CloudWatch::Alarm.Dimension" }, - "markdownDescription": "The metric dimensions that you want to be used for the metric that the alarm will watch\\.\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The metric dimensions that you want to be used for the metric that the alarm will watch\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html) \n*Maximum*: `30` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Dimensions", "type": "array" }, @@ -32520,7 +33150,7 @@ "type": "string" }, "Expression": { - "markdownDescription": "The math expression to be performed on the returned data, if this object is performing a math expression\\. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions\\. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*\\. \nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The math expression to be performed on the returned data, if this object is performing a math expression\\. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions\\. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*\\. \nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Expression", "type": "string" }, @@ -32710,7 +33340,7 @@ "type": "string" }, "Value": { - "markdownDescription": "The value of the dimension\\. Dimension values must contain only ASCII characters and must include at least one non\\-whitespace character\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The value of the dimension\\. Dimension values must contain only ASCII characters and must include at least one non\\-whitespace character\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Value", "type": "string" } @@ -32728,7 +33358,7 @@ "items": { "$ref": "#/definitions/AWS::CloudWatch::AnomalyDetector.Dimension" }, - "markdownDescription": "The dimensions for the metric\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html) \n*Maximum*: `10` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The dimensions for the metric\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html) \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Dimensions", "type": "array" }, @@ -32758,12 +33388,12 @@ "additionalProperties": false, "properties": { "AccountId": { - "markdownDescription": "The ID of the account where the metrics are located, if this is a cross\\-account alarm\\. \nUse this field only for `PutMetricAlarm` operations\\. It is not used in `GetMetricData` operations\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the account where the metrics are located\\. \nIf you are performing a `GetMetricData` operation in a monitoring account, use this to specify which account to retrieve this metric from\\. \nIf you are performing a `PutMetricAlarm` operation, use this to specify which account contains the metric that the alarm is watching\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AccountId", "type": "string" }, "Expression": { - "markdownDescription": "This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data\\. For more information about Metrics Insights queries, see [Metrics Insights query components and syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage) in the *Amazon CloudWatch User Guide*\\. \nA math expression can use the `Id` of the other metrics or queries to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions\\. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*\\. \nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data\\. For more information about Metrics Insights queries, see [Metrics Insights query components and syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage) in the *Amazon CloudWatch User Guide*\\. \nA math expression can use the `Id` of the other metrics or queries to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions\\. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*\\. \nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Expression", "type": "string" }, @@ -32788,7 +33418,7 @@ "type": "number" }, "ReturnData": { - "markdownDescription": "When used in `GetMetricData`, this option indicates whether to return the timestamps and raw data values of this metric\\. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify `False`\\. If you omit this, the default of `True` is used\\. \nWhen used in `PutMetricAlarm`, specify `True` for the one expression result to use as the alarm\\. For all other metrics and expressions in the same `PutMetricAlarm` operation, specify `ReturnData` as False\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When used in `GetMetricData`, this option indicates whether to return the timestamps and raw data values of this metric\\. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify `false`\\. If you omit this, the default of `true` is used\\. \nWhen used in `PutMetricAlarm`, specify `true` for the one expression result to use as the alarm\\. For all other metrics and expressions in the same `PutMetricAlarm` operation, specify `ReturnData` as False\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReturnData", "type": "boolean" } @@ -32805,7 +33435,7 @@ "items": { "$ref": "#/definitions/AWS::CloudWatch::AnomalyDetector.MetricDataQuery" }, - "markdownDescription": "An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression\\. Each item in `MetricDataQueries` gets a metric or performs a math expression\\. One item in `MetricDataQueries` is the expression that provides the time series that the anomaly detector uses as input\\. Designate the expression by setting `ReturnData` to `True` for this object in the array\\. For all other expressions and metrics, set `ReturnData` to `False`\\. The designated expression must return a single time series\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataqueries.html) of [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression\\. Each item in `MetricDataQueries` gets a metric or performs a math expression\\. One item in `MetricDataQueries` is the expression that provides the time series that the anomaly detector uses as input\\. Designate the expression by setting `ReturnData` to `true` for this object in the array\\. For all other expressions and metrics, set `ReturnData` to `false`\\. The designated expression must return a single time series\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataqueries.html) of [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MetricDataQueries", "type": "array" } @@ -32870,7 +33500,7 @@ "items": { "$ref": "#/definitions/AWS::CloudWatch::AnomalyDetector.Dimension" }, - "markdownDescription": "The metric dimensions to create the anomaly detection model for\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html) \n*Maximum*: `10` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The metric dimensions to create the anomaly detection model for\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html) \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Dimensions", "type": "array" }, @@ -32933,12 +33563,18 @@ "type": "boolean" }, "ActionsSuppressor": { + "markdownDescription": "Actions will be suppressed if the suppressor alarm is in the `ALARM` state\\. `ActionsSuppressor` can be an AlarmName or an Amazon Resource Name \\(ARN\\) from an existing alarm\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActionsSuppressor", "type": "string" }, "ActionsSuppressorExtensionPeriod": { + "markdownDescription": "The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the `ALARM` state\\. After this time, the composite alarm performs its actions\\. \n `ExtensionPeriod` is required only when `ActionsSuppressor` is specified\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActionsSuppressorExtensionPeriod", "type": "number" }, "ActionsSuppressorWaitPeriod": { + "markdownDescription": "The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the `ALARM` state\\. After this time, the composite alarm performs its actions\\. \n `WaitPeriod` is required only when `ActionsSuppressor` is specified\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActionsSuppressorWaitPeriod", "type": "number" }, "AlarmActions": { @@ -32955,7 +33591,7 @@ "type": "string" }, "AlarmName": { - "markdownDescription": "The name for the composite alarm\\. This name must be unique within your AWS account\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name for the composite alarm\\. This name must be unique within your AWS account\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AlarmName", "type": "string" }, @@ -33225,6 +33861,8 @@ "type": "array" }, "IncludeLinkedAccountsMetrics": { + "markdownDescription": "If you are creating a metric stream in a monitoring account, specify `true` to include metrics from source accounts that are linked to this monitoring account, in the metric stream\\. The default is `false`\\. \nFor more information about linking accounts, see [CloudWatch cross\\-account observability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludeLinkedAccountsMetrics", "type": "boolean" }, "Name": { @@ -33246,6 +33884,8 @@ "items": { "$ref": "#/definitions/AWS::CloudWatch::MetricStream.MetricStreamStatisticsConfiguration" }, + "markdownDescription": "By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed\\. You can use this parameter to have the metric stream also send additional statistics in the stream\\. This array can have up to 100 members\\. \nFor each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics\\. The additional statistics that you can stream depend on the stream's `OutputFormat`\\. If the `OutputFormat` is `json`, you can stream any additional statistic that is supported by CloudWatch, listed in [CloudWatch statistics definitions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html)\\. If the `OutputFormat` is `opentelemetry0`\\.7, you can stream percentile statistics *\\(p??\\)*\\. \n*Required*: No \n*Type*: List of [MetricStreamStatisticsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StatisticsConfigurations", "type": "array" }, "Tags": { @@ -33306,12 +33946,16 @@ "items": { "type": "string" }, + "markdownDescription": "The additional statistics to stream for the metrics listed in `IncludeMetrics`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalStatistics", "type": "array" }, "IncludeMetrics": { "items": { "$ref": "#/definitions/AWS::CloudWatch::MetricStream.MetricStreamStatisticsMetric" }, + "markdownDescription": "An array that defines the metrics that are to have additional statistics streamed\\. \n*Required*: Yes \n*Type*: List of [MetricStreamStatisticsMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludeMetrics", "type": "array" } }, @@ -33325,9 +33969,13 @@ "additionalProperties": false, "properties": { "MetricName": { + "markdownDescription": "The name of the metric\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetricName", "type": "string" }, "Namespace": { + "markdownDescription": "The namespace of the metric\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Namespace", "type": "string" } }, @@ -33476,7 +34124,7 @@ "items": { "type": "string" }, - "markdownDescription": "An array of external connections associated with the repository. Currently only one external connection is allowed per repository.\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of external connections associated with the repository\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExternalConnections", "type": "array" }, @@ -34843,12 +35491,12 @@ "additionalProperties": false, "properties": { "Type": { - "markdownDescription": "The minimum healthy instance type: \n+ HOST\\_COUNT: The minimum number of healthy instance as an absolute value\\.\n+ FLEET\\_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment\\.\nIn an example of nine instance, if a HOST\\_COUNT of six is specified, deploy to up to three instances at a time\\. The deployment is successful if six or more instances are deployed to successfully\\. Otherwise, the deployment fails\\. If a FLEET\\_PERCENT of 40 is specified, deploy to up to five instance at a time\\. The deployment is successful if four or more instance are deployed to successfully\\. Otherwise, the deployment fails\\. \nIn a call to `GetDeploymentConfig`, CodeDeployDefault\\.OneAtATime returns a minimum healthy instance type of MOST\\_CONCURRENCY and a value of 1\\. This means a deployment to only one instance at a time\\. \\(You cannot set the type to MOST\\_CONCURRENCY, only to HOST\\_COUNT or FLEET\\_PERCENT\\.\\) In addition, with CodeDeployDefault\\.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment\\. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful\\.\nFor more information, see [AWS CodeDeploy Instance Health](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html) in the *AWS CodeDeploy User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FLEET_PERCENT | HOST_COUNT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The minimum healthy instance type: \n+ HOST\\_COUNT: The minimum number of healthy instance as an absolute value\\.\n+ FLEET\\_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment\\.\nIn an example of nine instance, if a HOST\\_COUNT of six is specified, deploy to up to three instances at a time\\. The deployment is successful if six or more instances are deployed to successfully\\. Otherwise, the deployment fails\\. If a FLEET\\_PERCENT of 40 is specified, deploy to up to five instance at a time\\. The deployment is successful if four or more instance are deployed to successfully\\. Otherwise, the deployment fails\\. \nIn a call to `GetDeploymentConfig`, CodeDeployDefault\\.OneAtATime returns a minimum healthy instance type of MOST\\_CONCURRENCY and a value of 1\\. This means a deployment to only one instance at a time\\. \\(You cannot set the type to MOST\\_CONCURRENCY, only to HOST\\_COUNT or FLEET\\_PERCENT\\.\\) In addition, with CodeDeployDefault\\.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment\\. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful\\.\nFor more information, see [AWS CodeDeploy Instance Health](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html) in the *AWS CodeDeploy User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FLEET_PERCENT | HOST_COUNT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" }, "Value": { - "markdownDescription": "The minimum healthy instance value\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The minimum healthy instance value\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Value", "type": "number" } @@ -34863,12 +35511,12 @@ "additionalProperties": false, "properties": { "CanaryInterval": { - "markdownDescription": "The number of minutes between the first and second traffic shifts of a `TimeBasedCanary` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of minutes between the first and second traffic shifts of a `TimeBasedCanary` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CanaryInterval", "type": "number" }, "CanaryPercentage": { - "markdownDescription": "The percentage of traffic to shift in the first increment of a `TimeBasedCanary` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The percentage of traffic to shift in the first increment of a `TimeBasedCanary` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CanaryPercentage", "type": "number" } @@ -34883,12 +35531,12 @@ "additionalProperties": false, "properties": { "LinearInterval": { - "markdownDescription": "The number of minutes between each incremental traffic shift of a `TimeBasedLinear` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of minutes between each incremental traffic shift of a `TimeBasedLinear` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "LinearInterval", "type": "number" }, "LinearPercentage": { - "markdownDescription": "The percentage of traffic that is shifted at the start of each increment of a `TimeBasedLinear` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The percentage of traffic that is shifted at the start of each increment of a `TimeBasedLinear` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "LinearPercentage", "type": "number" } @@ -34904,16 +35552,16 @@ "properties": { "TimeBasedCanary": { "$ref": "#/definitions/AWS::CodeDeploy::DeploymentConfig.TimeBasedCanary", - "markdownDescription": "A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments\\. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file\\. \n*Required*: No \n*Type*: [TimeBasedCanary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedcanary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments\\. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file\\. \n*Required*: No \n*Type*: [TimeBasedCanary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedcanary.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TimeBasedCanary" }, "TimeBasedLinear": { "$ref": "#/definitions/AWS::CodeDeploy::DeploymentConfig.TimeBasedLinear", - "markdownDescription": "A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment\\. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file\\. \n*Required*: No \n*Type*: [TimeBasedLinear](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedlinear.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment\\. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file\\. \n*Required*: No \n*Type*: [TimeBasedLinear](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedlinear.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TimeBasedLinear" }, "Type": { - "markdownDescription": "The type of traffic shifting \\(`TimeBasedCanary` or `TimeBasedLinear`\\) used by a deployment configuration\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AllAtOnce | TimeBasedCanary | TimeBasedLinear` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of traffic shifting \\(`TimeBasedCanary` or `TimeBasedLinear`\\) used by a deployment configuration\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AllAtOnce | TimeBasedCanary | TimeBasedLinear` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -35046,6 +35694,8 @@ "title": "OnPremisesTagSet" }, "OutdatedInstancesStrategy": { + "markdownDescription": "Indicates what happens when new Amazon EC2 instances are launched mid\\-deployment and do not receive the deployed application revision\\. \nIf this option is set to `UPDATE` or is unspecified, CodeDeploy initiates one or more 'auto\\-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances\\. \nIf this option is set to `IGNORE`, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances\\. This may result in instances having different revisions\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IGNORE | UPDATE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OutdatedInstancesStrategy", "type": "string" }, "ServiceRoleArn": { @@ -35057,6 +35707,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them\\. Each tag consists of a key and an optional value, both of which you define\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TriggerConfigurations": { @@ -35113,7 +35765,7 @@ "items": { "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.Alarm" }, - "markdownDescription": "A list of alarms configured for the deployment group\\. A maximum of 10 alarms can be added to a deployment group\\. \n*Required*: No \n*Type*: List of [Alarm](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of alarms configured for the deployment or deployment group\\. A maximum of 10 alarms can be added\\. \n*Required*: No \n*Type*: List of [Alarm](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Alarms", "type": "array" }, @@ -35376,6 +36028,8 @@ "items": { "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TargetGroupPairInfo" }, + "markdownDescription": "The target group pair information\\. This is an array of `TargeGroupPairInfo` objects with a maximum size of one\\. \n*Required*: No \n*Type*: List of [TargetGroupPairInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetGroupPairInfoList", "type": "array" } }, @@ -35501,16 +36155,22 @@ "additionalProperties": false, "properties": { "ProdTrafficRoute": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TrafficRoute" + "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TrafficRoute", + "markdownDescription": "The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete\\. \n*Required*: No \n*Type*: [TrafficRoute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-trafficroute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ProdTrafficRoute" }, "TargetGroups": { "items": { "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TargetGroupInfo" }, + "markdownDescription": "One pair of target groups\\. One is associated with the original task set\\. The second is associated with the task set that serves traffic after the deployment is complete\\. \n*Required*: No \n*Type*: List of [TargetGroupInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgroupinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetGroups", "type": "array" }, "TestTrafficRoute": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TrafficRoute" + "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TrafficRoute", + "markdownDescription": "An optional path used by a load balancer to route test traffic after an Amazon ECS deployment\\. Validation can occur while test traffic is served during a deployment\\. \n*Required*: No \n*Type*: [TrafficRoute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-trafficroute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TestTrafficRoute" } }, "type": "object" @@ -35522,6 +36182,8 @@ "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of one listener\\. The listener identifies the route between a target group and a load balancer\\. This is an array of strings with a maximum size of one\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ListenerArns", "type": "array" } }, @@ -35588,7 +36250,7 @@ "properties": { "AgentPermissions": { "$ref": "#/definitions/AWS::CodeGuruProfiler::ProfilingGroup.AgentPermissions", - "markdownDescription": "The agent permissions attached to this profiling group\\. This action group grants `ConfigureAgent` and `PostAgentProfile` permissions to perform actions required by the profiling agent\\. The Json consists of key `Principals`\\. \n*Principals*: A list of string ARNs for the roles and users you want to grant access to the profiling group\\. Wildcards are not supported in the ARNs\\. You are allowed to provide up to 50 ARNs\\. An empty list is not permitted\\. This is a required key\\. \nFor more information, see [Resource\\-based policies in CodeGuru Profiler](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html) in the *Amazon CodeGuru Profiler user guide*, [ConfigureAgent](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html), and [PostAgentProfile](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The agent permissions attached to this profiling group\\. This action group grants `ConfigureAgent` and `PostAgentProfile` permissions to perform actions required by the profiling agent\\. The Json consists of key `Principals`\\. \n*Principals*: A list of string ARNs for the roles and users you want to grant access to the profiling group\\. Wildcards are not supported in the ARNs\\. You are allowed to provide up to 50 ARNs\\. An empty list is not permitted\\. This is a required key\\. \nFor more information, see [Resource\\-based policies in CodeGuru Profiler](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html) in the *Amazon CodeGuru Profiler user guide*, [ConfigureAgent](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html), and [PostAgentProfile](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html)\\. \n*Required*: No \n*Type*: [AgentPermissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeguruprofiler-profilinggroup-agentpermissions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AgentPermissions" }, "AnomalyDetectionNotificationConfiguration": { @@ -35651,6 +36313,8 @@ "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Principals", "type": "array" } }, @@ -35890,12 +36554,12 @@ "additionalProperties": false, "properties": { "MaximumCount": { - "markdownDescription": "The maximum number of artifacts allowed for the action type\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum number of artifacts allowed for the action type\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaximumCount", "type": "number" }, "MinimumCount": { - "markdownDescription": "The minimum number of artifacts allowed for the action type\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The minimum number of artifacts allowed for the action type\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MinimumCount", "type": "number" } @@ -35910,37 +36574,37 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "The description of the action configuration property that is displayed to users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `160` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the action configuration property that is displayed to users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `160` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Description", "type": "string" }, "Key": { - "markdownDescription": "Whether the configuration property is a key\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Whether the configuration property is a key\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Key", "type": "boolean" }, "Name": { - "markdownDescription": "The name of the action configuration property\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the action configuration property\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, "Queryable": { - "markdownDescription": "Indicates that the property is used with `PollForJobs`\\. When creating a custom action, an action can have up to one queryable property\\. If it has one, that property must be both required and not secret\\. \nIf you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions\\. The value must be less than or equal to twenty \\(20\\) characters\\. The value can contain only alphanumeric characters, underscores, and hyphens\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates that the property is used with `PollForJobs`\\. When creating a custom action, an action can have up to one queryable property\\. If it has one, that property must be both required and not secret\\. \nIf you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions\\. The value must be less than or equal to twenty \\(20\\) characters\\. The value can contain only alphanumeric characters, underscores, and hyphens\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Queryable", "type": "boolean" }, "Required": { - "markdownDescription": "Whether the configuration property is a required value\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Whether the configuration property is a required value\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Required", "type": "boolean" }, "Secret": { - "markdownDescription": "Whether the configuration property is secret\\. Secrets are hidden from all calls except for `GetJobDetails`, `GetThirdPartyJobDetails`, `PollForJobs`, and `PollForThirdPartyJobs`\\. \nWhen updating a pipeline, passing \\* \\* \\* \\* \\* without changing any other values of the action preserves the previous value of the secret\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Whether the configuration property is secret\\. Secrets are hidden from all calls except for `GetJobDetails`, `GetThirdPartyJobDetails`, `PollForJobs`, and `PollForThirdPartyJobs`\\. \nWhen updating a pipeline, passing \\* \\* \\* \\* \\* without changing any other values of the action preserves the previous value of the secret\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Secret", "type": "boolean" }, "Type": { - "markdownDescription": "The type of the configuration property\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Boolean | Number | String` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of the configuration property\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Boolean | Number | String` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -35957,22 +36621,22 @@ "additionalProperties": false, "properties": { "EntityUrlTemplate": { - "markdownDescription": "The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group\\. This link is provided as part of the action display in the pipeline\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group\\. This link is provided as part of the action display in the pipeline\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EntityUrlTemplate", "type": "string" }, "ExecutionUrlTemplate": { - "markdownDescription": "The URL returned to the CodePipeline console that contains a link to the top\\-level landing page for the external system, such as the console page for CodeDeploy\\. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The URL returned to the CodePipeline console that contains a link to the top\\-level landing page for the external system, such as the console page for CodeDeploy\\. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ExecutionUrlTemplate", "type": "string" }, "RevisionUrlTemplate": { - "markdownDescription": "The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RevisionUrlTemplate", "type": "string" }, "ThirdPartyConfigurationUrl": { - "markdownDescription": "The URL of a sign\\-up page where users can sign up for an external service and perform initial configuration of the action provided by that service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The URL of a sign\\-up page where users can sign up for an external service and perform initial configuration of the action provided by that service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ThirdPartyConfigurationUrl", "type": "string" } @@ -36111,7 +36775,7 @@ "items": { "$ref": "#/definitions/AWS::CodePipeline::Pipeline.InputArtifact" }, - "markdownDescription": "The name or ID of the artifact consumed by the action, such as a test or build artifact\\. \nFor a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource\\. For more information, see the [CodeBuild action reference page](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeBuild.html) in the *AWS CodePipeline User Guide*\\.\n*Required*: No \n*Type*: List of [InputArtifact](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name or ID of the artifact consumed by the action, such as a test or build artifact\\. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of input artifacts\\. To refer to the action configuration specification by action provider, see the [Action structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) in the *AWS CodePipeline User Guide*\\. \nFor a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource\\. For more information, see the [CodeBuild action reference page](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeBuild.html) in the *AWS CodePipeline User Guide*\\.\n*Required*: No \n*Type*: List of [InputArtifact](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InputArtifacts", "type": "array" }, @@ -36129,7 +36793,7 @@ "items": { "$ref": "#/definitions/AWS::CodePipeline::Pipeline.OutputArtifact" }, - "markdownDescription": "The name or ID of the result of the action declaration, such as a test or build artifact\\. \n*Required*: No \n*Type*: List of [OutputArtifact](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name or ID of the result of the action declaration, such as a test or build artifact\\. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of output artifacts\\. To refer to the action configuration specification by action provider, see the [Action structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) in the *AWS CodePipeline User Guide*\\. \n*Required*: No \n*Type*: List of [OutputArtifact](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OutputArtifacts", "type": "array" }, @@ -36256,7 +36920,7 @@ "additionalProperties": false, "properties": { "Id": { - "markdownDescription": "The ID used to identify the key\\. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN\\. \nAliases are recognized only in the account that created the AWS KMS key\\. For cross\\-account actions, you can only use the key ID or key ARN to identify the key\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID used to identify the key\\. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN\\. \nAliases are recognized only in the account that created the AWS KMS key\\. For cross\\-account actions, you can only use the key ID or key ARN to identify the key\\. Cross\\-account actions involve using the role from the other account \\(AccountB\\), so specifying the key ID will use the key from the other account \\(AccountB\\)\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Id", "type": "string" }, @@ -36276,7 +36940,7 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of the artifact to be worked on \\(for example, \"My App\"\\)\\. \nThe input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact\\. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z0-9_\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the artifact to be worked on \\(for example, \"My App\"\\)\\. \nArtifacts are the files that are worked on by actions in the pipeline\\. See the action configuration for each action for details about artifact parameters\\. For example, the S3 source action input artifact is a file name \\(or file path\\), and the files are generally provided as a ZIP file\\. Example artifact name: SampleApp\\_Windows\\.zip \nThe input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact\\. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z0-9_\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" } @@ -36537,7 +37201,7 @@ "title": "Code" }, "ConnectionArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectionArn", "type": "string" }, @@ -36759,7 +37423,7 @@ "additionalProperties": false, "properties": { "CreatedBy": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CreatedBy", "type": "string" }, @@ -36769,7 +37433,7 @@ "type": "string" }, "EventTypeId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventTypeId", "type": "string" }, @@ -36777,7 +37441,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of event types associated with this notification rule\\. For a complete list of event types and IDs, see [Notification concepts](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api) in the *Developer Tools Console User Guide*\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of event types associated with this notification rule\\. For a complete list of event types and IDs, see [Notification concepts](https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api) in the *Developer Tools Console User Guide*\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventTypeIds", "type": "array" }, @@ -36797,12 +37461,12 @@ "type": "string" }, "Tags": { - "markdownDescription": "A list of tags to apply to this notification rule\\. Key names cannot start with \"`aws`\"\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of tags to apply to this notification rule\\. Key names cannot start with \"`aws`\"\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "object" }, "TargetAddress": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TargetAddress", "type": "string" }, @@ -36810,7 +37474,7 @@ "items": { "$ref": "#/definitions/AWS::CodeStarNotifications::NotificationRule.Target" }, - "markdownDescription": "A list of Amazon Resource Names \\(ARNs\\) of AWS Chatbot topics and AWS Chatbot clients to associate with the notification rule\\. \n*Required*: Yes \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestarnotifications-notificationrule-target.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of Amazon Resource Names \\(ARNs\\) of Amazon Simple Notification Service topics and AWS Chatbot clients to associate with the notification rule\\. \n*Required*: Yes \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestarnotifications-notificationrule-target.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Targets", "type": "array" } @@ -37269,25 +37933,27 @@ "type": "array" }, "DeletionProtection": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeletionProtection", "type": "string" }, "DeviceConfiguration": { "$ref": "#/definitions/AWS::Cognito::UserPool.DeviceConfiguration", - "markdownDescription": "The device configuration\\. \n*Required*: No \n*Type*: [DeviceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The device\\-remembering configuration for a user pool\\. A null value indicates that you have deactivated device remembering in your user pool\\. \nWhen you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device\\-remembering feature\\.\n*Required*: No \n*Type*: [DeviceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeviceConfiguration" }, "EmailConfiguration": { "$ref": "#/definitions/AWS::Cognito::UserPool.EmailConfiguration", - "markdownDescription": "The email configuration\\. \n*Required*: No \n*Type*: [EmailConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The email configuration of your user pool\\. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool\\. \n*Required*: No \n*Type*: [EmailConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailConfiguration" }, "EmailVerificationMessage": { - "markdownDescription": "A string representing the email verification message\\. EmailVerificationMessage is allowed only if [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This parameter is no longer used\\. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailVerificationMessage", "type": "string" }, "EmailVerificationSubject": { - "markdownDescription": "A string representing the email verification subject\\. EmailVerificationSubject is allowed only if [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This parameter is no longer used\\. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailVerificationSubject", "type": "string" }, @@ -37305,7 +37971,7 @@ "title": "LambdaConfig" }, "MfaConfiguration": { - "markdownDescription": "The multi\\-factor \\(MFA\\) configuration\\. Valid values include: \n+ `OFF` MFA won't be used for any users\\.\n+ `ON` MFA is required for all users to sign in\\.\n+ `OPTIONAL` MFA will be required only for individual users who have an MFA factor activated\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `OFF | ON | OPTIONAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The multi\\-factor authentication \\(MFA\\) configuration\\. Valid values include: \n+ `OFF` MFA won't be used for any users\\.\n+ `ON` MFA is required for all users to sign in\\.\n+ `OPTIONAL` MFA will be required only for individual users who have an MFA factor activated\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `OFF | ON | OPTIONAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MfaConfiguration", "type": "string" }, @@ -37318,7 +37984,7 @@ "items": { "$ref": "#/definitions/AWS::Cognito::UserPool.SchemaAttribute" }, - "markdownDescription": "", + "markdownDescription": "The schema attributes for the new user pool\\. These attributes can be standard or custom attributes\\. \n During a user pool update, you can add new schema attributes but you cannot modify or delete an existing schema attribute\\.\n*Required*: No \n*Type*: List of [SchemaAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Schema", "type": "array" }, @@ -37329,16 +37995,18 @@ }, "SmsConfiguration": { "$ref": "#/definitions/AWS::Cognito::UserPool.SmsConfiguration", - "markdownDescription": "The SMS configuration\\. \n*Required*: No \n*Type*: [SmsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service\\. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management \\(IAM\\) role in your AWS account\\. \n*Required*: No \n*Type*: [SmsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SmsConfiguration" }, "SmsVerificationMessage": { - "markdownDescription": "A string representing the SMS verification message\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `140` \n*Pattern*: `.*\\{####\\}.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This parameter is no longer used\\. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `140` \n*Pattern*: `.*\\{####\\}.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SmsVerificationMessage", "type": "string" }, "UserAttributeUpdateSettings": { - "$ref": "#/definitions/AWS::Cognito::UserPool.UserAttributeUpdateSettings" + "$ref": "#/definitions/AWS::Cognito::UserPool.UserAttributeUpdateSettings", + "markdownDescription": "The settings for updates to user attributes\\. These settings include the property `AttributesRequireVerificationBeforeUpdate`, a user\\-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes\\. For more information, see [ Verifying updates to email addresses and phone numbers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates)\\. \n*Required*: No \n*Type*: [UserAttributeUpdateSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userattributeupdatesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserAttributeUpdateSettings" }, "UserPoolAddOns": { "$ref": "#/definitions/AWS::Cognito::UserPool.UserPoolAddOns", @@ -37424,7 +38092,7 @@ "title": "InviteMessageTemplate" }, "UnusedAccountValidityDays": { - "markdownDescription": "The user account expiration limit, in days, after which the account is no longer usable\\. To reset the account after that time limit, you must call `AdminCreateUser` again, specifying `\"RESEND\"` for the `MessageAction` parameter\\. The default value for this parameter is 7\\. \nIf you set a value for `TemporaryPasswordValidityDays` in `PasswordPolicy`, that value will be used, and `UnusedAccountValidityDays` will be no longer be an available parameter for that user pool\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `365` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable\\. To reset the account after that time limit, you must call `AdminCreateUser` again, specifying `\"RESEND\"` for the `MessageAction` parameter\\. The default value for this parameter is 7\\. \nIf you set a value for `TemporaryPasswordValidityDays` in `PasswordPolicy`, that value will be used, and `UnusedAccountValidityDays` will be no longer be an available parameter for that user pool\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `365` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UnusedAccountValidityDays", "type": "number" } @@ -37467,12 +38135,12 @@ "additionalProperties": false, "properties": { "ChallengeRequiredOnNewDevice": { - "markdownDescription": "When true, device authentication can replace SMS and time\\-based one\\-time password \\(TOTP\\) factors for multi\\-factor authentication \\(MFA\\)\\. \nUsers that sign in with devices that have not been confirmed or remembered will still have to provide a second factor, whether or not ChallengeRequiredOnNewDevice is true, when your user pool requires MFA\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When true, a remembered device can sign in with device authentication instead of SMS and time\\-based one\\-time password \\(TOTP\\) factors for multi\\-factor authentication \\(MFA\\)\\. \nWhether or not `ChallengeRequiredOnNewDevice` is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ChallengeRequiredOnNewDevice", "type": "boolean" }, "DeviceOnlyRememberedOnUserPrompt": { - "markdownDescription": "When true, users can opt in to remembering their device\\. Your app code must use callback functions to return the user's choice\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a [ ConfirmDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) API request\\. In your app, create a prompt for your user to choose whether they want to remember their device\\. Return the user's choice in an [ UpdateDeviceStatus](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) API request\\. \nWhen `DeviceOnlyRememberedOnUserPrompt` is `false`, Amazon Cognito immediately remembers devices that you register in a `ConfirmDevice` API request\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeviceOnlyRememberedOnUserPrompt", "type": "boolean" } @@ -37488,7 +38156,7 @@ "type": "string" }, "EmailSendingAccount": { - "markdownDescription": "Specifies whether Amazon Cognito emails your users by using its built\\-in email functionality or your Amazon Simple Email Service email configuration\\. Specify one of the following values: \nCOGNITO\\_DEFAULT \nWhen Amazon Cognito emails your users, it uses its built\\-in email functionality\\. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool\\. For typical production environments, the default email limit is less than the required delivery volume\\. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration\\. \nTo look up the email delivery limit for the default option, see [Limits in ](https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html) in the * Developer Guide*\\. \nThe default FROM address is `no-reply@verificationemail.com`\\. To customize the FROM address, provide the Amazon Resource Name \\(ARN\\) of an Amazon SES verified email address for the `SourceArn` parameter\\. \n If EmailSendingAccount is COGNITO\\_DEFAULT, you can't use the following parameters: \n+ EmailVerificationMessage\n+ EmailVerificationSubject\n+ InviteMessageTemplate\\.EmailMessage\n+ InviteMessageTemplate\\.EmailSubject\n+ VerificationMessageTemplate\\.EmailMessage\n+ VerificationMessageTemplate\\.EmailMessageByLink\n+ VerificationMessageTemplate\\.EmailSubject,\n+ VerificationMessageTemplate\\.EmailSubjectByLink\nDEVELOPER EmailSendingAccount is required\\. \nDEVELOPER \nWhen Amazon Cognito emails your users, it uses your Amazon SES configuration\\. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address\\. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account\\. \nIf you use this option, you must provide the ARN of an Amazon SES verified email address for the `SourceArn` parameter\\. \nBefore Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf\\. When you update your user pool with this option, Amazon Cognito creates a *service\\-linked role*, which is a type of role, in your AWS account\\. This role contains the permissions that allow to access Amazon SES and send email messages with your address\\. For more information about the service\\-linked role that Amazon Cognito creates, see [Using Service\\-Linked Roles for Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html) in the *Amazon Cognito Developer Guide*\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `COGNITO_DEFAULT | DEVELOPER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether Amazon Cognito uses its built\\-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration\\. Specify one of the following values: \nCOGNITO\\_DEFAULT \nWhen Amazon Cognito emails your users, it uses its built\\-in email functionality\\. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool\\. For typical production environments, the default email limit is less than the required delivery volume\\. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration\\. \nTo look up the email delivery limit for the default option, see [Limits](https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html) in the *Amazon Cognito Developer Guide*\\. \nThe default FROM address is `no-reply@verificationemail.com`\\. To customize the FROM address, provide the Amazon Resource Name \\(ARN\\) of an Amazon SES verified email address for the `SourceArn` parameter\\. \nDEVELOPER \nWhen Amazon Cognito emails your users, it uses your Amazon SES configuration\\. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address\\. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account\\. \nIf you use this option, provide the ARN of an Amazon SES verified email address for the `SourceArn` parameter\\. \nBefore Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf\\. When you update your user pool with this option, Amazon Cognito creates a *service\\-linked role*, which is a type of role in your AWS account\\. This role contains the permissions that allow you to access Amazon SES and send email messages from your email address\\. For more information about the service\\-linked role that Amazon Cognito creates, see [Using Service\\-Linked Roles for Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html) in the *Amazon Cognito Developer Guide*\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `COGNITO_DEFAULT | DEVELOPER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailSendingAccount", "type": "string" }, @@ -37503,7 +38171,7 @@ "type": "string" }, "SourceArn": { - "markdownDescription": "The ARN of a verified email address in Amazon SES\\. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the `EmailSendingAccount` parameter: \n+ If you specify `COGNITO_DEFAULT`, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built\\-in email account\\.\n+ If you specify `DEVELOPER`, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf\\.\n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN of a verified email address in Amazon SES\\. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the `EmailSendingAccount` parameter: \n+ If you specify `COGNITO_DEFAULT`, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built\\-in email account\\.\n+ If you specify `DEVELOPER`, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf\\.\nThe Region value of the `SourceArn` parameter must indicate a supported AWS Region of your user pool\\. Typically, the Region in the `SourceArn` and the user pool Region are the same\\. For more information, see [Amazon SES email configuration regions](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html#user-pool-email-developer-region-mapping) in the [Amazon Cognito Developer Guide](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceArn", "type": "string" } @@ -37647,7 +38315,7 @@ "type": "boolean" }, "TemporaryPasswordValidityDays": { - "markdownDescription": "The number of days a temporary password is valid in the password policy\\. If the user doesn't sign in during this time, an administrator must reset their password\\. \nWhen you set `TemporaryPasswordValidityDays` for a user pool, you can no longer set the deprecated `UnusedAccountValidityDays` value for that user pool\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `365` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of days a temporary password is valid in the password policy\\. If the user doesn't sign in during this time, an administrator must reset their password\\. \nWhen you set `TemporaryPasswordValidityDays` for a user pool, you can no longer set a value for the legacy `UnusedAccountValidityDays` parameter in that user pool\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `365` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TemporaryPasswordValidityDays", "type": "number" } @@ -37695,7 +38363,7 @@ "type": "boolean" }, "Mutable": { - "markdownDescription": "Specifies whether the value of the attribute can be changed\\. \nFor any user pool attribute that is mapped to an identity provider attribute, you must set this parameter to `true`\\. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider\\. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute\\. For more information, see [Specifying Identity Provider Attribute Mappings for Your User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the value of the attribute can be changed\\. \nFor any user pool attribute that is mapped to an IdP attribute, you must set this parameter to `true`\\. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP\\. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute\\. For more information, see [Specifying Identity Provider Attribute Mappings for Your User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Mutable", "type": "boolean" }, @@ -37736,7 +38404,7 @@ "type": "string" }, "SnsRegion": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS Region to use with Amazon SNS integration\\. You can choose the same Region as your user pool, or a supported **Legacy Amazon SNS alternate Region**\\. \n Amazon Cognito resources in the Asia Pacific \\(Seoul\\) AWS Region must use your Amazon SNS configuration in the Asia Pacific \\(Tokyo\\) Region\\. For more information, see [SMS message settings for Amazon Cognito user pools](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `5` \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SnsRegion", "type": "string" } @@ -37766,6 +38434,8 @@ "items": { "type": "string" }, + "markdownDescription": "Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute\\. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address\\. Amazon Cognito doesn\u2019t change the value of the attribute until your user responds to the verification message and confirms the new value\\. \nYou can verify an updated email address or phone number with a [VerifyUserAttribute](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html) API request\\. You can also call the [AdminUpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html) API and set `email_verified` or `phone_number_verified` to true\\. \nWhen `AttributesRequireVerificationBeforeUpdate` is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them\\. In a user pool where `AttributesRequireVerificationBeforeUpdate` is false, API operations that change attribute values can immediately update a user\u2019s `email` or `phone_number` attribute\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AttributesRequireVerificationBeforeUpdate", "type": "array" } }, @@ -37789,7 +38459,7 @@ "additionalProperties": false, "properties": { "CaseSensitive": { - "markdownDescription": "Specifies whether username case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs\\. \nValid values include: \n+ ** `True` **: Enables case sensitivity for all username input\\. When this option is set to `True`, users must sign in using the exact capitalization of their given username, such as \u201cUserName\u201d\\. This is the default value\\.\n+ ** `False` **: Enables case insensitivity for all username input\\. For example, when this option is set to `False`, users can sign in using either \"username\" or \"Username\"\\. This option also enables both `preferred_username` and `email` alias to be case insensitive, in addition to the `username` attribute\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs\\. For most use cases, set case sensitivity to `False` \\(case insensitive\\) as a best practice\\. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name\\. \nValid values include: \nTrue \nEnables case sensitivity for all username input\\. When this option is set to `True`, users must sign in using the exact capitalization of their given username, such as \u201cUserName\u201d\\. This is the default value\\. \nFalse \nEnables case insensitivity for all username input\\. For example, when this option is set to `False`, users can sign in using `username`, `USERNAME`, or `UserName`\\. This option also enables both `preferred_username` and `email` alias to be case insensitive, in addition to the `username` attribute\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CaseSensitive", "type": "boolean" } @@ -37805,27 +38475,27 @@ "type": "string" }, "EmailMessage": { - "markdownDescription": "The email message template\\. EmailMessage is allowed only if [ EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailMessage", "type": "string" }, "EmailMessageByLink": { - "markdownDescription": "The email message template for sending a confirmation link to the user\\. EmailMessageByLink is allowed only if [ EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{##[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*##\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{##[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*##\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailMessageByLink", "type": "string" }, "EmailSubject": { - "markdownDescription": "The subject line for the email message template\\. EmailSubject is allowed only if [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailSubject", "type": "string" }, "EmailSubjectByLink": { - "markdownDescription": "The subject line for the email message template for sending a confirmation link to the user\\. EmailSubjectByLink is allowed only [ EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailSubjectByLink", "type": "string" }, "SmsMessage": { - "markdownDescription": "The SMS message template\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `140` \n*Pattern*: `.*\\{####\\}.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The template for SMS messages that Amazon Cognito sends to your users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `140` \n*Pattern*: `.*\\{####\\}.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SmsMessage", "type": "string" } @@ -37868,7 +38538,7 @@ "additionalProperties": false, "properties": { "AccessTokenValidity": { - "markdownDescription": "The time limit, after which the access token is no longer valid and cannot be used\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The access token time limit\\. After this limit expires, your user can't use their access token\\. To specify the time unit for `AccessTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request\\. \nFor example, when you set `AccessTokenValidity` to `10` and `TokenValidityUnits` to `hours`, your user can authorize access with their access token for 10 hours\\. \nThe default time unit for `AccessTokenValidity` in an API request is hours\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessTokenValidity", "type": "number" }, @@ -37876,7 +38546,7 @@ "items": { "type": "string" }, - "markdownDescription": "The allowed OAuth flows\\. \nSet to `code` to initiate a code grant flow, which provides an authorization code as the response\\. This code can be exchanged for access tokens with the token endpoint\\. \nSet to `implicit` to specify that the client should get the access token \\(and, optionally, ID token, based on scopes\\) directly\\. \nSet to `client_credentials` to specify that the client should get the access token \\(and, optionally, ID token, based on scopes\\) from the token endpoint using a combination of client and client\\_secret\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The allowed OAuth flows\\. \ncode \nUse a code grant flow, which provides an authorization code as the response\\. This code can be exchanged for access tokens with the `/oauth2/token` endpoint\\. \nimplicit \nIssue the access token \\(and, optionally, ID token, based on scopes\\) directly to your user\\. \nclient\\_credentials \nIssue the access token from the `/oauth2/token` endpoint directly to a non\\-person user using a combination of the client ID and client secret\\.\n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowedOAuthFlows", "type": "array" }, @@ -37889,23 +38559,25 @@ "items": { "type": "string" }, - "markdownDescription": "The allowed OAuth scopes\\. Possible values provided by OAuth are: `phone`, `email`, `openid`, and `profile`\\. Possible values provided by AWS are: `aws.cognito.signin.user.admin`\\. Custom scopes created in Resource Servers are also supported\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The allowed OAuth scopes\\. Possible values provided by OAuth are `phone`, `email`, `openid`, and `profile`\\. Possible values provided by AWS are `aws.cognito.signin.user.admin`\\. Custom scopes created in Resource Servers are also supported\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowedOAuthScopes", "type": "array" }, "AnalyticsConfiguration": { "$ref": "#/definitions/AWS::Cognito::UserPoolClient.AnalyticsConfiguration", - "markdownDescription": "The Amazon Pinpoint analytics configuration for collecting metrics for this user pool\\. \nIn AWS Regions where isn't available, User Pools only supports sending events to Amazon Pinpoint projects in AWS Region us\\-east\\-1\\. In Regions where is available, User Pools will support sending events to Amazon Pinpoint projects within that same Region\\. \n*Required*: No \n*Type*: [AnalyticsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign\\. \nIn AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us\\-east\\-1\\. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region\\.\n*Required*: No \n*Type*: [AnalyticsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AnalyticsConfiguration" }, "AuthSessionValidity": { + "markdownDescription": "Amazon Cognito creates a session token for each API request in an authentication flow\\. `AuthSessionValidity` is the duration, in minutes, of that session token\\. Your user pool native user must respond to each authentication challenge before the session expires\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `3` \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AuthSessionValidity", "type": "number" }, "CallbackURLs": { "items": { "type": "string" }, - "markdownDescription": "A list of allowed redirect \\(callback\\) URLs for the identity providers\\. \nA redirect URI must: \n+ Be an absolute URI\\.\n+ Be registered with the authorization server\\.\n+ Not include a fragment component\\.\nSee [OAuth 2\\.0 \\- Redirection Endpoint](https://tools.ietf.org/html/rfc6749#section-3.1.2)\\. \nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only\\. \nApp callback URLs such as myapp://example are also supported\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of allowed redirect \\(callback\\) URLs for the IdPs\\. \nA redirect URI must: \n+ Be an absolute URI\\.\n+ Be registered with the authorization server\\.\n+ Not include a fragment component\\.\nSee [OAuth 2\\.0 \\- Redirection Endpoint](https://tools.ietf.org/html/rfc6749#section-3.1.2)\\. \nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only\\. \nApp callback URLs such as myapp://example are also supported\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CallbackURLs", "type": "array" }, @@ -37920,6 +38592,8 @@ "type": "string" }, "EnablePropagateAdditionalUserContextData": { + "markdownDescription": "Activates the propagation of additional user context data\\. For more information about propagation of user context data, see [ Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html)\\. If you don\u2019t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security\\. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnablePropagateAdditionalUserContextData", "type": "boolean" }, "EnableTokenRevocation": { @@ -37931,7 +38605,7 @@ "items": { "type": "string" }, - "markdownDescription": "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\\. Note that values with `ALLOW_` prefix must be used only along with the `ALLOW_` prefix\\. \nValid values include: \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*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The authentication flows that you want your user pool client to support\\. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password \\(SRP\\), a user name and password, or a custom authentication process that you define with Lambda functions\\. \nIf you don't specify a value for `ExplicitAuthFlows`, your user client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`, and `ALLOW_CUSTOM_AUTH`\\.\nValid values include: \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, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password \\(SRP\\) protocol to securely transmit the password\\.\n+ `ALLOW_CUSTOM_AUTH`: Enable 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\\.\nIn some environments, you will see the values `ADMIN_NO_SRP_AUTH`, `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`\\. You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_`, like `ALLOW_USER_SRP_AUTH`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExplicitAuthFlows", "type": "array" }, @@ -37941,7 +38615,7 @@ "type": "boolean" }, "IdTokenValidity": { - "markdownDescription": "The time limit, after which the ID token is no longer valid and cannot be used\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID token time limit\\. After this limit expires, your user can't use their ID token\\. To specify the time unit for `IdTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request\\. \nFor example, when you set `IdTokenValidity` as `10` and `TokenValidityUnits` as `hours`, your user can authenticate their session with their ID token for 10 hours\\. \nThe default time unit for `AccessTokenValidity` in an API request is hours\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdTokenValidity", "type": "number" }, @@ -37949,7 +38623,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of allowed logout URLs for the identity providers\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of allowed logout URLs for the IdPs\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogoutURLs", "type": "array" }, @@ -37967,7 +38641,7 @@ "type": "array" }, "RefreshTokenValidity": { - "markdownDescription": "The time limit, in days, after which the refresh token is no longer valid and can't be used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `315360000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The refresh token time limit\\. After this limit expires, your user can't use their refresh token\\. To specify the time unit for `RefreshTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request\\. \nFor example, when you set `RefreshTokenValidity` as `10` and `TokenValidityUnits` as `days`, your user can refresh their session and retrieve new access and ID tokens for 10 days\\. \nThe default time unit for `RefreshTokenValidity` in an API request is days\\. You can't set `RefreshTokenValidity` to 0\\. If you do, Amazon Cognito overrides the value with the default value of 30 days\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RefreshTokenValidity", "type": "number" }, @@ -37975,13 +38649,13 @@ "items": { "type": "string" }, - "markdownDescription": "A list of provider names for the identity providers that are supported on this client\\. The following are supported: `COGNITO`, `Facebook`, `SignInWithApple`, `Google` and `LoginWithAmazon`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of provider names for the identity providers \\(IdPs\\) that are supported on this client\\. The following are supported: `COGNITO`, `Facebook`, `Google`, `SignInWithApple`, and `LoginWithAmazon`\\. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SupportedIdentityProviders", "type": "array" }, "TokenValidityUnits": { "$ref": "#/definitions/AWS::Cognito::UserPoolClient.TokenValidityUnits", - "markdownDescription": "The units in which the validity times are represented in\\. Default for RefreshToken is days, and default for ID and access tokens are hours\\. \n*Required*: No \n*Type*: [TokenValidityUnits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The units in which the validity times are represented\\. The default unit for RefreshToken is days, and default for ID and access tokens are hours\\. \n*Required*: No \n*Type*: [TokenValidityUnits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TokenValidityUnits" }, "UserPoolId": { @@ -37993,7 +38667,7 @@ "items": { "type": "string" }, - "markdownDescription": "The user pool attributes that the app client can write to\\. \nIf your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes\\. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider\\. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute\\. For more information, see [Specifying Identity Provider Attribute Mappings for Your User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user pool attributes that the app client can write to\\. \nIf your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes\\. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP\\. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute\\. For more information, see [Specifying IdP Attribute Mappings for Your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WriteAttributes", "type": "array" } @@ -38048,7 +38722,7 @@ "type": "string" }, "UserDataShared": { - "markdownDescription": "If `UserDataShared` is `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If `UserDataShared` is `true`, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UserDataShared", "type": "boolean" } @@ -38059,17 +38733,17 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "A time unit in \u201cseconds\u201d, \u201cminutes\u201d, \u201chours\u201d or \u201cdays\u201d for the value in AccessTokenValidity, defaults to hours\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A time unit of `seconds`, `minutes`, `hours`, or `days` for the value that you set in the `AccessTokenValidity` parameter\\. The default `AccessTokenValidity` time unit is hours\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `days | hours | minutes | seconds` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, "IdToken": { - "markdownDescription": "A time unit in \u201cseconds\u201d, \u201cminutes\u201d, \u201chours\u201d or \u201cdays\u201d for the value in IdTokenValidity, defaults to hours\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A time unit of `seconds`, `minutes`, `hours`, or `days` for the value that you set in the `IdTokenValidity` parameter\\. The default `IdTokenValidity` time unit is hours\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `days | hours | minutes | seconds` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdToken", "type": "string" }, "RefreshToken": { - "markdownDescription": "A time unit in \u201cseconds\u201d, \u201cminutes\u201d, \u201chours\u201d or \u201cdays\u201d for the value in RefreshTokenValidity, defaults to days\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A time unit of `seconds`, `minutes`, `hours`, or `days` for the value that you set in the `RefreshTokenValidity` parameter\\. The default `RefreshTokenValidity` time unit is days\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `days | hours | minutes | seconds` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RefreshToken", "type": "string" } @@ -38211,7 +38885,7 @@ "type": "string" }, "Precedence": { - "markdownDescription": "A non\\-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool\\. Zero is the highest precedence value\\. Groups with lower `Precedence` values take precedence over groups with higher ornull `Precedence` values\\. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims\\. \nTwo groups can have the same `Precedence` value\\. If this happens, neither group takes precedence over the other\\. If two groups with the same `Precedence` have the same role ARN, that role is used in the `cognito:preferred_role` claim in tokens for users in each group\\. If the two groups have different role ARNs, the `cognito:preferred_role` claim isn't set in users' tokens\\. \nThe default `Precedence` value is null\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A non\\-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool\\. Zero is the highest precedence value\\. Groups with lower `Precedence` values take precedence over groups with higher or null `Precedence` values\\. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims\\. \nTwo groups can have the same `Precedence` value\\. If this happens, neither group takes precedence over the other\\. If two groups with the same `Precedence` have the same role ARN, that role is used in the `cognito:preferred_role` claim in tokens for users in each group\\. If the two groups have different role ARNs, the `cognito:preferred_role` claim isn't set in users' tokens\\. \nThe default `Precedence` value is null\\. The maximum `Precedence` value is `2^31-1`\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Precedence", "type": "number" }, @@ -38288,7 +38962,7 @@ "additionalProperties": false, "properties": { "AttributeMapping": { - "markdownDescription": "A mapping of identity provider attributes to standard and custom user pool attributes\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A mapping of IdP attributes to standard and custom user pool attributes\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeMapping", "type": "object" }, @@ -38296,22 +38970,22 @@ "items": { "type": "string" }, - "markdownDescription": "A list of identity provider identifiers\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of IdP identifiers\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdpIdentifiers", "type": "array" }, "ProviderDetails": { - "markdownDescription": "The identity provider details\\. The following list describes the provider detail keys for each identity provider type\\. \n+ For Google and Login with Amazon:\n + client\\_id\n + client\\_secret\n + authorize\\_scopes\n+ For Facebook:\n + client\\_id\n + client\\_secret\n + authorize\\_scopes\n + api\\_version\n+ For Sign in with Apple:\n + client\\_id\n + team\\_id\n + key\\_id\n + private\\_key\n + authorize\\_scopes\n+ For OpenID Connect \\(OIDC\\) providers:\n + client\\_id\n + client\\_secret\n + attributes\\_request\\_method\n + oidc\\_issuer\n + authorize\\_scopes\n + authorize\\_url *if not available from discovery URL specified by oidc\\_issuer key* \n + token\\_url *if not available from discovery URL specified by oidc\\_issuer key* \n + attributes\\_url *if not available from discovery URL specified by oidc\\_issuer key* \n + jwks\\_uri *if not available from discovery URL specified by oidc\\_issuer key* \n + attributes\\_url\\_add\\_attributes *a read\\-only property that is set automatically* \n+ For SAML providers:\n + MetadataFile OR MetadataURL\n + IDPSignout \\(optional\\)\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The IdP details\\. The following list describes the provider detail keys for each IdP type\\. \n+ For Google and Login with Amazon:\n + client\\_id\n + client\\_secret\n + authorize\\_scopes\n+ For Facebook:\n + client\\_id\n + client\\_secret\n + authorize\\_scopes\n + api\\_version\n+ For Sign in with Apple:\n + client\\_id\n + team\\_id\n + key\\_id\n + private\\_key\n + authorize\\_scopes\n+ For OpenID Connect \\(OIDC\\) providers:\n + client\\_id\n + client\\_secret\n + attributes\\_request\\_method\n + oidc\\_issuer\n + authorize\\_scopes\n + The following keys are only present if Amazon Cognito didn't discover them at the `oidc_issuer` URL\\.\n + authorize\\_url \n + token\\_url \n + attributes\\_url \n + jwks\\_uri \n + Amazon Cognito sets the value of the following keys automatically\\. They are read\\-only\\.\n + attributes\\_url\\_add\\_attributes \n+ For SAML providers:\n + MetadataFile or MetadataURL\n + IDPSignout *optional* \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProviderDetails", "type": "object" }, "ProviderName": { - "markdownDescription": "The identity provider name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Pattern*: `[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The IdP name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `32` \n*Pattern*: `[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ProviderName", "type": "string" }, "ProviderType": { - "markdownDescription": "The identity provider type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Facebook | Google | LoginWithAmazon | OIDC | SAML | SignInWithApple` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The IdP type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Facebook | Google | LoginWithAmazon | OIDC | SAML | SignInWithApple` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ProviderType", "type": "string" }, @@ -38548,7 +39222,7 @@ "additionalProperties": false, "properties": { "EventAction": { - "markdownDescription": "The event action\\. \n+ `BLOCK` Choosing this action will block the request\\.\n+ `MFA_IF_CONFIGURED` Present an MFA challenge if user has configured it, else allow the request\\.\n+ `MFA_REQUIRED` Present an MFA challenge if user has configured it, else block the request\\.\n+ `NO_ACTION` Allow the user to sign in\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `BLOCK | MFA_IF_CONFIGURED | MFA_REQUIRED | NO_ACTION` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action to take in response to the account takeover action\\. Valid values are as follows: \n+ `BLOCK` Choosing this action will block the request\\.\n+ `MFA_IF_CONFIGURED` Present an MFA challenge if user has configured it, else allow the request\\.\n+ `MFA_REQUIRED` Present an MFA challenge if user has configured it, else block the request\\.\n+ `NO_ACTION` Allow the user to sign in\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `BLOCK | MFA_IF_CONFIGURED | MFA_REQUIRED | NO_ACTION` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventAction", "type": "string" }, @@ -39152,7 +39826,7 @@ }, "Source": { "$ref": "#/definitions/AWS::Config::ConfigRule.Source", - "markdownDescription": "Provides the rule owner \\(AWS or customer\\), the rule identifier, and the notifications that cause the function to evaluate your AWS resources\\. \n*Required*: Yes \n*Type*: [Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides the rule owner \\(` AWS ` for managed rules, `CUSTOM_POLICY` for Custom Policy rules, and `CUSTOM_LAMBDA` for Custom Lambda rules\\), the rule identifier, and the notifications that cause the function to evaluate your AWS resources\\. \n*Required*: Yes \n*Type*: [Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Source" } }, @@ -39186,12 +39860,18 @@ "additionalProperties": false, "properties": { "EnableDebugLogDelivery": { + "markdownDescription": "The boolean expression for enabling debug logging for your AWS Config Custom Policy rule\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableDebugLogDelivery", "type": "boolean" }, "PolicyRuntime": { + "markdownDescription": "The runtime system for your AWS Config Custom Policy rule\\. Guard is a policy\\-as\\-code language that allows you to write policies that are enforced by AWS Config Custom Policy rules\\. For more information about Guard, see the [Guard GitHub Repository](https://github.com/aws-cloudformation/cloudformation-guard)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `guard\\-2\\.x\\.x` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyRuntime", "type": "string" }, "PolicyText": { + "markdownDescription": "The policy definition containing the logic for your AWS Config Custom Policy rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyText", "type": "string" } }, @@ -39230,10 +39910,12 @@ "additionalProperties": false, "properties": { "CustomPolicyDetails": { - "$ref": "#/definitions/AWS::Config::ConfigRule.CustomPolicyDetails" + "$ref": "#/definitions/AWS::Config::ConfigRule.CustomPolicyDetails", + "markdownDescription": "Provides the runtime system, policy definition, and whether debug logging is enabled\\. Required when owner is set to `CUSTOM_POLICY`\\. \n*Required*: No \n*Type*: [CustomPolicyDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-custompolicydetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomPolicyDetails" }, "Owner": { - "markdownDescription": "Indicates whether AWS or the customer owns and manages the AWS Config rule\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AWS | CUSTOM_LAMBDA` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether AWS or the customer owns and manages the AWS Config rule\\. \n AWS Config Managed Rules are predefined rules owned by AWS\\. For more information, see [AWS Config Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) in the * AWS Config developer guide*\\. \n AWS Config Custom Rules are rules that you can develop either with Guard \\(`CUSTOM_POLICY`\\) or AWS Lambda \\(`CUSTOM_LAMBDA`\\)\\. For more information, see [AWS Config Custom Rules ](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html) in the * AWS Config developer guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AWS | CUSTOM_LAMBDA | CUSTOM_POLICY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Owner", "type": "string" }, @@ -39241,12 +39923,12 @@ "items": { "$ref": "#/definitions/AWS::Config::ConfigRule.SourceDetail" }, - "markdownDescription": "Provides the source and type of the event that causes AWS Config to evaluate your AWS resources\\. \n*Required*: No \n*Type*: List of [SourceDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source-sourcedetails.html) \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides the source and the message types that cause AWS Config to evaluate your AWS resources against a rule\\. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic\\. \nIf the owner is set to `CUSTOM_POLICY`, the only acceptable values for the AWS Config rule trigger message type are `ConfigurationItemChangeNotification` and `OversizedConfigurationItemChangeNotification`\\. \n*Required*: No \n*Type*: List of [SourceDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source-sourcedetails.html) \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceDetails", "type": "array" }, "SourceIdentifier": { - "markdownDescription": "For AWS Config managed rules, a predefined identifier from a list\\. For example, `IAM_PASSWORD_POLICY` is a managed rule\\. To reference a managed rule, see [Using AWS Config managed rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html)\\. \nFor custom rules, the identifier is the Amazon Resource Name \\(ARN\\) of the rule's AWS Lambda function, such as `arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "For AWS Config Managed rules, a predefined identifier from a list\\. For example, `IAM_PASSWORD_POLICY` is a managed rule\\. To reference a managed rule, see [List of AWS Config Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html)\\. \nFor AWS Config Custom Lambda rules, the identifier is the Amazon Resource Name \\(ARN\\) of the rule's AWS Lambda function, such as `arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name`\\. \nFor AWS Config Custom Policy rules, this field will be ignored\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceIdentifier", "type": "string" } @@ -39592,7 +40274,9 @@ "type": "string" }, "TemplateSSMDocumentDetails": { - "$ref": "#/definitions/AWS::Config::ConformancePack.TemplateSSMDocumentDetails" + "$ref": "#/definitions/AWS::Config::ConformancePack.TemplateSSMDocumentDetails", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [TemplateSSMDocumentDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TemplateSSMDocumentDetails" } }, "required": [ @@ -39645,9 +40329,13 @@ "additionalProperties": false, "properties": { "DocumentName": { + "markdownDescription": "The name or Amazon Resource Name \\(ARN\\) of the SSM document to use to create a conformance pack\\. If you use the document name, AWS Config checks only your account and AWS Region for the SSM document\\. If you want to use an SSM document from another Region or account, you must provide the ARN\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,200}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DocumentName", "type": "string" }, "DocumentVersion": { + "markdownDescription": "The version of the SSM document to use to create a conformance pack\\. By default, AWS Config uses the latest version\\. \nThis field is optional\\.\n*Required*: No \n*Type*: String \n*Pattern*: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DocumentVersion", "type": "string" } }, @@ -39699,12 +40387,12 @@ "type": "string" }, "S3BucketName": { - "markdownDescription": "The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files\\. \nIf you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config\\. For more information, see [Permissions for the Amazon S3 Bucket](https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html) in the AWS Config Developer Guide\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files\\. \nIf you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config\\. For more information, see [Permissions for the Amazon S3 Bucket](https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html) in the * AWS Config Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3BucketName", "type": "string" }, "S3KeyPrefix": { - "markdownDescription": "The prefix for the specified Amazon S3 bucket\\. Do not include 'AWSLogs/' in your value as it is prepended automatically\\. Ex: BucketName/S3KeyPrefix/AWSLogs/sourceAccountID/Config/Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The prefix for the specified Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3KeyPrefix", "type": "string" }, @@ -39714,7 +40402,7 @@ "type": "string" }, "SnsTopicARN": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes\\. \nIf you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config\\. For more information, see [Permissions for the Amazon SNS Topic](https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html) in the AWS Config Developer Guide\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes\\. \nIf you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config\\. For more information, see [Permissions for the Amazon SNS Topic](https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html) in the * AWS Config Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SnsTopicARN", "type": "string" } @@ -39795,17 +40483,19 @@ "items": { "type": "string" }, - "markdownDescription": "A comma\\-separated list of accounts excluded from organization config rule\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A comma\\-separated list of accounts excluded from organization AWS Config rule\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExcludedAccounts", "type": "array" }, "OrganizationConfigRuleName": { - "markdownDescription": "The name that you assign to organization config rule\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name that you assign to organization AWS Config rule\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "OrganizationConfigRuleName", "type": "string" }, "OrganizationCustomPolicyRuleMetadata": { - "$ref": "#/definitions/AWS::Config::OrganizationConfigRule.OrganizationCustomPolicyRuleMetadata" + "$ref": "#/definitions/AWS::Config::OrganizationConfigRule.OrganizationCustomPolicyRuleMetadata", + "markdownDescription": "An object that specifies metadata for your organization's AWS Config Custom Policy rule\\. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of AWS resource, and organization trigger types that initiate AWS Config to evaluate AWS resources against a rule\\. \n*Required*: No \n*Type*: [OrganizationCustomPolicyRuleMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationCustomPolicyRuleMetadata" }, "OrganizationCustomRuleMetadata": { "$ref": "#/definitions/AWS::Config::OrganizationConfigRule.OrganizationCustomRuleMetadata", @@ -39851,42 +40541,64 @@ "items": { "type": "string" }, + "markdownDescription": "A list of accounts that you can enable debug logging for your organization AWS Config Custom Policy rule\\. List is null when debug logging is enabled for all accounts\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DebugLogDeliveryAccounts", "type": "array" }, "Description": { + "markdownDescription": "The description that you provide for your organization AWS Config Custom Policy rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "InputParameters": { + "markdownDescription": "A string, in JSON format, that is passed to your organization AWS Config Custom Policy rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputParameters", "type": "string" }, "MaximumExecutionFrequency": { + "markdownDescription": "The maximum frequency with which AWS Config runs evaluations for a rule\\. Your AWS Config Custom Policy rule is triggered when AWS Config delivers the configuration snapshot\\. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-configsnapshotdeliveryproperties)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `One_Hour | Six_Hours | Three_Hours | Twelve_Hours | TwentyFour_Hours` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumExecutionFrequency", "type": "string" }, "OrganizationConfigRuleTriggerTypes": { "items": { "type": "string" }, + "markdownDescription": "The type of notification that initiates AWS Config to run an evaluation for a rule\\. For AWS Config Custom Policy rules, AWS Config supports change\\-initiated notification types: \n+ `ConfigurationItemChangeNotification` \\- Initiates an evaluation when AWS Config delivers a configuration item as a result of a resource change\\.\n+ `OversizedConfigurationItemChangeNotification` \\- Initiates an evaluation when AWS Config delivers an oversized configuration item\\. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationConfigRuleTriggerTypes", "type": "array" }, "PolicyText": { + "markdownDescription": "The policy definition containing the logic for your organization AWS Config Custom Policy rule\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyText", "type": "string" }, "ResourceIdScope": { + "markdownDescription": "The ID of the AWS resource that was evaluated\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `768` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceIdScope", "type": "string" }, "ResourceTypesScope": { "items": { "type": "string" }, + "markdownDescription": "The type of the AWS resource that was evaluated\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceTypesScope", "type": "array" }, "Runtime": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Runtime", "type": "string" }, "TagKeyScope": { + "markdownDescription": "One part of a key\\-value pair that make up a tag\\. A key is a general label that acts like a category for more specific tag values\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TagKeyScope", "type": "string" }, "TagValueScope": { + "markdownDescription": "The optional part of a key\\-value pair that make up a tag\\. A value acts as a descriptor within a tag category \\(key\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TagValueScope", "type": "string" } }, @@ -39900,12 +40612,12 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "The description that you provide for organization config rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description that you provide for your organization AWS Config rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "InputParameters": { - "markdownDescription": "A string, in JSON format, that is passed to organization config rule Lambda function\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string, in JSON format, that is passed to your organization AWS Config rule Lambda function\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InputParameters", "type": "string" }, @@ -39961,17 +40673,17 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "The description that you provide for organization config rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description that you provide for your organization AWS Config rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "InputParameters": { - "markdownDescription": "A string, in JSON format, that is passed to organization config rule Lambda function\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string, in JSON format, that is passed to your organization AWS Config rule Lambda function\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InputParameters", "type": "string" }, "MaximumExecutionFrequency": { - "markdownDescription": "The maximum frequency with which AWS Config runs evaluations for a rule\\. You are using an AWS Config managed rule that is triggered at a periodic frequency\\. \nBy default, rules with a periodic trigger are evaluated every 24 hours\\. To change the frequency, specify a valid value for the `MaximumExecutionFrequency` parameter\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `One_Hour | Six_Hours | Three_Hours | Twelve_Hours | TwentyFour_Hours` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum frequency with which AWS Config runs evaluations for a rule\\. This is for an AWS Config managed rule that is triggered at a periodic frequency\\. \nBy default, rules with a periodic trigger are evaluated every 24 hours\\. To change the frequency, specify a valid value for the `MaximumExecutionFrequency` parameter\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `One_Hour | Six_Hours | Three_Hours | Twelve_Hours | TwentyFour_Hours` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaximumExecutionFrequency", "type": "string" }, @@ -40188,7 +40900,7 @@ "type": "number" }, "Parameters": { - "markdownDescription": "An object of the RemediationParameterValue\\. \nThe type is a map of strings to RemediationParameterValue\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An object of the RemediationParameterValue\\. For more information, see [RemediationParameterValue](https://docs.aws.amazon.com/config/latest/APIReference/API_RemediationParameterValue.html)\\. \nThe type is a map of strings to RemediationParameterValue\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Parameters", "type": "object" }, @@ -40436,9 +41148,13 @@ "additionalProperties": false, "properties": { "InstanceId": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Minimum*: `1` \n*Maximum*: `100` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InstanceId", "type": "string" }, "Origin": { + "markdownDescription": "Domain name to be added to the allow\\-list of the instance\\. \n*Maximum*: `267` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Origin", "type": "string" } }, @@ -40505,12 +41221,12 @@ "additionalProperties": false, "properties": { "Content": { - "markdownDescription": "The content of the contact flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The content of the flow\\. \nFor more information, see [Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html) in the *Amazon Connect Administrator Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Content", "type": "string" }, "Description": { - "markdownDescription": "The description of the contact flow\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the flow\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -40520,12 +41236,12 @@ "type": "string" }, "Name": { - "markdownDescription": "The name of the contact flow\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the flow\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "State": { - "markdownDescription": "The state of the contact flow\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | ARCHIVED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The state of the flow\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | ARCHIVED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "State", "type": "string" }, @@ -40538,7 +41254,7 @@ "type": "array" }, "Type": { - "markdownDescription": "The type of the contact flow\\. For descriptions of the available types, see [Choose a Contact Flow Type](https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) in the *Amazon Connect Administrator Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AGENT_HOLD | AGENT_TRANSFER | AGENT_WHISPER | CONTACT_FLOW | CUSTOMER_HOLD | CUSTOMER_QUEUE | CUSTOMER_WHISPER | OUTBOUND_WHISPER | QUEUE_TRANSFER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of the flow\\. For descriptions of the available types, see [Choose a flow type](https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) in the *Amazon Connect Administrator Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AGENT_HOLD | AGENT_TRANSFER | AGENT_WHISPER | CONTACT_FLOW | CUSTOMER_HOLD | CUSTOMER_QUEUE | CUSTOMER_WHISPER | OUTBOUND_WHISPER | QUEUE_TRANSFER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -40608,12 +41324,12 @@ "additionalProperties": false, "properties": { "Content": { - "markdownDescription": "The content of the contact flow module\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The content of the flow module\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Content", "type": "string" }, "Description": { - "markdownDescription": "The description of the contact flow module\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the flow module\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -40623,12 +41339,12 @@ "type": "string" }, "Name": { - "markdownDescription": "The name of the contact flow module\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `127` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the flow module\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `127` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "State": { - "markdownDescription": "The state of the contact flow module\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | ARCHIVED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The state of the flow module\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | ARCHIVED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "State", "type": "string" }, @@ -40731,7 +41447,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -40852,15 +41568,23 @@ "additionalProperties": false, "properties": { "Attributes": { - "$ref": "#/definitions/AWS::Connect::Instance.Attributes" + "$ref": "#/definitions/AWS::Connect::Instance.Attributes", + "markdownDescription": "A toggle for an individual feature at the instance level\\. \n*Required*: Yes \n*Type*: [Attributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instance-attributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Attributes" }, "DirectoryId": { + "markdownDescription": "The identifier for the directory\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DirectoryId", "type": "string" }, "IdentityManagementType": { + "markdownDescription": "The identity management type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONNECT_MANAGED | EXISTING_DIRECTORY | SAML` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IdentityManagementType", "type": "string" }, "InstanceAlias": { + "markdownDescription": "The alias of instance\\. `InstanceAlias` is only required when `IdentityManagementType` is `CONNECT_MANAGED` or `SAML`\\. `InstanceAlias` is not required when `IdentityManagementType` is `EXISTING_DIRECTORY`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `62` \n*Pattern*: `^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InstanceAlias", "type": "string" } }, @@ -40895,24 +41619,38 @@ "additionalProperties": false, "properties": { "AutoResolveBestVoices": { + "markdownDescription": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoResolveBestVoices", "type": "boolean" }, "ContactLens": { + "markdownDescription": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContactLens", "type": "boolean" }, "ContactflowLogs": { + "markdownDescription": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContactflowLogs", "type": "boolean" }, "EarlyMedia": { + "markdownDescription": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EarlyMedia", "type": "boolean" }, "InboundCalls": { + "markdownDescription": "*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InboundCalls", "type": "boolean" }, "OutboundCalls": { + "markdownDescription": "*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OutboundCalls", "type": "boolean" }, "UseCustomTTSVoices": { + "markdownDescription": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseCustomTTSVoices", "type": "boolean" } }, @@ -40958,24 +41696,38 @@ "additionalProperties": false, "properties": { "InstanceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InstanceArn", "type": "string" }, "KinesisFirehoseConfig": { - "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.KinesisFirehoseConfig" + "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.KinesisFirehoseConfig", + "markdownDescription": "The configuration of the Kinesis Firehose delivery stream\\. \n*Required*: No \n*Type*: [KinesisFirehoseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisfirehoseconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KinesisFirehoseConfig" }, "KinesisStreamConfig": { - "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.KinesisStreamConfig" + "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.KinesisStreamConfig", + "markdownDescription": "The configuration of the Kinesis data stream\\. \n*Required*: No \n*Type*: [KinesisStreamConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisstreamconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KinesisStreamConfig" }, "KinesisVideoStreamConfig": { - "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.KinesisVideoStreamConfig" + "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.KinesisVideoStreamConfig", + "markdownDescription": "The configuration of the Kinesis video stream\\. \n*Required*: No \n*Type*: [KinesisVideoStreamConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisvideostreamconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KinesisVideoStreamConfig" }, "ResourceType": { + "markdownDescription": "A valid resource type\\. Following are the valid resource types: `CHAT_TRANSCRIPTS` \\| `CALL_RECORDINGS` \\| `SCHEDULED_REPORTS` \\| `MEDIA_STREAMS` \\| `CONTACT_TRACE_RECORDS` \\| `AGENT_EVENTS` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceType", "type": "string" }, "S3Config": { - "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.S3Config" + "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.S3Config", + "markdownDescription": "The S3 bucket configuration\\. \n*Required*: No \n*Type*: [S3Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-s3config.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3Config" }, "StorageType": { + "markdownDescription": "A valid storage type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KINESIS_FIREHOSE | KINESIS_STREAM | KINESIS_VIDEO_STREAM | S3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageType", "type": "string" } }, @@ -41011,9 +41763,13 @@ "additionalProperties": false, "properties": { "EncryptionType": { + "markdownDescription": "The type of encryption\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionType", "type": "string" }, "KeyId": { + "markdownDescription": "The full ARN of the encryption key\\. \nBe sure to provide the full ARN of the encryption key, not just the ID\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KeyId", "type": "string" } }, @@ -41027,6 +41783,8 @@ "additionalProperties": false, "properties": { "FirehoseArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the delivery stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FirehoseArn", "type": "string" } }, @@ -41039,6 +41797,8 @@ "additionalProperties": false, "properties": { "StreamArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the data stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StreamArn", "type": "string" } }, @@ -41051,12 +41811,18 @@ "additionalProperties": false, "properties": { "EncryptionConfig": { - "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.EncryptionConfig" + "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.EncryptionConfig", + "markdownDescription": "The encryption configuration\\. \n*Required*: No \n*Type*: [EncryptionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-encryptionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionConfig" }, "Prefix": { + "markdownDescription": "The prefix of the video stream\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Prefix", "type": "string" }, "RetentionPeriodHours": { + "markdownDescription": "The number of hours data is retained in the stream\\. Kinesis Video Streams retains the data in a data store that is associated with the stream\\. \nThe default value is 0, indicating that the stream does not persist data\\. \n*Required*: Yes \n*Type*: Double \n*Minimum*: `0` \n*Maximum*: `87600` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetentionPeriodHours", "type": "number" } }, @@ -41070,13 +41836,19 @@ "additionalProperties": false, "properties": { "BucketName": { + "markdownDescription": "The S3 bucket name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketName", "type": "string" }, "BucketPrefix": { + "markdownDescription": "The S3 bucket prefix\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketPrefix", "type": "string" }, "EncryptionConfig": { - "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.EncryptionConfig" + "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.EncryptionConfig", + "markdownDescription": "The Amazon S3 encryption configuration\\. \n*Required*: No \n*Type*: [EncryptionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-encryptionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionConfig" } }, "required": [ @@ -41121,12 +41893,18 @@ "additionalProperties": false, "properties": { "InstanceId": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Minimum*: `1` \n*Maximum*: `100` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InstanceId", "type": "string" }, "IntegrationArn": { + "markdownDescription": "ARN of the integration being associated with the instance\\. \n*Minimum*: `1` \n*Maximum*: `140` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IntegrationArn", "type": "string" }, "IntegrationType": { + "markdownDescription": "Specifies the integration type to be associated with the instance\\. \n*Allowed Values*: `LEX_BOT` \\| `LAMBDA_FUNCTION` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IntegrationType", "type": "string" } }, @@ -41194,24 +41972,36 @@ "additionalProperties": false, "properties": { "CountryCode": { + "markdownDescription": "The ISO country code\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AD | AE | AF | AG | AI | AL | AM | AN | AO | AQ | AR | AS | AT | AU | AW | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BR | BS | BT | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GG | GH | GI | GL | GM | GN | GQ | GR | GT | GU | GW | GY | HK | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | ST | SV | SX | SY | SZ | TC | TD | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CountryCode", "type": "string" }, "Description": { + "markdownDescription": "The description of the phone number\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `^[\\W\\S_]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Description", "type": "string" }, "Prefix": { + "markdownDescription": "The prefix of the phone number\\. If provided, it must contain `+` as part of the country code\\. \n*Pattern*: `^\\\\+[0-9]{1,15}` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Prefix", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TargetArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for Amazon Connect instances or traffic distribution group that phone numbers are claimed to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetArn", "type": "string" }, "Type": { + "markdownDescription": "The type of phone number\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DID | TOLL_FREE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -41302,7 +42092,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -41339,7 +42129,7 @@ "additionalProperties": false, "properties": { "PhoneNumber": { - "markdownDescription": "The phone number in E\\.164 format\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The phone number in E\\.164 format\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\\\+[1-9]\\\\d{1,14}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PhoneNumber", "type": "string" } @@ -41353,7 +42143,7 @@ "additionalProperties": false, "properties": { "ContactFlowArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the contact flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContactFlowArn", "type": "string" }, @@ -41402,7 +42192,7 @@ "additionalProperties": false, "properties": { "ContactFlowArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the contact flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContactFlowArn", "type": "string" }, @@ -41454,28 +42244,42 @@ "additionalProperties": false, "properties": { "Actions": { - "$ref": "#/definitions/AWS::Connect::Rule.Actions" + "$ref": "#/definitions/AWS::Connect::Rule.Actions", + "markdownDescription": "A list of actions to be run when the rule is triggered\\. \n*Required*: Yes \n*Type*: [Actions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-actions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Actions" }, "Function": { + "markdownDescription": "The conditions of the rule\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Function", "type": "string" }, "InstanceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InstanceArn", "type": "string" }, "Name": { + "markdownDescription": "The name of the rule\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "PublishStatus": { + "markdownDescription": "The publish status of the rule\\. \n*Allowed values*: `DRAFT` \\| `PUBLISHED` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PublishStatus", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TriggerEventSource": { - "$ref": "#/definitions/AWS::Connect::Rule.RuleTriggerEventSource" + "$ref": "#/definitions/AWS::Connect::Rule.RuleTriggerEventSource", + "markdownDescription": "The event source to trigger the rule\\. \n*Required*: Yes \n*Type*: [RuleTriggerEventSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-ruletriggereventsource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TriggerEventSource" } }, "required": [ @@ -41516,24 +42320,32 @@ "items": { "type": "object" }, + "markdownDescription": "Information about the contact category action\\. The syntax can be empty, for example, `{}`\\. \n*Required*: No \n*Type*: List of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssignContactCategoryActions", "type": "array" }, "EventBridgeActions": { "items": { "$ref": "#/definitions/AWS::Connect::Rule.EventBridgeAction" }, + "markdownDescription": "Information about the EventBridge action\\. \n*Required*: No \n*Type*: List of [EventBridgeAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-eventbridgeaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventBridgeActions", "type": "array" }, "SendNotificationActions": { "items": { "$ref": "#/definitions/AWS::Connect::Rule.SendNotificationAction" }, + "markdownDescription": "Information about the send notification action\\. \n*Required*: No \n*Type*: List of [SendNotificationAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-sendnotificationaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SendNotificationActions", "type": "array" }, "TaskActions": { "items": { "$ref": "#/definitions/AWS::Connect::Rule.TaskAction" }, + "markdownDescription": "Information about the task action\\. This field is required if `TriggerEventSource` is one of the following values: `OnZendeskTicketCreate` \\| `OnZendeskTicketStatusUpdate` \\| `OnSalesforceCaseCreate` \n*Required*: No \n*Type*: List of [TaskAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-taskaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TaskActions", "type": "array" } }, @@ -41543,6 +42355,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -41558,15 +42372,19 @@ "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the user account\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserArns", "type": "array" }, "UserTags": { "additionalProperties": true, + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. Amazon Connect users with the specified tags will be notified\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "UserTags", "type": "object" } }, @@ -41576,9 +42394,13 @@ "additionalProperties": false, "properties": { "Type": { + "markdownDescription": "The type of the reference\\. `DATE` must be of type Epoch timestamp\\. \n*Allowed values*: `URL` \\| `ATTACHMENT` \\| `NUMBER` \\| `STRING` \\| `DATE` \\| `EMAIL` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "Value": { + "markdownDescription": "A valid value for the reference\\. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel \\(CCP\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -41592,9 +42414,13 @@ "additionalProperties": false, "properties": { "EventSourceName": { + "markdownDescription": "The name of the event source\\. \n*Allowed values*: `OnPostCallAnalysisAvailable` \\| `OnRealTimeCallAnalysisAvailable` \\| `OnPostChatAnalysisAvailable` \\| `OnZendeskTicketCreate` \\| `OnZendeskTicketStatusUpdate` \\| `OnSalesforceCaseCreate` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EventSourceName", "type": "string" }, "IntegrationAssociationArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the integration association\\. `IntegrationAssociationArn` is required if `TriggerEventSource` is one of the following values: `OnZendeskTicketCreate` \\| `OnZendeskTicketStatusUpdate` \\| `OnSalesforceCaseCreate` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IntegrationAssociationArn", "type": "string" } }, @@ -41607,18 +42433,28 @@ "additionalProperties": false, "properties": { "Content": { + "markdownDescription": "Notification content\\. Supports variable injection\\. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Content", "type": "string" }, "ContentType": { + "markdownDescription": "Content type format\\. \n*Allowed value*: `PLAIN_TEXT` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContentType", "type": "string" }, "DeliveryMethod": { + "markdownDescription": "Notification delivery method\\. \n*Allowed value*: `EMAIL` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeliveryMethod", "type": "string" }, "Recipient": { - "$ref": "#/definitions/AWS::Connect::Rule.NotificationRecipientType" + "$ref": "#/definitions/AWS::Connect::Rule.NotificationRecipientType", + "markdownDescription": "Notification recipient\\. \n*Required*: Yes \n*Type*: [NotificationRecipientType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-notificationrecipienttype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Recipient" }, "Subject": { + "markdownDescription": "The subject of the email if the delivery method is `EMAIL`\\. Supports variable injection\\. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Subject", "type": "string" } }, @@ -41634,21 +42470,29 @@ "additionalProperties": false, "properties": { "ContactFlowArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContactFlowArn", "type": "string" }, "Description": { + "markdownDescription": "The description\\. Supports variable injection\\. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name\\. Supports variable injection\\. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "References": { "additionalProperties": false, + "markdownDescription": "Information about the reference when the `referenceType` is `URL`\\. Otherwise, null\\. `URL` is the only accepted type\\. \\(Supports variable injection in the `Value` field\\.\\) \n*Required*: No \n*Type*: Map of [Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-reference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::Connect::Rule.Reference" } }, + "title": "References", "type": "object" } }, @@ -41694,9 +42538,13 @@ "additionalProperties": false, "properties": { "InstanceId": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Minimum*: `1` \n*Maximum*: `100` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InstanceId", "type": "string" }, "Key": { + "markdownDescription": "A valid security key in PEM format\\. \n*Minimum*: `1` \n*Maximum*: `1024` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" } }, @@ -41763,42 +42611,62 @@ "additionalProperties": false, "properties": { "ClientToken": { + "markdownDescription": "A unique, case\\-sensitive identifier that you provide to ensure the idempotency of the request\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientToken", "type": "string" }, "Constraints": { - "$ref": "#/definitions/AWS::Connect::TaskTemplate.Constraints" + "$ref": "#/definitions/AWS::Connect::TaskTemplate.Constraints", + "markdownDescription": "Constraints that are applicable to the fields listed\\. \nThe values can be represented in either JSON or YAML format\\. For an example of the JSON configuration, see *Examples* at the bottom of this page\\. \n*Required*: No \n*Type*: [Constraints](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-constraints.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Constraints" }, "ContactFlowArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow that runs by default when a task is created by referencing this template\\. `ContactFlowArn` is not required when there is a field with `fieldType` = `QUICK_CONNECT`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContactFlowArn", "type": "string" }, "Defaults": { "items": { "$ref": "#/definitions/AWS::Connect::TaskTemplate.DefaultFieldValue" }, + "markdownDescription": "The default values for fields when a task is created by referencing this template\\. \n*Required*: No \n*Type*: List of [DefaultFieldValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-defaultfieldvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Defaults", "type": "array" }, "Description": { + "markdownDescription": "The description of the task template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Fields": { "items": { "$ref": "#/definitions/AWS::Connect::TaskTemplate.Field" }, + "markdownDescription": "Fields that are part of the template\\. A template requires at least one field that has type `Name`\\. \n*Required*: No \n*Type*: List of [Field](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-field.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Fields", "type": "array" }, "InstanceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon Connect instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InstanceArn", "type": "string" }, "Name": { + "markdownDescription": "The name of the task template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Status": { + "markdownDescription": "The status of the task template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -41835,18 +42703,24 @@ "items": { "$ref": "#/definitions/AWS::Connect::TaskTemplate.InvisibleFieldInfo" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [InvisibleFieldInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-invisiblefieldinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InvisibleFields", "type": "array" }, "ReadOnlyFields": { "items": { "$ref": "#/definitions/AWS::Connect::TaskTemplate.ReadOnlyFieldInfo" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ReadOnlyFieldInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-readonlyfieldinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReadOnlyFields", "type": "array" }, "RequiredFields": { "items": { "$ref": "#/definitions/AWS::Connect::TaskTemplate.RequiredFieldInfo" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [RequiredFieldInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-requiredfieldinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RequiredFields", "type": "array" } }, @@ -41856,10 +42730,14 @@ "additionalProperties": false, "properties": { "DefaultValue": { + "markdownDescription": "Default value for the field\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultValue", "type": "string" }, "Id": { - "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier" + "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier", + "markdownDescription": "Identifier of a field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id" } }, "required": [ @@ -41872,18 +42750,26 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Id": { - "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier" + "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier", + "markdownDescription": "The unique identifier for the field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id" }, "SingleSelectOptions": { "items": { "type": "string" }, + "markdownDescription": "A list of options for a single select field\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SingleSelectOptions", "type": "array" }, "Type": { + "markdownDescription": "Indicates the type of field\\. Following are the valid field types: `NAME` `DESCRIPTION` \\| `SCHEDULED_TIME` \\| `QUICK_CONNECT` \\| `URL` \\| `NUMBER` \\| `TEXT` \\| `TEXT_AREA` \\| `DATE_TIME` \\| `BOOLEAN` \\| `SINGLE_SELECT` \\| `EMAIL` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -41897,6 +42783,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the task template field\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -41909,7 +42797,9 @@ "additionalProperties": false, "properties": { "Id": { - "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier" + "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier", + "markdownDescription": "Identifier of the invisible field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id" } }, "required": [ @@ -41921,7 +42811,9 @@ "additionalProperties": false, "properties": { "Id": { - "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier" + "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier", + "markdownDescription": "Identifier of the read\\-only field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id" } }, "required": [ @@ -41933,7 +42825,9 @@ "additionalProperties": false, "properties": { "Id": { - "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier" + "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier", + "markdownDescription": "The unique identifier for the field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id" } }, "required": [ @@ -42082,9 +42976,13 @@ "type": "string" }, "Mobile": { + "markdownDescription": "The user's mobile number\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\\\+[1-9]\\\\d{1,14}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Mobile", "type": "string" }, "SecondaryEmail": { + "markdownDescription": "The user's secondary email address\\. If you provide a secondary email, the user receives email notifications \\-\\- other than password reset notifications \\-\\- to this email address instead of to their primary email address\\. \n*Pattern*: `(?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecondaryEmail", "type": "string" } }, @@ -42094,7 +42992,7 @@ "additionalProperties": false, "properties": { "AfterContactWorkTimeLimit": { - "markdownDescription": "The After Call Work \\(ACW\\) timeout setting, in seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The After Call Work \\(ACW\\) timeout setting, in seconds\\. \nWhen returned by a `SearchUsers` call, `AfterContactWorkTimeLimit` is returned in milliseconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AfterContactWorkTimeLimit", "type": "number" }, @@ -42104,7 +43002,7 @@ "type": "boolean" }, "DeskPhoneNumber": { - "markdownDescription": "The phone number for the user's desk phone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The phone number for the user's desk phone\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\\\+[1-9]\\\\d{1,14}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeskPhoneNumber", "type": "string" }, @@ -42233,21 +43131,31 @@ "additionalProperties": false, "properties": { "ConnectInstanceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon Connect instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConnectInstanceArn", "type": "string" }, "DialerConfig": { - "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.DialerConfig" + "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.DialerConfig", + "markdownDescription": "Contains information about the dialer configuration\\. \n*Required*: Yes \n*Type*: [DialerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-dialerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DialerConfig" }, "Name": { + "markdownDescription": "The name of the campaign\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "OutboundCallConfig": { - "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.OutboundCallConfig" + "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.OutboundCallConfig", + "markdownDescription": "Contains information about the outbound call configuration\\. \n*Required*: Yes \n*Type*: [OutboundCallConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-outboundcallconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OutboundCallConfig" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -42284,6 +43192,8 @@ "additionalProperties": false, "properties": { "EnableAnswerMachineDetection": { + "markdownDescription": "Whether answering machine detection is enabled\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableAnswerMachineDetection", "type": "boolean" } }, @@ -42296,10 +43206,14 @@ "additionalProperties": false, "properties": { "PredictiveDialerConfig": { - "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.PredictiveDialerConfig" + "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.PredictiveDialerConfig", + "markdownDescription": "The configuration of the predictive dialer\\. \n*Required*: No \n*Type*: [PredictiveDialerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-predictivedialerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PredictiveDialerConfig" }, "ProgressiveDialerConfig": { - "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.ProgressiveDialerConfig" + "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.ProgressiveDialerConfig", + "markdownDescription": "The configuration of the progressive dialer\\. \n*Required*: No \n*Type*: [ProgressiveDialerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-progressivedialerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ProgressiveDialerConfig" } }, "type": "object" @@ -42308,15 +43222,23 @@ "additionalProperties": false, "properties": { "AnswerMachineDetectionConfig": { - "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.AnswerMachineDetectionConfig" + "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.AnswerMachineDetectionConfig", + "markdownDescription": "Whether answering machine detection has been enabled\\. \n*Required*: No \n*Type*: [AnswerMachineDetectionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-answermachinedetectionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AnswerMachineDetectionConfig" }, "ConnectContactFlowArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectContactFlowArn", "type": "string" }, "ConnectQueueArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the queue\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectQueueArn", "type": "string" }, "ConnectSourcePhoneNumber": { + "markdownDescription": "The phone number associated with the outbound call\\. This is the caller ID that is displayed to customers when an agent calls them\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectSourcePhoneNumber", "type": "string" } }, @@ -42330,6 +43252,8 @@ "additionalProperties": false, "properties": { "BandwidthAllocation": { + "markdownDescription": "Bandwidth allocation for the predictive dialer\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BandwidthAllocation", "type": "number" } }, @@ -42342,6 +43266,8 @@ "additionalProperties": false, "properties": { "BandwidthAllocation": { + "markdownDescription": "Bandwidth allocation for the progressive dialer\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BandwidthAllocation", "type": "number" } }, @@ -42386,9 +43312,13 @@ "additionalProperties": false, "properties": { "ControlIdentifier": { + "markdownDescription": "The ARN of the control\\. Only **Strongly recommended** and **Elective** controls are permitted, with the exception of the **Region deny** guardrail\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ControlIdentifier", "type": "string" }, "TargetIdentifier": { + "markdownDescription": "The ARN of the organizational unit\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TargetIdentifier", "type": "string" } }, @@ -42551,7 +43481,7 @@ }, "FlowDefinition": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.FlowDefinition", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [FlowDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The configuration that controls how Customer Profiles retrieves data from the source\\. \n*Required*: No \n*Type*: [FlowDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FlowDefinition" }, "ObjectTypeName": { @@ -42563,7 +43493,7 @@ "items": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.ObjectTypeMapping" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [ObjectTypeMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object type mapping\\. \n*Required*: No \n*Type*: List of [ObjectTypeMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ObjectTypeNames", "type": "array" }, @@ -42611,27 +43541,27 @@ "additionalProperties": false, "properties": { "Marketo": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided Marketo source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | DIVISION | GREATER_THAN | LESS_THAN | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Marketo", "type": "string" }, "S3": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided Amazon S3 source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3", "type": "string" }, "Salesforce": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided Salesforce source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Salesforce", "type": "string" }, "ServiceNow": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided ServiceNow source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceNow", "type": "string" }, "Zendesk": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided Zendesk source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | DIVISION | GREATER_THAN | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Zendesk", "type": "string" } @@ -42642,36 +43572,36 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description of the flow you want to create\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `[\\w!@#\\-.?,\\s]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "FlowName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The specified name of the flow\\. Use underscores \\(\\_\\) or hyphens \\(\\-\\) only\\. Spaces are not allowed\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9][\\w!@#.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FlowName", "type": "string" }, "KmsArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS Key Management Service \\(KMS\\) key you provide for encryption\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:aws:kms:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KmsArn", "type": "string" }, "SourceFlowConfig": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.SourceFlowConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [SourceFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The configuration that controls how Customer Profiles retrieves data from the source\\. \n*Required*: Yes \n*Type*: [SourceFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceFlowConfig" }, "Tasks": { "items": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.Task" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: List of [Task](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of tasks that Customer Profiles performs while transferring the data in the flow run\\. \n*Required*: Yes \n*Type*: List of [Task](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tasks", "type": "array" }, "TriggerConfig": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.TriggerConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [TriggerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The trigger settings that determine how and when the flow runs\\. \n*Required*: Yes \n*Type*: [TriggerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TriggerConfig" } }, @@ -42688,7 +43618,7 @@ "additionalProperties": false, "properties": { "DatetimeTypeFieldName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DatetimeTypeFieldName", "type": "string" } @@ -42699,7 +43629,7 @@ "additionalProperties": false, "properties": { "Object": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object specified in the Marketo flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Object", "type": "string" } @@ -42713,12 +43643,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Value": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -42733,12 +43663,12 @@ "additionalProperties": false, "properties": { "BucketName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon S3 bucket name where the source files are stored\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BucketName", "type": "string" }, "BucketPrefix": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object key for the Amazon S3 bucket in which the source files are stored\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BucketPrefix", "type": "string" } @@ -42752,17 +43682,17 @@ "additionalProperties": false, "properties": { "EnableDynamicFieldUpdate": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The flag that enables dynamic fetching of new \\(recently added\\) fields in the Salesforce objects while running a flow\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableDynamicFieldUpdate", "type": "boolean" }, "IncludeDeletedRecords": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether Amazon AppFlow includes deleted files in the flow run\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeDeletedRecords", "type": "boolean" }, "Object": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object specified in the Salesforce flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Object", "type": "string" } @@ -42776,37 +43706,37 @@ "additionalProperties": false, "properties": { "DataPullMode": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Complete | Incremental` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataPullMode", "type": "string" }, "FirstExecutionFrom": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the date range for the records to import from the connector in the first flow run\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FirstExecutionFrom", "type": "number" }, "ScheduleEndTime": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the scheduled end time for a scheduled\\-trigger flow\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleEndTime", "type": "number" }, "ScheduleExpression": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The scheduling expression that determines the rate at which the schedule will run, for example rate \\(5 minutes\\)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleExpression", "type": "string" }, "ScheduleOffset": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the optional offset that is added to the time interval for a schedule\\-triggered flow\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleOffset", "type": "number" }, "ScheduleStartTime": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the scheduled start time for a scheduled\\-trigger flow\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleStartTime", "type": "number" }, "Timezone": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the time zone used when referring to the date and time of a scheduled\\-triggered flow, such as America/New\\_York\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Timezone", "type": "string" } @@ -42820,7 +43750,7 @@ "additionalProperties": false, "properties": { "Object": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object specified in the ServiceNow flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Object", "type": "string" } @@ -42835,27 +43765,27 @@ "properties": { "Marketo": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.MarketoSourceProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [MarketoSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-marketosourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties that are applied when Marketo is being used as a source\\. \n*Required*: No \n*Type*: [MarketoSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-marketosourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Marketo" }, "S3": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.S3SourceProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [S3SourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties that are applied when Amazon S3 is being used as the flow source\\. \n*Required*: No \n*Type*: [S3SourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3" }, "Salesforce": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.SalesforceSourceProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SalesforceSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties that are applied when Salesforce is being used as a source\\. \n*Required*: No \n*Type*: [SalesforceSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Salesforce" }, "ServiceNow": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.ServiceNowSourceProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ServiceNowSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-servicenowsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties that are applied when ServiceNow is being used as a source\\. \n*Required*: No \n*Type*: [ServiceNowSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-servicenowsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceNow" }, "Zendesk": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.ZendeskSourceProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ZendeskSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-zendesksourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties that are applied when using Zendesk as a flow source\\. \n*Required*: No \n*Type*: [ZendeskSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-zendesksourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Zendesk" } }, @@ -42865,23 +43795,23 @@ "additionalProperties": false, "properties": { "ConnectorProfileName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the Amazon AppFlow connector profile\\. This name must be unique for each connector profile in the AWS account\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[\\w/!@#+=.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectorProfileName", "type": "string" }, "ConnectorType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of connector, such as Salesforce, Marketo, and so on\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Marketo | S3 | Salesforce | Servicenow | Zendesk` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectorType", "type": "string" }, "IncrementalPullConfig": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.IncrementalPullConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [IncrementalPullConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-incrementalpullconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Defines the configuration for a scheduled incremental data pull\\. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull\\. \n*Required*: No \n*Type*: [IncrementalPullConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-incrementalpullconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncrementalPullConfig" }, "SourceConnectorProperties": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.SourceConnectorProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [SourceConnectorProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the information that is required to query a particular source connector\\. \n*Required*: Yes \n*Type*: [SourceConnectorProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceConnectorProperties" } }, @@ -42896,11 +43826,11 @@ "properties": { "ConnectorOperator": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.ConnectorOperator", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ConnectorOperator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided source fields\\. \n*Required*: No \n*Type*: [ConnectorOperator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectorOperator" }, "DestinationField": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A field in a destination connector, or a field value against which Amazon AppFlow validates a source field\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DestinationField", "type": "string" }, @@ -42908,7 +43838,7 @@ "items": { "type": "string" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The source fields to which a particular task is applied\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceFields", "type": "array" }, @@ -42916,12 +43846,12 @@ "items": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.TaskPropertiesMap" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [TaskPropertiesMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A map used to store task\\-related information\\. The service looks for particular information based on the TaskType\\. \n*Required*: No \n*Type*: List of [TaskPropertiesMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TaskProperties", "type": "array" }, "TaskType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the particular task implementation that Amazon AppFlow performs\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Arithmetic | Filter | Map | Mask | Merge | Truncate | Validate` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TaskType", "type": "string" } @@ -42936,12 +43866,12 @@ "additionalProperties": false, "properties": { "OperatorPropertyKey": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The task property key\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OperatorPropertyKey", "type": "string" }, "Property": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The task property value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Property", "type": "string" } @@ -42957,11 +43887,11 @@ "properties": { "TriggerProperties": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.TriggerProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [TriggerProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the configuration details of a schedule\\-triggered flow that you define\\. Currently, these settings only apply to the Scheduled trigger type\\. \n*Required*: No \n*Type*: [TriggerProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TriggerProperties" }, "TriggerType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the type of flow trigger\\. It can be OnDemand, Scheduled, or Event\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Event | OnDemand | Scheduled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TriggerType", "type": "string" } @@ -42976,7 +43906,7 @@ "properties": { "Scheduled": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.ScheduledTriggerProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ScheduledTriggerProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the configuration details of a schedule\\-triggered flow that you define\\. \n*Required*: No \n*Type*: [ScheduledTriggerProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Scheduled" } }, @@ -42986,7 +43916,7 @@ "additionalProperties": false, "properties": { "Object": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object specified in the Zendesk flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Object", "type": "string" } @@ -43612,7 +44542,9 @@ "additionalProperties": false, "properties": { "RetentionArchiveTier": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.RetentionArchiveTier" + "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.RetentionArchiveTier", + "markdownDescription": "Information about retention period in the Amazon EBS Snapshots Archive\\. For more information, see [Archive Amazon EBS snapshots](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/snapshot-archive.html)\\. \n*Required*: Yes \n*Type*: [RetentionArchiveTier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retentionarchivetier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetentionArchiveTier" } }, "required": [ @@ -43624,7 +44556,9 @@ "additionalProperties": false, "properties": { "RetainRule": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.ArchiveRetainRule" + "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.ArchiveRetainRule", + "markdownDescription": "Information about the retention period for the snapshot archiving rule\\. \n*Required*: Yes \n*Type*: [ArchiveRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-archiveretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetainRule" } }, "required": [ @@ -43651,7 +44585,7 @@ "type": "string" }, "Location": { - "markdownDescription": "Specifies the destination for snapshots created by the policy\\. To create snapshots in the same Region as the source resource, specify `CLOUD`\\. To create snapshots on the same Outpost as the source resource, specify `OUTPOST_LOCAL`\\. If you omit this parameter, `CLOUD` is used by default\\. \nIf the policy targets resources in an AWS Region, then you must create snapshots in the same Region as the source resource\\. \nIf the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CLOUD | OUTPOST_LOCAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot policies only\\]** Specifies the destination for snapshots created by the policy\\. To create snapshots in the same Region as the source resource, specify `CLOUD`\\. To create snapshots on the same Outpost as the source resource, specify `OUTPOST_LOCAL`\\. If you omit this parameter, `CLOUD` is used by default\\. \nIf the policy targets resources in an AWS Region, then you must create snapshots in the same Region as the source resource\\. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CLOUD | OUTPOST_LOCAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Location", "type": "string" }, @@ -43659,7 +44593,7 @@ "items": { "type": "string" }, - "markdownDescription": "The time, in UTC, to start the operation\\. The supported format is hh:mm\\. \nThe operation occurs within a one\\-hour window following the specified time\\. If you do not specify a time, Amazon DLM selects a time within the next 24 hours\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The time, in UTC, to start the operation\\. The supported format is hh:mm\\. \nThe operation occurs within a one\\-hour window following the specified time\\. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Times", "type": "array" } @@ -43676,7 +44610,7 @@ }, "RetainRule": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule", - "markdownDescription": "Specifies the retention rule for cross\\-Region snapshot copies\\. \n*Required*: No \n*Type*: [CrossRegionCopyRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a retention rule for cross\\-Region snapshot copies created by snapshot or event\\-based policies, or cross\\-Region AMI copies created by AMI policies\\. After the retention period expires, the cross\\-Region copy is deleted\\. \n*Required*: No \n*Type*: [CrossRegionCopyRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RetainRule" }, "Target": { @@ -43700,7 +44634,7 @@ "type": "number" }, "IntervalUnit": { - "markdownDescription": "The unit of time in which to measure the **Interval**\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unit of time in which to measure the **Interval**\\. For example, to deprecate a cross\\-Region AMI copy after 3 months, specify `Interval=3` and `IntervalUnit=MONTHS`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IntervalUnit", "type": "string" } @@ -43715,12 +44649,12 @@ "additionalProperties": false, "properties": { "Interval": { - "markdownDescription": "The amount of time to retain each snapshot\\. The maximum is 100 years\\. This is equivalent to 1200 months, 5200 weeks, or 36500 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of time to retain a cross\\-Region snapshot or AMI copy\\. The maximum is 100 years\\. This is equivalent to 1200 months, 5200 weeks, or 36500 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Interval", "type": "number" }, "IntervalUnit": { - "markdownDescription": "The unit of time for time\\-based retention\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unit of time for time\\-based retention\\. For example, to retain a cross\\-Region copy for 3 months, specify `Interval=3` and `IntervalUnit=MONTHS`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IntervalUnit", "type": "string" } @@ -43740,13 +44674,13 @@ "type": "string" }, "CopyTags": { - "markdownDescription": "Indicates whether to copy all user\\-defined tags from the source snapshot to the cross\\-Region snapshot copy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether to copy all user\\-defined tags from the source snapshot or AMI to the cross\\-Region copy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CopyTags", "type": "boolean" }, "DeprecateRule": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.CrossRegionCopyDeprecateRule", - "markdownDescription": "The AMI deprecation rule for cross\\-Region AMI copies created by the rule\\. \n*Required*: No \n*Type*: [CrossRegionCopyDeprecateRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopydeprecaterule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[AMI policies only\\]** The AMI deprecation rule for cross\\-Region AMI copies created by the rule\\. \n*Required*: No \n*Type*: [CrossRegionCopyDeprecateRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopydeprecaterule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeprecateRule" }, "Encrypted": { @@ -43756,7 +44690,7 @@ }, "RetainRule": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule", - "markdownDescription": "The retention rule that indicates how long snapshot copies are to be retained in the destination Region\\. \n*Required*: No \n*Type*: [CrossRegionCopyRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The retention rule that indicates how long the cross\\-Region snapshot or AMI copies are to be retained in the destination Region\\. \n*Required*: No \n*Type*: [CrossRegionCopyRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RetainRule" }, "Target": { @@ -43765,7 +44699,7 @@ "type": "string" }, "TargetRegion": { - "markdownDescription": "Avoid using this parameter when creating new policies\\. Instead, use **Target** to specify a target Region or a target Outpost for snapshot copies\\. \nFor policies created before the **Target** parameter was introduced, this parameter indicates the target Region for snapshot copies\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `16` \n*Pattern*: `([a-z]+-){2,3}\\d` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Avoid using this parameter when creating new policies\\. Instead, use **Target** to specify a target Region or a target Outpost for snapshot copies\\. \nFor policies created before the **Target** parameter was introduced, this parameter indicates the target Region for snapshot copies\\.\n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `16` \n*Pattern*: `([a-z]+-){2,3}\\d` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TargetRegion", "type": "string" } @@ -43895,7 +44829,7 @@ "additionalProperties": false, "properties": { "ExcludeBootVolume": { - "markdownDescription": "\\[EBS Snapshot Management \u2013 Instance policies only\\] Indicates whether to exclude the root volume from snapshots created using [CreateSnapshots](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSnapshots.html)\\. The default is false\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot policies that target instances only\\]** Indicates whether to exclude the root volume from multi\\-volume snapshot sets\\. The default is `false`\\. If you specify `true`, then the root volumes attached to targeted instances will be excluded from the multi\\-volume snapshot sets created by the policy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExcludeBootVolume", "type": "boolean" }, @@ -43903,10 +44837,12 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "**\\[Snapshot policies that target instances only\\]** The tags used to identify data \\(non\\-root\\) volumes to exclude from multi\\-volume snapshot sets\\. \nIf you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi\\-volume snapshot sets created by the policy\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExcludeDataVolumeTags", "type": "array" }, "NoReboot": { - "markdownDescription": "Applies to AMI lifecycle policies only\\. Indicates whether targeted instances are rebooted when the lifecycle policy runs\\. `true` indicates that targeted instances are not rebooted when the policy runs\\. `false` indicates that target instances are rebooted when the policy runs\\. The default is `true` \\(instances are not rebooted\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[AMI policies only\\]** Indicates whether targeted instances are rebooted when the lifecycle policy runs\\. `true` indicates that targeted instances are not rebooted when the policy runs\\. `false` indicates that target instances are rebooted when the policy runs\\. The default is `true` \\(instances are not rebooted\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NoReboot", "type": "boolean" } @@ -43920,22 +44856,22 @@ "items": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.Action" }, - "markdownDescription": "The actions to be performed when the event\\-based policy is triggered\\. You can specify only one action per policy\\. \nThis parameter is required for event\\-based policies only\\. If you are creating a snapshot or AMI policy, omit this parameter\\. \n*Required*: No \n*Type*: List of [Action](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-action.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Event\\-based policies only\\]** The actions to be performed when the event\\-based policy is activated\\. You can specify only one action per policy\\. \n*Required*: No \n*Type*: List of [Action](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-action.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Actions", "type": "array" }, "EventSource": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.EventSource", - "markdownDescription": "The event that triggers the event\\-based policy\\. \nThis parameter is required for event\\-based policies only\\. If you are creating a snapshot or AMI policy, omit this parameter\\. \n*Required*: No \n*Type*: [EventSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventsource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Event\\-based policies only\\]** The event that activates the event\\-based policy\\. \n*Required*: No \n*Type*: [EventSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventsource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventSource" }, "Parameters": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.Parameters", - "markdownDescription": "A set of optional parameters for snapshot and AMI lifecycle policies\\. \nThis parameter is required for snapshot and AMI policies only\\. If you are creating an event\\-based policy, omit this parameter\\. \nIf you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require\\. You can't omit this parameter or set its values to null\\.\n*Required*: No \n*Type*: [Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot and AMI policies only\\]** A set of optional parameters for snapshot and AMI lifecycle policies\\. \nIf you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require\\. You can't omit this parameter or set its values to null\\.\n*Required*: No \n*Type*: [Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Parameters" }, "PolicyType": { - "markdownDescription": "The valid target resource types and actions a policy can manage\\. Specify `EBS_SNAPSHOT_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots\\. Specify `IMAGE_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of EBS\\-backed AMIs\\. Specify `EVENT_BASED_POLICY ` to create an event\\-based policy that performs specific actions when a defined event occurs in your AWS account\\. \nThe default is `EBS_SNAPSHOT_MANAGEMENT`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EBS_SNAPSHOT_MANAGEMENT | EVENT_BASED_POLICY | IMAGE_MANAGEMENT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[All policy types\\]** The valid target resource types and actions a policy can manage\\. Specify `EBS_SNAPSHOT_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots\\. Specify `IMAGE_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of EBS\\-backed AMIs\\. Specify `EVENT_BASED_POLICY ` to create an event\\-based policy that performs specific actions when a defined event occurs in your AWS account\\. \nThe default is `EBS_SNAPSHOT_MANAGEMENT`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EBS_SNAPSHOT_MANAGEMENT | EVENT_BASED_POLICY | IMAGE_MANAGEMENT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PolicyType", "type": "string" }, @@ -43943,7 +44879,7 @@ "items": { "type": "string" }, - "markdownDescription": "The location of the resources to backup\\. If the source resources are located in an AWS Region, specify `CLOUD`\\. If the source resources are located on an Outpost in your account, specify `OUTPOST`\\. \nIf you specify `OUTPOST`, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot and AMI policies only\\]** The location of the resources to backup\\. If the source resources are located in an AWS Region, specify `CLOUD`\\. If the source resources are located on an Outpost in your account, specify `OUTPOST`\\. \nIf you specify `OUTPOST`, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceLocations", "type": "array" }, @@ -43951,7 +44887,7 @@ "items": { "type": "string" }, - "markdownDescription": "The target resource type for snapshot and AMI lifecycle policies\\. Use `VOLUME `to create snapshots of individual volumes or use `INSTANCE` to create multi\\-volume snapshots from the volumes for an instance\\. \nThis parameter is required for snapshot and AMI policies only\\. If you are creating an event\\-based policy, omit this parameter\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot policies only\\]** The target resource type for snapshot and AMI lifecycle policies\\. Use `VOLUME `to create snapshots of individual volumes or use `INSTANCE` to create multi\\-volume snapshots from the volumes for an instance\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceTypes", "type": "array" }, @@ -43959,7 +44895,7 @@ "items": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.Schedule" }, - "markdownDescription": "The schedules of policy\\-defined actions for snapshot and AMI lifecycle policies\\. A policy can have up to four schedules\u2014one mandatory schedule and up to three optional schedules\\. \nThis parameter is required for snapshot and AMI policies only\\. If you are creating an event\\-based policy, omit this parameter\\. \n*Required*: No \n*Type*: List of [Schedule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html) \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot and AMI policies only\\]** The schedules of policy\\-defined actions for snapshot and AMI lifecycle policies\\. A policy can have up to four schedules\u2014one mandatory schedule and up to three optional schedules\\. \n*Required*: No \n*Type*: List of [Schedule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html) \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Schedules", "type": "array" }, @@ -43967,7 +44903,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The single tag that identifies targeted resources for this policy\\. \nThis parameter is required for snapshot and AMI policies only\\. If you are creating an event\\-based policy, omit this parameter\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot and AMI policies only\\]** The single tag that identifies targeted resources for this policy\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TargetTags", "type": "array" } @@ -43978,17 +44914,17 @@ "additionalProperties": false, "properties": { "Count": { - "markdownDescription": "The number of snapshots to retain for each volume, up to a maximum of 1000\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of snapshots to retain for each volume, up to a maximum of 1000\\. For example if you want to retain a maximum of three snapshots, specify `3`\\. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an [ArchiveRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-archiverule)\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Count", "type": "number" }, "Interval": { - "markdownDescription": "The amount of time to retain each snapshot\\. The maximum is 100 years\\. This is equivalent to 1200 months, 5200 weeks, or 36500 days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of time to retain each snapshot\\. The maximum is 100 years\\. This is equivalent to 1200 months, 5200 weeks, or 36500 days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Interval", "type": "number" }, "IntervalUnit": { - "markdownDescription": "The unit of time for time\\-based retention\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unit of time for time\\-based retention\\. For example, to retain snapshots for 3 months, specify `Interval=3` and `IntervalUnit=MONTHS`\\. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an [ArchiveRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-archiverule)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IntervalUnit", "type": "string" } @@ -43999,12 +44935,18 @@ "additionalProperties": false, "properties": { "Count": { + "markdownDescription": "The maximum number of snapshots to retain in the archive storage tier for each volume\\. The count must ensure that each snapshot remains in the archive tier for at least 90 days\\. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Count", "type": "number" }, "Interval": { + "markdownDescription": "Specifies the period of time to retain snapshots in the archive tier\\. After this period expires, the snapshot is permanently deleted\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Interval", "type": "number" }, "IntervalUnit": { + "markdownDescription": "The unit of time in which to measure the **Interval**\\. For example, to retain a snapshots in the archive tier for 6 months, specify `Interval=6` and `IntervalUnit=MONTHS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntervalUnit", "type": "string" } }, @@ -44014,7 +44956,9 @@ "additionalProperties": false, "properties": { "ArchiveRule": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.ArchiveRule" + "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.ArchiveRule", + "markdownDescription": "**\\[Snapshot policies that target volumes only\\]** The snapshot archiving rule for the schedule\\. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met\\. Snapshots are then retained in the archive tier for the archive retention period that you specify\\. \nFor more information about using snapshot archiving, see [Considerations for snapshot lifecycle policies](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive)\\. \n*Required*: No \n*Type*: [ArchiveRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-archiverule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ArchiveRule" }, "CopyTags": { "markdownDescription": "Copy all user\\-defined tags on a source volume to snapshots of the volume created by this policy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -44030,18 +44974,18 @@ "items": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.CrossRegionCopyRule" }, - "markdownDescription": "The rule for cross\\-Region snapshot copies\\. \nYou can only specify cross\\-Region copy rules for policies that create snapshots in a Region\\. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost\\. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts\\. \n*Required*: No \n*Type*: List of [CrossRegionCopyRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html) \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a rule for copying snapshots or AMIs across regions\\. \nYou can't specify cross\\-Region copy rules for policies that create snapshots on an Outpost\\. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts\\.\n*Required*: No \n*Type*: List of [CrossRegionCopyRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html) \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrossRegionCopyRules", "type": "array" }, "DeprecateRule": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.DeprecateRule", - "markdownDescription": "The AMI deprecation rule for the schedule\\. \n*Required*: No \n*Type*: [DeprecateRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[AMI policies only\\]** The AMI deprecation rule for the schedule\\. \n*Required*: No \n*Type*: [DeprecateRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeprecateRule" }, "FastRestoreRule": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.FastRestoreRule", - "markdownDescription": "The rule for enabling fast snapshot restore\\. \n*Required*: No \n*Type*: [FastRestoreRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot policies only\\]** The rule for enabling fast snapshot restore\\. \n*Required*: No \n*Type*: [FastRestoreRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FastRestoreRule" }, "Name": { @@ -44051,14 +44995,14 @@ }, "RetainRule": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.RetainRule", - "markdownDescription": "The retention rule\\. \n*Required*: No \n*Type*: [RetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The retention rule for snapshots or AMIs created by the policy\\. \n*Required*: No \n*Type*: [RetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RetainRule" }, "ShareRules": { "items": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.ShareRule" }, - "markdownDescription": "The rule for sharing snapshots with other AWS accounts\\. \n*Required*: No \n*Type*: List of [ShareRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot policies only\\]** The rule for sharing snapshots with other AWS accounts\\. \n*Required*: No \n*Type*: List of [ShareRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ShareRules", "type": "array" }, @@ -44074,7 +45018,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "A collection of key/value pairs with values determined dynamically when the policy is executed\\. Keys may be any valid Amazon EC2 tag key\\. Values must be in one of the two following formats: `$(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/instance-id.html)` or `$(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/timestamp.html)`\\. Variable tags are only valid for EBS Snapshot Management \u2013 Instance policies\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `45` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[AMI policies and snapshot policies that target instances only\\]** A collection of key/value pairs with values determined dynamically when the policy is executed\\. Keys may be any valid Amazon EC2 tag key\\. Values must be in one of the two following formats: `$(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/instance-id.html)` or `$(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/timestamp.html)`\\. Variable tags are only valid for EBS Snapshot Management \u2013 Instance policies\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `45` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VariableTags", "type": "array" } @@ -44146,12 +45090,12 @@ "type": "string" }, "CertificatePem": { - "markdownDescription": "The contents of the \\.pem X\\.509 certificate file for the certificate\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The contents of a `.pem` file, which contains an X\\.509 certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CertificatePem", "type": "string" }, "CertificateWallet": { - "markdownDescription": "The location of the imported Oracle Wallet certificate for use with SSL\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The location of an imported Oracle Wallet certificate for use with SSL\\. An example is: `filebase64(\"${path.root}/rds-ca-2019-root.sso\")` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CertificateWallet", "type": "string" } @@ -44219,23 +45163,23 @@ "type": "string" }, "DatabaseName": { - "markdownDescription": "The name of the endpoint database\\. For a MySQL source or target endpoint, do not specify DatabaseName\\. To migrate to a specific database, use this setting and `targetDbType`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the endpoint database\\. For a MySQL source or target endpoint, don't specify `DatabaseName`\\. To migrate to a specific database, use this setting and `targetDbType`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DatabaseName", "type": "string" }, "DocDbSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.DocDbSettings", - "markdownDescription": "Settings in JSON format for the source DocumentDB endpoint\\. For more information about the available settings, see the configuration properties section in [ Using DocumentDB as a Target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [DocDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target DocumentDB endpoint\\. For more information about other available settings, see [ Using extra connections attributes with Amazon DocumentDB as a source](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html#CHAP_Source.DocumentDB.ECAs) and [ Using Amazon DocumentDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DocumentDB.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [DocDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DocDbSettings" }, "DynamoDbSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.DynamoDbSettings", - "markdownDescription": "Settings in JSON format for the target Amazon DynamoDB endpoint\\. For information about other available settings, see [Using Object Mapping to Migrate Data to DynamoDB](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [DynamoDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the target Amazon DynamoDB endpoint\\. For information about other available settings, see [ Using object mapping to migrate data to DynamoDB](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [DynamoDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DynamoDbSettings" }, "ElasticsearchSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.ElasticsearchSettings", - "markdownDescription": "Settings in JSON format for the target OpenSearch endpoint\\. For more information about the available settings, see [Extra Connection Attributes When Using OpenSearch as a Target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) in the * AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [ElasticsearchSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the target OpenSearch endpoint\\. For more information about the available settings, see [ Extra connection attributes when using OpenSearch as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [ElasticsearchSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ElasticsearchSettings" }, "EndpointIdentifier": { @@ -44249,63 +45193,63 @@ "type": "string" }, "EngineName": { - "markdownDescription": "The type of engine for the endpoint\\. Valid values, depending on the `EndpointType` value, include `\"mysql\"`, `\"oracle\"`, `\"postgres\"`, `\"mariadb\"`, `\"aurora\"`, `\"aurora-postgresql\"`, `\"opensearch\"`, `\"redshift\"`, `\"s3\"`, `\"db2\"`, `\"azuredb\"`, `\"sybase\"`, `\"dynamodb\"`, `\"mongodb\"`, `\"kinesis\"`, `\"kafka\"`, `\"elasticsearch\"`, `\"docdb\"`, `\"sqlserver\"`, and `\"neptune\"`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of engine for the endpoint, depending on the `EndpointType` value\\. \n*Valid values*: `mysql` \\| `oracle` \\| `postgres` \\| `mariadb` \\| `aurora` \\| `aurora-postgresql` \\| `opensearch` \\| `redshift` \\| `s3` \\| `db2` \\| `azuredb` \\| `sybase` \\| `dynamodb` \\| `mongodb` \\| `kinesis` \\| `kafka` \\| `elasticsearch` \\| `docdb` \\| `sqlserver` \\| `neptune` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EngineName", "type": "string" }, "ExtraConnectionAttributes": { - "markdownDescription": "Additional attributes associated with the connection\\. Each attribute is specified as a name\\-value pair associated by an equal sign \\(=\\)\\. Multiple attributes are separated by a semicolon \\(;\\) with no additional white space\\. For information on the attributes available for connecting your source or target endpoint, see [Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Additional attributes associated with the connection\\. Each attribute is specified as a name\\-value pair associated by an equal sign \\(=\\)\\. Multiple attributes are separated by a semicolon \\(;\\) with no additional white space\\. For information on the attributes available for connecting your source or target endpoint, see [ Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExtraConnectionAttributes", "type": "string" }, "GcpMySQLSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.GcpMySQLSettings", - "markdownDescription": "Settings in JSON format for the source GCP MySQL endpoint\\. \n*Required*: No \n*Type*: [GcpMySQLSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source GCP MySQL endpoint\\. These settings are much the same as the settings for any MySQL\\-compatible endpoint\\. For more information, see [ Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [GcpMySQLSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "GcpMySQLSettings" }, "IbmDb2Settings": { "$ref": "#/definitions/AWS::DMS::Endpoint.IbmDb2Settings", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [IbmDb2Settings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source IBM Db2 LUW endpoint\\. For information about other available settings, see [ Extra connection attributes when using Db2 LUW as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [IbmDb2Settings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IbmDb2Settings" }, "KafkaSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.KafkaSettings", - "markdownDescription": "Settings in JSON format for the target Apache Kafka endpoint\\. For more information about the available settings, see [Using object mapping to migrate data to a Kafka topic](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [KafkaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the target Apache Kafka endpoint\\. For more information about other available settings, see [ Using object mapping to migrate data to a Kafka topic](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [KafkaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KafkaSettings" }, "KinesisSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.KinesisSettings", - "markdownDescription": "Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams\\. For more information about the available settings, see [Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [KinesisSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams\\. For more information about other available settings, see [ Using object mapping to migrate data to a Kinesis data stream](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [KinesisSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KinesisSettings" }, "KmsKeyId": { - "markdownDescription": "An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint\\. \nIf you don't specify a value for the `KmsKeyId` parameter, then AWS DMS uses your default encryption key\\. \n AWS KMS creates the default encryption key for your AWS account\\. Your AWS account has a different default encryption key for each AWS Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint\\. \nIf you don't specify a value for the `KmsKeyId` parameter, AWS DMS uses your default encryption key\\. \nAWS KMS creates the default encryption key for your AWS account\\. Your AWS account has a different default encryption key for each AWS Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" }, "MicrosoftSqlServerSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.MicrosoftSqlServerSettings", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [MicrosoftSqlServerSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target Microsoft SQL Server endpoint\\. For information about other available settings, see [ Extra connection attributes when using SQL Server as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib) and [ Extra connection attributes when using SQL Server as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [MicrosoftSqlServerSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MicrosoftSqlServerSettings" }, "MongoDbSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.MongoDbSettings", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [MongoDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source MongoDB endpoint\\. For more information about the available settings, see [ Using MongoDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [MongoDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MongoDbSettings" }, "MySqlSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.MySqlSettings", - "markdownDescription": "Settings in JSON format for the source and target MySQL endpoint\\. For information about other available settings, see [Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) and [Extra connection attributes when using a MySQL\\-compatible database as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [MySqlSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target MySQL endpoint\\. For information about other available settings, see [ Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) and [ Extra connection attributes when using a MySQL\\-compatible database as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [MySqlSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MySqlSettings" }, "NeptuneSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.NeptuneSettings", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [NeptuneSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the target Amazon Neptune endpoint\\. For more information about the available settings, see [ Specifying endpoint settings for Amazon Neptune as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [NeptuneSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NeptuneSettings" }, "OracleSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.OracleSettings", - "markdownDescription": "Settings in JSON format for the source and target Oracle endpoint\\. For information about other available settings, see [Extra connection attributes when using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) and [ Extra connection attributes when using Oracle as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [OracleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target Oracle endpoint\\. For information about other available settings, see [ Extra connection attributes when using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) and [ Extra connection attributes when using Oracle as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [OracleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OracleSettings" }, "Password": { @@ -44320,27 +45264,27 @@ }, "PostgreSqlSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.PostgreSqlSettings", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [PostgreSqlSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target PostgreSQL endpoint\\. \nFor information about other available settings, see [ Extra connection attributes when using PostgreSQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) and [ Extra connection attributes when using PostgreSQL as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [PostgreSqlSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PostgreSqlSettings" }, "RedisSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.RedisSettings", - "markdownDescription": "Settings in JSON format for the target Redis endpoint\\. \n*Required*: No \n*Type*: [RedisSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the target Redis endpoint\\. For information about other available settings, see [ Specifying endpoint settings for Redis as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redis.html#CHAP_Target.Redis.EndpointSettings) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [RedisSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RedisSettings" }, "RedshiftSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.RedshiftSettings", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [RedshiftSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the Amazon Redshift endpoint\\. \nFor more information about other available settings, see [ Extra connection attributes when using Amazon Redshift as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redshift.html#CHAP_Target.Redshift.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [RedshiftSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RedshiftSettings" }, "ResourceIdentifier": { - "markdownDescription": "A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. \nFor example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceIdentifier", "type": "string" }, "S3Settings": { "$ref": "#/definitions/AWS::DMS::Endpoint.S3Settings", - "markdownDescription": "Settings in JSON format for the target Amazon S3 endpoint\\. For more information about the available settings, see [Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [S3Settings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target Amazon S3 endpoint\\. For more information about other available settings, see [ Extra connection attributes when using Amazon S3 as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.S3.html#CHAP_Source.S3.Configuring) and [ Extra connection attributes when using Amazon S3 as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) in the*AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [S3Settings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3Settings" }, "ServerName": { @@ -44349,20 +45293,20 @@ "type": "string" }, "SslMode": { - "markdownDescription": "The Secure Sockets Layer \\(SSL\\) mode to use for the SSL connection\\. The default is `none`\\. \nWhen `engine_name` is set to S3, then the only allowed value is `none`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `none | require | verify-ca | verify-full` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Secure Sockets Layer \\(SSL\\) mode to use for the SSL connection\\. The default is `none`\\. \nWhen `engine_name` is set to S3, the only allowed value is `none`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `none | require | verify-ca | verify-full` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SslMode", "type": "string" }, "SybaseSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.SybaseSettings", - "markdownDescription": "Settings in JSON format for the source and target SAP ASE endpoint\\. For information about other available settings, see [Extra connection attributes when using SAP ASE as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) and [Extra connection attributes when using SAP ASE as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [SybaseSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target SAP ASE endpoint\\. For information about other available settings, see [ Extra connection attributes when using SAP ASE as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) and [ Extra connection attributes when using SAP ASE as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [SybaseSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SybaseSettings" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "One or more tags to be assigned to the endpoint\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "One or more tags to be assigned to the endpoint\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -44403,21 +45347,27 @@ "additionalProperties": false, "properties": { "DocsToInvestigate": { + "markdownDescription": "Indicates the number of documents to preview to determine the document organization\\. Use this setting when `NestingLevel` is set to `\"one\"`\\. \nMust be a positive value greater than `0`\\. Default value is `1000`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DocsToInvestigate", "type": "number" }, "ExtractDocId": { + "markdownDescription": "Specifies the document ID\\. Use this setting when `NestingLevel` is set to `\"none\"`\\. \nDefault value is `\"false\"`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExtractDocId", "type": "boolean" }, "NestingLevel": { + "markdownDescription": "Specifies either document or table mode\\. \nDefault value is `\"none\"`\\. Specify `\"none\"` to use document mode\\. Specify `\"one\"` to use table mode\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `none | one` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NestingLevel", "type": "string" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the DocumentDB endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the DocumentDB endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" } @@ -44439,7 +45389,7 @@ "additionalProperties": false, "properties": { "EndpointUri": { - "markdownDescription": "The endpoint for the OpenSearch cluster\\. AWS DMS uses HTTPS if a transport protocol \\(http/https\\) is not specified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The endpoint for the OpenSearch cluster\\. AWS DMS uses HTTPS if a transport protocol \\(either HTTP or HTTPS\\) isn't specified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EndpointUri", "type": "string" }, @@ -44449,7 +45399,7 @@ "type": "number" }, "FullLoadErrorPercentage": { - "markdownDescription": "The maximum percentage of records that can fail to be written before a full load operation stops\\. \nTo avoid early failure, this counter is only effective after 1000 records are transferred\\. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window\\. If transfer of all records fail in the last 10 minutes, the full load operation stops\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum percentage of records that can fail to be written before a full load operation stops\\. \nTo avoid early failure, this counter is only effective after 1,000 records are transferred\\. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window\\. If transfer of all records fail in the last 10 minutes, the full load operation stops\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FullLoadErrorPercentage", "type": "number" }, @@ -44500,17 +45450,17 @@ "type": "string" }, "Port": { - "markdownDescription": "*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The port used by the endpoint database\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Port", "type": "number" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret.` The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the AWS Database Migration Service User Guide\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret.` The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, @@ -44520,7 +45470,7 @@ "type": "string" }, "ServerTimezone": { - "markdownDescription": "Specifies the time zone for the source MySQL database\\. \nExample: `serverTimezone=US/Pacific;` \nNote: Do not enclose time zones in single quotes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the time zone for the source MySQL database\\. Don't enclose time zones in single quotation marks\\. \nExample: `serverTimezone=US/Pacific;` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServerTimezone", "type": "string" }, @@ -44536,22 +45486,28 @@ "additionalProperties": false, "properties": { "CurrentLsn": { + "markdownDescription": "For ongoing replication \\(CDC\\), use CurrentLSN to specify a log sequence number \\(LSN\\) where you want the replication to start\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CurrentLsn", "type": "string" }, "MaxKBytesPerRead": { + "markdownDescription": "Maximum number of bytes per read, as a NUMBER value\\. The default is 64 KB\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxKBytesPerRead", "type": "number" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the IBMDB2 endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "SetDataCaptureChanges": { + "markdownDescription": "Enables ongoing replication \\(CDC\\) as a BOOLEAN value\\. The default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SetDataCaptureChanges", "type": "boolean" } }, @@ -44561,7 +45517,7 @@ "additionalProperties": false, "properties": { "Broker": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A comma\\-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance\\. Specify each broker location in the form `broker-hostname-or-ip:port`\\. For example, `\"ec2-12-345-678-901.compute-1.amazonaws.com:2345\"`\\. For more information and examples of specifying a list of broker locations, see [ Using Apache Kafka as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Broker", "type": "string" }, @@ -44576,6 +45532,8 @@ "type": "boolean" }, "IncludePartitionValue": { + "markdownDescription": "Shows the partition value within the Kafka message output unless the partition type is `schema-table-type`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludePartitionValue", "type": "boolean" }, "IncludeTableAlterOperations": { @@ -44589,9 +45547,13 @@ "type": "boolean" }, "MessageFormat": { + "markdownDescription": "The output format for the records created on the endpoint\\. The message format is `JSON` \\(default\\) or `JSON_UNFORMATTED` \\(a single line with no tab\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `json | json-unformatted` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageFormat", "type": "string" }, "MessageMaxBytes": { + "markdownDescription": "The maximum size in bytes for records created on the endpoint The default is 1,000,000\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageMaxBytes", "type": "number" }, "NoHexPrefix": { @@ -44605,12 +45567,12 @@ "type": "boolean" }, "SaslPassword": { - "markdownDescription": "The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL\\-SSL authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL\\-SSL authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SaslPassword", "type": "string" }, "SaslUserName": { - "markdownDescription": "The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL\\-SSL authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL\\-SSL authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SaslUserName", "type": "string" }, @@ -44640,7 +45602,7 @@ "type": "string" }, "Topic": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The topic to which you migrate the data\\. If you don't specify a topic, AWS DMS specifies `\"kafka-default-topic\"` as the migration topic\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Topic", "type": "string" } @@ -44661,6 +45623,8 @@ "type": "boolean" }, "IncludePartitionValue": { + "markdownDescription": "Shows the partition value within the Kinesis message output, unless the partition type is `schema-table-type`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludePartitionValue", "type": "boolean" }, "IncludeTableAlterOperations": { @@ -44674,7 +45638,7 @@ "type": "boolean" }, "MessageFormat": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `json | json-unformatted` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The output format for the records created on the endpoint\\. The message format is `JSON` \\(default\\) or `JSON_UNFORMATTED` \\(a single line with no tab\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `json | json-unformatted` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageFormat", "type": "string" }, @@ -44689,12 +45653,12 @@ "type": "boolean" }, "ServiceAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the IAM role that AWS DMS uses to write to the Kinesis data stream\\. The role must allow the `iam:PassRole` action\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceAccessRoleArn", "type": "string" }, "StreamArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the Amazon Kinesis Data Streams endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamArn", "type": "string" } @@ -44705,34 +45669,48 @@ "additionalProperties": false, "properties": { "BcpPacketSize": { + "markdownDescription": "The maximum size of the packets \\(in bytes\\) used to transfer data using BCP\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BcpPacketSize", "type": "number" }, "ControlTablesFileGroup": { + "markdownDescription": "Specifies a file group for the AWS DMS internal tables\\. When the replication task starts, all the internal AWS DMS control tables \\(awsdms\\_ apply\\_exception, awsdms\\_apply, awsdms\\_changes\\) are created for the specified file group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ControlTablesFileGroup", "type": "string" }, "QuerySingleAlwaysOnNode": { + "markdownDescription": "Cleans and recreates table metadata information on the replication instance when a mismatch occurs\\. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "QuerySingleAlwaysOnNode", "type": "boolean" }, "ReadBackupOnly": { + "markdownDescription": "When this attribute is set to `Y`, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication\\. Setting this parameter to `Y` enables you to control active transaction log file growth during full load and ongoing replication tasks\\. However, it can add some source latency to ongoing replication\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReadBackupOnly", "type": "boolean" }, "SafeguardPolicy": { + "markdownDescription": "Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods\\. \n *Start transactions in the database:* This is the default method\\. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database\\. As long as such a transaction is open, changes that appear after the transaction started aren't truncated\\. If you need Microsoft Replication to be enabled in your database, then you must choose this method\\. \n *Exclusively use sp\\_repldone within a single task*: When this method is used, AWS DMS reads the changes and then uses sp\\_repldone to mark the TLOG transactions as ready for truncation\\. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running\\. Also, when using this method, only one AWS DMS task can access the database at any given time\\. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SafeguardPolicy", "type": "string" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MicrosoftSQLServer endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "UseBcpFullLoad": { + "markdownDescription": "Use this to attribute to transfer data for full\\-load operations using BCP\\. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseBcpFullLoad", "type": "boolean" }, "UseThirdPartyBackupDevice": { + "markdownDescription": "When this attribute is set to `Y`, DMS processes third\\-party transaction log backups if they are created in native format\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseThirdPartyBackupDevice", "type": "boolean" } }, @@ -44742,67 +45720,67 @@ "additionalProperties": false, "properties": { "AuthMechanism": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `default | mongodb_cr | scram_sha_1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The authentication mechanism you use to access the MongoDB source endpoint\\. \nFor the default value, in MongoDB version 2\\.x, `\"default\"` is `\"mongodb_cr\"`\\. For MongoDB version 3\\.x or later, `\"default\"` is `\"scram_sha_1\"`\\. This setting isn't used when `AuthType` is set to `\"no\"`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `default | mongodb_cr | scram_sha_1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthMechanism", "type": "string" }, "AuthSource": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The MongoDB database name\\. This setting isn't used when `AuthType` is set to `\"no\"`\\. \nThe default is `\"admin\"`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthSource", "type": "string" }, "AuthType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `no | password` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The authentication type you use to access the MongoDB source endpoint\\. \nWhen set to `\"no\"`, user name and password parameters are not used and can be empty\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `no | password` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthType", "type": "string" }, "DatabaseName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The database name on the MongoDB source endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DatabaseName", "type": "string" }, "DocsToInvestigate": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates the number of documents to preview to determine the document organization\\. Use this setting when `NestingLevel` is set to `\"one\"`\\. \nMust be a positive value greater than `0`\\. Default value is `1000`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DocsToInvestigate", "type": "string" }, "ExtractDocId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the document ID\\. Use this setting when `NestingLevel` is set to `\"none\"`\\. \nDefault value is `\"false\"`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExtractDocId", "type": "string" }, "NestingLevel": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `none | one` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies either document or table mode\\. \nDefault value is `\"none\"`\\. Specify `\"none\"` to use document mode\\. Specify `\"one\"` to use table mode\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `none | one` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NestingLevel", "type": "string" }, "Password": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The password for the user account you use to access the MongoDB source endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Password", "type": "string" }, "Port": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The port value for the MongoDB source endpoint\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Port", "type": "number" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MongoDB endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "ServerName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the server on the MongoDB source endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServerName", "type": "string" }, "Username": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user name you use to access the MongoDB source endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Username", "type": "string" } @@ -44813,34 +45791,48 @@ "additionalProperties": false, "properties": { "AfterConnectScript": { + "markdownDescription": "Specifies a script to run immediately after AWS DMS connects to the endpoint\\. The migration task continues running regardless if the SQL statement succeeds or fails\\. \nFor this parameter, provide the code of the script itself, not the name of a file containing the script\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AfterConnectScript", "type": "string" }, "CleanSourceMetadataOnMismatch": { + "markdownDescription": "Cleans and recreates table metadata information on the replication instance when a mismatch occurs\\. For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CleanSourceMetadataOnMismatch", "type": "boolean" }, "EventsPollInterval": { + "markdownDescription": "Specifies how often to check the binary log for new changes/events when the database is idle\\. The default is five seconds\\. \nExample: `eventsPollInterval=5;` \nIn the example, AWS DMS checks for changes in the binary logs every five seconds\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventsPollInterval", "type": "number" }, "MaxFileSize": { + "markdownDescription": "Specifies the maximum size \\(in KB\\) of any \\.csv file used to transfer data to a MySQL\\-compatible database\\. \nExample: `maxFileSize=512` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxFileSize", "type": "number" }, "ParallelLoadThreads": { + "markdownDescription": "Improves performance when loading data into the MySQL\\-compatible target database\\. Specifies how many threads to use to load the data into the MySQL\\-compatible target database\\. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread\\. The default is one\\. \nExample: `parallelLoadThreads=1` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ParallelLoadThreads", "type": "number" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "ServerTimezone": { + "markdownDescription": "Specifies the time zone for the source MySQL database\\. \nExample: `serverTimezone=US/Pacific;` \nNote: Do not enclose time zones in single quotes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerTimezone", "type": "string" }, "TargetDbType": { + "markdownDescription": "Specifies where to migrate source tables on the target, either to a single database or multiple databases\\. If you specify `SPECIFIC_DATABASE`, specify the database name using the `DatabaseName` parameter of the `Endpoint` object\\. \nExample: `targetDbType=MULTIPLE_DATABASES` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetDbType", "type": "string" } }, @@ -44855,7 +45847,7 @@ "type": "number" }, "IamAuthEnabled": { - "markdownDescription": "If you want AWS Identity and Access Management \\(IAM\\) authorization enabled for this endpoint, set this parameter to `true`\\. Then attach the appropriate IAM policy document to your service role specified by `ServiceAccessRoleArn`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If you want IAM authorization enabled for this endpoint, set this parameter to `true`\\. Then attach the appropriate IAM policy document to your service role specified by `ServiceAccessRoleArn`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IamAuthEnabled", "type": "boolean" }, @@ -44880,7 +45872,7 @@ "type": "string" }, "ServiceAccessRoleArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the service role that you created for the Neptune target endpoint\\. The role must allow the `iam:PassRole` action\\. For more information, see [Creating an IAM Service Role for Accessing Amazon Neptune as a Target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole) in the * AWS Database Migration Service User Guide\\. * \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the service role that you created for the Neptune target endpoint\\. The role must allow the `iam:PassRole` action\\. \nFor more information, see [ Creating an IAM Service Role for Accessing Amazon Neptune as a Target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceAccessRoleArn", "type": "string" } @@ -44891,119 +45883,181 @@ "additionalProperties": false, "properties": { "AccessAlternateDirectly": { + "markdownDescription": "Set this attribute to `false` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessAlternateDirectly", "type": "boolean" }, "AddSupplementalLogging": { + "markdownDescription": "Set this attribute to set up table\\-level supplemental logging for the Oracle database\\. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task\\. \nIf you use this option, you still need to enable database\\-level supplemental logging\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AddSupplementalLogging", "type": "boolean" }, "AdditionalArchivedLogDestId": { + "markdownDescription": "Set this attribute with `ArchivedLogDestId` in a primary/ standby setup\\. This attribute is useful in the case of a switchover\\. In this case, AWS DMS needs to know which destination to get archive redo logs from to read changes\\. This need arises because the previous primary instance is now a standby instance after switchover\\. \nAlthough AWS DMS supports the use of the Oracle `RESETLOGS` option to open the database, never use `RESETLOGS` unless necessary\\. For additional information about `RESETLOGS`, see [RMAN Data Repair Concepts](https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the *Oracle Database Backup and Recovery User's Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalArchivedLogDestId", "type": "number" }, "AllowSelectNestedTables": { + "markdownDescription": "Set this attribute to `true` to enable replication of Oracle tables containing columns that are nested tables or defined types\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowSelectNestedTables", "type": "boolean" }, "ArchivedLogDestId": { + "markdownDescription": "Specifies the ID of the destination for the archived redo logs\\. This value should be the same as a number in the dest\\_id column of the v$archived\\_log view\\. If you work with an additional redo log destination, use the `AdditionalArchivedLogDestId` option to specify the additional destination ID\\. Doing this improves performance by ensuring that the correct logs are accessed from the outset\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ArchivedLogDestId", "type": "number" }, "ArchivedLogsOnly": { + "markdownDescription": "When this field is set to `Y`, AWS DMS only accesses the archived redo logs\\. If the archived redo logs are stored on Automatic Storage Management \\(ASM\\) only, the AWS DMS user account needs to be granted ASM privileges\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ArchivedLogsOnly", "type": "boolean" }, "AsmPassword": { + "markdownDescription": "For an Oracle source endpoint, your Oracle Automatic Storage Management \\(ASM\\) password\\. You can set this value from the ` asm_user_password ` value\\. You set this value as part of the comma\\-separated value that you set to the `Password` request parameter when you create the endpoint to access transaction logs using Binary Reader\\. For more information, see [Configuration for change data capture \\(CDC\\) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AsmPassword", "type": "string" }, "AsmServer": { + "markdownDescription": "For an Oracle source endpoint, your ASM server address\\. You can set this value from the `asm_server` value\\. You set `asm_server` as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM\\. For more information, see [Configuration for change data capture \\(CDC\\) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AsmServer", "type": "string" }, "AsmUser": { + "markdownDescription": "For an Oracle source endpoint, your ASM user name\\. You can set this value from the `asm_user` value\\. You set `asm_user` as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM\\. For more information, see [Configuration for change data capture \\(CDC\\) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AsmUser", "type": "string" }, "CharLengthSemantics": { + "markdownDescription": "Specifies whether the length of a character column is in bytes or in characters\\. To indicate that the character column length is in characters, set this attribute to `CHAR`\\. Otherwise, the character column length is in bytes\\. \nExample: `charLengthSemantics=CHAR;` \n*Required*: No \n*Type*: String \n*Allowed values*: `byte | char | default` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CharLengthSemantics", "type": "string" }, "DirectPathNoLog": { + "markdownDescription": "When set to `true`, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DirectPathNoLog", "type": "boolean" }, "DirectPathParallelLoad": { + "markdownDescription": "When set to `true`, this attribute specifies a parallel load when `useDirectPathFullLoad` is set to `Y`\\. This attribute also only applies when you use the AWS DMS parallel load feature\\. Note that the target table cannot have any constraints or indexes\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DirectPathParallelLoad", "type": "boolean" }, "EnableHomogenousTablespace": { + "markdownDescription": "Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableHomogenousTablespace", "type": "boolean" }, "ExtraArchivedLogDestIds": { "items": { "type": "number" }, + "markdownDescription": "Specifies the IDs of one more destinations for one or more archived redo logs\\. These IDs are the values of the `dest_id` column in the `v$archived_log` view\\. Use this setting with the `archivedLogDestId` extra connection attribute in a primary\\-to\\-single setup or a primary\\-to\\-multiple\\-standby setup\\. \nThis setting is useful in a switchover when you use an Oracle Data Guard database as a source\\. In this case, AWS DMS needs information about what destination to get archive redo logs from to read changes\\. AWS DMS needs this because after the switchover the previous primary is a standby instance\\. For example, in a primary\\-to\\-single standby setup you might apply the following settings\\. \n `archivedLogDestId=1; ExtraArchivedLogDestIds=[2]` \nIn a primary\\-to\\-multiple\\-standby setup, you might apply the following settings\\. \n `archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]` \nAlthough AWS DMS supports the use of the Oracle `RESETLOGS` option to open the database, never use `RESETLOGS` unless it's necessary\\. For more information about `RESETLOGS`, see [ RMAN Data Repair Concepts](https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the *Oracle Database Backup and Recovery User's Guide*\\. \n*Required*: No \n*Type*: List of Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExtraArchivedLogDestIds", "type": "array" }, "FailTasksOnLobTruncation": { + "markdownDescription": "When set to `true`, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified `LobMaxSize`\\. \nIf a task is set to limited LOB mode and this option is set to `true`, the task fails instead of truncating the LOB data\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailTasksOnLobTruncation", "type": "boolean" }, "NumberDatatypeScale": { + "markdownDescription": "Specifies the number scale\\. You can select a scale up to 38, or you can select FLOAT\\. By default, the NUMBER data type is converted to precision 38, scale 10\\. \nExample: `numberDataTypeScale=12` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NumberDatatypeScale", "type": "number" }, "OraclePathPrefix": { + "markdownDescription": "Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This value specifies the default Oracle root used to access the redo logs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OraclePathPrefix", "type": "string" }, "ParallelAsmReadThreads": { + "markdownDescription": "Set this attribute to change the number of threads that DMS configures to perform a change data capture \\(CDC\\) load using Oracle Automatic Storage Management \\(ASM\\)\\. You can specify an integer value between 2 \\(the default\\) and 8 \\(the maximum\\)\\. Use this attribute together with the `readAheadBlocks` attribute\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ParallelAsmReadThreads", "type": "number" }, "ReadAheadBlocks": { + "markdownDescription": "Set this attribute to change the number of read\\-ahead blocks that DMS configures to perform a change data capture \\(CDC\\) load using Oracle Automatic Storage Management \\(ASM\\)\\. You can specify an integer value between 1000 \\(the default\\) and 200,000 \\(the maximum\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReadAheadBlocks", "type": "number" }, "ReadTableSpaceName": { + "markdownDescription": "When set to `true`, this attribute supports tablespace replication\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReadTableSpaceName", "type": "boolean" }, "ReplacePathPrefix": { + "markdownDescription": "Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This setting tells DMS instance to replace the default Oracle root with the specified `usePathPrefix` setting to access the redo logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReplacePathPrefix", "type": "boolean" }, "RetryInterval": { + "markdownDescription": "Specifies the number of seconds that the system waits before resending a query\\. \nExample: `retryInterval=6;` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetryInterval", "type": "number" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the Oracle endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerOracleAsmAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Required only if your Oracle endpoint uses Advanced Storage Manager \\(ASM\\)\\. The full ARN of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the `SecretsManagerOracleAsmSecret`\\. This `SecretsManagerOracleAsmSecret` has the secret value that allows access to the Oracle ASM of the endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerOracleAsmSecretId`\\. Or you can specify clear\\-text values for `AsmUserName`, `AsmPassword`, and `AsmServerName`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerOracleAsmSecret`, the corresponding `SecretsManagerOracleAsmAccessRoleArn`, and the `SecretsManagerOracleAsmSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerOracleAsmAccessRoleArn", "type": "string" }, "SecretsManagerOracleAsmSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Required only if your Oracle endpoint uses Advanced Storage Manager \\(ASM\\)\\. The full ARN, partial ARN, or display name of the `SecretsManagerOracleAsmSecret` that contains the Oracle ASM connection details for the Oracle endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerOracleAsmSecretId", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the Oracle endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "SecurityDbEncryption": { + "markdownDescription": "For an Oracle source endpoint, the transparent data encryption \\(TDE\\) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader\\. It is also the ` TDE_Password ` part of the comma\\-separated value you set to the `Password` request parameter when you create the endpoint\\. The `SecurityDbEncryptian` setting is related to this `SecurityDbEncryptionName` setting\\. For more information, see [ Supported encryption methods for using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) in the * AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityDbEncryption", "type": "string" }, "SecurityDbEncryptionName": { + "markdownDescription": "For an Oracle source endpoint, the name of a key used for the transparent data encryption \\(TDE\\) of the columns and tablespaces in an Oracle source database that is encrypted using TDE\\. The key value is the value of the `SecurityDbEncryption` setting\\. For more information on setting the key name value of `SecurityDbEncryptionName`, see the information and example for setting the `securityDbEncryptionName` extra connection attribute in [ Supported encryption methods for using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) in the * AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityDbEncryptionName", "type": "string" }, "SpatialDataOptionToGeoJsonFunctionName": { + "markdownDescription": "Use this attribute to convert `SDO_GEOMETRY` to `GEOJSON` format\\. By default, DMS calls the `SDO2GEOJSON` custom function if present and accessible\\. Or you can create your own custom function that mimics the operation of `SDOGEOJSON` and set `SpatialDataOptionToGeoJsonFunctionName` to call it instead\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SpatialDataOptionToGeoJsonFunctionName", "type": "string" }, "StandbyDelayTime": { + "markdownDescription": "Use this attribute to specify a time in minutes for the delay in standby sync\\. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases\\. \nIn AWS DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes\\. Doing this eliminates the need to connect to an active database that might be in production\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StandbyDelayTime", "type": "number" }, "UseAlternateFolderForOnline": { + "markdownDescription": "Set this attribute to `true` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This tells the DMS instance to use any specified prefix replacement to access all online redo logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseAlternateFolderForOnline", "type": "boolean" }, "UseBFile": { + "markdownDescription": "Set this attribute to Y to capture change data using the Binary Reader utility\\. Set `UseLogminerReader` to N to set this attribute to Y\\. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes\\. For more information about using this setting with Oracle Automatic Storage Management \\(ASM\\), see [ Using Oracle LogMiner or AWS DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseBFile", "type": "boolean" }, "UseDirectPathFullLoad": { + "markdownDescription": "Set this attribute to Y to have AWS DMS use a direct path full load\\. Specify this value to use the direct path protocol in the Oracle Call Interface \\(OCI\\)\\. By using this OCI protocol, you can bulk\\-load Oracle target tables during a full load\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseDirectPathFullLoad", "type": "boolean" }, "UseLogminerReader": { + "markdownDescription": "Set this attribute to Y to capture change data using the Oracle LogMiner utility \\(the default\\)\\. Set this attribute to N if you want to access the redo logs as a binary file\\. When you set `UseLogminerReader` to N, also set `UseBfile` to Y\\. For more information on this setting and using Oracle ASM, see [ Using Oracle LogMiner or AWS DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC) in the * AWS DMS User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseLogminerReader", "type": "boolean" }, "UsePathPrefix": { + "markdownDescription": "Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This value specifies the path prefix used to replace the default Oracle root to access the redo logs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UsePathPrefix", "type": "string" } }, @@ -45013,46 +46067,68 @@ "additionalProperties": false, "properties": { "AfterConnectScript": { + "markdownDescription": "For use with change data capture \\(CDC\\) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data\\. \nExample: `afterConnectScript=SET session_replication_role='replica'` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AfterConnectScript", "type": "string" }, "CaptureDdls": { + "markdownDescription": "To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts\\. You can later remove these artifacts\\. \nIf this value is set to `N`, you don't have to create tables or triggers on the source database\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CaptureDdls", "type": "boolean" }, "DdlArtifactsSchema": { + "markdownDescription": "The schema in which the operational DDL database artifacts are created\\. \nExample: `ddlArtifactsSchema=xyzddlschema;` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DdlArtifactsSchema", "type": "string" }, "ExecuteTimeout": { + "markdownDescription": "Sets the client statement timeout for the PostgreSQL instance, in seconds\\. The default value is 60 seconds\\. \nExample: `executeTimeout=100;` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExecuteTimeout", "type": "number" }, "FailTasksOnLobTruncation": { + "markdownDescription": "When set to `true`, this value causes a task to fail if the actual size of a LOB column is greater than the specified `LobMaxSize`\\. \nIf task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailTasksOnLobTruncation", "type": "boolean" }, "HeartbeatEnable": { + "markdownDescription": "The write\\-ahead log \\(WAL\\) heartbeat feature mimics a dummy transaction\\. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source\\. This heartbeat keeps `restart_lsn` moving and prevents storage full scenarios\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HeartbeatEnable", "type": "boolean" }, "HeartbeatFrequency": { + "markdownDescription": "Sets the WAL heartbeat frequency \\(in minutes\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HeartbeatFrequency", "type": "number" }, "HeartbeatSchema": { + "markdownDescription": "Sets the schema in which the heartbeat artifacts are created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HeartbeatSchema", "type": "string" }, "MaxFileSize": { + "markdownDescription": "Specifies the maximum size \\(in KB\\) of any \\.csv file used to transfer data to PostgreSQL\\. \nExample: `maxFileSize=512` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxFileSize", "type": "number" }, "PluginName": { + "markdownDescription": "Specifies the plugin to use to create a replication slot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PluginName", "type": "string" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the PostgreSQL endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "SlotName": { + "markdownDescription": "Sets the name of a previously created logical replication slot for a change data capture \\(CDC\\) load of the PostgreSQL source instance\\. \nWhen used with the `CdcStartPosition` request parameter for the AWS DMS API , this attribute also makes it possible to use native CDC start points\\. DMS verifies that the specified logical replication slot exists before starting the CDC load task\\. It also verifies that the task was created with a valid setting of `CdcStartPosition`\\. If the specified slot doesn't exist or the task doesn't have a valid `CdcStartPosition` setting, DMS raises an error\\. \nFor more information about setting the `CdcStartPosition` request parameter, see [Determining a CDC native start point](dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native) in the * AWS Database Migration Service User Guide*\\. For more information about using `CdcStartPosition`, see [CreateReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html), [StartReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html), and [ModifyReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SlotName", "type": "string" } }, @@ -45103,82 +46179,128 @@ "additionalProperties": false, "properties": { "AcceptAnyDate": { + "markdownDescription": "A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error\\. You can choose `true` or `false` \\(the default\\)\\. \nThis parameter applies only to TIMESTAMP and DATE columns\\. Always use ACCEPTANYDATE with the DATEFORMAT parameter\\. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AcceptAnyDate", "type": "boolean" }, "AfterConnectScript": { + "markdownDescription": "Code to run after connecting\\. This parameter should contain the code itself, not the name of a file containing the code\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AfterConnectScript", "type": "string" }, "BucketFolder": { + "markdownDescription": "An S3 folder where the comma\\-separated\\-value \\(\\.csv\\) files are stored before being uploaded to the target Redshift cluster\\. \nFor full load mode, AWS DMS converts source records into \\.csv files and loads them to the *BucketFolder/TableID* path\\. AWS DMS uses the Redshift `COPY` command to upload the \\.csv files to the target table\\. The files are deleted once the `COPY` operation has finished\\. For more information, see [COPY](https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) in the *Amazon Redshift Database Developer Guide*\\. \nFor change\\-data\\-capture \\(CDC\\) mode, AWS DMS creates a *NetChanges* table, and loads the \\.csv files to this *BucketFolder/NetChangesTableID* path\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketFolder", "type": "string" }, "BucketName": { + "markdownDescription": "The name of the intermediate S3 bucket used to store \\.csv files before uploading data to Redshift\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketName", "type": "string" }, "CaseSensitiveNames": { + "markdownDescription": "If Amazon Redshift is configured to support case sensitive schema names, set `CaseSensitiveNames` to `true`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CaseSensitiveNames", "type": "boolean" }, "CompUpdate": { + "markdownDescription": "If you set `CompUpdate` to `true` Amazon Redshift applies automatic compression if the table is empty\\. This applies even if the table columns already have encodings other than `RAW`\\. If you set `CompUpdate` to `false`, automatic compression is disabled and existing column encodings aren't changed\\. The default is `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CompUpdate", "type": "boolean" }, "ConnectionTimeout": { + "markdownDescription": "A value that sets the amount of time to wait \\(in milliseconds\\) before timing out, beginning from when you initially establish a connection\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectionTimeout", "type": "number" }, "DateFormat": { + "markdownDescription": "The date format that you are using\\. Valid values are `auto` \\(case\\-sensitive\\), your date format string enclosed in quotes, or NULL\\. If this parameter is left unset \\(NULL\\), it defaults to a format of 'YYYY\\-MM\\-DD'\\. Using `auto` recognizes most strings, even some that aren't supported when you use a date format string\\. \nIf your date and time values use formats different from each other, set this to `auto`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DateFormat", "type": "string" }, "EmptyAsNull": { + "markdownDescription": "A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL\\. A value of `true` sets empty CHAR and VARCHAR fields to null\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EmptyAsNull", "type": "boolean" }, "EncryptionMode": { + "markdownDescription": "The type of server\\-side encryption that you want to use for your data\\. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3\\. You can choose either `SSE_S3` \\(the default\\) or `SSE_KMS`\\. \nFor the `ModifyEndpoint` operation, you can change the existing value of the `EncryptionMode` parameter from `SSE_KMS` to `SSE_S3`\\. But you can\u2019t change the existing value from `SSE_S3` to `SSE_KMS`\\.\nTo use `SSE_S3`, create an AWS Identity and Access Management \\(IAM\\) role with a policy that allows `\"arn:aws:s3:::*\"` to use the following actions: `\"s3:PutObject\", \"s3:ListBucket\"` \n*Required*: No \n*Type*: String \n*Allowed values*: `sse-kms | sse-s3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionMode", "type": "string" }, "ExplicitIds": { + "markdownDescription": "This setting is only valid for a full\\-load migration task\\. Set `ExplicitIds` to `true` to have tables with `IDENTITY` columns override their auto\\-generated values with explicit values loaded from the source data files used to populate the tables\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExplicitIds", "type": "boolean" }, "FileTransferUploadStreams": { + "markdownDescription": "The number of threads used to upload a single file\\. This parameter accepts a value from 1 through 64\\. It defaults to 10\\. \nThe number of parallel streams used to upload a single \\.csv file to an S3 bucket using S3 Multipart Upload\\. For more information, see [Multipart upload overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html)\\. \n `FileTransferUploadStreams` accepts a value from 1 through 64\\. It defaults to 10\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FileTransferUploadStreams", "type": "number" }, "LoadTimeout": { + "markdownDescription": "The amount of time to wait \\(in milliseconds\\) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LoadTimeout", "type": "number" }, "MaxFileSize": { + "markdownDescription": "The maximum size \\(in KB\\) of any \\.csv file used to load data on an S3 bucket and transfer data to Amazon Redshift\\. It defaults to 1048576KB \\(1 GB\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxFileSize", "type": "number" }, "RemoveQuotes": { + "markdownDescription": "A value that specifies to remove surrounding quotation marks from strings in the incoming data\\. All characters within the quotation marks, including delimiters, are retained\\. Choose `true` to remove quotation marks\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RemoveQuotes", "type": "boolean" }, "ReplaceChars": { + "markdownDescription": "A value that specifies to replaces the invalid characters specified in `ReplaceInvalidChars`, substituting the specified characters instead\\. The default is `\"?\"`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReplaceChars", "type": "string" }, "ReplaceInvalidChars": { + "markdownDescription": "A list of characters that you want to replace\\. Use with `ReplaceChars`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReplaceInvalidChars", "type": "string" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the Amazon Redshift endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "ServerSideEncryptionKmsKeyId": { + "markdownDescription": "The AWS KMS key ID\\. If you are using `SSE_KMS` for the `EncryptionMode`, provide this key ID\\. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerSideEncryptionKmsKeyId", "type": "string" }, "ServiceAccessRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IAM role that has access to the Amazon Redshift service\\. The role must allow the `iam:PassRole` action\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceAccessRoleArn", "type": "string" }, "TimeFormat": { + "markdownDescription": "The time format that you want to use\\. Valid values are `auto` \\(case\\-sensitive\\), `'timeformat_string'`, `'epochsecs'`, or `'epochmillisecs'`\\. It defaults to 10\\. Using `auto` recognizes most strings, even some that aren't supported when you use a time format string\\. \nIf your date and time values use formats different from each other, set this parameter to `auto`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TimeFormat", "type": "string" }, "TrimBlanks": { + "markdownDescription": "A value that specifies to remove the trailing white space characters from a VARCHAR string\\. This parameter applies only to columns with a VARCHAR data type\\. Choose `true` to remove unneeded white space\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrimBlanks", "type": "boolean" }, "TruncateColumns": { + "markdownDescription": "A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column\\. This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less\\. Choose `true` to truncate data\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TruncateColumns", "type": "boolean" }, "WriteBufferSize": { + "markdownDescription": "The size \\(in KB\\) of the in\\-memory file write buffer used when generating \\.csv files on the local disk at the DMS replication instance\\. The default value is 1000 \\(buffer size is 1000KB\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WriteBufferSize", "type": "number" } }, @@ -45193,27 +46315,27 @@ "type": "boolean" }, "BucketFolder": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional parameter to set a folder name in the S3 bucket\\. If provided, tables are created in the path `bucketFolder/schema_name/table_name/`\\. If this parameter isn't specified, the path used is `schema_name/table_name/`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BucketFolder", "type": "string" }, "BucketName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BucketName", "type": "string" }, "CannedAclForObjects": { - "markdownDescription": "A value that enables AWS DMS to specify a predefined \\(canned\\) access control list for objects created in an Amazon S3 bucket as \\.csv or \\.parquet files\\. For more information about Amazon S3 canned ACLs, see [Canned ACL](http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 Developer Guide\\.* \nThe default value is NONE\\. Valid values include NONE, PRIVATE, PUBLIC\\_READ, PUBLIC\\_READ\\_WRITE, AUTHENTICATED\\_READ, AWS\\_EXEC\\_READ, BUCKET\\_OWNER\\_READ, and BUCKET\\_OWNER\\_FULL\\_CONTROL\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `authenticated-read | aws-exec-read | bucket-owner-full-control | bucket-owner-read | none | private | public-read | public-read-write` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that enables AWS DMS to specify a predefined \\(canned\\) access control list \\(ACL\\) for objects created in an Amazon S3 bucket as \\.csv or \\.parquet files\\. For more information about Amazon S3 canned ACLs, see [ Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 Developer Guide*\\. \nThe default value is NONE\\. Valid values include NONE, PRIVATE, PUBLIC\\_READ, PUBLIC\\_READ\\_WRITE, AUTHENTICATED\\_READ, AWS\\_EXEC\\_READ, BUCKET\\_OWNER\\_READ, and BUCKET\\_OWNER\\_FULL\\_CONTROL\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `authenticated-read | aws-exec-read | bucket-owner-full-control | bucket-owner-read | none | private | public-read | public-read-write` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CannedAclForObjects", "type": "string" }, "CdcInsertsAndUpdates": { - "markdownDescription": "A value that enables a change data capture \\(CDC\\) load to write INSERT and UPDATE operations to \\.csv or \\.parquet \\(columnar storage\\) output files\\. The default setting is `false`, but when `CdcInsertsAndUpdates` is set to `true` or `y`, only INSERTs and UPDATEs from the source database are migrated to the \\.csv or \\.parquet file\\. \nFor \\.csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the `IncludeOpForFullLoad` parameter\\. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to either `I` or `U` to indicate INSERT and UPDATE operations at the source\\. But if `IncludeOpForFullLoad` is set to `false`, CDC records are written without an indication of INSERT or UPDATE operations at the source\\. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the * AWS Database Migration Service User Guide\\.*\\. \n AWS DMS supports the use of the `CdcInsertsAndUpdates` parameter in versions 3\\.3\\.1 and later\\. \n `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint\\. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that enables a change data capture \\(CDC\\) load to write INSERT and UPDATE operations to \\.csv or \\.parquet \\(columnar storage\\) output files\\. The default setting is `false`, but when `CdcInsertsAndUpdates` is set to `true` or `y`, only INSERTs and UPDATEs from the source database are migrated to the \\.csv or \\.parquet file\\. \nFor \\.csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the `IncludeOpForFullLoad` parameter\\. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to either `I` or `U` to indicate INSERT and UPDATE operations at the source\\. But if `IncludeOpForFullLoad` is set to `false`, CDC records are written without an indication of INSERT or UPDATE operations at the source\\. For more information about how these settings work together, see [ Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide*\\. \n AWS DMS supports the use of the `CdcInsertsAndUpdates` parameter in versions 3\\.3\\.1 and later\\. \n `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint\\. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdcInsertsAndUpdates", "type": "boolean" }, "CdcInsertsOnly": { - "markdownDescription": "A value that enables a change data capture \\(CDC\\) load to write only INSERT operations to \\.csv or columnar storage \\(\\.parquet\\) output files\\. By default \\(the `false` setting\\), the first field in a \\.csv or \\.parquet record contains the letter I \\(INSERT\\), U \\(UPDATE\\), or D \\(DELETE\\)\\. These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target\\. \nIf `CdcInsertsOnly` is set to `true` or `y`, only INSERTs from the source database are migrated to the \\.csv or \\.parquet file\\. For \\.csv format only, how these INSERTs are recorded depends on the value of `IncludeOpForFullLoad`\\. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to I to indicate the INSERT operation at the source\\. If `IncludeOpForFullLoad` is set to `false`, every CDC record is written without a first field to indicate the INSERT operation at the source\\. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the * AWS Database Migration Service User Guide\\.*\\. \n AWS DMS supports the interaction described preceding between the `CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in versions 3\\.1\\.4 and later\\. \n `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint\\. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that enables a change data capture \\(CDC\\) load to write only INSERT operations to \\.csv or columnar storage \\(\\.parquet\\) output files\\. By default \\(the `false` setting\\), the first field in a \\.csv or \\.parquet record contains the letter I \\(INSERT\\), U \\(UPDATE\\), or D \\(DELETE\\)\\. These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target\\. \nIf `CdcInsertsOnly` is set to `true` or `y`, only INSERTs from the source database are migrated to the \\.csv or \\.parquet file\\. For \\.csv format only, how these INSERTs are recorded depends on the value of `IncludeOpForFullLoad`\\. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to I to indicate the INSERT operation at the source\\. If `IncludeOpForFullLoad` is set to `false`, every CDC record is written without a first field to indicate the INSERT operation at the source\\. For more information about how these settings work together, see [ Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide*\\. \nAWS DMS supports the interaction described preceding between the `CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in versions 3\\.1\\.4 and later\\. \n `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint\\. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdcInsertsOnly", "type": "boolean" }, @@ -45223,22 +46345,22 @@ "type": "number" }, "CdcMinFileSize": { - "markdownDescription": "Minimum file size, defined in megabytes, to reach for a file output to Amazon S3\\. \nWhen `CdcMinFileSize` and `CdcMaxBatchInterval` are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template\\. \nThe default value is 32 MB\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3\\. \nWhen `CdcMinFileSize` and `CdcMaxBatchInterval` are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template\\. \nThe default value is 32 MB\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdcMinFileSize", "type": "number" }, "CdcPath": { - "markdownDescription": "Specifies the folder path of CDC files\\. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional\\. If `CdcPath` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint\\. For an S3 target if you set [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) to `true`, AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load\\. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) and [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName)\\. \nFor example, if you specify `CdcPath` as `MyChangedData`, and you specify `BucketName` as `MyTargetBucket` but do not specify `BucketFolder`, AWS DMS creates the CDC folder path following: `MyTargetBucket/MyChangedData`\\. \nIf you specify the same `CdcPath`, and you specify `BucketName` as `MyTargetBucket` and `BucketFolder` as `MyTargetData`, AWS DMS creates the CDC folder path following: `MyTargetBucket/MyTargetData/MyChangedData`\\. \nFor more information on CDC including transaction order on an S3 target, see [Capturing data changes \\(CDC\\) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath)\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.2 and later\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the folder path of CDC files\\. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional\\. If `CdcPath` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint\\. For an S3 target if you set [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) to `true`, AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load\\. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) and [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName)\\. \nFor example, if you specify `CdcPath` as `MyChangedData`, and you specify `BucketName` as `MyTargetBucket` but do not specify `BucketFolder`, AWS DMS creates the CDC folder path following: `MyTargetBucket/MyChangedData`\\. \nIf you specify the same `CdcPath`, and you specify `BucketName` as `MyTargetBucket` and `BucketFolder` as `MyTargetData`, AWS DMS creates the CDC folder path following: `MyTargetBucket/MyTargetData/MyChangedData`\\. \nFor more information on CDC including transaction order on an S3 target, see [ Capturing data changes \\(CDC\\) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath)\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.2 and later\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdcPath", "type": "string" }, "CompressionType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `gzip | none` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional parameter\\. When set to GZIP it enables the service to compress the target files\\. To allow the service to write the target files uncompressed, either set this parameter to NONE \\(the default\\) or don't specify the parameter at all\\. This parameter applies to both \\.csv and \\.parquet file formats\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `gzip | none` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CompressionType", "type": "string" }, "CsvDelimiter": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The delimiter used to separate columns in the \\.csv file for both source and target\\. The default is a comma\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CsvDelimiter", "type": "string" }, @@ -45253,7 +46375,7 @@ "type": "string" }, "CsvRowDelimiter": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The delimiter used to separate rows in the \\.csv file for both source and target\\. \nThe default is a carriage return \\(`\\n`\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CsvRowDelimiter", "type": "string" }, @@ -45273,7 +46395,7 @@ "type": "string" }, "DatePartitionEnabled": { - "markdownDescription": "When set to `true`, this parameter partitions S3 bucket folders based on transaction commit dates\\. The default value is `false`\\. For more information about date\\-based folder partitioning, see [Using date\\-based folder partitioning](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When set to `true`, this parameter partitions S3 bucket folders based on transaction commit dates\\. The default value is `false`\\. For more information about date\\-based folder partitioning, see [ Using date\\-based folder partitioning](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DatePartitionEnabled", "type": "boolean" }, @@ -45283,7 +46405,7 @@ "type": "string" }, "DatePartitionTimezone": { - "markdownDescription": "When creating an S3 target endpoint, set `DatePartitionTimezone` to convert the current UTC time into a specified time zone\\. The conversion occurs when a date partition folder is created and a CDC filename is generated\\. The time zone format is Area/Location\\. Use this parameter when `DatePartitionedEnabled` is set to `true`, as shown in the following example\\. \n `s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\", \"DatePartitionDelimiter\": \"SLASH\", \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\": \"dms-nattarat-test\"}'` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When creating an S3 target endpoint, set `DatePartitionTimezone` to convert the current UTC time into a specified time zone\\. The conversion occurs when a date partition folder is created and a change data capture \\(CDC\\) file name is generated\\. The time zone format is Area/Location\\. Use this parameter when `DatePartitionedEnabled` is set to `true`, as shown in the following example\\. \n `s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\", \"DatePartitionDelimiter\": \"SLASH\", \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\": \"dms-nattarat-test\"}'` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DatePartitionTimezone", "type": "string" }, @@ -45298,17 +46420,17 @@ "type": "boolean" }, "EncodingType": { - "markdownDescription": "The type of encoding you are using: \n+ `RLE_DICTIONARY` uses a combination of bit\\-packing and run\\-length encoding to store repeated values more efficiently\\. This is the default\\.\n+ `PLAIN` doesn't use encoding at all\\. Values are stored as they are\\.\n+ `PLAIN_DICTIONARY` builds a dictionary of the values encountered in a given column\\. The dictionary is stored in a dictionary page for each column chunk\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `plain | plain-dictionary | rle-dictionary` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of encoding that you're using: \n+ `RLE_DICTIONARY` uses a combination of bit\\-packing and run\\-length encoding to store repeated values more efficiently\\. This is the default\\.\n+ `PLAIN` doesn't use encoding at all\\. Values are stored as they are\\.\n+ `PLAIN_DICTIONARY` builds a dictionary of the values encountered in a given column\\. The dictionary is stored in a dictionary page for each column chunk\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `plain | plain-dictionary | rle-dictionary` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EncodingType", "type": "string" }, "EncryptionMode": { - "markdownDescription": "The type of server\\-side encryption that you want to use for your data\\. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3\\. You can choose either `SSE_S3` \\(the default\\) or `SSE_KMS`\\. \nFor the `ModifyEndpoint` operation, you can change the existing value of the `EncryptionMode` parameter from `SSE_KMS` to `SSE_S3`\\. But you can\u2019t change the existing value from `SSE_S3` to `SSE_KMS`\\.\nTo use `SSE_S3`, you need an AWS Identity and Access Management \\(IAM\\) role with permission to allow `\"arn:aws:s3:::dms-*\"` to use the following actions: \n+ `s3:CreateBucket` \n+ `s3:ListBucket` \n+ `s3:DeleteBucket` \n+ `s3:GetBucketLocation` \n+ `s3:GetObject` \n+ `s3:PutObject` \n+ `s3:DeleteObject` \n+ `s3:GetObjectVersion` \n+ `s3:GetBucketPolicy` \n+ `s3:PutBucketPolicy` \n+ `s3:DeleteBucketPolicy` \n*Required*: No \n*Type*: String \n*Allowed values*: `sse-kms | sse-s3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of server\\-side encryption that you want to use for your data\\. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3\\. You can choose either `SSE_S3` \\(the default\\) or `SSE_KMS`\\. \nFor the `ModifyEndpoint` operation, you can change the existing value of the `EncryptionMode` parameter from `SSE_KMS` to `SSE_S3`\\. But you can\u2019t change the existing value from `SSE_S3` to `SSE_KMS`\\.\nTo use `SSE_S3`, you need an IAM role with permission to allow `\"arn:aws:s3:::dms-*\"` to use the following actions: \n+ `s3:CreateBucket` \n+ `s3:ListBucket` \n+ `s3:DeleteBucket` \n+ `s3:GetBucketLocation` \n+ `s3:GetObject` \n+ `s3:PutObject` \n+ `s3:DeleteObject` \n+ `s3:GetObjectVersion` \n+ `s3:GetBucketPolicy` \n+ `s3:PutBucketPolicy` \n+ `s3:DeleteBucketPolicy` \n*Required*: No \n*Type*: String \n*Allowed values*: `sse-kms | sse-s3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EncryptionMode", "type": "string" }, "ExternalTableDefinition": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The external table definition\\. \nConditional: If `S3` is used as a source then `ExternalTableDefinition` is required\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExternalTableDefinition", "type": "string" }, @@ -45318,7 +46440,7 @@ "type": "number" }, "IncludeOpForFullLoad": { - "markdownDescription": "A value that enables a full load to write INSERT operations to the comma\\-separated value \\(\\.csv\\) output files only to indicate how the rows were added to the source database\\. \n AWS DMS supports the `IncludeOpForFullLoad` parameter in versions 3\\.1\\.4 and later\\.\nFor full load, records can only be inserted\\. By default \\(the `false` setting\\), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database\\. If `IncludeOpForFullLoad` is set to `true` or `y`, the INSERT is recorded as an I annotation in the first field of the \\.csv file\\. This allows the format of your target records from a full load to be consistent with the target records from a CDC load\\. \nThis setting works together with the `CdcInsertsOnly` and the `CdcInsertsAndUpdates` parameters for output to \\.csv files only\\. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the * AWS Database Migration Service User Guide\\.*\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that enables a full load to write INSERT operations to the comma\\-separated value \\(\\.csv\\) output files only to indicate how the rows were added to the source database\\. \n AWS DMS supports the `IncludeOpForFullLoad` parameter in versions 3\\.1\\.4 and later\\.\nFor full load, records can only be inserted\\. By default \\(the `false` setting\\), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database\\. If `IncludeOpForFullLoad` is set to `true` or `y`, the INSERT is recorded as an I annotation in the first field of the \\.csv file\\. This allows the format of your target records from a full load to be consistent with the target records from a CDC load\\. \nThis setting works together with the `CdcInsertsOnly` and the `CdcInsertsAndUpdates` parameters for output to \\.csv files only\\. For more information about how these settings work together, see [ Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeOpForFullLoad", "type": "boolean" }, @@ -45338,7 +46460,7 @@ "type": "string" }, "PreserveTransactions": { - "markdownDescription": "If set to `true`, AWS DMS saves the transaction order for a change data capture \\(CDC\\) load on the Amazon S3 target specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath)\\. For more information, see [Capturing data changes \\(CDC\\) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath)\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.2 and later\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If this setting is set to `true`, AWS DMS saves the transaction order for a change data capture \\(CDC\\) load on the Amazon S3 target specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath)\\. For more information, see [ Capturing data changes \\(CDC\\) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath)\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.2 and later\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PreserveTransactions", "type": "boolean" }, @@ -45353,22 +46475,22 @@ "type": "number" }, "ServerSideEncryptionKmsKeyId": { - "markdownDescription": "If you are using `SSE_KMS` for the `EncryptionMode`, provide the AWS KMS key ID\\. The key that you use needs an attached policy that enables AWS Identity and Access Management \\(IAM\\) user permissions and allows use of the key\\. \nHere is a CLI example: `aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value ` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If you are using `SSE_KMS` for the `EncryptionMode`, provide the AWS KMS key ID\\. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key\\. \nHere is a CLI example: `aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value ` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServerSideEncryptionKmsKeyId", "type": "string" }, "ServiceAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A required parameter that specifies the Amazon Resource Name \\(ARN\\) used by the service to access the IAM role\\. The role must allow the `iam:PassRole` action\\. It enables AWS DMS to read and write objects from an S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceAccessRoleArn", "type": "string" }, "TimestampColumnName": { - "markdownDescription": "A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target\\. \n AWS DMS supports the `TimestampColumnName` parameter in versions 3\\.1\\.4 and later\\.\nDMS includes an additional `STRING` column in the \\.csv or \\.parquet object files of your migrated data when you set `TimestampColumnName` to a nonblank value\\. \nFor a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS\\. \nFor a change data capture \\(CDC\\) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database\\. \nThe string format for this timestamp column value is `yyyy-MM-dd HH:mm:ss.SSSSSS`\\. By default, the precision of this value is in microseconds\\. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database\\. \nWhen the `AddColumnName` parameter is set to `true`, DMS also includes a name for the timestamp column that you set with `TimestampColumnName`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target\\. \n AWS DMS supports the `TimestampColumnName` parameter in versions 3\\.1\\.4 and later\\.\nAWS DMS includes an additional `STRING` column in the \\.csv or \\.parquet object files of your migrated data when you set `TimestampColumnName` to a nonblank value\\. \nFor a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS\\. \nFor a change data capture \\(CDC\\) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database\\. \nThe string format for this timestamp column value is `yyyy-MM-dd HH:mm:ss.SSSSSS`\\. By default, the precision of this value is in microseconds\\. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database\\. \nWhen the `AddColumnName` parameter is set to `true`, DMS also includes a name for the timestamp column that you set with `TimestampColumnName`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimestampColumnName", "type": "string" }, "UseCsvNoSupValue": { - "markdownDescription": "This setting applies if the S3 output files during a change data capture \\(CDC\\) load are written in \\.csv format\\. If set to `true` for columns not included in the supplemental log, AWS DMS uses the value specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue)\\. If not set or set to `false`, AWS DMS uses the null value for these columns\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.1 and later\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This setting applies if the S3 output files during a change data capture \\(CDC\\) load are written in \\.csv format\\. If this setting is set to `true` for columns not included in the supplemental log, AWS DMS uses the value specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue)\\. If this setting isn't set or is set to `false`, AWS DMS uses the null value for these columns\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.1 and later\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UseCsvNoSupValue", "type": "boolean" }, @@ -45384,12 +46506,12 @@ "additionalProperties": false, "properties": { "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the SAP ASE endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the SAP SAE endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" } @@ -45440,12 +46562,12 @@ "items": { "type": "string" }, - "markdownDescription": "A list of event categories for a source type that you want to subscribe to\\. If you don't specify this property, you are notified about all event categories\\. For more information, see [Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS DMS User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of event categories for a source type that you want to subscribe to\\. If you don't specify this property, you are notified about all event categories\\. For more information, see [ Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS DMS User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventCategories", "type": "array" }, "SnsTopicArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon SNS topic created for event notification\\. The ARN is created by Amazon SNS when you create a topic and subscribe to it\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon SNS topic created for event notification\\. The ARN is created by Amazon SNS when you create a topic and subscribe to it\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SnsTopicArn", "type": "string" }, @@ -45458,7 +46580,7 @@ "type": "array" }, "SourceType": { - "markdownDescription": "The type of AWS DMS resource that generates the events\\. For example, if you want to be notified of events generated by a replication instance, you set this parameter to `replication-instance`\\. If this value isn't specified, all events are returned\\. \nValid values: `replication-instance` \\| `replication-task` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of AWS DMS resource that generates the events\\. For example, if you want to be notified of events generated by a replication instance, you set this parameter to `replication-instance`\\. If this value isn't specified, all events are returned\\. \n*Valid values*: `replication-instance` \\| `replication-task` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceType", "type": "string" }, @@ -45471,7 +46593,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "One or more tags to be assigned to the event subscription\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "One or more tags to be assigned to the event subscription\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -45548,12 +46670,12 @@ "type": "boolean" }, "AutoMinorVersionUpgrade": { - "markdownDescription": "A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window\\. This parameter defaults to `true`\\. \nDefault: `true` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window\\. This parameter defaults to `true`\\. \nDefault: `true` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutoMinorVersionUpgrade", "type": "boolean" }, "AvailabilityZone": { - "markdownDescription": "The Availability Zone that the replication instance will be created in\\. \nThe default value is a random, system\\-chosen Availability Zone in the endpoint's , for example: `us-east-1d` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Availability Zone that the replication instance will be created in\\. \nThe default value is a random, system\\-chosen Availability Zone in the endpoint's AWS Region, for example `us-east-1d`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AvailabilityZone", "type": "string" }, @@ -45563,32 +46685,32 @@ "type": "string" }, "KmsKeyId": { - "markdownDescription": "An AWS KMS key identifier that is used to encrypt the data on the replication instance\\. \nIf you don't specify a value for the `KmsKeyId` parameter, then AWS DMS uses your default encryption key\\. \n AWS KMS creates the default encryption key for your AWS account\\. Your AWS account has a different default encryption key for each AWS Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An AWS KMS key identifier that is used to encrypt the data on the replication instance\\. \nIf you don't specify a value for the `KmsKeyId` parameter, AWS DMS uses your default encryption key\\. \nAWS KMS creates the default encryption key for your AWS account\\. Your AWS account has a different default encryption key for each AWS Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" }, "MultiAZ": { - "markdownDescription": "Specifies whether the replication instance is a Multi\\-AZ deployment\\. You can't set the `AvailabilityZone` parameter if the Multi\\-AZ parameter is set to `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the replication instance is a Multi\\-AZ deployment\\. You can't set the `AvailabilityZone` parameter if the Multi\\-AZ parameter is set to `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MultiAZ", "type": "boolean" }, "PreferredMaintenanceWindow": { - "markdownDescription": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \n Format: `ddd:hh24:mi-ddd:hh24:mi` \nDefault: A 30\\-minute window selected at random from an 8\\-hour block of time per AWS Region, occurring on a random day of the week\\. \nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun \nConstraints: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The weekly time range during which system maintenance can occur, in UTC\\. \n*Format*: `ddd:hh24:mi-ddd:hh24:mi` \n*Default*: A 30\\-minute window selected at random from an 8\\-hour block of time per AWS Region, occurring on a random day of the week\\. \n*Valid days* \\(`ddd`\\): `Mon` \\| `Tue` \\| `Wed` \\| `Thu` \\| `Fri` \\| `Sat` \\| `Sun` \n*Constraints*: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PreferredMaintenanceWindow", "type": "string" }, "PubliclyAccessible": { - "markdownDescription": "Specifies the accessibility options for the replication instance\\. A value of `true` represents an instance with a public IP address\\. A value of `false` represents an instance with a private IP address\\. The default value is `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the accessibility options for the replication instance\\. A value of `true` represents an instance with a public IP address\\. A value of `false` represents an instance with a private IP address\\. The default value is `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PubliclyAccessible", "type": "boolean" }, "ReplicationInstanceClass": { - "markdownDescription": "The compute and memory capacity of the replication instance as defined for the specified replication instance class\\. For example to specify the instance class dms\\.c4\\.large, set this parameter to `\"dms.c4.large\"`\\. \nFor more information on the settings and capacities for the available replication instance classes, see [ Selecting the right AWS DMS replication instance for your migration](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The compute and memory capacity of the replication instance as defined for the specified replication instance class\\. For example, to specify the instance class dms\\.c4\\.large, set this parameter to `\"dms.c4.large\"`\\. For more information on the settings and capacities for the available replication instance classes, see [ Selecting the right AWS DMS replication instance for your migration](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth) in the *AWS Database Migration Service User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReplicationInstanceClass", "type": "string" }, "ReplicationInstanceIdentifier": { - "markdownDescription": "The replication instance identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain 1\\-63 alphanumeric characters or hyphens\\.\n+ First character must be a letter\\.\n+ Can't end with a hyphen or contain two consecutive hyphens\\.\nExample: `myrepinstance` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The replication instance identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain 1\\-63 alphanumeric characters or hyphens\\.\n+ First character must be a letter\\.\n+ Can't end with a hyphen or contain two consecutive hyphens\\.\nExample: `myrepinstance` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReplicationInstanceIdentifier", "type": "string" }, @@ -45598,7 +46720,7 @@ "type": "string" }, "ResourceIdentifier": { - "markdownDescription": "A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceIdentifier", "type": "string" }, @@ -45606,7 +46728,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "One or more tags to be assigned to the replication instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "One or more tags to be assigned to the replication instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -45614,7 +46736,7 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies the VPC security group to be used with the replication instance\\. The VPC security group must work with the VPC containing the replication instance\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the virtual private cloud \\(VPC\\) security group to be used with the replication instance\\. The VPC security group must work with the VPC containing the replication instance\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VpcSecurityGroupIds", "type": "array" } @@ -45686,7 +46808,7 @@ "type": "string" }, "ReplicationSubnetGroupIdentifier": { - "markdownDescription": "The identifier for the replication subnet group\\. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the identifier\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The identifier for the replication subnet group\\. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the identifier\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ReplicationSubnetGroupIdentifier", "type": "string" }, @@ -45702,7 +46824,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "One or more tags to be assigned to the subnet group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "One or more tags to be assigned to the subnet group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -45770,7 +46892,7 @@ "additionalProperties": false, "properties": { "CdcStartPosition": { - "markdownDescription": "Indicates when you want a change data capture \\(CDC\\) operation to start\\. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start\\. Specifying both values results in an error\\. \n The value can be in date, checkpoint, or LSN/SCN format\\. \nDate Example: \\-\\-cdc\\-start\\-position \u201c2018\\-03\\-08T12:12:12\u201d \nCheckpoint Example: \\-\\-cdc\\-start\\-position \"checkpoint:V1\\#27\\#mysql\\-bin\\-changelog\\.157832:1975:\\-1:2002:677883278264080:mysql\\-bin\\-changelog\\.157832:1876\\#0\\#0\\#\\*\\#0\\#93\" \nLSN Example: \\-\\-cdc\\-start\\-position \u201cmysql\\-bin\\-changelog\\.000024:373\u201d \nWhen you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint\\. You can verify this by setting the `slotName` extra connection attribute to the name of this logical replication slot\\. For more information, see [Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates when you want a change data capture \\(CDC\\) operation to start\\. Use either `CdcStartPosition` or `CdcStartTime` to specify when you want a CDC operation to start\\. Specifying both values results in an error\\. \n The value can be in date, checkpoint, log sequence number \\(LSN\\), or system change number \\(SCN\\) format\\. \nHere is a date example: `--cdc-start-position \"2018-03-08T12:12:12\"` \nHere is a checkpoint example: `--cdc-start-position \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"` \nHere is an LSN example: `--cdc-start-position \u201cmysql-bin-changelog.000024:373\u201d` \nWhen you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint\\. You can verify this by setting the `slotName` extra connection attribute to the name of this logical replication slot\\. For more information, see [ Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdcStartPosition", "type": "string" }, @@ -45780,7 +46902,7 @@ "type": "number" }, "CdcStopPosition": { - "markdownDescription": "Indicates when you want a change data capture \\(CDC\\) operation to stop\\. The value can be either server time or commit time\\. \nServer time example: \\-\\-cdc\\-stop\\-position \u201cserver\\_time:2018\\-02\\-09T12:12:12\u201d \nCommit time example: \\-\\-cdc\\-stop\\-position \u201ccommit\\_time: 2018\\-02\\-09T12:12:12 \u201c \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates when you want a change data capture \\(CDC\\) operation to stop\\. The value can be either server time or commit time\\. \nHere is a server time example: `--cdc-stop-position \"server_time:2018-02-09T12:12:12\"` \nHere is a commit time example: `--cdc-stop-position \"commit_time: 2018-02-09T12:12:12\"` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdcStopPosition", "type": "string" }, @@ -45800,12 +46922,12 @@ "type": "string" }, "ReplicationTaskSettings": { - "markdownDescription": "Overall settings for the task, in JSON format\\. For more information, see [Specifying Task Settings for AWS Database Migration Service Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Overall settings for the task, in JSON format\\. For more information, see [ Specifying Task Settings for AWS Database Migration Service Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReplicationTaskSettings", "type": "string" }, "ResourceIdentifier": { - "markdownDescription": "A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. \nFor example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceIdentifier", "type": "string" }, @@ -45815,7 +46937,7 @@ "type": "string" }, "TableMappings": { - "markdownDescription": "The table mappings for the task, in JSON format\\. For more information, see [Using Table Mapping to Specify Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The table mappings for the task, in JSON format\\. For more information, see [ Using Table Mapping to Specify Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TableMappings", "type": "string" }, @@ -45823,7 +46945,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "One or more tags to be assigned to the replication task\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "One or more tags to be assigned to the replication task\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -45833,7 +46955,7 @@ "type": "string" }, "TaskData": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TaskData", "type": "string" } @@ -45904,7 +47026,7 @@ "additionalProperties": false, "properties": { "Format": { - "markdownDescription": "The file format of a dataset that is created from an Amazon S3 file or folder\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CSV | EXCEL | JSON | PARQUET` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The file format of a dataset that is created from an Amazon S3 file or folder\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CSV | EXCEL | JSON | ORC | PARQUET` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Format", "type": "string" }, @@ -46413,7 +47535,7 @@ }, "OutputLocation": { "$ref": "#/definitions/AWS::DataBrew::Job.OutputLocation", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [OutputLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputlocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [OutputLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputlocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OutputLocation" }, "Outputs": { @@ -46754,7 +47876,7 @@ "type": "string" }, "BucketOwner": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BucketOwner", "type": "string" }, @@ -46863,7 +47985,7 @@ "properties": { "Parameters": { "additionalProperties": true, - "markdownDescription": "A map that includes overrides of an evaluation\u2019s parameters\\. \n*Required*: Yes \n*Type*: [ParameterMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-parametermap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A map that includes overrides of an evaluation\u2019s parameters\\. \n*Required*: Yes \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -47141,7 +48263,7 @@ }, "Parameters": { "$ref": "#/definitions/AWS::DataBrew::Recipe.RecipeParameters", - "markdownDescription": "Contextual parameters for the transformation\\. \n*Required*: No \n*Type*: [ParameterMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-parametermap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contextual parameters for the transformation\\. \n*Required*: No \n*Type*: [RecipeParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Parameters" } }, @@ -47205,10 +48327,14 @@ "additionalProperties": false, "properties": { "DataCatalogInputDefinition": { - "$ref": "#/definitions/AWS::DataBrew::Recipe.DataCatalogInputDefinition" + "$ref": "#/definitions/AWS::DataBrew::Recipe.DataCatalogInputDefinition", + "markdownDescription": "The AWS Glue Data Catalog parameters for the data\\. \n*Required*: No \n*Type*: [DataCatalogInputDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-datacataloginputdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataCatalogInputDefinition" }, "S3InputDefinition": { - "$ref": "#/definitions/AWS::DataBrew::Recipe.S3Location" + "$ref": "#/definitions/AWS::DataBrew::Recipe.S3Location", + "markdownDescription": "The Amazon S3 location where the data is stored\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3InputDefinition" } }, "type": "object" @@ -47363,7 +48489,7 @@ }, "Input": { "$ref": "#/definitions/AWS::DataBrew::Recipe.Input", - "markdownDescription": "The input location to load the dataset from \\- Amazon S3 or AWS Glue Data Catalog\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The input location to load the dataset from \\- Amazon S3 or AWS Glue Data Catalog\\. \n*Required*: No \n*Type*: [Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-input.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Input" }, "Interval": { @@ -48027,7 +49153,7 @@ "additionalProperties": false, "properties": { "CronExpression": { - "markdownDescription": "The dates and times when the job is to run\\. For more information, see [Cron expressions](https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) in the * AWS Glue DataBrew Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The dates and times when the job is to run\\. For more information, see [Working with cron expressions for recipe jobs](https://docs.aws.amazon.com/databrew/latest/dg/jobs.recipe.html#jobs.cron) in the * AWS Glue DataBrew Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CronExpression", "type": "string" }, @@ -48134,7 +49260,7 @@ "items": { "$ref": "#/definitions/AWS::DataPipeline::Pipeline.ParameterObject" }, - "markdownDescription": "The parameter objects used with the pipeline\\. \n*Required*: Yes \n*Type*: List of [ParameterObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The parameter objects used with the pipeline\\. \n*Required*: No \n*Type*: List of [ParameterObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ParameterObjects", "type": "array" }, @@ -48142,7 +49268,7 @@ "items": { "$ref": "#/definitions/AWS::DataPipeline::Pipeline.ParameterValue" }, - "markdownDescription": "The parameter values used with the pipeline\\. \n*Required*: No \n*Type*: List of [ParameterValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalues.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The parameter values used with the pipeline\\. \n*Required*: No \n*Type*: List of [ParameterValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ParameterValues", "type": "array" }, @@ -48150,7 +49276,7 @@ "items": { "$ref": "#/definitions/AWS::DataPipeline::Pipeline.PipelineObject" }, - "markdownDescription": "The objects that define the pipeline\\. These objects overwrite the existing pipeline definition\\. Not all objects, fields, and values can be updated\\. For information about restrictions, see [Editing Your Pipeline](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-manage-pipeline-modify-console.html) in the *AWS Data Pipeline Developer Guide*\\. \n*Required*: No \n*Type*: List of [PipelineObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The objects that define the pipeline\\. These objects overwrite the existing pipeline definition\\. Not all objects, fields, and values can be updated\\. For information about restrictions, see [Editing Your Pipeline](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-manage-pipeline-modify-console.html) in the *AWS Data Pipeline Developer Guide*\\. \n*Required*: No \n*Type*: List of [PipelineObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PipelineObjects", "type": "array" }, @@ -48158,7 +49284,7 @@ "items": { "$ref": "#/definitions/AWS::DataPipeline::Pipeline.PipelineTag" }, - "markdownDescription": "A list of arbitrary tags \\(key\\-value pairs\\) to associate with the pipeline, which you can use to control permissions\\. For more information, see [Controlling Access to Pipelines and Resources](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the *AWS Data Pipeline Developer Guide*\\. \n*Required*: No \n*Type*: List of [PipelineTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of arbitrary tags \\(key\\-value pairs\\) to associate with the pipeline, which you can use to control permissions\\. For more information, see [Controlling Access to Pipelines and Resources](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the *AWS Data Pipeline Developer Guide*\\. \n*Required*: No \n*Type*: List of [PipelineTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetag.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PipelineTags", "type": "array" } @@ -48240,7 +49366,7 @@ "items": { "$ref": "#/definitions/AWS::DataPipeline::Pipeline.ParameterAttribute" }, - "markdownDescription": "The attributes of the parameter object\\. \n*Required*: Yes \n*Type*: List of [ParameterAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects-attributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The attributes of the parameter object\\. \n*Required*: Yes \n*Type*: List of [ParameterAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterattribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Attributes", "type": "array" }, @@ -48283,7 +49409,7 @@ "items": { "$ref": "#/definitions/AWS::DataPipeline::Pipeline.Field" }, - "markdownDescription": "Key\\-value pairs that define the properties of the object\\. \n*Required*: Yes \n*Type*: List of [Field](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Key\\-value pairs that define the properties of the object\\. \n*Required*: Yes \n*Type*: List of [Field](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-field.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Fields", "type": "array" }, @@ -48361,7 +49487,7 @@ "additionalProperties": false, "properties": { "ActivationKey": { - "markdownDescription": "Your agent activation key\\. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address \\(port 80\\)\\. Alternatively, you can get it from the DataSync console\\. \nThe redirect URL returned in the response provides you the activation key for your agent in the query string parameter `activationKey`\\. It might also include other activation\\-related parameters; however, these are merely defaults\\. The arguments you pass to this API call determine the actual configuration of your agent\\. \nFor more information, see [Creating and activating an agent](https://docs.aws.amazon.com/datasync/latest/userguide/activating-agent.html) in the * AWS DataSync User Guide\\.* \n*Required*: Yes \n*Type*: String \n*Maximum*: `29` \n*Pattern*: `[A-Z0-9]{5}(-[A-Z0-9]{5}){4}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Your agent activation key\\. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address \\(port 80\\)\\. Alternatively, you can get it from the DataSync console\\. \nThe redirect URL returned in the response provides you the activation key for your agent in the query string parameter `activationKey`\\. It might also include other activation\\-related parameters; however, these are merely defaults\\. The arguments you pass to this API call determine the actual configuration of your agent\\. \nFor more information, see [Creating and activating an agent](https://docs.aws.amazon.com/datasync/latest/userguide/activating-agent.html) in the * AWS DataSync User Guide\\.* \n*Required*: No \n*Type*: String \n*Maximum*: `29` \n*Pattern*: `[A-Z0-9]{5}(-[A-Z0-9]{5}){4}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ActivationKey", "type": "string" }, @@ -48458,26 +49584,32 @@ "additionalProperties": false, "properties": { "AccessPointArn": { + "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of the access point that DataSync uses to access the Amazon EFS file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AccessPointArn", "type": "string" }, "Ec2Config": { "$ref": "#/definitions/AWS::DataSync::LocationEFS.Ec2Config", - "markdownDescription": "The subnet and security group that the Amazon EFS file system uses\\. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified\\. \nThe exact relationship between security group M \\(of the mount target\\) and security group S \\(which you provide for DataSync to use at this stage\\) is as follows: \n+ Security group M \\(which you associate with the mount target\\) must allow inbound access for the Transmission Control Protocol \\(TCP\\) on the NFS port \\(2049\\) from security group S\\. You can enable inbound connections either by IP address \\(CIDR range\\) or security group\\. \n+ Security group S \\(provided to DataSync to access EFS\\) should have a rule that enables outbound connections to the NFS port on one of the file system\u2019s mount targets\\. You can enable outbound connections either by IP address \\(CIDR range\\) or security group\\.", + "markdownDescription": "Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system\\. \n*Required*: Yes \n*Type*: [Ec2Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationefs-ec2config.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Ec2Config" }, "EfsFilesystemArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the Amazon EFS file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the ARN for the Amazon EFS file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EfsFilesystemArn", "type": "string" }, "FileSystemAccessRoleArn": { + "markdownDescription": "Specifies an AWS Identity and Access Management \\(IAM\\) role that DataSync assumes when mounting the Amazon EFS file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemAccessRoleArn", "type": "string" }, "InTransitEncryption": { + "markdownDescription": "Specifies whether you want DataSync to use Transport Layer Security \\(TLS\\) 1\\.2 encryption when it copies data to or from the Amazon EFS file system\\. \nIf you specify an access point using `AccessPointArn` or an IAM role using `FileSystemAccessRoleArn`, you must set this parameter to `TLS1_2`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | TLS1_2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InTransitEncryption", "type": "string" }, "Subdirectory": { - "markdownDescription": "A subdirectory in the location\u2019s path\\. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination\\. By default, AWS DataSync uses the root directory\\. \n `Subdirectory` must be specified with forward slashes\\. For example, `/path/to/folder`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a mount path for your Amazon EFS file system\\. This is where DataSync reads or writes data \\(depending on if this is a source or destination location\\)\\. By default, DataSync uses the root directory, but you can also include subdirectories\\. \nYou must specify a value with forward slashes \\(for example, `/path/to/folder`\\)\\.\n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Subdirectory", "type": "string" }, @@ -48485,7 +49617,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The key\\-value pair that represents a tag that you want to add to the resource\\. The value can be an empty string\\. This value helps you manage, filter, and search for your resources\\. We recommend that you create a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the key\\-value pair that represents a tag that you want to add to the resource\\. The value can be an empty string\\. This value helps you manage, filter, and search for your resources\\. We recommend that you create a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -48523,12 +49655,12 @@ "items": { "type": "string" }, - "markdownDescription": "The Amazon Resource Names \\(ARNs\\) of the security groups that are configured for the Amazon EC2 resource\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the Amazon Resource Names \\(ARNs\\) of the security groups associated with an Amazon EFS file system's mount target\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SecurityGroupArns", "type": "array" }, "SubnetArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the subnet that DataSync uses to access the target EFS file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the ARN of a subnet where DataSync creates the [network interfaces](datasync/latest/userguide/datasync-network.html#required-network-interfaces) for managing traffic during your transfer\\. \nThe subnet must be located: \n+ In the same virtual private cloud \\(VPC\\) as the Amazon EFS file system\\.\n+ In the same Availability Zone as at least one mount target for the Amazon EFS file system\\.\nYou don't need to specify a subnet that includes a file system mount target\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SubnetArn", "type": "string" } @@ -48575,7 +49707,7 @@ "additionalProperties": false, "properties": { "FsxFilesystemArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the FSx for Lustre file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the FSx for Lustre file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "FsxFilesystemArn", "type": "string" }, @@ -48583,7 +49715,7 @@ "items": { "type": "string" }, - "markdownDescription": "The ARNs of the security groups that are used to configure the FSx for Lustre file system\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Length constraints*: Maximum length of 128\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARNs of the security groups that are used to configure the FSx for Lustre file system\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Length constraints*: Maximum length of 128\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SecurityGroupArns", "type": "array" }, @@ -48663,24 +49795,34 @@ "additionalProperties": false, "properties": { "Protocol": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.Protocol" + "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.Protocol", + "markdownDescription": "Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system\\. \n*Required*: No \n*Type*: [Protocol](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-protocol.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Protocol" }, "SecurityGroupArns": { "items": { "type": "string" }, + "markdownDescription": "Specifies the Amazon Resource Names \\(ARNs\\) of the security groups that DataSync can use to access your FSx for ONTAP file system\\. You must configure the security groups to allow outbound traffic on the following ports \\(depending on the protocol that you're using\\): \n+ **Network File System \\(NFS\\)**: TCP ports 111, 635, and 2049\n+ **Server Message Block \\(SMB\\)**: TCP port 445\nYour file system's security groups must also allow inbound traffic on the same port\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SecurityGroupArns", "type": "array" }, "StorageVirtualMachineArn": { + "markdownDescription": "Specifies the ARN of the storage virtual machine \\(SVM\\) in your file system where you want to copy data to or from\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `162` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StorageVirtualMachineArn", "type": "string" }, "Subdirectory": { + "markdownDescription": "Specifies a path to the file share in the SVM where you'll copy your data\\. \nYou can specify a junction path \\(also known as a mount point\\), qtree path \\(for NFS file shares\\), or share name \\(for SMB file shares\\)\\. For example, your mount path might be `/vol1`, `/vol1/tree1`, or `/share1`\\. \nDon't specify a junction path in the SVM's root volume\\. For more information, see [Managing FSx for ONTAP storage virtual machines](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) in the *Amazon FSx for NetApp ONTAP User Guide*\\.\n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Subdirectory", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Specifies labels that help you categorize, filter, and search for your AWS resources\\. We recommend creating at least a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -48715,7 +49857,9 @@ "additionalProperties": false, "properties": { "MountOptions": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.NfsMountOptions" + "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.NfsMountOptions", + "markdownDescription": "Specifies how DataSync can access a location using the NFS protocol\\. \n*Required*: Yes \n*Type*: [NfsMountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfsmountoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MountOptions" } }, "required": [ @@ -48727,6 +49871,8 @@ "additionalProperties": false, "properties": { "Version": { + "markdownDescription": "Specifies the NFS version that you want DataSync to use when mounting your NFS share\\. If the server refuses to use the version specified, the task fails\\. \nYou can specify the following options: \n+ `AUTOMATIC` \\(default\\): DataSync chooses NFS version 4\\.1\\.\n+ `NFS3`: Stateless protocol version that allows for asynchronous writes on the server\\.\n+ `NFSv4_0`: Stateful, firewall\\-friendly protocol version that supports delegations and pseudo file systems\\.\n+ `NFSv4_1`: Stateful protocol version that supports sessions, directory delegations, and parallel data processing\\. NFS version 4\\.1 also includes all features available in version 4\\.0\\.\nDataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Version", "type": "string" } }, @@ -48736,10 +49882,14 @@ "additionalProperties": false, "properties": { "NFS": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.NFS" + "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.NFS", + "markdownDescription": "Specifies the Network File System \\(NFS\\) protocol configuration that DataSync uses to access your FSx for ONTAP file system's storage virtual machine \\(SVM\\)\\. \n*Required*: No \n*Type*: [NFS](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfs.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NFS" }, "SMB": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.SMB" + "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.SMB", + "markdownDescription": "Specifies the Server Message Block \\(SMB\\) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM\\. \n*Required*: No \n*Type*: [SMB](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SMB" } }, "type": "object" @@ -48748,15 +49898,23 @@ "additionalProperties": false, "properties": { "Domain": { + "markdownDescription": "Specifies the fully qualified domain name \\(FQDN\\) of the Microsoft Active Directory that your storage virtual machine \\(SVM\\) belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^[A-Za-z0-9]((\\.|-+)?[A-Za-z0-9]){0,252}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Domain", "type": "string" }, "MountOptions": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.SmbMountOptions" + "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.SmbMountOptions", + "markdownDescription": "Specifies how DataSync can access a location using the SMB protocol\\. \n*Required*: Yes \n*Type*: [SmbMountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smbmountoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MountOptions" }, "Password": { + "markdownDescription": "Specifies the password of a user who has permission to access your SVM\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Password", "type": "string" }, "User": { + "markdownDescription": "Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM\\. \nIf you provide a user in your Active Directory, note the following: \n+ If you're using AWS Directory Service for Microsoft Active Directory, the user must be a member of the AWS Delegated FSx Administrators group\\.\n+ If you're using a self\\-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system\\.\nMake sure that the user has the permissions it needs to copy the data you want: \n+ `SE_TCB_NAME`: Required to set object ownership and file metadata\\. With this privilege, you also can copy NTFS discretionary access lists \\(DACLs\\)\\.\n+ `SE_SECURITY_NAME`: May be needed to copy NTFS system access control lists \\(SACLs\\)\\. This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group\\. If you configure your task to copy SACLs, make sure that the user has the required privileges\\. For information about copying SACLs, see [Ownership and permissions\\-related options](https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions)\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "User", "type": "string" } }, @@ -48771,6 +49929,8 @@ "additionalProperties": false, "properties": { "Version": { + "markdownDescription": "By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server\\. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically\\. \nThese are the following options for configuring the SMB version: \n+ `AUTOMATIC` \\(default\\): DataSync and the SMB file server negotiate a protocol version that they mutually support\\. \\(DataSync supports SMB versions 1\\.0 and later\\.\\)", + "title": "Version", "type": "string" } }, @@ -48812,24 +49972,34 @@ "additionalProperties": false, "properties": { "FsxFilesystemArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the FSx for OpenZFS file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FsxFilesystemArn", "type": "string" }, "Protocol": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxOpenZFS.Protocol" + "$ref": "#/definitions/AWS::DataSync::LocationFSxOpenZFS.Protocol", + "markdownDescription": "The type of protocol that AWS DataSync uses to access your file system\\. \n*Required*: Yes \n*Type*: [Protocol](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-protocol.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Protocol" }, "SecurityGroupArns": { "items": { "type": "string" }, + "markdownDescription": "The ARNs of the security groups that are used to configure the FSx for OpenZFS file system\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Length constraints*: Maximum length of 128\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SecurityGroupArns", "type": "array" }, "Subdirectory": { + "markdownDescription": "A subdirectory in the location's path that must begin with `/fsx`\\. DataSync uses this subdirectory to read or write data \\(depending on whether the file system is a source or destination location\\)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,4096}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Subdirectory", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The key\\-value pair that represents a tag that you want to add to the resource\\. The value can be an empty string\\. This value helps you manage, filter, and search for your resources\\. We recommend that you create a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -48864,6 +50034,8 @@ "additionalProperties": false, "properties": { "Version": { + "markdownDescription": "The specific NFS version that you want DataSync to use to mount your NFS share\\. If the server refuses to use the version specified, the sync will fail\\. If you don't specify a version, DataSync defaults to `AUTOMATIC`\\. That is, DataSync automatically selects a version based on negotiation with the NFS server\\. \nYou can specify the following NFS versions: \n+ **[NFSv3](https://tools.ietf.org/html/rfc1813)**: Stateless protocol version that allows for asynchronous writes on the server\\.\n+ **[NFSv4\\.0](https://tools.ietf.org/html/rfc3530)**: Stateful, firewall\\-friendly protocol version that supports delegations and pseudo file systems\\.\n+ **[NFSv4\\.1](https://tools.ietf.org/html/rfc5661)**: Stateful protocol version that supports sessions, directory delegations, and parallel data processing\\. Version 4\\.1 also includes all features available in version 4\\.0\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Version", "type": "string" } }, @@ -48873,7 +50045,9 @@ "additionalProperties": false, "properties": { "MountOptions": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxOpenZFS.MountOptions" + "$ref": "#/definitions/AWS::DataSync::LocationFSxOpenZFS.MountOptions", + "markdownDescription": "Represents the mount options that are available for DataSync to access an NFS location\\. \n*Required*: Yes \n*Type*: [MountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-mountoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MountOptions" } }, "required": [ @@ -48885,7 +50059,9 @@ "additionalProperties": false, "properties": { "NFS": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxOpenZFS.NFS" + "$ref": "#/definitions/AWS::DataSync::LocationFSxOpenZFS.NFS", + "markdownDescription": "Represents the Network File System \\(NFS\\) protocol that DataSync uses to access your FSx for OpenZFS file system\\. \n*Required*: No \n*Type*: [NFS](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-nfs.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NFS" } }, "type": "object" @@ -48926,17 +50102,17 @@ "additionalProperties": false, "properties": { "Domain": { - "markdownDescription": "The name of the Windows domain that the FSx for Windows File Server belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the name of the Windows domain that the FSx for Windows File Server belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^[A-Za-z0-9]((\\.|-+)?[A-Za-z0-9]){0,252}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Domain", "type": "string" }, "FsxFilesystemArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the FSx for Windows File Server file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) for the FSx for Windows File Server file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "FsxFilesystemArn", "type": "string" }, "Password": { - "markdownDescription": "The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the password of the user who has the permissions to access files and folders in the file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Password", "type": "string" }, @@ -48949,7 +50125,7 @@ "type": "array" }, "Subdirectory": { - "markdownDescription": "A subdirectory in the location's path\\. This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a mount path for your file system using forward slashes\\. This is where DataSync reads or writes data \\(depending on if this is a source or destination location\\)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Subdirectory", "type": "string" }, @@ -48957,7 +50133,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The key\\-value pair that represents a tag that you want to add to the resource\\. The value can be an empty string\\. This value helps you manage, filter, and search for your resources\\. We recommend that you create a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies labels that help you categorize, filter, and search for your AWS resources\\. We recommend creating at least a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -49038,7 +50214,7 @@ "type": "array" }, "AuthenticationType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthenticationType", "type": "string" }, @@ -49214,12 +50390,12 @@ "title": "OnPremConfig" }, "ServerHostname": { - "markdownDescription": "The name of the NFS server\\. This value is the IP address or Domain Name Service \\(DNS\\) name of the NFS server\\. An agent that is installed on\\-premises uses this host name to mount the NFS server in a network\\. \nIf you are copying data to or from your AWS Snowcone device, see [NFS Server on AWS Snowcone](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) for more information\\. \nThis name must either be DNS\\-compliant or must be an IP version 4 \\(IPv4\\) address\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the NFS server\\. This value is the IP address or Domain Name Service \\(DNS\\) name of the NFS server\\. An agent that is installed on\\-premises uses this hostname to mount the NFS server in a network\\. \nIf you are copying data to or from your AWS Snowcone device, see [NFS Server on AWS Snowcone](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) for more information\\. \nThis name must either be DNS\\-compliant or must be an IP version 4 \\(IPv4\\) address\\.\n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ServerHostname", "type": "string" }, "Subdirectory": { - "markdownDescription": "The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination\\. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path\\. The path should be such that it can be mounted by other NFS clients in your network\\. \nTo see all the paths exported by your NFS server, run \"`showmount -e nfs-server-name`\" from an NFS client that has access to your server\\. You can specify any directory that appears in the results, and any subdirectory of that directory\\. Ensure that the NFS export is accessible without Kerberos authentication\\. \nTo transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data\\. To ensure this, either configure the NFS export with `no_root_squash,` or ensure that the permissions for all of the files that you want DataSync allow read access for all users\\. Doing either enables the agent to read the files\\. For the agent to access directories, you must additionally enable all execute access\\. \nIf you are copying data to or from your AWS Snowcone device, see [NFS Server on AWS Snowcone](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) for more information\\. \nFor information about NFS export configuration, see [18\\.7\\. The /etc/exports Configuration File](http://web.mit.edu/rhel-doc/5/RHEL-5-manual/Deployment_Guide-en-US/s1-nfs-server-config-exports.html) in the Red Hat Enterprise Linux documentation\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination\\. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path\\. The path should be such that it can be mounted by other NFS clients in your network\\. \nTo see all the paths exported by your NFS server, run \"`showmount -e nfs-server-name`\" from an NFS client that has access to your server\\. You can specify any directory that appears in the results, and any subdirectory of that directory\\. Ensure that the NFS export is accessible without Kerberos authentication\\. \nTo transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data\\. To ensure this, either configure the NFS export with `no_root_squash,` or ensure that the permissions for all of the files that you want DataSync allow read access for all users\\. Doing either enables the agent to read the files\\. For the agent to access directories, you must additionally enable all execute access\\. \nIf you are copying data to or from your AWS Snowcone device, see [NFS Server on AWS Snowcone](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) for more information\\. \nFor information about NFS export configuration, see [18\\.7\\. The /etc/exports Configuration File](http://web.mit.edu/rhel-doc/5/RHEL-5-manual/Deployment_Guide-en-US/s1-nfs-server-config-exports.html) in the Red Hat Enterprise Linux documentation\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Subdirectory", "type": "string" }, @@ -49262,7 +50438,7 @@ "additionalProperties": false, "properties": { "Version": { - "markdownDescription": "The specific NFS version that you want DataSync to use to mount your NFS share\\. If the server refuses to use the version specified, the sync will fail\\. If you don't specify a version, DataSync defaults to `AUTOMATIC`\\. That is, DataSync automatically selects a version based on negotiation with the NFS server\\. \nYou can specify the following NFS versions: \n+ ** [NFSv3](https://tools.ietf.org/html/rfc1813) ** \\- stateless protocol version that allows for asynchronous writes on the server\\.\n+ ** [NFSv4\\.0](https://tools.ietf.org/html/rfc3530) ** \\- stateful, firewall\\-friendly protocol version that supports delegations and pseudo file systems\\.\n+ ** [NFSv4\\.1](https://tools.ietf.org/html/rfc5661) ** \\- stateful protocol version that supports sessions, directory delegations, and parallel data processing\\. Version 4\\.1 also includes all features available in version 4\\.0\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the NFS version that you want DataSync to use when mounting your NFS share\\. If the server refuses to use the version specified, the task fails\\. \nYou can specify the following options: \n+ `AUTOMATIC` \\(default\\): DataSync chooses NFS version 4\\.1\\.\n+ `NFS3`: Stateless protocol version that allows for asynchronous writes on the server\\.\n+ `NFSv4_0`: Stateful, firewall\\-friendly protocol version that supports delegations and pseudo file systems\\.\n+ `NFSv4_1`: Stateful protocol version that supports sessions, directory delegations, and parallel data processing\\. NFS version 4\\.1 also includes all features available in version 4\\.0\\.\nDataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -49322,7 +50498,7 @@ "additionalProperties": false, "properties": { "AccessKey": { - "markdownDescription": "Optional\\. The access key is used if credentials are required to access the self\\-managed object storage server\\. If your object storage requires a user name and password to authenticate, use `AccessKey` and `SecretKey` to provide the user name and password, respectively\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `200` \n*Pattern*: `^.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the access key \\(for example, a user name\\) if credentials are required to authenticate with the object storage server\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `200` \n*Pattern*: `^.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessKey", "type": "string" }, @@ -49330,40 +50506,42 @@ "items": { "type": "string" }, - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the agents associated with the self\\-managed object storage server location\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the Amazon Resource Names \\(ARNs\\) of the DataSync agents that can securely connect with your location\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AgentArns", "type": "array" }, "BucketName": { - "markdownDescription": "The bucket on the self\\-managed object storage server that is used to read data from\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the name of the object storage bucket involved in the transfer\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "BucketName", "type": "string" }, "SecretKey": { - "markdownDescription": "Optional\\. The secret key is used if credentials are required to access the self\\-managed object storage server\\. If your object storage requires a user name and password to authenticate, use `AccessKey` and `SecretKey` to provide the user name and password, respectively\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `200` \n*Pattern*: `^.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the secret key \\(for example, a password\\) if credentials are required to authenticate with the object storage server\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `200` \n*Pattern*: `^.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretKey", "type": "string" }, "ServerCertificate": { + "markdownDescription": "Specifies a certificate to authenticate with an object storage system that uses a private or self\\-signed certificate authority \\(CA\\)\\. You must specify a Base64\\-encoded `.pem` file \\(for example, `file:///home/user/.ssh/storage_sys_certificate.pem`\\)\\. The certificate can be up to 32768 bytes \\(before Base64 encoding\\)\\. \nTo use this parameter, configure `ServerProtocol` to `HTTPS`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerCertificate", "type": "string" }, "ServerHostname": { - "markdownDescription": "The name of the self\\-managed object storage server\\. This value is the IP address or Domain Name Service \\(DNS\\) name of the object storage server\\. An agent uses this host name to mount the object storage server in a network\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the domain name or IP address of the object storage server\\. A DataSync agent uses this hostname to mount the object storage server in a network\\. \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ServerHostname", "type": "string" }, "ServerPort": { - "markdownDescription": "The port that your self\\-managed object storage server accepts inbound network traffic on\\. The server port is set by default to TCP 80 \\(HTTP\\) or TCP 443 \\(HTTPS\\)\\. You can specify a custom port if your self\\-managed object storage server requires one\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65536` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the port that your object storage server accepts inbound network traffic on \\(for example, port 443\\)\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65536` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServerPort", "type": "number" }, "ServerProtocol": { - "markdownDescription": "The protocol that the object storage server uses to communicate\\. Valid values are HTTP or HTTPS\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HTTP | HTTPS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the protocol that your object storage server uses to communicate\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HTTP | HTTPS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServerProtocol", "type": "string" }, "Subdirectory": { - "markdownDescription": "The subdirectory in the self\\-managed object storage server that is used to read data from\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the object prefix for your object storage server\\. If this is a source location, DataSync only copies objects with this prefix\\. If this is a destination location, DataSync writes all objects with this prefix\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Subdirectory", "type": "string" }, @@ -49371,7 +50549,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The key\\-value pair that represents the tag that you want to add to the location\\. The value can be an empty string\\. We recommend using tags to name your resources\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the key\\-value pair that represents a tag that you want to add to the resource\\. Tags can help you manage, filter, and search for your resources\\. We recommend creating a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -49438,7 +50616,7 @@ "additionalProperties": false, "properties": { "S3BucketArn": { - "markdownDescription": "The ARN of the Amazon S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `156` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Maximum*: `156` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "S3BucketArn", "type": "string" }, @@ -49448,7 +50626,7 @@ "title": "S3Config" }, "S3StorageClass": { - "markdownDescription": "The Amazon S3 storage class that you want to store your files in when this location is used as a task destination\\. For buckets in AWS Regions, the storage class defaults to S3 Standard\\. \nFor more information about S3 storage classes, see [Amazon S3 Storage Classes](http://aws.amazon.com/s3/storage-classes/)\\. Some storage classes have behaviors that can affect your S3 storage costs\\. 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)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEEP_ARCHIVE | GLACIER | INTELLIGENT_TIERING | ONEZONE_IA | OUTPOSTS | STANDARD | STANDARD_IA` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon S3 storage class that you want to store your files in when this location is used as a task destination\\. For buckets in AWS Regions, the storage class defaults to S3 Standard\\. \nFor more information about S3 storage classes, see [Amazon S3 Storage Classes](http://aws.amazon.com/s3/storage-classes/)\\. Some storage classes have behaviors that can affect your S3 storage costs\\. 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)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEEP_ARCHIVE | GLACIER | GLACIER_INSTANT_RETRIEVAL | INTELLIGENT_TIERING | ONEZONE_IA | OUTPOSTS | STANDARD | STANDARD_IA` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "S3StorageClass", "type": "string" }, @@ -49550,27 +50728,27 @@ "type": "array" }, "Domain": { - "markdownDescription": "The name of the Windows domain that the SMB server belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the Windows domain name that your SMB file server belongs to\\. \nFor more information, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) for SMB locations\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^[A-Za-z0-9]((\\.|-+)?[A-Za-z0-9]){0,252}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Domain", "type": "string" }, "MountOptions": { "$ref": "#/definitions/AWS::DataSync::LocationSMB.MountOptions", - "markdownDescription": "The mount options used by DataSync to access the SMB server\\. \n*Required*: No \n*Type*: [MountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-mountoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the version of the SMB protocol that DataSync uses to access your SMB file server\\. \n*Required*: No \n*Type*: [MountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-mountoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MountOptions" }, "Password": { - "markdownDescription": "The password of the user who can mount the share and has the permissions to access files and folders in the SMB share\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The password of the user who can mount the share and has the permissions to access files and folders in the SMB share\\. \n*Required*: No \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Password", "type": "string" }, "ServerHostname": { - "markdownDescription": "The name of the SMB server\\. This value is the IP address or Domain Name Service \\(DNS\\) name of the SMB server\\. An agent that is installed on\\-premises uses this hostname to mount the SMB server in a network\\. \nThis name must either be DNS\\-compliant or must be an IP version 4 \\(IPv4\\) address\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the Domain Name Service \\(DNS\\) name or IP address of the SMB file server that your DataSync agent will mount\\. \nYou can't specify an IP version 6 \\(IPv6\\) address\\.\n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ServerHostname", "type": "string" }, "Subdirectory": { - "markdownDescription": "The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination\\. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path\\. The path should be such that it can be mounted by other SMB clients in your network\\. \n `Subdirectory` must be specified with forward slashes\\. For example, `/path/to/folder`\\.\nTo transfer all the data in the folder you specified, DataSync must have permissions to mount the SMB share, as well as to access all the data in that share\\. To ensure this, either make sure that the user name and password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share\\. Doing either one enables the agent to access the data\\. For the agent to access directories, you must additionally enable all execute access\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination\\. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path\\. The path should be such that it can be mounted by other SMB clients in your network\\. \n `Subdirectory` must be specified with forward slashes\\. For example, `/path/to/folder`\\.\nTo transfer all the data in the folder you specified, DataSync must have permissions to mount the SMB share, as well as to access all the data in that share\\. To ensure this, either make sure that the user name and password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share\\. Doing either one enables the agent to access the data\\. For the agent to access directories, you must additionally enable all execute access\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Subdirectory", "type": "string" }, @@ -49578,7 +50756,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The key\\-value pair that represents the tag that you want to add to the location\\. The value can be an empty string\\. We recommend using tags to name your resources\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies labels that help you categorize, filter, and search for your AWS resources\\. We recommend creating at least a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -49619,7 +50797,7 @@ "additionalProperties": false, "properties": { "Version": { - "markdownDescription": "The specific SMB version that you want DataSync to use to mount your SMB share\\. If you don't specify a version, DataSync defaults to `AUTOMATIC`\\. That is, DataSync automatically selects a version based on negotiation with the SMB server\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | SMB2 | SMB3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server\\. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically\\. \nThese are the following options for configuring the SMB version: \n+ `AUTOMATIC` \\(default\\): DataSync and the SMB file server negotiate a protocol version that they mutually support\\. \\(DataSync supports SMB versions 1\\.0 and later\\.\\)", "title": "Version", "type": "string" } @@ -49675,7 +50853,7 @@ "items": { "$ref": "#/definitions/AWS::DataSync::Task.FilterRule" }, - "markdownDescription": "A list of filter rules that determines which files to exclude from a task\\. The list should contain a single filter string that consists of the patterns to exclude\\. The patterns are delimited by \"\\|\" \\(that is, a pipe\\), for example, `\"/folder1|/folder2\"`\\. \n \n*Required*: No \n*Type*: List of [FilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of filter rules that exclude specific data during your transfer\\. For more information and examples, see [Filtering data transferred by DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)\\. \n*Required*: No \n*Type*: List of [FilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Excludes", "type": "array" }, @@ -49683,7 +50861,7 @@ "items": { "$ref": "#/definitions/AWS::DataSync::Task.FilterRule" }, - "markdownDescription": "A list of filter rules that determines which files to include when running a task\\. The pattern contains a single filter string that consists of the patterns to include\\. The patterns are delimited by \"\\|\" \\(that is, a pipe\\), for example, `\"/folder1|/folder2\"`\\. \n*Required*: No \n*Type*: List of [FilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of filter rules that include specific data during your transfer\\. For more information and examples, see [Filtering data transferred by DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)\\. \n*Required*: No \n*Type*: List of [FilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Includes", "type": "array" }, @@ -49694,7 +50872,7 @@ }, "Options": { "$ref": "#/definitions/AWS::DataSync::Task.Options", - "markdownDescription": "The set of configuration options that control the behavior of a single execution of the task that occurs when you call `StartTaskExecution`\\. You can configure these options to preserve metadata such as user ID \\(UID\\) and group ID \\(GID\\), file permissions, data integrity verification, and so on\\. \nFor each individual task execution, you can override these options by specifying the `OverrideOptions` before starting the task execution\\. For more information, see the [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) operation\\. \n*Required*: No \n*Type*: [Options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the configuration options for a task\\. Some options include preserving file or object metadata and verifying data integrity\\. \nYou can also override these options before starting an individual run of a task \\(also known as a *task execution*\\)\\. For more information, see [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html)\\. \n*Required*: No \n*Type*: [Options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Options" }, "Schedule": { @@ -49711,7 +50889,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The key\\-value pair that represents the tag that you want to add to the resource\\. The value can be an empty string\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the tags that you want to apply to the Amazon Resource Name \\(ARN\\) representing the task\\. \n *Tags* are key\\-value pairs that help you manage, filter, and search for your DataSync resources\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -49752,7 +50930,7 @@ "type": "string" }, "Value": { - "markdownDescription": "A single filter string that consists of the patterns to include or exclude\\. The patterns are delimited by \"\\|\" \\(that is, a pipe\\), for example: `/folder1|/folder2` \n \n*Required*: No \n*Type*: String \n*Maximum*: `409600` \n*Pattern*: `^[^\\x00]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A single filter string that consists of the patterns to include or exclude\\. The patterns are delimited by \"\\|\" \\(that is, a pipe\\), for example: `/folder1|/folder2` \n \n*Required*: No \n*Type*: String \n*Maximum*: `102400` \n*Pattern*: `^[^\\x00]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -49778,7 +50956,7 @@ "type": "string" }, "LogLevel": { - "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `BASIC | OFF | TRANSFER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group\\. To specify the log group, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn)\\. \nIf you set `LogLevel` to `OFF`, no logs are published\\. `BASIC` publishes logs on errors for individual files transferred\\. `TRANSFER` publishes logs for every file or object that is transferred and integrity checked\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `BASIC | OFF | TRANSFER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogLevel", "type": "string" }, @@ -49788,10 +50966,12 @@ "type": "string" }, "ObjectTags": { + "markdownDescription": "Specifies whether object tags are preserved when transferring between object storage systems\\. If you want your DataSync task to ignore object tags, specify the `NONE` value\\. \nDefault Value: `PRESERVE` \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | PRESERVE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObjectTags", "type": "string" }, "OverwriteMode": { - "markdownDescription": "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\\. \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*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS | NEVER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether data at the destination location should be overwritten or preserved\\. If set to `NEVER`, a destination file for example 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\\. \nSome storage classes have specific behaviors that can affect your Amazon 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)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS | NEVER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OverwriteMode", "type": "string" }, @@ -49816,7 +50996,7 @@ "type": "string" }, "TaskQueueing": { - "markdownDescription": "A value that determines whether tasks should be queued before executing the tasks\\. If set to `ENABLED`, the tasks will be queued\\. The default is `ENABLED`\\. \nIf you use the same agent to run multiple tasks, you can enable the tasks to run in series\\. For more information, see [Queueing task executions](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether tasks should be queued before executing the tasks\\. The default is `ENABLED`, which means the tasks will be queued\\. \nIf you use the same agent to run multiple tasks, you can enable the tasks to run in series\\. For more information, see [Queueing task executions](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TaskQueueing", "type": "string" }, @@ -50078,7 +51258,9 @@ "additionalProperties": false, "properties": { "Filters": { - "$ref": "#/definitions/AWS::DevOpsGuru::NotificationChannel.NotificationFilterConfig" + "$ref": "#/definitions/AWS::DevOpsGuru::NotificationChannel.NotificationFilterConfig", + "markdownDescription": "The filter configurations for the Amazon SNS notification topic you use with DevOps Guru\\. If you do not provide filter configurations, the default configurations are to receive notifications for all message types of `High` or `Medium` severity\\. \n*Required*: No \n*Type*: [NotificationFilterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationfilterconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Filters" }, "Sns": { "$ref": "#/definitions/AWS::DevOpsGuru::NotificationChannel.SnsChannelConfig", @@ -50095,12 +51277,16 @@ "items": { "type": "string" }, + "markdownDescription": "The events that you want to receive notifications for\\. For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MessageTypes", "type": "array" }, "Severities": { "items": { "type": "string" }, + "markdownDescription": "The severity levels that you want to receive notifications for\\. For example, you can choose to receive notifications only for insights with `HIGH` and `MEDIUM` severity levels\\. For more information, see [Understanding insight severities](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Severities", "type": "array" } }, @@ -50210,6 +51396,8 @@ "items": { "$ref": "#/definitions/AWS::DevOpsGuru::ResourceCollection.TagCollection" }, + "markdownDescription": "The AWS tags used to filter the resources in the resource collection\\. \nTags help you identify and organize your AWS resources\\. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related\\. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function\\. For more information about using tags, see the [Tagging best practices](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) whitepaper\\. \nEach AWS tag has two parts\\. \n+ A tag *key* \\(for example, `CostCenter`, `Environment`, `Project`, or `Secret`\\)\\. Tag *keys* are case\\-sensitive\\.\n+ An optional field known as a tag *value* \\(for example, `111122223333`, `Production`, or a team name\\)\\. Omitting the tag *value* is the same as using an empty string\\. Like tag *keys*, tag *values* are case\\-sensitive\\.\nTogether these are known as *key*\\-*value* pairs\\. \nThe string used for a *key* in a tag that you use to define your resource coverage must begin with the prefix `Devops-guru-`\\. The tag *key* might be `DevOps-Guru-deployment-application` or `devops-guru-rds-application`\\. When you create a *key*, the case of characters in the *key* can be whatever you choose\\. After you create a *key*, it is case\\-sensitive\\. For example, DevOps Guru works with a *key* named `devops-guru-rds` and a *key* named `DevOps-Guru-RDS`, and these act as two different *keys*\\. Possible *key*/*value* pairs in your application might be `Devops-Guru-production-application/RDS` or `Devops-Guru-production-application/containers`\\.\n*Required*: No \n*Type*: List of [TagCollection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-tagcollection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -50219,12 +51407,16 @@ "additionalProperties": false, "properties": { "AppBoundaryKey": { + "markdownDescription": "An AWS tag *key* that is used to identify the AWS resources that DevOps Guru analyzes\\. All AWS resources in your account and Region tagged with this *key* make up your DevOps Guru application and analysis boundary\\. \nThe string used for a *key* in a tag that you use to define your resource coverage must begin with the prefix `Devops-guru-`\\. The tag *key* might be `DevOps-Guru-deployment-application` or `devops-guru-rds-application`\\. When you create a *key*, the case of characters in the *key* can be whatever you choose\\. After you create a *key*, it is case\\-sensitive\\. For example, DevOps Guru works with a *key* named `devops-guru-rds` and a *key* named `DevOps-Guru-RDS`, and these act as two different *keys*\\. Possible *key*/*value* pairs in your application might be `Devops-Guru-production-application/RDS` or `Devops-Guru-production-application/containers`\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppBoundaryKey", "type": "string" }, "TagValues": { "items": { "type": "string" }, + "markdownDescription": "The values in an AWS tag collection\\. \nThe tag's *value* is an optional field used to associate a string with the tag *key* \\(for example, `111122223333`, `Production`, or a team name\\)\\. The *key* and *value* are the tag's *key* pair\\. Omitting the tag *value* is the same as using an empty string\\. Like tag *keys*, tag *values* are case\\-sensitive\\. You can specify a maximum of 256 characters for a tag value\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TagValues", "type": "array" } }, @@ -50408,7 +51600,7 @@ "type": "string" }, "Password": { - "markdownDescription": "The password for the directory administrator\\. The directory creation process creates a directory administrator account with the user name `Administrator` and this password\\. \nIf you need to change the password for the administrator account, see the [ResetUserPassword](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html) API call in the *AWS Directory Service API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `(?=^.{8,64}$)((?=.*\\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[^A-Za-z0-9\\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\\s]))^.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The password for the directory administrator\\. The directory creation process creates a directory administrator account with the user name `Administrator` and this password\\. \nIf you need to change the password for the administrator account, see the [ResetUserPassword](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html) API call in the *AWS Directory Service API Reference*\\. \n*Required*: No \n*Type*: String \n*Pattern*: `(?=^.{8,64}$)((?=.*\\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[^A-Za-z0-9\\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\\s]))^.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Password", "type": "string" }, @@ -50463,12 +51655,12 @@ "items": { "type": "string" }, - "markdownDescription": "The identifiers of the subnets for the directory servers\\. The two subnets must be in different Availability Zones\\. AWS Directory Service specifies a directory server and a DNS server in each of these subnets\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifiers of the subnets for the directory servers\\. The two subnets must be in different Availability Zones\\. AWS Directory Service specifies a directory server and a DNS server in each of these subnets\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SubnetIds", "type": "array" }, "VpcId": { - "markdownDescription": "The identifier of the VPC in which to create the directory\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of the VPC in which to create the directory\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VpcId", "type": "string" } @@ -50528,7 +51720,7 @@ "type": "number" }, "CopyTagsToSnapshot": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CopyTagsToSnapshot", "type": "boolean" }, @@ -50596,9 +51788,13 @@ "type": "string" }, "RestoreToTime": { + "markdownDescription": "The date and time to restore the cluster to\\. \nValid values: A time in Universal Coordinated Time \\(UTC\\) format\\. \nConstraints: \n+ Must be before the latest restorable time for the instance\\.\n+ Must be specified if the `UseLatestRestorableTime` parameter is not provided\\.\n+ Cannot be specified if the `UseLatestRestorableTime` parameter is `true`\\.\n+ Cannot be specified if the `RestoreType` parameter is `copy-on-write`\\.\nExample: `2015-03-07T23:45:00Z` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RestoreToTime", "type": "string" }, "RestoreType": { + "markdownDescription": "The type of restore to be performed\\. You can specify one of the following values: \n+ `full-copy` \\- The new DB cluster is restored as a full copy of the source DB cluster\\.\n+ `copy-on-write` \\- The new DB cluster is restored as a clone of the source DB cluster\\.\nConstraints: You can't specify `copy-on-write` if the engine version of the source DB cluster is earlier than 1\\.11\\. \nIf you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RestoreType", "type": "string" }, "SnapshotIdentifier": { @@ -50607,6 +51803,8 @@ "type": "string" }, "SourceDBClusterIdentifier": { + "markdownDescription": "The identifier of the source cluster from which to restore\\. \nConstraints: \n+ Must match the identifier of an existing `DBCluster`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceDBClusterIdentifier", "type": "string" }, "StorageEncrypted": { @@ -50623,6 +51821,8 @@ "type": "array" }, "UseLatestRestorableTime": { + "markdownDescription": "A value that is set to `true` to restore the cluster to the latest restorable backup time, and `false` otherwise\\. \nDefault: `false` \nConstraints: Cannot be specified if the `RestoreToTime` parameter is provided\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseLatestRestorableTime", "type": "boolean" }, "VpcSecurityGroupIds": { @@ -50809,6 +52009,8 @@ "type": "string" }, "EnablePerformanceInsights": { + "markdownDescription": "A value that indicates whether to enable Performance Insights for the DB Instance\\. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnablePerformanceInsights", "type": "boolean" }, "PreferredMaintenanceWindow": { @@ -50977,45 +52179,67 @@ "additionalProperties": false, "properties": { "AdminUserName": { + "markdownDescription": "The name of the Amazon DocumentDB elastic clusters administrator\\. \n*Constraints*: \n+ Must be from 1 to 63 letters or numbers\\.\n+ The first character must be a letter\\.\n+ Cannot be a reserved word\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AdminUserName", "type": "string" }, "AdminUserPassword": { + "markdownDescription": "The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters\\. \n*Constraints*: \n+ Must contain from 8 to 100 characters\\.\n+ Cannot contain a forward slash \\(/\\), double quote \\(\"\\), or the \"at\" symbol \\(@\\)\\.\n+ A valid `AdminUserName` entry is also required\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdminUserPassword", "type": "string" }, "AuthType": { + "markdownDescription": "The authentication type used to determine where to fetch the password used for accessing the elastic cluster\\. Valid types are `PLAIN_TEXT` or `SECRET_ARN`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AuthType", "type": "string" }, "ClusterName": { + "markdownDescription": "The name of the new elastic cluster\\. This parameter is stored as a lowercase string\\. \n*Constraints*: \n+ Must contain from 1 to 63 letters, numbers, or hyphens\\.\n+ The first character must be a letter\\.\n+ Cannot end with a hyphen or contain two consecutive hyphens\\.\n*Example*: `my-cluster` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ClusterName", "type": "string" }, "KmsKeyId": { + "markdownDescription": "The KMS key identifier to use to encrypt the new elastic cluster\\. \nThe KMS key identifier is the Amazon Resource Name \\(ARN\\) for the KMS encryption key\\. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key\\. \nIf an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account\\. Your account has a different default encryption key for each Amazon Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" }, "PreferredMaintenanceWindow": { + "markdownDescription": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \n*Format*: `ddd:hh24:mi-ddd:hh24:mi` \n*Default*: a 30\\-minute window selected at random from an 8\\-hour block of time for each AWS Region, occurring on a random day of the week\\. \n*Valid days*: Mon, Tue, Wed, Thu, Fri, Sat, Sun \n*Constraints*: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PreferredMaintenanceWindow", "type": "string" }, "ShardCapacity": { + "markdownDescription": "The number of vCPUs assigned to each elastic cluster shard\\. Maximum is 64\\. Allowed values are 2, 4, 8, 16, 32, 64\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ShardCapacity", "type": "number" }, "ShardCount": { + "markdownDescription": "The number of shards assigned to the elastic cluster\\. Maximum is 32\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ShardCount", "type": "number" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "The Amazon EC2 subnet IDs for the new elastic cluster\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetIds", "type": "array" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags to be assigned to the new elastic cluster\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "VpcSecurityGroupIds": { "items": { "type": "string" }, + "markdownDescription": "A list of EC2 VPC security groups to associate with the new elastic cluster\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcSecurityGroupIds", "type": "array" } }, @@ -51093,7 +52317,7 @@ "type": "array" }, "BillingMode": { - "markdownDescription": "Specifies how you are charged for read and write throughput and how you manage capacity\\. Valid values are: \n+ `PAY_PER_REQUEST`\n+ `PROVISIONED`\nAll replicas in your global table will have the same billing mode\\. If you use `PROVISIONED` billing mode, you must provide an auto scaling configuration via the `WriteProvisionedThroughputSettings` property\\. The default value of this property is `PROVISIONED`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PAY_PER_REQUEST | PROVISIONED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how you are charged for read and write throughput and how you manage capacity\\. Valid values are: \n+ `PAY_PER_REQUEST`\n+ `PROVISIONED`\nAll replicas in your global table will have the same billing mode\\. If you use `PROVISIONED` billing mode, you must provide an auto scaling configuration via the `WriteProvisionedThroughputSettings` property\\. The default value of this property is `PROVISIONED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BillingMode", "type": "string" }, @@ -51140,7 +52364,7 @@ "title": "StreamSpecification" }, "TableName": { - "markdownDescription": "A name for the global table\\. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name\\. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A name for the global table\\. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name\\. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TableName", "type": "string" }, @@ -51187,12 +52411,12 @@ "additionalProperties": false, "properties": { "AttributeName": { - "markdownDescription": "A name for the attribute\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A name for the attribute\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeName", "type": "string" }, "AttributeType": { - "markdownDescription": "The data type for the attribute, where: \n+ `S` \\- the attribute is of type String\n+ `N` \\- the attribute is of type Number\n+ `B` \\- the attribute is of type Binary\n*Required*: Yes \n*Type*: String \n*Allowed values*: `B | N | S` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The data type for the attribute, where: \n+ `S` \\- the attribute is of type String\n+ `N` \\- the attribute is of type Number\n+ `B` \\- the attribute is of type Binary\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeType", "type": "string" } @@ -51238,7 +52462,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "Indicates whether CloudWatch Contributor Insights are to be enabled \\(true\\) or disabled \\(false\\)\\. \n*Required*: Yes \n*Type*: Boolean \n*Allowed values*: `DISABLE | ENABLE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether CloudWatch Contributor Insights are to be enabled \\(true\\) or disabled \\(false\\)\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -51252,7 +52476,7 @@ "additionalProperties": false, "properties": { "IndexName": { - "markdownDescription": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: Updates are not supported\\.", "title": "IndexName", "type": "string" }, @@ -51260,7 +52484,7 @@ "items": { "$ref": "#/definitions/AWS::DynamoDB::GlobalTable.KeySchema" }, - "markdownDescription": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) \n*Maximum*: `2` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) \n*Update requires*: Updates are not supported\\.", "title": "KeySchema", "type": "array" }, @@ -51291,7 +52515,7 @@ "type": "string" }, "KeyType": { - "markdownDescription": "The role that this key attribute will assume: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `HASH | RANGE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The role that this key attribute will assume: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeyType", "type": "string" } @@ -51306,6 +52530,8 @@ "additionalProperties": false, "properties": { "StreamArn": { + "markdownDescription": "The ARN for a specific Kinesis data stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StreamArn", "type": "string" } }, @@ -51318,7 +52544,7 @@ "additionalProperties": false, "properties": { "IndexName": { - "markdownDescription": "The name of the local secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The name of the local secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: Updates are not supported\\.", "title": "IndexName", "type": "string" }, @@ -51326,7 +52552,7 @@ "items": { "$ref": "#/definitions/AWS::DynamoDB::GlobalTable.KeySchema" }, - "markdownDescription": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) \n*Maximum*: `2` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) \n*Update requires*: Updates are not supported\\.", "title": "KeySchema", "type": "array" }, @@ -51361,12 +52587,12 @@ "items": { "type": "string" }, - "markdownDescription": "Represents the non\\-key attribute names which will be projected into the index\\. \nFor local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, must not exceed 20\\. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Represents the non\\-key attribute names which will be projected into the index\\. \nFor local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, must not exceed 100\\. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "NonKeyAttributes", "type": "array" }, "ProjectionType": { - "markdownDescription": "The set of attributes that are projected into the index: \n+ `KEYS_ONLY` \\- Only the index and primary keys are projected into the index\\.\n+ `INCLUDE` \\- In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non\\-key attributes that you specify\\.\n+ `ALL` \\- All of the table attributes are projected into the index\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ALL | INCLUDE | KEYS_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The set of attributes that are projected into the index: \n+ `KEYS_ONLY` \\- Only the index and primary keys are projected into the index\\.\n+ `INCLUDE` \\- In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non\\-key attributes that you specify\\.\n+ `ALL` \\- All of the table attributes are projected into the index\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "ProjectionType", "type": "string" } @@ -51398,7 +52624,7 @@ "title": "ContributorInsightsSpecification" }, "IndexName": { - "markdownDescription": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IndexName", "type": "string" }, @@ -51444,7 +52670,9 @@ "type": "array" }, "KinesisStreamSpecification": { - "$ref": "#/definitions/AWS::DynamoDB::GlobalTable.KinesisStreamSpecification" + "$ref": "#/definitions/AWS::DynamoDB::GlobalTable.KinesisStreamSpecification", + "markdownDescription": "Defines the Kinesis Data Streams configuration for the specified replica\\. \n*Required*: No \n*Type*: [KinesisStreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-kinesisstreamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KinesisStreamSpecification" }, "PointInTimeRecoverySpecification": { "$ref": "#/definitions/AWS::DynamoDB::GlobalTable.PointInTimeRecoverySpecification", @@ -51467,7 +52695,7 @@ "title": "SSESpecification" }, "TableClass": { - "markdownDescription": "The table class of the specified table\\. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `STANDARD | STANDARD_INFREQUENT_ACCESS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The table class of the specified table\\. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TableClass", "type": "string" }, @@ -51489,12 +52717,12 @@ "additionalProperties": false, "properties": { "SSEEnabled": { - "markdownDescription": "Indicates whether server\\-side encryption is performed using an AWS managed key or an AWS owned key\\. If disabled \\(false\\) or not specified, server\\-side encryption uses an AWS owned key\\. If enabled \\(true\\), the server\\-side encryption type is set to KMS and an AWS managed key is used \\(AWS KMS charges apply\\)\\. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the `ReplicaSpecification.SSESpecification` object\\. You cannot mix AWS managed and customer managed KMS keys\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether server\\-side encryption is performed using an AWS managed key or an AWS owned key\\. If enabled \\(true\\), server\\-side encryption type is set to KMS and an AWS managed key is used \\(AWS KMS charges apply\\)\\. If disabled \\(false\\) or not specified,server\\-side encryption is set to an AWS owned key\\. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the `ReplicaSpecification.SSESpecification` object\\. You cannot mix AWS managed and customer managed KMS keys\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SSEEnabled", "type": "boolean" }, "SSEType": { - "markdownDescription": "Server\\-side encryption type\\. The only supported value is: \n+ `KMS` \\- Server\\-side encryption that uses AWS Key Management Service\\. The key is stored in your account and is managed by AWS KMS \\(AWS KMS charges apply\\)\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AES256 | KMS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Server\\-side encryption type\\. The only supported value is: \n+ `KMS` \\- Server\\-side encryption that uses AWS Key Management Service\\. The key is stored in your account and is managed by AWS KMS \\(AWS KMS charges apply\\)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SSEType", "type": "string" } @@ -51508,7 +52736,7 @@ "additionalProperties": false, "properties": { "StreamViewType": { - "markdownDescription": "When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table\\. Valid values for `StreamViewType` are: \n+ `KEYS_ONLY` \\- Only the key attributes of the modified item are written to the stream\\.\n+ `NEW_IMAGE` \\- The entire item, as it appears after it was modified, is written to the stream\\.\n+ `OLD_IMAGE` \\- The entire item, as it appeared before it was modified, is written to the stream\\.\n+ `NEW_AND_OLD_IMAGES` \\- Both the new and the old item images of the item are written to the stream\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `KEYS_ONLY | NEW_AND_OLD_IMAGES | NEW_IMAGE | OLD_IMAGE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table\\. Valid values for `StreamViewType` are: \n+ `KEYS_ONLY` \\- Only the key attributes of the modified item are written to the stream\\.\n+ `NEW_IMAGE` \\- The entire item, as it appears after it was modified, is written to the stream\\.\n+ `OLD_IMAGE` \\- The entire item, as it appeared before it was modified, is written to the stream\\.\n+ `NEW_AND_OLD_IMAGES` \\- Both the new and the old item images of the item are written to the stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamViewType", "type": "string" } @@ -51551,7 +52779,7 @@ "additionalProperties": false, "properties": { "AttributeName": { - "markdownDescription": "The name of the attribute used to store the expiration time for items in the table\\. \nCurrently, you cannot directly change the attribute name used to evaluate time to live\\. In order to do so, you must first disable time to live, and then re\\-enable it with the new attribute name\\. It can take up to one hour for changes to time to live to take effect\\. If you attempt to modify time to live within that time window, your stack operation might be delayed\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the attribute used to store the expiration time for items in the table\\. \nCurrently, you cannot directly change the attribute name used to evaluate time to live\\. In order to do so, you must first disable time to live, and then re\\-enable it with the new attribute name\\. It can take up to one hour for changes to time to live to take effect\\. If you attempt to modify time to live within that time window, your stack operation might be delayed\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeName", "type": "string" }, @@ -51623,49 +52851,51 @@ "items": { "$ref": "#/definitions/AWS::DynamoDB::Table.AttributeDefinition" }, - "markdownDescription": "A list of attributes that describe the key schema for the table and indexes\\. \nThis property is required to create a DynamoDB table\\. \nUpdate requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\\. Replacement if you edit an existing AttributeDefinition\\. \n*Required*: Conditional \n*Type*: List of [AttributeDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "A list of attributes that describe the key schema for the table and indexes\\. \nThis property is required to create a DynamoDB table\\. \nUpdate requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\\. Replacement if you edit an existing AttributeDefinition\\. \n*Required*: Conditional \n*Type*: List of [AttributeDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-attributedefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeDefinitions", "type": "array" }, "BillingMode": { - "markdownDescription": "Specify how you are charged for read and write throughput and how you manage capacity\\. \nValid values include: \n+ `PROVISIONED` \\- We recommend using `PROVISIONED` for predictable workloads\\. `PROVISIONED` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual)\\.\n+ `PAY_PER_REQUEST` \\- We recommend using `PAY_PER_REQUEST` for unpredictable workloads\\. `PAY_PER_REQUEST` sets the billing mode to [On\\-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand)\\.\nIf not specified, the default is `PROVISIONED`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PAY_PER_REQUEST | PROVISIONED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify how you are charged for read and write throughput and how you manage capacity\\. \nValid values include: \n+ `PROVISIONED` \\- We recommend using `PROVISIONED` for predictable workloads\\. `PROVISIONED` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual)\\.\n+ `PAY_PER_REQUEST` \\- We recommend using `PAY_PER_REQUEST` for unpredictable workloads\\. `PAY_PER_REQUEST` sets the billing mode to [On\\-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand)\\.\nIf not specified, the default is `PROVISIONED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BillingMode", "type": "string" }, "ContributorInsightsSpecification": { "$ref": "#/definitions/AWS::DynamoDB::Table.ContributorInsightsSpecification", - "markdownDescription": "The settings used to enable or disable CloudWatch Contributor Insights for the specified table\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The settings used to enable or disable CloudWatch Contributor Insights for the specified table\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContributorInsightsSpecification" }, "GlobalSecondaryIndexes": { "items": { "$ref": "#/definitions/AWS::DynamoDB::Table.GlobalSecondaryIndex" }, - "markdownDescription": "Global secondary indexes to be created on the table\\. You can create up to 20 global secondary indexes\\. \nIf you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update\\. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table\\. You can't use the index or update the table until the index's status is `ACTIVE`\\. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command\\. \nIf you add or delete an index during an update, we recommend that you don't update any other resources\\. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index\\. \nUpdates are not supported\\. The following are exceptions: \n+ If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption\\.\n+ You can delete or add one global secondary index without interruption\\. If you do both in the same update \\(for example, by changing the index's logical ID\\), the update fails\\.\n*Required*: No \n*Type*: List of [GlobalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Global secondary indexes to be created on the table\\. You can create up to 20 global secondary indexes\\. \nIf you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update\\. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table\\. You can't use the index or update the table until the index's status is `ACTIVE`\\. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command\\. \nIf you add or delete an index during an update, we recommend that you don't update any other resources\\. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index\\. \nUpdates are not supported\\. The following are exceptions: \n+ If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption\\.\n+ You can delete or add one global secondary index without interruption\\. If you do both in the same update \\(for example, by changing the index's logical ID\\), the update fails\\.\n*Required*: No \n*Type*: List of [GlobalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "GlobalSecondaryIndexes", "type": "array" }, "ImportSourceSpecification": { - "$ref": "#/definitions/AWS::DynamoDB::Table.ImportSourceSpecification" + "$ref": "#/definitions/AWS::DynamoDB::Table.ImportSourceSpecification", + "markdownDescription": "Specifies the properties of data being imported from the S3 bucket source to the table\\. \nIf you specify the `ImportSourceSpecification` property, and also specify either the `StreamSpecification` or `TableClass` property, the IAM entity creating/updating stack must have `UpdateTable` permission\\.\n*Required*: No \n*Type*: [ImportSourceSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-importsourcespecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ImportSourceSpecification" }, "KeySchema": { "items": { "$ref": "#/definitions/AWS::DynamoDB::Table.KeySchema" }, - "markdownDescription": "Specifies the attributes that make up the primary key for the table\\. The attributes in the `KeySchema` property must also be defined in the `AttributeDefinitions` property\\. \n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the attributes that make up the primary key for the table\\. The attributes in the `KeySchema` property must also be defined in the `AttributeDefinitions` property\\. \n*Required*: Yes \n*Type*: [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeySchema", "type": "array" }, "KinesisStreamSpecification": { "$ref": "#/definitions/AWS::DynamoDB::Table.KinesisStreamSpecification", - "markdownDescription": "The Kinesis Data Streams configuration for the specified table\\. \n*Required*: No \n*Type*: [KinesisStreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-kinesisstreamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Kinesis Data Streams configuration for the specified table\\. \n*Required*: No \n*Type*: [KinesisStreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-kinesisstreamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KinesisStreamSpecification" }, "LocalSecondaryIndexes": { "items": { "$ref": "#/definitions/AWS::DynamoDB::Table.LocalSecondaryIndex" }, - "markdownDescription": "Local secondary indexes to be created on the table\\. You can create up to 5 local secondary indexes\\. Each index is scoped to a given hash key value\\. The size of each hash key can be up to 10 gigabytes\\. \n*Required*: No \n*Type*: List of [LocalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Local secondary indexes to be created on the table\\. You can create up to 5 local secondary indexes\\. Each index is scoped to a given hash key value\\. The size of each hash key can be up to 10 gigabytes\\. \n*Required*: No \n*Type*: List of [LocalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-localsecondaryindex.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LocalSecondaryIndexes", "type": "array" }, @@ -51676,7 +52906,7 @@ }, "ProvisionedThroughput": { "$ref": "#/definitions/AWS::DynamoDB::Table.ProvisionedThroughput", - "markdownDescription": "Throughput for the specified table, which consists of values for `ReadCapacityUnits` and `WriteCapacityUnits`\\. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html)\\. \nIf you set `BillingMode` as `PROVISIONED`, you must specify this property\\. If you set `BillingMode` as `PAY_PER_REQUEST`, you cannot specify this property\\. \n*Required*: Conditional \n*Type*: [ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Throughput for the specified table, which consists of values for `ReadCapacityUnits` and `WriteCapacityUnits`\\. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html)\\. \nIf you set `BillingMode` as `PROVISIONED`, you must specify this property\\. If you set `BillingMode` as `PAY_PER_REQUEST`, you cannot specify this property\\. \n*Required*: Conditional \n*Type*: [ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProvisionedThroughput" }, "SSESpecification": { @@ -51686,11 +52916,11 @@ }, "StreamSpecification": { "$ref": "#/definitions/AWS::DynamoDB::Table.StreamSpecification", - "markdownDescription": "The settings for the DynamoDB table stream, which capture changes to items stored in the table\\. \n*Required*: No \n*Type*: [StreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-streamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The settings for the DynamoDB table stream, which capture changes to items stored in the table\\. \n*Required*: No \n*Type*: [StreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-streamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamSpecification" }, "TableClass": { - "markdownDescription": "The table class of the new table\\. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `STANDARD | STANDARD_INFREQUENT_ACCESS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The table class of the new table\\. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TableClass", "type": "string" }, @@ -51709,7 +52939,7 @@ }, "TimeToLiveSpecification": { "$ref": "#/definitions/AWS::DynamoDB::Table.TimeToLiveSpecification", - "markdownDescription": "Specifies the Time to Live \\(TTL\\) settings for the table\\. \nFor detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide\\. \n*Required*: No \n*Type*: [TimeToLiveSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the Time to Live \\(TTL\\) settings for the table\\. \nFor detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide\\. \n*Required*: No \n*Type*: [TimeToLiveSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-timetolivespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeToLiveSpecification" } }, @@ -51743,12 +52973,12 @@ "additionalProperties": false, "properties": { "AttributeName": { - "markdownDescription": "A name for the attribute\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A name for the attribute\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeName", "type": "string" }, "AttributeType": { - "markdownDescription": "The data type for the attribute, where: \n+ `S` \\- the attribute is of type String\n+ `N` \\- the attribute is of type Number\n+ `B` \\- the attribute is of type Binary\n*Required*: Yes \n*Type*: String \n*Allowed values*: `B | N | S` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The data type for the attribute, where: \n+ `S` \\- the attribute is of type String\n+ `N` \\- the attribute is of type Number\n+ `B` \\- the attribute is of type Binary\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeType", "type": "string" } @@ -51763,7 +52993,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "Indicates whether CloudWatch Contributor Insights are to be enabled \\(true\\) or disabled \\(false\\)\\. \n*Required*: Yes \n*Type*: Boolean \n*Allowed values*: `DISABLE | ENABLE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether CloudWatch Contributor Insights are to be enabled \\(true\\) or disabled \\(false\\)\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -51777,12 +53007,16 @@ "additionalProperties": false, "properties": { "Delimiter": { + "markdownDescription": "The delimiter used for separating items in the CSV file being imported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Delimiter", "type": "string" }, "HeaderList": { "items": { "type": "string" }, + "markdownDescription": "List of the headers used to specify a common header for all source CSV files being imported\\. If this field is specified then the first line of each CSV file is treated as data instead of the header\\. If this field is not specified the the first line of each CSV file is treated as the header\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "HeaderList", "type": "array" } }, @@ -51793,11 +53027,11 @@ "properties": { "ContributorInsightsSpecification": { "$ref": "#/definitions/AWS::DynamoDB::Table.ContributorInsightsSpecification", - "markdownDescription": "The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContributorInsightsSpecification" }, "IndexName": { - "markdownDescription": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: Updates are not supported\\.", "title": "IndexName", "type": "string" }, @@ -51805,18 +53039,18 @@ "items": { "$ref": "#/definitions/AWS::DynamoDB::Table.KeySchema" }, - "markdownDescription": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) \n*Maximum*: `2` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) \n*Update requires*: Updates are not supported\\.", "title": "KeySchema", "type": "array" }, "Projection": { "$ref": "#/definitions/AWS::DynamoDB::Table.Projection", - "markdownDescription": "Represents attributes that are copied \\(projected\\) from the table into the global secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html) \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "Represents attributes that are copied \\(projected\\) from the table into the global secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-projection.html) \n*Update requires*: Updates are not supported\\.", "title": "Projection" }, "ProvisionedThroughput": { "$ref": "#/definitions/AWS::DynamoDB::Table.ProvisionedThroughput", - "markdownDescription": "Represents the provisioned throughput settings for the specified global secondary index\\. \nFor current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*\\. \n*Required*: No \n*Type*: [ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Represents the provisioned throughput settings for the specified global secondary index\\. \nFor current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*\\. \n*Required*: No \n*Type*: [ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProvisionedThroughput" } }, @@ -51831,16 +53065,24 @@ "additionalProperties": false, "properties": { "InputCompressionType": { + "markdownDescription": "Type of compression to be used on the input coming from the imported table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InputCompressionType", "type": "string" }, "InputFormat": { + "markdownDescription": "The format of the source data\\. Valid values for `ImportFormat` are `CSV`, `DYNAMODB_JSON` or `ION`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InputFormat", "type": "string" }, "InputFormatOptions": { - "$ref": "#/definitions/AWS::DynamoDB::Table.InputFormatOptions" + "$ref": "#/definitions/AWS::DynamoDB::Table.InputFormatOptions", + "markdownDescription": "Additional properties that specify how the input is formatted, \n*Required*: No \n*Type*: [InputFormatOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-inputformatoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InputFormatOptions" }, "S3BucketSource": { - "$ref": "#/definitions/AWS::DynamoDB::Table.S3BucketSource" + "$ref": "#/definitions/AWS::DynamoDB::Table.S3BucketSource", + "markdownDescription": "The S3 bucket that provides the source for the import\\. \n*Required*: Yes \n*Type*: [S3BucketSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-s3bucketsource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3BucketSource" } }, "required": [ @@ -51853,7 +53095,9 @@ "additionalProperties": false, "properties": { "Csv": { - "$ref": "#/definitions/AWS::DynamoDB::Table.Csv" + "$ref": "#/definitions/AWS::DynamoDB::Table.Csv", + "markdownDescription": "The options for imported source files in CSV format\\. The values are Delimiter and HeaderList\\. \n*Required*: No \n*Type*: [Csv](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-csv.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Csv" } }, "type": "object" @@ -51867,7 +53111,7 @@ "type": "string" }, "KeyType": { - "markdownDescription": "The role that this key attribute will assume: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `HASH | RANGE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The role that this key attribute will assume: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeyType", "type": "string" } @@ -51882,7 +53126,7 @@ "additionalProperties": false, "properties": { "StreamArn": { - "markdownDescription": "The ARN for a specific Kinesis data stream\\. \nLength Constraints: Minimum length of 37\\. Maximum length of 1024\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `37` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN for a specific Kinesis data stream\\. \nLength Constraints: Minimum length of 37\\. Maximum length of 1024\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamArn", "type": "string" } @@ -51896,7 +53140,7 @@ "additionalProperties": false, "properties": { "IndexName": { - "markdownDescription": "The name of the local secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The name of the local secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: Updates are not supported\\.", "title": "IndexName", "type": "string" }, @@ -51904,13 +53148,13 @@ "items": { "$ref": "#/definitions/AWS::DynamoDB::Table.KeySchema" }, - "markdownDescription": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) \n*Maximum*: `2` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) \n*Update requires*: Updates are not supported\\.", "title": "KeySchema", "type": "array" }, "Projection": { "$ref": "#/definitions/AWS::DynamoDB::Table.Projection", - "markdownDescription": "Represents attributes that are copied \\(projected\\) from the table into the local secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html) \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "Represents attributes that are copied \\(projected\\) from the table into the local secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-projection.html) \n*Update requires*: Updates are not supported\\.", "title": "Projection" } }, @@ -51939,12 +53183,12 @@ "items": { "type": "string" }, - "markdownDescription": "Represents the non\\-key attribute names which will be projected into the index\\. \nFor local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, must not exceed 20\\. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Represents the non\\-key attribute names which will be projected into the index\\. \nFor local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, must not exceed 100\\. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NonKeyAttributes", "type": "array" }, "ProjectionType": { - "markdownDescription": "The set of attributes that are projected into the index: \n+ `KEYS_ONLY` \\- Only the index and primary keys are projected into the index\\.\n+ `INCLUDE` \\- In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non\\-key attributes that you specify\\.\n+ `ALL` \\- All of the table attributes are projected into the index\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ALL | INCLUDE | KEYS_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The set of attributes that are projected into the index: \n+ `KEYS_ONLY` \\- Only the index and primary keys are projected into the index\\.\n+ `INCLUDE` \\- In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non\\-key attributes that you specify\\.\n+ `ALL` \\- All of the table attributes are projected into the index\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProjectionType", "type": "string" } @@ -51955,12 +53199,12 @@ "additionalProperties": false, "properties": { "ReadCapacityUnits": { - "markdownDescription": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`\\. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide*\\. \nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0\\. \n*Required*: Yes \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`\\. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide*\\. \nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReadCapacityUnits", "type": "number" }, "WriteCapacityUnits": { - "markdownDescription": "The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`\\. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide*\\. \nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0\\. \n*Required*: Yes \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`\\. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide*\\. \nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WriteCapacityUnits", "type": "number" } @@ -51975,12 +53219,18 @@ "additionalProperties": false, "properties": { "S3Bucket": { + "markdownDescription": "The S3 bucket that is being imported from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3Bucket", "type": "string" }, "S3BucketOwner": { + "markdownDescription": "The account number of the S3 bucket that is being imported from\\. If the bucket is owned by the requester this is optional\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3BucketOwner", "type": "string" }, "S3KeyPrefix": { + "markdownDescription": "The key prefix shared by all S3 Objects that are being imported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3KeyPrefix", "type": "string" } }, @@ -52017,7 +53267,7 @@ "additionalProperties": false, "properties": { "StreamViewType": { - "markdownDescription": "When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table\\. Valid values for `StreamViewType` are: \n+ `KEYS_ONLY` \\- Only the key attributes of the modified item are written to the stream\\.\n+ `NEW_IMAGE` \\- The entire item, as it appears after it was modified, is written to the stream\\.\n+ `OLD_IMAGE` \\- The entire item, as it appeared before it was modified, is written to the stream\\.\n+ `NEW_AND_OLD_IMAGES` \\- Both the new and the old item images of the item are written to the stream\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `KEYS_ONLY | NEW_AND_OLD_IMAGES | NEW_IMAGE | OLD_IMAGE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table\\. Valid values for `StreamViewType` are: \n+ `KEYS_ONLY` \\- Only the key attributes of the modified item are written to the stream\\.\n+ `NEW_IMAGE` \\- The entire item, as it appears after it was modified, is written to the stream\\.\n+ `OLD_IMAGE` \\- The entire item, as it appeared before it was modified, is written to the stream\\.\n+ `NEW_AND_OLD_IMAGES` \\- Both the new and the old item images of the item are written to the stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamViewType", "type": "string" } @@ -52031,7 +53281,7 @@ "additionalProperties": false, "properties": { "AttributeName": { - "markdownDescription": "The name of the TTL attribute used to store the expiration time for items in the table\\. \nTo update this property, you must first disable TTL then enable TTL with the new attribute name\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the TTL attribute used to store the expiration time for items in the table\\. \nTo update this property, you must first disable TTL then enable TTL with the new attribute name\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeName", "type": "string" }, @@ -52184,7 +53434,7 @@ "additionalProperties": false, "properties": { "ResourceType": { - "markdownDescription": "The type of resource to tag\\. Specify `capacity-reservation`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of resource to tag\\. Specify `capacity-reservation`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceType", "type": "string" }, @@ -52332,7 +53582,7 @@ "type": "string" }, "InstanceType": { - "markdownDescription": "The instance type for which the Capacity Reservation Fleet reserves capacity\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The instance type for which the Capacity Reservation Fleet reserves capacity\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, @@ -52830,7 +54080,7 @@ "additionalProperties": false, "properties": { "ResourceType": { - "markdownDescription": "The type of resource to tag\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of resource to tag\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceType", "type": "string" }, @@ -53435,7 +54685,7 @@ "title": "InstanceRequirements" }, "InstanceType": { - "markdownDescription": "The instance type\\. \nIf you specify `InstanceType`, you can't specify `InstanceRequirements`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The instance type\\. \nIf you specify `InstanceType`, you can't specify `InstanceRequirements`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, @@ -53843,7 +55093,7 @@ "additionalProperties": false, "properties": { "ResourceType": { - "markdownDescription": "The type of resource to tag\\. `ResourceType` must be `fleet`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of resource to tag\\. `ResourceType` must be `fleet`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceType", "type": "string" }, @@ -53988,7 +55238,7 @@ "type": "array" }, "TransferAddress": { - "markdownDescription": "The Elastic IP address you are accepting for transfer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Elastic IP address you are accepting for transfer\\. You can only accept one transferred address\\. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TransferAddress", "type": "string" } @@ -54201,12 +55451,12 @@ "additionalProperties": false, "properties": { "CertificateArn": { - "markdownDescription": "The ARN of the ACM certificate with which to associate the IAM role\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1283` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the ACM certificate with which to associate the IAM role\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CertificateArn", "type": "string" }, "RoleArn": { - "markdownDescription": "The ARN of the IAM role to associate with the ACM certificate\\. You can associate up to 16 IAM roles with an ACM certificate\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1283` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the IAM role to associate with the ACM certificate\\. You can associate up to 16 IAM roles with an ACM certificate\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RoleArn", "type": "string" } @@ -54586,9 +55836,13 @@ "additionalProperties": false, "properties": { "DefaultResourceDiscoveryAssociationId": { + "markdownDescription": "The IPAM's default resource discovery association ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultResourceDiscoveryAssociationId", "type": "string" }, "DefaultResourceDiscoveryId": { + "markdownDescription": "The IPAM's default resource discovery ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultResourceDiscoveryId", "type": "string" }, "Description": { @@ -54605,6 +55859,8 @@ "type": "array" }, "ResourceDiscoveryAssociationCount": { + "markdownDescription": "The IPAM's resource discovery association count\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceDiscoveryAssociationCount", "type": "number" }, "Tags": { @@ -54831,6 +56087,8 @@ "type": "array" }, "PublicIpSource": { + "markdownDescription": "The IP address source for pools in the public scope\\. Only used for provisioning IP address CIDRs to pools in the public scope\\. Default is `BYOIP`\\. For more information, see [Create IPv6 pools](https://docs.aws.amazon.com/vpc/latest/ipam/intro-create-ipv6-pools.html) in the *Amazon VPC IPAM User Guide*\\. By default, you can add only one Amazon\\-provided IPv6 CIDR block to a top\\-level IPv6 pool\\. For information on increasing the default limit, see [ Quotas for your IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) in the *Amazon VPC IPAM User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `amazon | byoip` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PublicIpSource", "type": "string" }, "PubliclyAdvertisable": { @@ -54929,12 +56187,18 @@ "additionalProperties": false, "properties": { "Cidr": { + "markdownDescription": "The CIDR provisioned to the IPAM pool\\. A CIDR is a representation of an IP address and its associated network mask \\(or netmask\\) and refers to a range of IP addresses\\. An IPv4 CIDR example is `10.24.34.0/23`\\. An IPv6 CIDR example is `2001:DB8::/32`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Cidr", "type": "string" }, "IpamPoolId": { + "markdownDescription": "The ID of the IPAM pool\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IpamPoolId", "type": "string" }, "NetmaskLength": { + "markdownDescription": "The netmask length of the CIDR you'd like to provision to a pool\\. Can be used for provisioning Amazon\\-provided IPv6 CIDRs to top\\-level pools and for provisioning CIDRs to pools with source pools\\. Cannot be used to provision BYOIP CIDRs to top\\-level pools\\. \"NetmaskLength\" or \"Cidr\" is required\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NetmaskLength", "type": "number" } }, @@ -55000,18 +56264,24 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The resource discovery description\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "OperatingRegions": { "items": { "$ref": "#/definitions/AWS::EC2::IPAMResourceDiscovery.IpamOperatingRegion" }, + "markdownDescription": "The operating Regions for the resource discovery\\. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs\\. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions\\. \n*Required*: No \n*Type*: List of [IpamOperatingRegion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamoperatingregion.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OperatingRegions", "type": "array" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A tag is a label that you assign to an AWS resource\\. Each tag consists of a key and an optional value\\. You can use tags to search and filter your resources or track your AWS costs\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -55041,6 +56311,8 @@ "additionalProperties": false, "properties": { "RegionName": { + "markdownDescription": "The name of the operating Region\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RegionName", "type": "string" } }, @@ -55085,15 +56357,21 @@ "additionalProperties": false, "properties": { "IpamId": { + "markdownDescription": "The IPAM ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IpamId", "type": "string" }, "IpamResourceDiscoveryId": { + "markdownDescription": "The resource discovery ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IpamResourceDiscoveryId", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A tag is a label that you assign to an AWS resource\\. Each tag consists of a key and an optional value\\. You can use tags to search and filter your resources or track your AWS costs\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -55337,7 +56615,7 @@ "type": "string" }, "InstanceType": { - "markdownDescription": "The instance type\\. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*\\. \nDefault: `m1.small` \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The instance type\\. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*\\. \nDefault: `m1.small` \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "InstanceType", "type": "string" }, @@ -56647,7 +57925,7 @@ "title": "InstanceRequirements" }, "InstanceType": { - "markdownDescription": "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*\\. \nIf you specify `InstanceType`, you can't specify `InstanceRequirements`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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*\\. \nIf you specify `InstanceType`, you can't specify `InstanceRequirements`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InstanceType", "type": "string" }, @@ -56759,7 +58037,7 @@ "additionalProperties": false, "properties": { "ResourceType": { - "markdownDescription": "The type of resource\\. To tag the launch template, `ResourceType` must be `launch-template`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of resource\\. To tag the launch template, `ResourceType` must be `launch-template`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceType", "type": "string" }, @@ -57141,7 +58419,7 @@ "additionalProperties": false, "properties": { "ResourceType": { - "markdownDescription": "The type of resource to tag\\. \nThe `Valid Values` are all the resource types that can be tagged\\. However, when creating a launch template, you can specify tags for the following resource types only: `instance` \\| `volume` \\| `elastic-gpu` \\| `network-interface` \\| `spot-instances-request` \nTo tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of resource to tag\\. \nThe `Valid Values` are all the resource types that can be tagged\\. However, when creating a launch template, you can specify tags for the following resource types only: `instance` \\| `volume` \\| `elastic-gpu` \\| `network-interface` \\| `spot-instances-request` \nTo tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceType", "type": "string" }, @@ -57271,6 +58549,80 @@ ], "type": "object" }, + "AWS::EC2::LocalGatewayRouteTable": { + "additionalProperties": false, + "properties": { + "Condition": { + "type": "string" + }, + "DeletionPolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + }, + "DependsOn": { + "anyOf": [ + { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + { + "items": { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "type": "array" + } + ] + }, + "Metadata": { + "type": "object" + }, + "Properties": { + "additionalProperties": false, + "properties": { + "LocalGatewayId": { + "type": "string" + }, + "Mode": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "required": [ + "LocalGatewayId" + ], + "type": "object" + }, + "Type": { + "enum": [ + "AWS::EC2::LocalGatewayRouteTable" + ], + "type": "string" + }, + "UpdateReplacePolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Properties" + ], + "type": "object" + }, "AWS::EC2::LocalGatewayRouteTableVPCAssociation": { "additionalProperties": false, "properties": { @@ -57352,6 +58704,81 @@ ], "type": "object" }, + "AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { + "additionalProperties": false, + "properties": { + "Condition": { + "type": "string" + }, + "DeletionPolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + }, + "DependsOn": { + "anyOf": [ + { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + { + "items": { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "type": "array" + } + ] + }, + "Metadata": { + "type": "object" + }, + "Properties": { + "additionalProperties": false, + "properties": { + "LocalGatewayRouteTableId": { + "type": "string" + }, + "LocalGatewayVirtualInterfaceGroupId": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "required": [ + "LocalGatewayRouteTableId", + "LocalGatewayVirtualInterfaceGroupId" + ], + "type": "object" + }, + "Type": { + "enum": [ + "AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation" + ], + "type": "string" + }, + "UpdateReplacePolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Properties" + ], + "type": "object" + }, "AWS::EC2::NatGateway": { "additionalProperties": false, "properties": { @@ -57398,7 +58825,7 @@ "type": "string" }, "MaxDrainDurationSeconds": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum amount of time to wait \\(in seconds\\) before forcibly releasing the IP addresses if connections are still in progress\\. Default value is 350 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `4000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxDrainDurationSeconds", "type": "number" }, @@ -57411,12 +58838,12 @@ "items": { "type": "string" }, - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Secondary EIP allocation IDs\\. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecondaryAllocationIds", "type": "array" }, "SecondaryPrivateIpAddressCount": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "\\[Private NAT gateway only\\] The number of secondary private IPv4 addresses you want to assign to the NAT gateway\\. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*\\. \n`SecondaryPrivateIpAddressCount` and `SecondaryPrivateIpAddresses` cannot be set at the same time\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `7` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecondaryPrivateIpAddressCount", "type": "number" }, @@ -57424,7 +58851,7 @@ "items": { "type": "string" }, - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Secondary private IPv4 addresses\\. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*\\. \n`SecondaryPrivateIpAddressCount` and `SecondaryPrivateIpAddresses` cannot be set at the same time\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecondaryPrivateIpAddresses", "type": "array" }, @@ -58085,9 +59512,13 @@ "items": { "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [AnalysisComponent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LoadBalancers", "type": "array" }, "ServiceName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceName", "type": "string" } }, @@ -58690,6 +60121,8 @@ "type": "number" }, "ServiceName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceName", "type": "string" }, "SourceVpc": { @@ -58813,7 +60246,7 @@ "additionalProperties": false, "properties": { "Destination": { - "markdownDescription": "The AWS resource that is the destination of the path\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The AWS resource that is the destination of the path\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Destination", "type": "string" }, @@ -59756,7 +61189,7 @@ "type": "array" }, "VpcId": { - "markdownDescription": "\\[VPC only\\] The ID of the VPC for the security group\\. Your default VPC ID will be used if you do not define the VpcId here\\. Furthermore\\, VpcId is required if you specify SecurityGroupEgress rules\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\[VPC only\\] The ID of the VPC for the security group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VpcId", "type": "string" } @@ -60647,7 +62080,7 @@ "title": "InstanceRequirements" }, "InstanceType": { - "markdownDescription": "The instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, @@ -60821,7 +62254,7 @@ "title": "InstanceRequirements" }, "InstanceType": { - "markdownDescription": "The instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, @@ -60885,7 +62318,7 @@ "type": "array" }, "UserData": { - "markdownDescription": "The Base64\\-encoded user data that instances use when starting up\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The base64\\-encoded user data that instances use when starting up\\. User data is limited to 16 KB\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "UserData", "type": "string" }, @@ -61049,7 +62482,7 @@ "additionalProperties": false, "properties": { "ResourceType": { - "markdownDescription": "The type of resource\\. Currently, the only resource type that is supported is `instance`\\. To tag the Spot Fleet request on creation, use the `TagSpecifications` parameter in ` [SpotFleetRequestConfigData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html) `\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of resource\\. Currently, the only resource type that is supported is `instance`\\. To tag the Spot Fleet request on creation, use the `TagSpecifications` parameter in ` [SpotFleetRequestConfigData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html) `\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceType", "type": "string" }, @@ -64402,7 +65835,7 @@ "type": "number" }, "VolumeType": { - "markdownDescription": "The volume type\\. This parameter can be one of the following values: \n+ General Purpose SSD: `gp2` \\| `gp3` \n+ Provisioned IOPS SSD: `io1` \\| `io2` \n+ Throughput Optimized HDD: `st1` \n+ Cold HDD: `sc1` \n+ Magnetic: `standard` \nThroughput Optimized HDD \\(`st1`\\) and Cold HDD \\(`sc1`\\) volumes can't be used as boot volumes\\.\nFor more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*\\. \nDefault: `gp2` \n*Required*: No \n*Type*: String \n*Allowed values*: `gp2 | gp3 | io1 | io2 | sc1 | st1 | standard` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The volume type\\. This parameter can be one of the following values: \n+ General Purpose SSD: `gp2` \\| `gp3` \n+ Provisioned IOPS SSD: `io1` \\| `io2` \n+ Throughput Optimized HDD: `st1` \n+ Cold HDD: `sc1` \n+ Magnetic: `standard` \nFor more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*\\. \nDefault: `gp2` \n*Required*: No \n*Type*: String \n*Allowed values*: `gp2 | gp3 | io1 | io2 | sc1 | st1 | standard` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumeType", "type": "string" } @@ -64549,7 +65982,7 @@ "properties": { "RepositoryCatalogData": { "$ref": "#/definitions/AWS::ECR::PublicRepository.RepositoryCatalogData", - "markdownDescription": "The details about the repository that are publicly visible in the Amazon ECR Public Gallery\\. For more information, see [Amazon ECR Public repository catalog data](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html) in the *Amazon ECR Public User Guide*\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The details about the repository that are publicly visible in the Amazon ECR Public Gallery\\. For more information, see [Amazon ECR Public repository catalog data](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html) in the *Amazon ECR Public User Guide*\\. \n*Required*: No \n*Type*: [RepositoryCatalogData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-publicrepository-repositorycatalogdata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RepositoryCatalogData" }, "RepositoryName": { @@ -64597,24 +66030,34 @@ "additionalProperties": false, "properties": { "AboutText": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AboutText", "type": "string" }, "Architectures": { "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Architectures", "type": "array" }, "OperatingSystems": { "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OperatingSystems", "type": "array" }, "RepositoryDescription": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RepositoryDescription", "type": "string" }, "UsageText": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UsageText", "type": "string" } }, @@ -65039,7 +66482,7 @@ "type": "string" }, "RegistryId": { - "markdownDescription": "The AWS account ID associated with the registry that contains the repository\\. If you do not specify a registry, the default registry is assumed\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[0-9]{12}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS account ID associated with the registry that contains the repository\\. If you do\u2028 not specify a registry, the default registry is assumed\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[0-9]{12}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RegistryId", "type": "string" } @@ -65130,7 +66573,7 @@ "additionalProperties": false, "properties": { "AutoScalingGroupArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) or short name that identifies the Auto Scaling group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) that identifies the Auto Scaling group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AutoScalingGroupArn", "type": "string" }, @@ -65140,7 +66583,7 @@ "title": "ManagedScaling" }, "ManagedTerminationProtection": { - "markdownDescription": "The managed termination protection setting to use for the Auto Scaling group capacity provider\\. This determines whether the Auto Scaling group has managed termination protection\\. The default is disabled\\. \nWhen using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work\\.\nWhen managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale\\-in action\\. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale\\-in actions enabled as well\\. For more information, see [Instance Protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) in the * AWS Auto Scaling User Guide*\\. \nWhen managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The managed termination protection setting to use for the Auto Scaling group capacity provider\\. This determines whether the Auto Scaling group has managed termination protection\\. The default is off\\. \nWhen using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work\\.\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale\\-in action\\. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale\\-in actions enabled as well\\. For more information, see [Instance Protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) in the * AWS Auto Scaling User Guide*\\. \nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ManagedTerminationProtection", "type": "string" } @@ -65159,12 +66602,12 @@ "type": "number" }, "MaximumScalingStepSize": { - "markdownDescription": "The maximum number of container instances that Amazon ECS scales in or scales out at one time\\. If this parameter is omitted, the default value of `10000` is used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time\\. The scale in process is not affected by this parameter\\. If this parameter is omitted, the default value of `1` is used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaximumScalingStepSize", "type": "number" }, "MinimumScalingStepSize": { - "markdownDescription": "The minimum number of container instances that Amazon ECS scales in or scales out at one time\\. If this parameter is omitted, the default value of `1` is used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time\\. The scale in process is not affected by this parameter If this parameter is omitted, the default value of `1` is used\\. \nWhen additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size\\. \nIf you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MinimumScalingStepSize", "type": "number" }, @@ -65220,7 +66663,7 @@ "items": { "type": "string" }, - "markdownDescription": "The short name of one or more capacity providers to associate with the cluster\\. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy\\. \nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster\\. \nTo use an AWS Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers\\. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The short name of one or more capacity providers to associate with the cluster\\. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) actions\\. \nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster\\. New Auto Scaling group capacity providers can be created with the [CreateCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) API operation\\. \nTo use a AWS Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers\\. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used\\. \nThe [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available capacity providers for a cluster after the cluster is created\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CapacityProviders", "type": "array" }, @@ -65233,7 +66676,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::Cluster.ClusterSettings" }, - "markdownDescription": "The setting to use when creating a cluster\\. This parameter is used to enable CloudWatch Container Insights for a cluster\\. If this value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html) of [ClusterSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The setting to use when creating a cluster\\. This parameter is used to use CloudWatch Container Insights for a cluster\\. If this value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html) of [ClusterSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClusterSettings", "type": "array" }, @@ -65251,7 +66694,9 @@ "type": "array" }, "ServiceConnectDefaults": { - "$ref": "#/definitions/AWS::ECS::Cluster.ServiceConnectDefaults" + "$ref": "#/definitions/AWS::ECS::Cluster.ServiceConnectDefaults", + "markdownDescription": "Use this parameter to set a default Service Connect namespace\\. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace\\. This setting only applies to new services that set the `enabled` parameter to `true` in the `ServiceConnectConfiguration`\\. You can set the namespace of each service individually in the `ServiceConnectConfiguration` to override this default parameter\\. \nTasks that run in a namespace can use short names to connect to services in the namespace\\. Tasks can connect to services across all of the clusters in the namespace\\. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility\\. Only the tasks that Amazon ECS services create are supported with Service Connect\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [ServiceConnectDefaults](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-serviceconnectdefaults.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceConnectDefaults" }, "Tags": { "items": { @@ -65325,7 +66770,7 @@ "type": "string" }, "Value": { - "markdownDescription": "The value to set for the cluster setting\\. The supported values are `enabled` and `disabled`\\. If `enabled` is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the `containerInsights` account setting is enabled\\. If a cluster value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value to set for the cluster setting\\. The supported values are `enabled` and `disabled`\\. If `enabled` is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be off unless the `containerInsights` account setting is turned on\\. If a cluster value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -65357,7 +66802,7 @@ "additionalProperties": false, "properties": { "CloudWatchEncryptionEnabled": { - "markdownDescription": "Determines whether to use encryption on the CloudWatch logs\\. If not specified, encryption will be disabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether to use encryption on the CloudWatch logs\\. If not specified, encryption will be off\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchEncryptionEnabled", "type": "boolean" }, @@ -65388,6 +66833,8 @@ "additionalProperties": false, "properties": { "Namespace": { + "markdownDescription": "The namespace name or full Amazon Resource Name \\(ARN\\) of the AWS Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration\\. The namespace name can include up to 1024 characters\\. The name is case\\-sensitive\\. The name can't include hyphens \\(\\-\\), tilde \\(\\~\\), greater than \\(>\\), less than \\(<\\), or slash \\(/\\)\\. \nIf you enter an existing namespace name or ARN, then that namespace will be used\\. Any namespace type is supported\\. The namespace must be in this account and this AWS Region\\. \nIf you enter a new name, a AWS Cloud Map namespace will be created\\. Amazon ECS creates a AWS Cloud Map namespace with the \"API calls\" method of instance discovery only\\. This instance discovery method is the \"HTTP\" namespace type in the AWS Command Line Interface\\. Other types of instance discovery aren't used by Service Connect\\. \nIf you update the service with an empty string `\"\"` for the namespace name, the cluster configuration for Service Connect is removed\\. Note that the namespace will remain in AWS Cloud Map and must be deleted separately\\. \nFor more information about AWS Cloud Map, see [Working with Services](https://docs.aws.amazon.com/) in the * AWS Cloud Map Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Namespace", "type": "string" } }, @@ -65645,7 +67092,7 @@ "type": "number" }, "EnableECSManagedTags": { - "markdownDescription": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service\\. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service\\. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableECSManagedTags", "type": "boolean" }, @@ -65655,7 +67102,7 @@ "type": "boolean" }, "HealthCheckGracePeriodSeconds": { - "markdownDescription": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started\\. This is only used when your service is configured to use a load balancer\\. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of `0` is used\\. \nIf you do not use an Elastic Load Balancing, we recomend that you use the `startPeriod` in the task definition healtch check parameters\\. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html)\\. \nIf your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds \\(about 69 years\\)\\. During that time, the Amazon ECS service scheduler ignores health check status\\. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started\\. This is only used when your service is configured to use a load balancer\\. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of `0` is used\\. \nIf you do not use an Elastic Load Balancing, we recommend that you use the `startPeriod` in the task definition health check parameters\\. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html)\\. \nIf your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds \\(about 69 years\\)\\. During that time, the Amazon ECS service scheduler ignores health check status\\. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HealthCheckGracePeriodSeconds", "type": "number" }, @@ -65681,7 +67128,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::Service.PlacementConstraint" }, - "markdownDescription": "An array of placement constraint objects to use for tasks in your service\\. You can specify a maximum of 10 constraints for each task\\. This limit includes constraints in the task definition and those specified at runtime\\. \n*Required*: No \n*Type*: List of [PlacementConstraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An array of placement constraint objects to use for tasks in your service\\. You can specify a maximum of 10 constraints for each task\\. This limit includes constraints in the task definition and those specified at runtime\\. \n*Required*: No \n*Type*: List of [PlacementConstraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PlacementConstraints", "type": "array" }, @@ -65689,7 +67136,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::Service.PlacementStrategy" }, - "markdownDescription": "The placement strategy objects to use for tasks in your service\\. You can specify a maximum of five strategy rules per service\\. For more information, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [PlacementStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The placement strategy objects to use for tasks in your service\\. You can specify a maximum of five strategy rules per service\\. For more information, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [PlacementStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PlacementStrategies", "type": "array" }, @@ -65714,7 +67161,9 @@ "type": "string" }, "ServiceConnectConfiguration": { - "$ref": "#/definitions/AWS::ECS::Service.ServiceConnectConfiguration" + "$ref": "#/definitions/AWS::ECS::Service.ServiceConnectConfiguration", + "markdownDescription": "The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace\\. \nTasks that run in a namespace can use short names to connect to services in the namespace\\. Tasks can connect to services across all of the clusters in the namespace\\. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility\\. Only the tasks that Amazon ECS services create are supported with Service Connect\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [ServiceConnectConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceConnectConfiguration" }, "ServiceName": { "markdownDescription": "The name of your service\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, underscores, and hyphens are allowed\\. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -65738,7 +67187,7 @@ "type": "array" }, "TaskDefinition": { - "markdownDescription": "The `family` and `revision` \\(`family:revision`\\) or full ARN of the task definition to run in your service\\. The `revision` is required in order for the resource to stabilize\\. \nA task definition must be specified if the service is using either the `ECS` or `CODE_DEPLOY` deployment controllers\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The `family` and `revision` \\(`family:revision`\\) or full ARN of the task definition to run in your service\\. The `revision` is required in order for the resource to stabilize\\. \nA task definition must be specified if the service is using either the `ECS` or `CODE_DEPLOY` deployment controllers\\. \nFor more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TaskDefinition", "type": "string" } @@ -65820,12 +67269,18 @@ "items": { "type": "string" }, + "markdownDescription": "One or more CloudWatch alarm names\\. Use a \",\" to separate the alarms\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmNames", "type": "array" }, "Enable": { + "markdownDescription": "Determines whether to use the CloudWatch alarm option in the service deployment process\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enable", "type": "boolean" }, "Rollback": { + "markdownDescription": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails\\. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Rollback", "type": "boolean" } }, @@ -65845,7 +67300,7 @@ "type": "boolean" }, "Rollback": { - "markdownDescription": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails\\. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails\\. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Rollback", "type": "boolean" } @@ -65860,20 +67315,22 @@ "additionalProperties": false, "properties": { "Alarms": { - "$ref": "#/definitions/AWS::ECS::Service.DeploymentAlarms" + "$ref": "#/definitions/AWS::ECS::Service.DeploymentAlarms", + "markdownDescription": "Information about the CloudWatch alarms\\. \n*Required*: No \n*Type*: [DeploymentAlarms](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentalarms.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Alarms" }, "DeploymentCircuitBreaker": { "$ref": "#/definitions/AWS::ECS::Service.DeploymentCircuitBreaker", - "markdownDescription": "The deployment circuit breaker can only be used for services using the rolling update \\(`ECS`\\) deployment type that are not behind a Classic Load Balancer\\.\nThe **deployment circuit breaker** determines whether a service deployment will fail if the service can't reach a steady state\\. If enabled, a service deployment will transition to a failed state and stop launching new tasks\\. You can also enable Amazon ECS to roll back your service to the last completed deployment after a failure\\. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [DeploymentCircuitBreaker](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The deployment circuit breaker can only be used for services using the rolling update \\(`ECS`\\) deployment type\\.\nThe **deployment circuit breaker** determines whether a service deployment will fail if the service can't reach a steady state\\. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks\\. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully\\. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide* \n*Required*: No \n*Type*: [DeploymentCircuitBreaker](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeploymentCircuitBreaker" }, "MaximumPercent": { - "markdownDescription": "If a service is using the rolling update \\(`ECS`\\) deployment type, the **maximum percent** parameter represents an upper limit on the number of tasks in a service that are allowed in the `RUNNING` or `PENDING` state during a deployment, as a percentage of the desired number of tasks \\(rounded down to the nearest integer\\), and while any container instances are in the `DRAINING` state if the service contains tasks using the EC2 launch type\\. This parameter enables you to define the deployment batch size\\. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks \\(provided that the cluster resources required to do this are available\\)\\. The default value for maximum percent is 200%\\. \nIf a service is using the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and tasks that use the EC2 launch type, the **maximum percent** value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state\\. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If a service is using the rolling update \\(`ECS`\\) deployment type, the `maximumPercent` parameter represents an upper limit on the number of your service's tasks that are allowed in the `RUNNING` or `PENDING` state during a deployment, as a percentage of the `desiredCount` \\(rounded down to the nearest integer\\)\\. This parameter enables you to define the deployment batch size\\. For example, if your service is using the `REPLICA` service scheduler and has a `desiredCount` of four tasks and a `maximumPercent` value of 200%, the scheduler may start four new tasks before stopping the four older tasks \\(provided that the cluster resources required to do this are available\\)\\. The default `maximumPercent` value for a service using the `REPLICA` service scheduler is 200%\\. \nIf a service is using either the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and tasks that use the EC2 launch type, the **maximum percent** value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state\\. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaximumPercent", "type": "number" }, "MinimumHealthyPercent": { - "markdownDescription": "If a service is using the rolling update \\(`ECS`\\) deployment type, the **minimum healthy percent** represents a lower limit on the number of tasks in a service that must remain in the `RUNNING` state during a deployment, as a percentage of the desired number of tasks \\(rounded up to the nearest integer\\), and while any container instances are in the `DRAINING` state if the service contains tasks using the EC2 launch type\\. This parameter enables you to deploy without using additional cluster capacity\\. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks\\. Tasks for services that *do not* use a load balancer are considered healthy if they're in the `RUNNING` state; tasks for services that *do* use a load balancer are considered healthy if they're in the `RUNNING` state and they're reported as healthy by the load balancer\\. The default value for minimum healthy percent is 100%\\. \nIf a service is using the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and tasks that use the EC2 launch type, the **minimum healthy percent** value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state\\. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If a service is using the rolling update \\(`ECS`\\) deployment type, the `minimumHealthyPercent` represents a lower limit on the number of your service's tasks that must remain in the `RUNNING` state during a deployment, as a percentage of the `desiredCount` \\(rounded up to the nearest integer\\)\\. This parameter enables you to deploy without using additional cluster capacity\\. For example, if your service has a `desiredCount` of four tasks and a `minimumHealthyPercent` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks\\. \nFor services that *do not* use a load balancer, the following should be noted: \n+ A service is considered healthy if all essential containers within the tasks in the service pass their health checks\\.\n+ If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a `RUNNING` state before the task is counted towards the minimum healthy percent total\\.\n+ If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total\\. A task is considered healthy when all essential containers within the task have passed their health checks\\. The amount of time the service scheduler can wait for is determined by the container health check settings\\. \nFor services are that *do* use a load balancer, the following should be noted: \n+ If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total\\.\n+ If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total\\.\nIf a service is using either the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and is running tasks that use the EC2 launch type, the **minimum healthy percent** value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state\\. If a service is using either the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MinimumHealthyPercent", "type": "number" } @@ -65910,7 +67367,7 @@ "type": "string" }, "TargetGroupArn": { - "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the Elastic Load Balancing target group or groups associated with a service or task set\\. \nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer\\. If you're using a Classic Load Balancer, omit the target group ARN\\. \nFor services using the `ECS` deployment controller, you can specify one or multiple target groups\\. For more information, see [Registering Multiple Target Groups with a Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer\\. For more information, see [Blue/Green Deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance`\\. Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance\\. This network mode is required for the Fargate launch type\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the Elastic Load Balancing target group or groups associated with a service or task set\\. \nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer\\. If you're using a Classic Load Balancer, omit the target group ARN\\. \nFor services using the `ECS` deployment controller, you can specify one or multiple target groups\\. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer\\. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance`\\. Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance\\. This network mode is required for the Fargate launch type\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TargetGroupArn", "type": "string" } @@ -65921,21 +67378,27 @@ "additionalProperties": false, "properties": { "LogDriver": { + "markdownDescription": "The log driver to use for the container\\. \nFor tasks on AWS Fargate, the supported log drivers are `awslogs`, `splunk`, and `awsfirelens`\\. \nFor tasks hosted on Amazon EC2 instances, the supported log drivers are `awslogs`, `fluentd`, `gelf`, `json-file`, `journald`, `logentries`,`syslog`, `splunk`, and `awsfirelens`\\. \nFor more information about using the `awslogs` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor more information about using the `awsfirelens` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver\\. We encourage you to submit pull requests for changes that you would like to have included\\. However, we don't currently provide support for running modified copies of this software\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `awsfirelens | awslogs | fluentd | gelf | journald | json-file | splunk | syslog` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogDriver", "type": "string" }, "Options": { "additionalProperties": true, + "markdownDescription": "The configuration options to send to the log driver\\. This parameter requires version 1\\.19 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Options", "type": "object" }, "SecretOptions": { "items": { "$ref": "#/definitions/AWS::ECS::Service.Secret" }, + "markdownDescription": "The secrets to pass to the log configuration\\. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [Secret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-secret.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecretOptions", "type": "array" } }, @@ -65956,12 +67419,12 @@ "additionalProperties": false, "properties": { "Expression": { - "markdownDescription": "A cluster query language expression to apply to the constraint\\. The expression can have a maximum length of 2000 characters\\. You can't specify an expression if the constraint type is `distinctInstance`\\. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A cluster query language expression to apply to the constraint\\. The expression can have a maximum length of 2000 characters\\. You can't specify an expression if the constraint type is `distinctInstance`\\. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Expression", "type": "string" }, "Type": { - "markdownDescription": "The type of constraint\\. Use `distinctInstance` to ensure that each task in a particular group is running on a different container instance\\. Use `memberOf` to restrict the selection to a group of valid candidates\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `distinctInstance | memberOf` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of constraint\\. Use `distinctInstance` to ensure that each task in a particular group is running on a different container instance\\. Use `memberOf` to restrict the selection to a group of valid candidates\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `distinctInstance | memberOf` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" } @@ -65975,12 +67438,12 @@ "additionalProperties": false, "properties": { "Field": { - "markdownDescription": "The field to apply the placement strategy against\\. For the `spread` placement strategy, valid values are `instanceId` \\(or `host`, which has the same effect\\), or any platform or custom attribute that's applied to a container instance, such as `attribute:ecs.availability-zone`\\. For the `binpack` placement strategy, valid values are `cpu` and `memory`\\. For the `random` placement strategy, this field is not used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The field to apply the placement strategy against\\. For the `spread` placement strategy, valid values are `instanceId` \\(or `host`, which has the same effect\\), or any platform or custom attribute that is applied to a container instance, such as `attribute:ecs.availability-zone`\\. For the `binpack` placement strategy, valid values are `CPU` and `MEMORY`\\. For the `random` placement strategy, this field is not used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Field", "type": "string" }, "Type": { - "markdownDescription": "The type of placement strategy\\. The `random` placement strategy randomly places tasks on available candidates\\. The `spread` placement strategy spreads placement across available candidates evenly based on the `field` parameter\\. The `binpack` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the `field` parameter\\. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `binpack | random | spread` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of placement strategy\\. The `random` placement strategy randomly places tasks on available candidates\\. The `spread` placement strategy spreads placement across available candidates evenly based on the `field` parameter\\. The `binpack` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the `field` parameter\\. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `binpack | random | spread` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" } @@ -65994,9 +67457,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the secret\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ValueFrom": { + "markdownDescription": "The secret to expose to the container\\. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store\\. \nFor information about the require AWS Identity and Access Management permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) \\(for Secrets Manager\\) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) \\(for Systems Manager Parameter store\\) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter\\. If the parameter exists in a different Region, then the full ARN must be specified\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ValueFrom", "type": "string" } }, @@ -66010,9 +67477,13 @@ "additionalProperties": false, "properties": { "DnsName": { + "markdownDescription": "The `dnsName` is the name that you use in the applications of client tasks to connect to this service\\. The name must be a valid DNS name but doesn't need to be fully\\-qualified\\. The name can include up to 127 characters\\. The name can include lowercase letters, numbers, underscores \\(\\_\\), hyphens \\(\\-\\), and periods \\(\\.\\)\\. The name can't start with a hyphen\\. \nIf this parameter isn't specified, the default value of `discoveryName.namespace` is used\\. If the `discoveryName` isn't specified, the port mapping name from the task definition is used in `portName.namespace`\\. \nTo avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default\\. For example, a few common names are `database`, `db`, or the lowercase name of a database, such as `mysql` or `redis`\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DnsName", "type": "string" }, "Port": { + "markdownDescription": "The listening port number for the Service Connect proxy\\. This port is available inside of all of the tasks within the same namespace\\. \nTo avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" } }, @@ -66025,18 +67496,26 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Specifies whether to use Service Connect with this service\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "LogConfiguration": { - "$ref": "#/definitions/AWS::ECS::Service.LogConfiguration" + "$ref": "#/definitions/AWS::ECS::Service.LogConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogConfiguration" }, "Namespace": { + "markdownDescription": "The namespace name or full Amazon Resource Name \\(ARN\\) of the AWS Cloud Map namespace for use with Service Connect\\. The namespace must be in the same AWS Region as the Amazon ECS service and cluster\\. The type of namespace doesn't affect Service Connect\\. For more information about AWS Cloud Map, see [Working with Services](https://docs.aws.amazon.com/) in the * AWS Cloud Map Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Namespace", "type": "string" }, "Services": { "items": { "$ref": "#/definitions/AWS::ECS::Service.ServiceConnectService" }, + "markdownDescription": "The list of Service Connect service objects\\. These are names and aliases \\(also known as endpoints\\) that are used by other Amazon ECS services to connect to this service\\. \nThis field is not required for a \"client\" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace\\. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means\\. \nAn object selects a port from the task definition, assigns a name for the AWS Cloud Map service, and a list of aliases \\(endpoints\\) and ports for client applications to refer to this service\\. \n*Required*: No \n*Type*: List of [ServiceConnectService](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Services", "type": "array" } }, @@ -66052,15 +67531,23 @@ "items": { "$ref": "#/definitions/AWS::ECS::Service.ServiceConnectClientAlias" }, + "markdownDescription": "The list of client aliases for this Service Connect service\\. You use these to assign names that can be used by client applications\\. The maximum number of client aliases that you can have in this list is 1\\. \nEach alias \\(\"endpoint\"\\) is a fully\\-qualified name and port number that other Amazon ECS tasks \\(\"clients\"\\) can use to connect to this service\\. \nEach name and port mapping must be unique within the namespace\\. \nFor each `ServiceConnectService`, you must provide at least one `clientAlias` with one `port`\\. \n*Required*: No \n*Type*: List of [ServiceConnectClientAlias](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientAliases", "type": "array" }, "DiscoveryName": { + "markdownDescription": "The `discoveryName` is the name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service\\. This must be unique within the AWS Cloud Map namespace\\. The name can contain up to 64 characters\\. The name can include lowercase letters, numbers, underscores \\(\\_\\), and hyphens \\(\\-\\)\\. The name can't start with a hyphen\\. \nIf this parameter isn't specified, the default value of `discoveryName.namespace` is used\\. If the `discoveryName` isn't specified, the port mapping name from the task definition is used in `portName.namespace`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DiscoveryName", "type": "string" }, "IngressPortOverride": { + "markdownDescription": "The port number for the Service Connect proxy to listen on\\. \nUse the value of this field to bypass the proxy for traffic on the port number specified in the named `portMapping` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service\\. \nIn `awsvpc` mode and Fargate, the default value is the container port number\\. The container port number is in the `portMapping` in the task definition\\. In bridge mode, the default value is the ephemeral port of the Service Connect proxy\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IngressPortOverride", "type": "number" }, "PortName": { + "markdownDescription": "The `portName` must match the name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PortName", "type": "string" } }, @@ -66134,12 +67621,12 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.ContainerDefinition" }, - "markdownDescription": "A list of container definitions in JSON format that describe the different containers that make up your task\\. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [ContainerDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of container definitions in JSON format that describe the different containers that make up your task\\. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [ContainerDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ContainerDefinitions", "type": "array" }, "Cpu": { - "markdownDescription": "The number of `cpu` units used by the task\\. If you use the EC2 launch type, this field is optional\\. Any value can be used\\. If you use the Fargate launch type, this field is required\\. You must use one of the following values\\. The value that you choose determines your range of valid values for the `memory` parameter\\. \nThe CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate\\. \n+ 256 \\(\\.25 vCPU\\) \\- Available `memory` values: 512 \\(0\\.5 GB\\), 1024 \\(1 GB\\), 2048 \\(2 GB\\)\n+ 512 \\(\\.5 vCPU\\) \\- Available `memory` values: 1024 \\(1 GB\\), 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\)\n+ 1024 \\(1 vCPU\\) \\- Available `memory` values: 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\), 5120 \\(5 GB\\), 6144 \\(6 GB\\), 7168 \\(7 GB\\), 8192 \\(8 GB\\)\n+ 2048 \\(2 vCPU\\) \\- Available `memory` values: Between 4096 \\(4 GB\\) and 16384 \\(16 GB\\) in increments of 1024 \\(1 GB\\)\n+ 4096 \\(4 vCPU\\) \\- Available `memory` values: Between 8192 \\(8 GB\\) and 30720 \\(30 GB\\) in increments of 1024 \\(1 GB\\)\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The number of `cpu` units used by the task\\. If you use the EC2 launch type, this field is optional\\. Any value can be used\\. If you use the Fargate launch type, this field is required\\. You must use one of the following values\\. The value that you choose determines your range of valid values for the `memory` parameter\\. \nThe CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate\\. \n+ 256 \\(\\.25 vCPU\\) \\- Available `memory` values: 512 \\(0\\.5 GB\\), 1024 \\(1 GB\\), 2048 \\(2 GB\\)\n+ 512 \\(\\.5 vCPU\\) \\- Available `memory` values: 1024 \\(1 GB\\), 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\)\n+ 1024 \\(1 vCPU\\) \\- Available `memory` values: 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\), 5120 \\(5 GB\\), 6144 \\(6 GB\\), 7168 \\(7 GB\\), 8192 \\(8 GB\\)\n+ 2048 \\(2 vCPU\\) \\- Available `memory` values: 4096 \\(4 GB\\) and 16384 \\(16 GB\\) in increments of 1024 \\(1 GB\\)\n+ 4096 \\(4 vCPU\\) \\- Available `memory` values: 8192 \\(8 GB\\) and 30720 \\(30 GB\\) in increments of 1024 \\(1 GB\\)\n+ 8192 \\(8 vCPU\\) \\- Available `memory` values: 16 GB and 60 GB in 4 GB increments", "title": "Cpu", "type": "string" }, @@ -66172,12 +67659,12 @@ "type": "string" }, "Memory": { - "markdownDescription": "The amount \\(in MiB\\) of memory used by the task\\. \nIf your tasks runs on Amazon EC2 instances, you must specify either a task\\-level memory value or a container\\-level memory value\\. This field is optional and any value can be used\\. If a task\\-level memory value is specified, the container\\-level memory value is optional\\. For more information regarding container\\-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html)\\. \nIf your tasks runs on AWS Fargate, this field is required\\. You must use one of the following values\\. The value you choose determines your range of valid values for the `cpu` parameter\\. \n+ 512 \\(0\\.5 GB\\), 1024 \\(1 GB\\), 2048 \\(2 GB\\) \\- Available `cpu` values: 256 \\(\\.25 vCPU\\)\n+ 1024 \\(1 GB\\), 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\) \\- Available `cpu` values: 512 \\(\\.5 vCPU\\)\n+ 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\), 5120 \\(5 GB\\), 6144 \\(6 GB\\), 7168 \\(7 GB\\), 8192 \\(8 GB\\) \\- Available `cpu` values: 1024 \\(1 vCPU\\)\n+ Between 4096 \\(4 GB\\) and 16384 \\(16 GB\\) in increments of 1024 \\(1 GB\\) \\- Available `cpu` values: 2048 \\(2 vCPU\\)\n+ Between 8192 \\(8 GB\\) and 30720 \\(30 GB\\) in increments of 1024 \\(1 GB\\) \\- Available `cpu` values: 4096 \\(4 vCPU\\)\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The amount \\(in MiB\\) of memory used by the task\\. \nIf your tasks runs on Amazon EC2 instances, you must specify either a task\\-level memory value or a container\\-level memory value\\. This field is optional and any value can be used\\. If a task\\-level memory value is specified, the container\\-level memory value is optional\\. For more information regarding container\\-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html)\\. \nIf your tasks runs on AWS Fargate, this field is required\\. You must use one of the following values\\. The value you choose determines your range of valid values for the `cpu` parameter\\. \n+ 512 \\(0\\.5 GB\\), 1024 \\(1 GB\\), 2048 \\(2 GB\\) \\- Available `cpu` values: 256 \\(\\.25 vCPU\\)\n+ 1024 \\(1 GB\\), 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\) \\- Available `cpu` values: 512 \\(\\.5 vCPU\\)\n+ 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\), 5120 \\(5 GB\\), 6144 \\(6 GB\\), 7168 \\(7 GB\\), 8192 \\(8 GB\\) \\- Available `cpu` values: 1024 \\(1 vCPU\\)\n+ Between 4096 \\(4 GB\\) and 16384 \\(16 GB\\) in increments of 1024 \\(1 GB\\) \\- Available `cpu` values: 2048 \\(2 vCPU\\)\n+ Between 8192 \\(8 GB\\) and 30720 \\(30 GB\\) in increments of 1024 \\(1 GB\\) \\- Available `cpu` values: 4096 \\(4 vCPU\\)\n+ Between 16 GB and 60 GB in 4 GB increments \\- Available `cpu` values: 8192 \\(8 vCPU\\)", "title": "Memory", "type": "string" }, "NetworkMode": { - "markdownDescription": "The Docker networking mode to use for the containers in the task\\. The valid values are `none`, `bridge`, `awsvpc`, and `host`\\. The default Docker network mode is `bridge`\\. If you are using the Fargate launch type, the `awsvpc` network mode is required\\. If you are using the EC2 launch type, any network mode can be used\\. If the network mode is set to `none`, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity\\. The `host` and `awsvpc` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the `bridge` mode\\. \nWith the `host` and `awsvpc` network modes, exposed container ports are mapped directly to the corresponding host port \\(for the `host` network mode\\) or the attached elastic network interface port \\(for the `awsvpc` network mode\\), so you cannot take advantage of dynamic host port mappings\\. \nIf the network mode is `awsvpc`, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) value when you create a service or run a task with the task definition\\. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nCurrently, only Amazon ECS\\-optimized AMIs, other Amazon Linux variants with the `ecs-init` package, or AWS Fargate infrastructure support the `awsvpc` network mode\\. \nIf the network mode is `host`, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used\\. \nDocker for Windows uses different network modes than Docker for Linux\\. When you register a task definition with Windows containers, you must not specify a network mode\\. If you use the console to register a task definition with Windows containers, you must choose the `` network mode object\\. \nFor more information, see [Network settings](https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `awsvpc | bridge | host | none` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Docker networking mode to use for the containers in the task\\. The valid values are `none`, `bridge`, `awsvpc`, and `host`\\. If no network mode is specified, the default is `bridge`\\. \nFor Amazon ECS tasks on Fargate, the `awsvpc` network mode is required\\. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used\\. For Amazon ECS tasks on Amazon EC2 Windows instances, `` or `awsvpc` can be used\\. If the network mode is set to `none`, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity\\. The `host` and `awsvpc` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the `bridge` mode\\. \nWith the `host` and `awsvpc` network modes, exposed container ports are mapped directly to the corresponding host port \\(for the `host` network mode\\) or the attached elastic network interface port \\(for the `awsvpc` network mode\\), so you cannot take advantage of dynamic host port mappings\\. \nWhen using the `host` network mode, you should not run containers using the root user \\(UID 0\\)\\. It is considered best practice to use a non\\-root user\\.\nIf the network mode is `awsvpc`, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-networkconfiguration) value when you create a service or run a task with the task definition\\. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf the network mode is `host`, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used\\. \nFor more information, see [Network settings](https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `awsvpc | bridge | host | none` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "NetworkMode", "type": "string" }, @@ -66196,14 +67683,14 @@ }, "ProxyConfiguration": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.ProxyConfiguration", - "markdownDescription": "The `ProxyConfiguration` property specifies the configuration details for the App Mesh proxy\\. \nYour Amazon ECS container instances require at least version 1\\.26\\.0 of the container agent and at least version 1\\.26\\.0\\-1 of the `ecs-init` package to enable a proxy configuration\\. If your container instances are launched from the Amazon ECS\\-optimized AMI version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [ProxyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The configuration details for the App Mesh proxy\\. \nYour Amazon ECS container instances require at least version 1\\.26\\.0 of the container agent and at least version 1\\.26\\.0\\-1 of the `ecs-init` package to use a proxy configuration\\. If your container instances are launched from the Amazon ECS optimized AMI version `20190301` or later, they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [ProxyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ProxyConfiguration" }, "RequiresCompatibilities": { "items": { "type": "string" }, - "markdownDescription": "The task launch types the task definition was validated against\\. To determine which task launch types the task definition is validated for, see the `TaskDefinition$compatibilities` parameter\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The task launch types the task definition was validated against\\. To determine which task launch types the task definition is validated for, see the `TaskDefinition$compatibilities` parameter\\. \nThe valid values are: \n+ `EC2` \\- The EC2 launch type\n+ `FARGATE` \\- The Fargate launch type\n+ `EXTERNAL` \\- The external instance \\(ECS Anywhere\\) launch type\n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RequiresCompatibilities", "type": "array" }, @@ -66229,7 +67716,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.Volume" }, - "markdownDescription": "The list of data volume definitions for the task\\. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nThe `host` and `sourcePath` parameters aren't supported for tasks run on AWS Fargate\\.\n*Required*: No \n*Type*: List of [Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The list of data volume definitions for the task\\. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nThe `host` and `sourcePath` parameters aren't supported for tasks run on AWS Fargate\\. \n*Required*: No \n*Type*: List of [Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Volumes", "type": "array" } @@ -66260,12 +67747,12 @@ "additionalProperties": false, "properties": { "AccessPointId": { - "markdownDescription": "The Amazon EFS access point ID to use\\. If an access point is specified, the root directory value specified in the `EFSVolumeConfiguration` must either be omitted or set to `/` which will enforce the path set on the EFS access point\\. If an access point is used, transit encryption must be enabled in the `EFSVolumeConfiguration`\\. For more information, see [Working with Amazon EFS Access Points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon EFS access point ID to use\\. If an access point is specified, the root directory value specified in the `EFSVolumeConfiguration` must either be omitted or set to `/` which will enforce the path set on the EFS access point\\. If an access point is used, transit encryption must be enabled in the `EFSVolumeConfiguration`\\. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AccessPointId", "type": "string" }, "IAM": { - "markdownDescription": "Determines whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system\\. If enabled, transit encryption must be enabled in the `EFSVolumeConfiguration`\\. If this parameter is omitted, the default value of `DISABLED` is used\\. For more information, see [Using Amazon EFS Access Points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system\\. If enabled, transit encryption must be enabled in the `EFSVolumeConfiguration`\\. If this parameter is omitted, the default value of `DISABLED` is used\\. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IAM", "type": "string" } @@ -66292,12 +67779,12 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.ContainerDependency" }, - "markdownDescription": "The dependencies defined for container startup and shutdown\\. A container can contain multiple dependencies\\. When a dependency is defined for container startup, for container shutdown it is reversed\\. \nFor tasks using the EC2 launch type, the container instances require at least version 1\\.26\\.0 of the container agent to turn on container dependencies\\. However, we recommend using the latest container agent version\\. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*\\. If you're using an Amazon ECS\\-optimized Linux AMI, your instance needs at least version 1\\.26\\.0\\-1 of the `ecs-init` package\\. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor tasks using the Fargate launch type, the task or service requires the following platforms: \n+ Linux platform version `1.3.0` or later\\.\n+ Windows platform version `1.0.0` or later\\.\n*Required*: No \n*Type*: List of [ContainerDependency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The dependencies defined for container startup and shutdown\\. A container can contain multiple dependencies\\. When a dependency is defined for container startup, for container shutdown it is reversed\\. \nFor tasks using the EC2 launch type, the container instances require at least version 1\\.26\\.0 of the container agent to turn on container dependencies\\. However, we recommend using the latest container agent version\\. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*\\. If you're using an Amazon ECS\\-optimized Linux AMI, your instance needs at least version 1\\.26\\.0\\-1 of the `ecs-init` package\\. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor tasks using the Fargate launch type, the task or service requires the following platforms: \n+ Linux platform version `1.3.0` or later\\.\n+ Windows platform version `1.0.0` or later\\.\nIf the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the `dependsOn` parameter is not supported\\. For more information see [Issue \\#680](https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website\\. \n*Required*: No \n*Type*: List of [ContainerDependency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DependsOn", "type": "array" }, "DisableNetworking": { - "markdownDescription": "When this parameter is true, networking is disabled within the container\\. This parameter maps to `NetworkDisabled` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/)\\. \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "When this parameter is true, networking is off within the container\\. This parameter maps to `NetworkDisabled` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/)\\. \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DisableNetworking", "type": "boolean" }, @@ -66348,7 +67835,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.KeyValuePair" }, - "markdownDescription": "The environment variables to pass to a container\\. This parameter maps to `Env` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--env` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWe don't recommend that you use plaintext environment variables for sensitive information, such as credential data\\.\n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The environment variables to pass to a container\\. This parameter maps to `Env` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--env` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWe don't recommend that you use plaintext environment variables for sensitive information, such as credential data\\.\n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-keyvaluepair.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Environment", "type": "array" }, @@ -66369,7 +67856,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.HostEntry" }, - "markdownDescription": "A list of hostnames and IP address mappings to append to the `/etc/hosts` file on the container\\. This parameter maps to `ExtraHosts` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--add-host` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThis parameter isn't supported for Windows containers or tasks that use the `awsvpc` network mode\\.\n*Required*: No \n*Type*: List of [HostEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of hostnames and IP address mappings to append to the `/etc/hosts` file on the container\\. This parameter maps to `ExtraHosts` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--add-host` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThis parameter isn't supported for Windows containers or tasks that use the `awsvpc` network mode\\.\n*Required*: No \n*Type*: List of [HostEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-hostentry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ExtraHosts", "type": "array" }, @@ -66389,7 +67876,7 @@ "type": "string" }, "Image": { - "markdownDescription": "The image used to start a container\\. This string is passed directly to the Docker daemon\\. By default, images in the Docker Hub registry are available\\. Other repositories are specified with either ` repository-url/image:tag ` or ` repository-url/image@digest `\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed\\. This parameter maps to `Image` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `IMAGE` parameter of [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n+ When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use\\. However, subsequent updates to a repository image aren't propagated to already running tasks\\.\n+ Images in Amazon ECR repositories can be specified by either using the full `registry/repository:tag` or `registry/repository@digest`\\. For example, `012345678910.dkr.ecr..amazonaws.com/:latest` or `012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE`\\. \n+ Images in official repositories on Docker Hub use a single name \\(for example, `ubuntu` or `mongo`\\)\\.\n+ Images in other repositories on Docker Hub are qualified with an organization name \\(for example, `amazon/amazon-ecs-agent`\\)\\.\n+ Images in other online repositories are qualified further by a domain name \\(for example, `quay.io/assemblyline/ubuntu`\\)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The image used to start a container\\. This string is passed directly to the Docker daemon\\. By default, images in the Docker Hub registry are available\\. Other repositories are specified with either ` repository-url/image:tag ` or ` repository-url/image@digest `\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed\\. This parameter maps to `Image` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `IMAGE` parameter of [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n+ When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use\\. However, subsequent updates to a repository image aren't propagated to already running tasks\\.\n+ Images in Amazon ECR repositories can be specified by either using the full `registry/repository:tag` or `registry/repository@digest`\\. For example, `012345678910.dkr.ecr..amazonaws.com/:latest` or `012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE`\\. \n+ Images in official repositories on Docker Hub use a single name \\(for example, `ubuntu` or `mongo`\\)\\.\n+ Images in other repositories on Docker Hub are qualified with an organization name \\(for example, `amazon/amazon-ecs-agent`\\)\\.\n+ Images in other online repositories are qualified further by a domain name \\(for example, `quay.io/assemblyline/ubuntu`\\)\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Image", "type": "string" }, @@ -66413,7 +67900,7 @@ }, "LogConfiguration": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.LogConfiguration", - "markdownDescription": "The log configuration specification for the container\\. \nThis parameter maps to `LogConfig` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--log-driver` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. By default, containers use the same logging driver that the Docker daemon uses\\. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition\\. To use a different logging driver for a container, the log system must be configured properly on the container instance \\(or on a different log server for remote logging options\\)\\. For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation\\. \nAmazon ECS currently supports a subset of the logging drivers available to the Docker daemon \\(shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type\\)\\. Additional log drivers may be available in future releases of the Amazon ECS container agent\\.\nThis parameter requires version 1\\.18 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \nThe Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options\\. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*\\.\n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The log configuration specification for the container\\. \nThis parameter maps to `LogConfig` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--log-driver` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. By default, containers use the same logging driver that the Docker daemon uses\\. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition\\. To use a different logging driver for a container, the log system must be configured properly on the container instance \\(or on a different log server for remote logging options\\)\\. For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation\\. \nAmazon ECS currently supports a subset of the logging drivers available to the Docker daemon \\(shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type\\)\\. Additional log drivers may be available in future releases of the Amazon ECS container agent\\.\nThis parameter requires version 1\\.18 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \nThe Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options\\. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*\\.\n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-logconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "LogConfiguration" }, "Memory": { @@ -66422,7 +67909,7 @@ "type": "number" }, "MemoryReservation": { - "markdownDescription": "The soft limit \\(in MiB\\) of memory to reserve for the container\\. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit\\. However, your container can consume more memory when it needs to, up to either the hard limit specified with the `memory` parameter \\(if applicable\\), or all of the available memory on the container instance, whichever comes first\\. This parameter maps to `MemoryReservation` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--memory-reservation` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nIf a task\\-level memory value is not specified, you must specify a non\\-zero integer for one or both of `memory` or `memoryReservation` in a container definition\\. If you specify both, `memory` must be greater than `memoryReservation`\\. If you specify `memoryReservation`, then that value is subtracted from the available memory resources for the container instance where the container is placed\\. Otherwise, the value of `memory` is used\\. \nFor example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a `memoryReservation` of 128 MiB, and a `memory` hard limit of 300 MiB\\. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed\\. \nThe Docker daemon reserves a minimum of 4 MiB of memory for a container\\. Therefore, we recommend that you specify fewer than 4 MiB of memory for your containers\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The soft limit \\(in MiB\\) of memory to reserve for the container\\. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit\\. However, your container can consume more memory when it needs to, up to either the hard limit specified with the `memory` parameter \\(if applicable\\), or all of the available memory on the container instance, whichever comes first\\. This parameter maps to `MemoryReservation` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--memory-reservation` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nIf a task\\-level memory value is not specified, you must specify a non\\-zero integer for one or both of `memory` or `memoryReservation` in a container definition\\. If you specify both, `memory` must be greater than `memoryReservation`\\. If you specify `memoryReservation`, then that value is subtracted from the available memory resources for the container instance where the container is placed\\. Otherwise, the value of `memory` is used\\. \nFor example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a `memoryReservation` of 128 MiB, and a `memory` hard limit of 300 MiB\\. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed\\. \nThe Docker 20\\.10\\.0 or later daemon reserves a minimum of 6 MiB of memory for a container\\. So, don't specify less than 6 MiB of memory for your containers\\. \nThe Docker 19\\.03\\.13\\-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container\\. So, don't specify less than 4 MiB of memory for your containers\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MemoryReservation", "type": "number" }, @@ -66430,12 +67917,12 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.MountPoint" }, - "markdownDescription": "The mount points for data volumes in your container\\. \nThis parameter maps to `Volumes` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--volume` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWindows containers can mount whole directories on the same drive as `$env:ProgramData`\\. Windows containers can't mount directories on a different drive, and mount point can't be across drives\\. \n*Required*: No \n*Type*: List of [MountPoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The mount points for data volumes in your container\\. \nThis parameter maps to `Volumes` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--volume` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWindows containers can mount whole directories on the same drive as `$env:ProgramData`\\. Windows containers can't mount directories on a different drive, and mount point can't be across drives\\. \n*Required*: No \n*Type*: List of [MountPoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-mountpoint.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MountPoints", "type": "array" }, "Name": { - "markdownDescription": "The name of a container\\. If you're linking multiple containers together in a task definition, the `name` of one container can be entered in the `links` of another container to connect the containers\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, underscores, and hyphens are allowed\\. This parameter maps to `name` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--name` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of a container\\. If you're linking multiple containers together in a task definition, the `name` of one container can be entered in the `links` of another container to connect the containers\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, underscores, and hyphens are allowed\\. This parameter maps to `name` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--name` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -66443,7 +67930,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.PortMapping" }, - "markdownDescription": "The list of port mappings for the container\\. Port mappings allow containers to access ports on the host container instance to send or receive traffic\\. \nFor task definitions that use the `awsvpc` network mode, you should only specify the `containerPort`\\. The `hostPort` can be left blank or it must be the same value as the `containerPort`\\. \nPort mappings on Windows use the `NetNAT` gateway address rather than `localhost`\\. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself\\. \nThis parameter maps to `PortBindings` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--publish` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. If the network mode of a task definition is set to `none`, then you can't specify port mappings\\. If the network mode of a task definition is set to `host`, then host ports must either be undefined or they must match the container port in the port mapping\\. \nAfter a task reaches the `RUNNING` status, manual and automatic host and container port assignments are visible in the **Network Bindings** section of a container description for a selected task in the Amazon ECS console\\. The assignments are also visible in the `networkBindings` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses\\.\n*Required*: No \n*Type*: List of [PortMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The list of port mappings for the container\\. Port mappings allow containers to access ports on the host container instance to send or receive traffic\\. \nFor task definitions that use the `awsvpc` network mode, you should only specify the `containerPort`\\. The `hostPort` can be left blank or it must be the same value as the `containerPort`\\. \nPort mappings on Windows use the `NetNAT` gateway address rather than `localhost`\\. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself\\. \nThis parameter maps to `PortBindings` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--publish` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. If the network mode of a task definition is set to `none`, then you can't specify port mappings\\. If the network mode of a task definition is set to `host`, then host ports must either be undefined or they must match the container port in the port mapping\\. \nAfter a task reaches the `RUNNING` status, manual and automatic host and container port assignments are visible in the **Network Bindings** section of a container description for a selected task in the Amazon ECS console\\. The assignments are also visible in the `networkBindings` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses\\.\n*Required*: No \n*Type*: List of [PortMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-portmapping.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PortMappings", "type": "array" }, @@ -66505,7 +67992,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.Ulimit" }, - "markdownDescription": "A list of `ulimits` to set in the container\\. This parameter maps to `Ulimits` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--ulimit` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type\\. This parameter requires version 1\\.18 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: List of [Ulimit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of `ulimits` to set in the container\\. This parameter maps to `Ulimits` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--ulimit` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type\\. This parameter requires version 1\\.18 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: List of [Ulimit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-ulimit.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Ulimits", "type": "array" }, @@ -66518,7 +68005,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.VolumeFrom" }, - "markdownDescription": "Data volumes to mount from another container\\. This parameter maps to `VolumesFrom` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--volumes-from` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: No \n*Type*: List of [VolumeFrom](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Data volumes to mount from another container\\. This parameter maps to `VolumesFrom` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--volumes-from` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: No \n*Type*: List of [VolumeFrom](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumefrom.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VolumesFrom", "type": "array" }, @@ -66636,12 +68123,12 @@ "type": "string" }, "TransitEncryption": { - "markdownDescription": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server\\. Transit encryption must be enabled if Amazon EFS IAM authorization is used\\. If this parameter is omitted, the default value of `DISABLED` is used\\. For more information, see [Encrypting Data in Transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server\\. Transit encryption must be enabled if Amazon EFS IAM authorization is used\\. If this parameter is omitted, the default value of `DISABLED` is used\\. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TransitEncryption", "type": "string" }, "TransitEncryptionPort": { - "markdownDescription": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server\\. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses\\. For more information, see [EFS Mount Helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server\\. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses\\. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TransitEncryptionPort", "type": "number" } @@ -66707,7 +68194,7 @@ "items": { "type": "string" }, - "markdownDescription": "A string array representing the command that the container runs to determine if it is healthy\\. The string array must start with `CMD` to execute the command arguments directly, or `CMD-SHELL` to run the command with the container's default shell\\. \n When you use the AWS Management Console JSON panel, the AWS Command Line Interface, or the APIs, enclose the list of commands in brackets\\. \n `[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]` \nYou don't need to include the brackets when you use the AWS Management Console\\. \n ` \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ` \nAn exit code of 0 indicates success, and non\\-zero exit code indicates failure\\. For more information, see `HealthCheck` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A string array representing the command that the container runs to determine if it is healthy\\. The string array must start with `CMD` to run the command arguments directly, or `CMD-SHELL` to run the command with the container's default shell\\. \n When you use the AWS Management Console JSON panel, the AWS Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets\\. \n `[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]` \nYou don't include the double quotes and brackets when you use the AWS Management Console\\. \n ` CMD-SHELL, curl -f http://localhost/ || exit 1` \nAn exit code of 0 indicates success, and non\\-zero exit code indicates failure\\. For more information, see `HealthCheck` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Command", "type": "array" }, @@ -66722,7 +68209,7 @@ "type": "number" }, "StartPeriod": { - "markdownDescription": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries\\. You can specify between 0 and 300 seconds\\. By default, the `startPeriod` is disabled\\. \nIf a health check succeeds within the `startPeriod`, then the container is considered healthy and any subsequent failures count toward the maximum number of retries\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries\\. You can specify between 0 and 300 seconds\\. By default, the `startPeriod` is off\\. \nIf a health check succeeds within the `startPeriod`, then the container is considered healthy and any subsequent failures count toward the maximum number of retries\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StartPeriod", "type": "number" }, @@ -66885,7 +68372,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.Secret" }, - "markdownDescription": "The secrets to pass to the log configuration\\. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [Secret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The secrets to pass to the log configuration\\. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [Secret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SecretOptions", "type": "array" } @@ -66920,6 +68407,8 @@ "additionalProperties": false, "properties": { "AppProtocol": { + "markdownDescription": "The application protocol that's used for the port mapping\\. This parameter only applies to Service Connect\\. We recommend that you set this parameter to be consistent with the protocol that your application uses\\. If you set this parameter, Amazon ECS adds protocol\\-specific connection handling to the Service Connect proxy\\. If you set this parameter, Amazon ECS adds protocol\\-specific telemetry in the Amazon ECS console and CloudWatch\\. \nIf you don't set a value for this parameter, then TCP is used\\. However, Amazon ECS doesn't add protocol\\-specific telemetry for TCP\\. \nTasks that run in a namespace can use short names to connect to services in the namespace\\. Tasks can connect to services across all of the clusters in the namespace\\. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility\\. Only the tasks that Amazon ECS services create are supported with Service Connect\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `grpc | http | http2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AppProtocol", "type": "string" }, "ContainerPort": { @@ -66928,6 +68417,8 @@ "type": "number" }, "ContainerPortRange": { + "markdownDescription": "The port number range on the container that's bound to the dynamically mapped host port range\\. \nThe following rules apply when you specify a `containerPortRange`: \n+ You must use either the `bridge` network mode or the `awsvpc` network mode\\.\n+ This parameter is available for both the EC2 and AWS Fargate launch types\\.\n+ This parameter is available for both the Linux and Windows operating systems\\.\n+ The container instance must have at least version 1\\.67\\.0 of the container agent and at least version 1\\.67\\.0\\-1 of the `ecs-init` package \n+ You can specify a maximum of 100 port ranges per container\\.\n+ You do not specify a `hostPortRange`\\. The value of the `hostPortRange` is set as follows:\n + For containers in a task with the `awsvpc` network mode, the `hostPort` is set to the same value as the `containerPort`\\. This is a static mapping strategy\\.\n + For containers in a task with the `bridge` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports\\.\n+ The `containerPortRange` valid values are between 1 and 65535\\.\n+ A port can only be included in one port mapping per container\\.\n+ You cannot specify overlapping port ranges\\.\n+ The first port in the range must be less than last port in the range\\.\n+ Docker recommends that you turn off the docker\\-proxy in the Docker daemon config file when you have a large number of ports\\.", + "title": "ContainerPortRange", "type": "string" }, "HostPort": { @@ -66936,6 +68427,8 @@ "type": "number" }, "Name": { + "markdownDescription": "The name that's used for the port mapping\\. This parameter only applies to Service Connect\\. This parameter is the name that you use in the `serviceConnectConfiguration` of a service\\. The name can include up to 64 characters\\. The characters can include lowercase letters, numbers, underscores \\(\\_\\), and hyphens \\(\\-\\)\\. The name can't start with a hyphen\\. \nFor more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Protocol": { @@ -66958,7 +68451,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.KeyValuePair" }, - "markdownDescription": "The set of network configuration parameters to provide the Container Network Interface \\(CNI\\) plugin, specified as key\\-value pairs\\. \n+ `IgnoredUID` \\- \\(Required\\) The user ID \\(UID\\) of the proxy container as defined by the `user` parameter in a container definition\\. This is used to ensure the proxy ignores its own traffic\\. If `IgnoredGID` is specified, this field can be empty\\.\n+ `IgnoredGID` \\- \\(Required\\) The group ID \\(GID\\) of the proxy container as defined by the `user` parameter in a container definition\\. This is used to ensure the proxy ignores its own traffic\\. If `IgnoredUID` is specified, this field can be empty\\.\n+ `AppPorts` \\- \\(Required\\) The list of ports that the application uses\\. Network traffic to these ports is forwarded to the `ProxyIngressPort` and `ProxyEgressPort`\\.\n+ `ProxyIngressPort` \\- \\(Required\\) Specifies the port that incoming traffic to the `AppPorts` is directed to\\.\n+ `ProxyEgressPort` \\- \\(Required\\) Specifies the port that outgoing traffic from the `AppPorts` is directed to\\.\n+ `EgressIgnoredPorts` \\- \\(Required\\) The egress traffic going to the specified ports is ignored and not redirected to the `ProxyEgressPort`\\. It can be an empty list\\.\n+ `EgressIgnoredIPs` \\- \\(Required\\) The egress traffic going to the specified IP addresses is ignored and not redirected to the `ProxyEgressPort`\\. It can be an empty list\\.\n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The set of network configuration parameters to provide the Container Network Interface \\(CNI\\) plugin, specified as key\\-value pairs\\. \n+ `IgnoredUID` \\- \\(Required\\) The user ID \\(UID\\) of the proxy container as defined by the `user` parameter in a container definition\\. This is used to ensure the proxy ignores its own traffic\\. If `IgnoredGID` is specified, this field can be empty\\.\n+ `IgnoredGID` \\- \\(Required\\) The group ID \\(GID\\) of the proxy container as defined by the `user` parameter in a container definition\\. This is used to ensure the proxy ignores its own traffic\\. If `IgnoredUID` is specified, this field can be empty\\.\n+ `AppPorts` \\- \\(Required\\) The list of ports that the application uses\\. Network traffic to these ports is forwarded to the `ProxyIngressPort` and `ProxyEgressPort`\\.\n+ `ProxyIngressPort` \\- \\(Required\\) Specifies the port that incoming traffic to the `AppPorts` is directed to\\.\n+ `ProxyEgressPort` \\- \\(Required\\) Specifies the port that outgoing traffic from the `AppPorts` is directed to\\.\n+ `EgressIgnoredPorts` \\- \\(Required\\) The egress traffic going to the specified ports is ignored and not redirected to the `ProxyEgressPort`\\. It can be an empty list\\.\n+ `EgressIgnoredIPs` \\- \\(Required\\) The egress traffic going to the specified IP addresses is ignored and not redirected to the `ProxyEgressPort`\\. It can be an empty list\\.\n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-keyvaluepair.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ProxyConfigurationProperties", "type": "array" }, @@ -67008,7 +68501,7 @@ "additionalProperties": false, "properties": { "CpuArchitecture": { - "markdownDescription": "The CPU architecture\\. \nYou can run your Linux tasks on an ARM\\-based platform by setting the value to `ARM64`\\. This option is avaiable for tasks that run on Linuc Amazon EC2 instance or Linux containers on Fargate\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ARM64 | X86_64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The CPU architecture\\. \nYou can run your Linux tasks on an ARM\\-based platform by setting the value to `ARM64`\\. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ARM64 | X86_64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CpuArchitecture", "type": "string" }, @@ -67106,7 +68599,7 @@ "additionalProperties": false, "properties": { "HardLimit": { - "markdownDescription": "The hard limit for the ulimit type\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The hard limit for the `ulimit` type\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "HardLimit", "type": "number" }, @@ -67116,7 +68609,7 @@ "type": "string" }, "SoftLimit": { - "markdownDescription": "The soft limit for the ulimit type\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The soft limit for the `ulimit` type\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SoftLimit", "type": "number" } @@ -67143,7 +68636,7 @@ }, "Host": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.HostVolumeProperties", - "markdownDescription": "This parameter is specified when you use bind mount host volumes\\. The contents of the `host` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored\\. If the `host` parameter is empty, then the Docker daemon assigns a host path for your data volume\\. However, the data isn't guaranteed to persist after the containers that are associated with it stop running\\. \nWindows containers can mount whole directories on the same drive as `$env:ProgramData`\\. Windows containers can't mount directories on a different drive, and mount point can't be across drives\\. For example, you can mount `C:\\my\\path:C:\\my\\path` and `D:\\:D:\\`, but not `D:\\my\\path:C:\\my\\path` or `D:\\:C:\\my\\path`\\. \n*Required*: No \n*Type*: [HostVolumeProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes-host.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "This parameter is specified when you use bind mount host volumes\\. The contents of the `host` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored\\. If the `host` parameter is empty, then the Docker daemon assigns a host path for your data volume\\. However, the data isn't guaranteed to persist after the containers that are associated with it stop running\\. \nWindows containers can mount whole directories on the same drive as `$env:ProgramData`\\. Windows containers can't mount directories on a different drive, and mount point can't be across drives\\. For example, you can mount `C:\\my\\path:C:\\my\\path` and `D:\\:D:\\`, but not `D:\\my\\path:C:\\my\\path` or `D:\\:C:\\my\\path`\\. \n*Required*: No \n*Type*: [HostVolumeProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-hostvolumeproperties.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Host" }, "Name": { @@ -67216,7 +68709,7 @@ "type": "string" }, "LaunchType": { - "markdownDescription": "The launch type that new tasks in the task set uses\\. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf a `launchType` is specified, the `capacityProviderStrategy` parameter must be omitted\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EC2 | EXTERNAL | FARGATE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The launch type that new tasks in the task set uses\\. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf a `launchType` is specified, the `capacityProviderStrategy` parameter must be omitted\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EC2 | EXTERNAL | FARGATE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "LaunchType", "type": "string" }, @@ -67252,7 +68745,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskSet.ServiceRegistry" }, - "markdownDescription": "The details of the service discovery registries to assign to this task set\\. For more information, see [Service Discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html)\\. \n*Required*: No \n*Type*: List of [ServiceRegistry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The details of the service discovery registries to assign to this task set\\. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html)\\. \n*Required*: No \n*Type*: List of [ServiceRegistry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ServiceRegistries", "type": "array" }, @@ -67339,7 +68832,7 @@ "type": "string" }, "TargetGroupArn": { - "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the Elastic Load Balancing target group or groups associated with a service or task set\\. \nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer\\. If you're using a Classic Load Balancer, omit the target group ARN\\. \nFor services using the `ECS` deployment controller, you can specify one or multiple target groups\\. For more information, see [Registering Multiple Target Groups with a Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer\\. For more information, see [Blue/Green Deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance`\\. Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance\\. This network mode is required for the Fargate launch type\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the Elastic Load Balancing target group or groups associated with a service or task set\\. \nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer\\. If you're using a Classic Load Balancer, omit the target group ARN\\. \nFor services using the `ECS` deployment controller, you can specify one or multiple target groups\\. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer\\. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance`\\. Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance\\. This network mode is required for the Fargate launch type\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TargetGroupArn", "type": "string" } @@ -67621,7 +69114,7 @@ "title": "BackupPolicy" }, "BypassPolicyLockoutSafetyCheck": { - "markdownDescription": "\\(Optional\\) Use this boolean to use or bypass the `FileSystemPolicy` lockout safety check\\. The policy lockout safety check determines if the `FileSystemPolicy` in the request will lock out the IAM principal making the request, preventing them from making future `PutFileSystemPolicy` requests on the file system\\. Set `BypassPolicyLockoutSafetyCheck` to `True` only when you intend to prevent the IAM principal that is making the request from making a subsequent `PutFileSystemPolicy` request on the file system\\. The default value is `False`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "\\(Optional\\) A boolean that specifies whether or not to bypass the `FileSystemPolicy` lockout safety check\\. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future `PutFileSystemPolicy` requests on this file system\\. Set `BypassPolicyLockoutSafetyCheck` to `True` only when you intend to prevent the IAM principal that is making the request from making subsequent `PutFileSystemPolicy` requests on this file system\\. The default value is `False`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BypassPolicyLockoutSafetyCheck", "type": "boolean" }, @@ -67652,7 +69145,7 @@ "items": { "$ref": "#/definitions/AWS::EFS::FileSystem.LifecyclePolicy" }, - "markdownDescription": "A list of one LifecyclePolicy that tells EFS lifecycle management when to transition files to the Infrequent Access \\(IA\\) storage classes\\. \n*Required*: No \n*Type*: List of [LifecyclePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of `LifecyclePolicy` objects that define the file system's `LifecycleConfiguration` object\\. A `LifecycleConfiguration` object informs EFS lifecycle management and intelligent tiering of the following: \n+ When to move files in the file system from primary storage to the IA storage class\\.\n+ When to move files that are in IA storage to primary storage\\.\nAmazon EFS requires that each `LifecyclePolicy` object have only a single transition\\. This means that in a request body, `LifecyclePolicies` needs to be structured as an array of `LifecyclePolicy` objects, one object for each transition, `TransitionToIA`, `TransitionToPrimaryStorageClass`\\. See the example requests in the following section for more information\\.\n*Required*: No \n*Type*: List of [LifecyclePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html) \n*Maximum*: `2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LifecyclePolicies", "type": "array" }, @@ -67667,7 +69160,7 @@ "type": "number" }, "ThroughputMode": { - "markdownDescription": "Specifies the throughput mode for the file system, either `bursting` or `provisioned`\\. If you set `ThroughputMode` to `provisioned`, you must also set a value for `ProvisionedThroughputInMibps`\\. After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, as long as it\u2019s been more than 24 hours since the last decrease or throughput mode change\\. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*\\. \nDefault is `bursting`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `bursting | provisioned` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the throughput mode for the file system\\. The mode can be `bursting`, `provisioned`, or `elastic`\\. If you set `ThroughputMode` to `provisioned`, you must also set a value for `ProvisionedThroughputInMibps`\\. After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, with certain time restrictions\\. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*\\. \nDefault is `bursting`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `bursting | elastic | provisioned` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThroughputMode", "type": "string" } @@ -67732,7 +69225,7 @@ "additionalProperties": false, "properties": { "TransitionToIA": { - "markdownDescription": "Describes the period of time that a file is not accessed, after which it transitions to IA storage\\. Metadata operations such as listing the contents of a directory don't count as file access events\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AFTER_14_DAYS | AFTER_30_DAYS | AFTER_60_DAYS | AFTER_7_DAYS | AFTER_90_DAYS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Describes the period of time that a file is not accessed, after which it transitions to IA storage\\. Metadata operations such as listing the contents of a directory don't count as file access events\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AFTER_14_DAYS | AFTER_1_DAY | AFTER_30_DAYS | AFTER_60_DAYS | AFTER_7_DAYS | AFTER_90_DAYS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TransitionToIA", "type": "string" }, @@ -67882,13 +69375,17 @@ "type": "string" }, "ConfigurationValues": { + "markdownDescription": "The configuration values that you provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConfigurationValues", "type": "string" }, "PreserveOnDelete": { + "markdownDescription": "Specifying this option preserves the add\\-on software on your cluster but Amazon EKS stops managing any settings for the add\\-on\\. If an IAM account is associated with the add\\-on, it isn't removed\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PreserveOnDelete", "type": "boolean" }, "ResolveConflicts": { - "markdownDescription": "How to resolve parameter value conflicts when migrating an existing add\\-on to an Amazon EKS add\\-on\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | OVERWRITE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "How to resolve field value conflicts for an Amazon EKS add\\-on\\. Conflicts are handled based on the value you choose: \n+ **None** \u2013 If the self\\-managed version of the add\\-on is installed on your cluster, Amazon EKS doesn't change the value\\. Creation of the add\\-on might fail\\.\n+ **Overwrite** \u2013 If the self\\-managed version of the add\\-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value\\.\n+ **Preserve** \u2013 Not supported\\. You can set this value when updating an add\\-on though\\. For more information, see [UpdateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html)\\.\nIf you don't currently have the self\\-managed version of the add\\-on installed on your cluster, the Amazon EKS add\\-on is installed\\. Amazon EKS sets all values to default values, regardless of the option that you specify\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | OVERWRITE | PRESERVE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResolveConflicts", "type": "string" }, @@ -67992,7 +69489,9 @@ "type": "string" }, "OutpostConfig": { - "$ref": "#/definitions/AWS::EKS::Cluster.OutpostConfig" + "$ref": "#/definitions/AWS::EKS::Cluster.OutpostConfig", + "markdownDescription": "An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost\\. This object isn't available for clusters on the AWS cloud\\. \n*Required*: No \n*Type*: [OutpostConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-outpostconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OutpostConfig" }, "ResourcesVpcConfig": { "$ref": "#/definitions/AWS::EKS::Cluster.ResourcesVpcConfig", @@ -68013,7 +69512,7 @@ "type": "array" }, "Version": { - "markdownDescription": "The desired Kubernetes version for your cluster\\. If you don't specify a value here, the latest version available in Amazon EKS is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The desired Kubernetes version for your cluster\\. If you don't specify a value here, the default version available in Amazon EKS is used\\. \nThe default version might not be the latest version available\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -68063,6 +69562,8 @@ "additionalProperties": false, "properties": { "GroupName": { + "markdownDescription": "The name of the placement group for the Kubernetes control plane instances\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "GroupName", "type": "string" } }, @@ -68073,7 +69574,7 @@ "properties": { "Provider": { "$ref": "#/definitions/AWS::EKS::Cluster.Provider", - "markdownDescription": "The encryption provider for the cluster\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The encryption provider for the cluster\\. \n*Required*: No \n*Type*: [Provider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Provider" }, "Resources": { @@ -68091,12 +69592,12 @@ "additionalProperties": false, "properties": { "IpFamily": { - "markdownDescription": "Specify which IP family is used to assign Kubernetes pod and service IP addresses\\. If you don't specify a value, `ipv4` is used by default\\. You can only specify an IP family when you create a cluster and can't change this value once the cluster is created\\. If you specify `ipv6`, the VPC and subnets that you specify for cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them\\. You can't specify `ipv6` for clusters in China Regions\\. \nYou can only specify `ipv6` for 1\\.21 and later clusters that use version 1\\.10\\.1 or later of the Amazon VPC CNI add\\-on\\. If you specify `ipv6`, then ensure that your VPC meets the requirements listed in the considerations listed in [Assigning IPv6 addresses to pods and services](https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html) in the Amazon EKS User Guide\\. Kubernetes assigns services IPv6 addresses from the unique local address range \\(fc00::/7\\)\\. You can't specify a custom IPv6 CIDR block\\. Pod addresses are assigned from the subnet's IPv6 CIDR\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ipv4 | ipv6` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specify which IP family is used to assign Kubernetes pod and service IP addresses\\. If you don't specify a value, `ipv4` is used by default\\. You can only specify an IP family when you create a cluster and can't change this value once the cluster is created\\. If you specify `ipv6`, the VPC and subnets that you specify for cluster creation must have both `IPv4` and `IPv6` CIDR blocks assigned to them\\. You can't specify `ipv6` for clusters in China Regions\\. \nYou can only specify `ipv6` for `1.21` and later clusters that use version `1.10.1` or later of the Amazon VPC CNI add\\-on\\. If you specify `ipv6`, then ensure that your VPC meets the requirements listed in the considerations listed in [Assigning IPv6 addresses to pods and services](https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html) in the Amazon EKS User Guide\\. Kubernetes assigns services `IPv6` addresses from the unique local address range `(fc00::/7)`\\. You can't specify a custom `IPv6` CIDR block\\. Pod addresses are assigned from the subnet's `IPv6` CIDR\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ipv4 | ipv6` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IpFamily", "type": "string" }, "ServiceIpv4Cidr": { - "markdownDescription": "Don't specify a value if you select `ipv6` for **ipFamily**\\. The CIDR block to assign Kubernetes service IP addresses from\\. If you don't specify a block, Kubernetes assigns addresses from either the 10\\.100\\.0\\.0/16 or 172\\.20\\.0\\.0/16 CIDR blocks\\. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC\\. The block must meet the following requirements: \n+ Within one of the following private IP address blocks: 10\\.0\\.0\\.0/8, 172\\.16\\.0\\.0/12, or 192\\.168\\.0\\.0/16\\.\n+ Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC\\.\n+ Between /24 and /12\\.\nYou can only specify a custom CIDR block when you create a cluster and can't change this value once the cluster is created\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Don't specify a value if you select `ipv6` for **ipFamily**\\. The CIDR block to assign Kubernetes service IP addresses from\\. If you don't specify a block, Kubernetes assigns addresses from either the `10.100.0.0/16` or `172.20.0.0/16` CIDR blocks\\. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC\\. The block must meet the following requirements: \n+ Within one of the following private IP address blocks: `10.0.0.0/8`, `172.16.0.0/12`, or `192.168.0.0/16`\\.\n+ Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC\\.\n+ Between /24 and /12\\.\nYou can only specify a custom CIDR block when you create a cluster and can't change this value once the cluster is created\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ServiceIpv4Cidr", "type": "string" }, @@ -68134,15 +69635,21 @@ "additionalProperties": false, "properties": { "ControlPlaneInstanceType": { + "markdownDescription": "The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts\\. Choose an instance type based on the number of nodes that your cluster will have\\. For more information, see [Capacity considerations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the *Amazon EKS User Guide*\\. \nThe instance type that you specify is used for all Kubernetes control plane instances\\. The instance type can't be changed after cluster creation\\. The control plane is not automatically scaled by Amazon EKS\\. \n \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ControlPlaneInstanceType", "type": "string" }, "ControlPlanePlacement": { - "$ref": "#/definitions/AWS::EKS::Cluster.ControlPlanePlacement" + "$ref": "#/definitions/AWS::EKS::Cluster.ControlPlanePlacement", + "markdownDescription": "An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an AWS Outpost\\. For more information, see [Capacity considerations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: [ControlPlanePlacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-controlplaneplacement.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ControlPlanePlacement" }, "OutpostArns": { "items": { "type": "string" }, + "markdownDescription": "The ARN of the Outpost that you want to use for your local Amazon EKS cluster on Outposts\\. Only a single Outpost ARN is supported\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OutpostArns", "type": "array" } }, @@ -68156,6 +69663,8 @@ "additionalProperties": false, "properties": { "KeyArn": { + "markdownDescription": "Amazon Resource Name \\(ARN\\) or alias of the KMS key\\. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key\\. For more information, see [Allowing Users in Other Accounts to Use a KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html) in the * AWS Key Management Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KeyArn", "type": "string" } }, @@ -68186,7 +69695,7 @@ "items": { "type": "string" }, - "markdownDescription": "Specify one or more security groups for the cross\\-account elastic network interfaces that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes control plane\\. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes: \n+ 1\\.14 Amazon EKS platform version `eks.2` and earlier\n+ 1\\.14 Amazon EKS platform version `eks.3` and later \nFor more information, see [Amazon EKS security group considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the * *Amazon EKS User Guide* *\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specify one or more security groups for the cross\\-account elastic network interfaces that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes control plane\\. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes\\. For more information, see [Amazon EKS security group considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the * *Amazon EKS User Guide* *\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SecurityGroupIds", "type": "array" }, @@ -68396,7 +69905,7 @@ }, "Oidc": { "$ref": "#/definitions/AWS::EKS::IdentityProviderConfig.OidcIdentityProviderConfig", - "markdownDescription": "An object that represents an OpenID Connect \\(OIDC\\) identity provider configuration\\. \n*Required*: No \n*Type*: [OidcIdentityProviderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An object representing an OpenID Connect \\(OIDC\\) identity provider configuration\\. \n*Required*: No \n*Type*: [OidcIdentityProviderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Oidc" }, "Tags": { @@ -68544,7 +70053,7 @@ "additionalProperties": false, "properties": { "AmiType": { - "markdownDescription": "The AMI type for your node group\\. GPU instance types should use the `AL2_x86_64_GPU` AMI type\\. Non\\-GPU instances should use the `AL2_x86_64` AMI type\\. Arm instances should use the `AL2_ARM_64` AMI type\\. All types use the Amazon EKS optimized Amazon Linux 2 AMI\\. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `amiType`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AL2_ARM_64 | AL2_x86_64 | AL2_x86_64_GPU | BOTTLEROCKET_ARM_64 | BOTTLEROCKET_x86_64 | CUSTOM` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The AMI type for your node group\\. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `amiType`, or the node group deployment will fail\\. If your launch template uses a Windows custom AMI, then add `eks:kube-proxy-windows` to your Windows nodes `rolearn` in the `aws-auth` `ConfigMap`\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AL2_ARM_64 | AL2_x86_64 | AL2_x86_64_GPU | BOTTLEROCKET_ARM_64 | BOTTLEROCKET_ARM_64_NVIDIA | BOTTLEROCKET_x86_64 | BOTTLEROCKET_x86_64_NVIDIA | CUSTOM | WINDOWS_CORE_2019_x86_64 | WINDOWS_CORE_2022_x86_64 | WINDOWS_FULL_2019_x86_64 | WINDOWS_FULL_2022_x86_64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AmiType", "type": "string" }, @@ -68559,7 +70068,7 @@ "type": "string" }, "DiskSize": { - "markdownDescription": "The root device disk size \\(in GiB\\) for your node group instances\\. The default disk size is 20 GiB\\. If you specify `launchTemplate`, then don't specify `diskSize`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The root device disk size \\(in GiB\\) for your node group instances\\. The default disk size is 20 GiB for Linux and Bottlerocket\\. The default disk size is 50 GiB for Windows\\. If you specify `launchTemplate`, then don't specify `diskSize`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DiskSize", "type": "number" }, @@ -68572,13 +70081,13 @@ "items": { "type": "string" }, - "markdownDescription": "Specify the instance types for a node group\\. If you specify a GPU instance type, be sure to specify `AL2_x86_64_GPU` with the `amiType` parameter\\. If you specify `launchTemplate`, then you can specify zero or one instance type in your launch template *or* you can specify 0\\-20 instance types for `instanceTypes`\\. If however, you specify an instance type in your launch template *and* specify any `instanceTypes`, the node group deployment will fail\\. If you don't specify an instance type in a launch template or for `instanceTypes`, then `t3.medium` is used, by default\\. If you specify `Spot` for `capacityType`, then we recommend specifying multiple values for `instanceTypes`\\. For more information, see [Managed node group capacity types](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types) and [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specify the instance types for a node group\\. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the `amiType` parameter\\. If you specify `launchTemplate`, then you can specify zero or one instance type in your launch template *or* you can specify 0\\-20 instance types for `instanceTypes`\\. If however, you specify an instance type in your launch template *and* specify any `instanceTypes`, the node group deployment will fail\\. If you don't specify an instance type in a launch template or for `instanceTypes`, then `t3.medium` is used, by default\\. If you specify `Spot` for `capacityType`, then we recommend specifying multiple values for `instanceTypes`\\. For more information, see [Managed node group capacity types](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types) and [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceTypes", "type": "array" }, "Labels": { "additionalProperties": true, - "markdownDescription": "The Kubernetes labels to be applied to the nodes in the node group when they are created\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Kubernetes labels applied to the nodes in the node group\\. \nOnly labels that are applied with the Amazon EKS API are shown here\\. There may be other Kubernetes labels applied to the nodes in this group\\.\n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -68609,7 +70118,7 @@ }, "RemoteAccess": { "$ref": "#/definitions/AWS::EKS::Nodegroup.RemoteAccess", - "markdownDescription": "The remote access \\(SSH\\) configuration to use with your node group\\. If you specify `launchTemplate`, then don't specify `remoteAccess`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: [RemoteAccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The remote access configuration to use with your node group\\. For Linux, the protocol is SSH\\. For Windows, the protocol is RDP\\. If you specify `launchTemplate`, then don't specify `remoteAccess`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: [RemoteAccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RemoteAccess" }, "ScalingConfig": { @@ -68627,7 +70136,7 @@ }, "Tags": { "additionalProperties": true, - "markdownDescription": "The metadata to apply to the node group to assist with categorization and organization\\. Each tag consists of a key and an optional value\\. You define both\\. Node group tags don't propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets\\. \nUpdates to `Tags` can't be combined with updates to `ReleaseVersion`, `Version`, or `LaunchTemplate`\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The metadata applied to the node group to assist with categorization and organization\\. Each tag consists of a key and an optional value\\. You define both\\. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -68687,17 +70196,17 @@ "additionalProperties": false, "properties": { "Id": { - "markdownDescription": "The ID of the launch template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of the launch template\\. \nYou must specify either the launch template ID or the launch template name in the request, but not both\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Id", "type": "string" }, "Name": { - "markdownDescription": "The name of the launch template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the launch template\\. \nYou must specify either the launch template name or the launch template ID in the request, but not both\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Version": { - "markdownDescription": "The version of the launch template to use\\. If no version is specified, then the template's default version is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version number of the launch template to use\\. If no version is specified, then the template's default version is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -68708,7 +70217,7 @@ "additionalProperties": false, "properties": { "Ec2SshKey": { - "markdownDescription": "The Amazon EC2 SSH key that provides access for SSH communication with the nodes in the managed node group\\. For more information, see [Amazon EC2 key pairs and Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group\\. For more information, see [Amazon EC2 key pairs and Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*\\. For Windows, an Amazon EC2 SSH key is used to obtain the RDP password\\. For more information, see [Amazon EC2 key pairs and Windows instances](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html) in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Ec2SshKey", "type": "string" }, @@ -68716,7 +70225,7 @@ "items": { "type": "string" }, - "markdownDescription": "The security groups that are allowed SSH access \\(port 22\\) to the nodes\\. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the nodes is opened to the internet \\(0\\.0\\.0\\.0/0\\)\\. For more information, see [Security Groups for Your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The security group IDs that are allowed SSH access \\(port 22\\) to the nodes\\. For Windows, the port is 3389\\. If you specify an Amazon EC2 SSH key but don't specify a source security group when you create a managed node group, then the port on the nodes is opened to the internet \\(`0.0.0.0/0`\\)\\. For more information, see [Security Groups for Your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SourceSecurityGroups", "type": "array" } @@ -68838,7 +70347,9 @@ "type": "string" }, "AutoTerminationPolicy": { - "$ref": "#/definitions/AWS::EMR::Cluster.AutoTerminationPolicy" + "$ref": "#/definitions/AWS::EMR::Cluster.AutoTerminationPolicy", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AutoTerminationPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoterminationpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoTerminationPolicy" }, "BootstrapActions": { "items": { @@ -68902,6 +70413,8 @@ "type": "string" }, "OSReleaseLabel": { + "markdownDescription": "The Amazon Linux release specified in a cluster launch RunJobFlow request\\. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OSReleaseLabel", "type": "string" }, "ReleaseLabel": { @@ -69042,6 +70555,8 @@ "additionalProperties": false, "properties": { "IdleTimeout": { + "markdownDescription": "Specifies the amount of idle time in seconds after which the cluster automatically terminates\\. You can specify a minimum of 60 seconds and a maximum of 604800 seconds \\(seven days\\)\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IdleTimeout", "type": "number" } }, @@ -69198,11 +70713,11 @@ "properties": { "VolumeSpecification": { "$ref": "#/definitions/AWS::EMR::Cluster.VolumeSpecification", - "markdownDescription": "EBS volume specifications such as volume type, IOPS, and size \\(GiB\\) that will be requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "EBS volume specifications such as volume type, IOPS, size \\(GiB\\) and throughput \\(MiB/s\\) that are requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumeSpecification" }, "VolumesPerInstance": { - "markdownDescription": "Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumesPerInstance", "type": "number" } @@ -69310,7 +70825,7 @@ }, "SpotSpecification": { "$ref": "#/definitions/AWS::EMR::Cluster.SpotProvisioningSpecification", - "markdownDescription": "The launch specification for Spot Instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy\\. \n*Required*: No \n*Type*: [SpotProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy\\. \n*Required*: No \n*Type*: [SpotProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SpotSpecification" } }, @@ -69512,12 +71027,16 @@ "items": { "$ref": "#/definitions/AWS::EMR::Cluster.InstanceFleetConfig" }, + "markdownDescription": "Describes the EC2 instances and instance configurations for the task instance fleets when using clusters with the instance fleet configuration\\. These task instance fleets are added to the cluster as part of the cluster launch\\. Each task instance fleet must have a unique name specified so that CloudFormation can differentiate between the task instance fleets\\. \nYou can currently specify only one task instance fleet for a cluster\\. After creating the cluster, you can only modify the mutable properties of `InstanceFleetConfig`, which are `TargetOnDemandCapacity` and `TargetSpotCapacity`\\. Modifying any other property results in cluster replacement\\.\nTo allow a maximum of 30 Amazon EC2 instance types per fleet, include `TaskInstanceFleets` when you create your cluster\\. If you create your cluster without `TaskInstanceFleets`, Amazon EMR uses its default allocation strategy, which allows for a maximum of five Amazon EC2 instance types\\.\n*Required*: No \n*Type*: List of [InstanceFleetConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "TaskInstanceFleets", "type": "array" }, "TaskInstanceGroups": { "items": { "$ref": "#/definitions/AWS::EMR::Cluster.InstanceGroupConfig" }, + "markdownDescription": "Describes the EC2 instances and instance configurations for task instance groups when using clusters with the uniform instance group configuration\\. These task instance groups are added to the cluster as part of the cluster launch\\. Each task instance group must have a unique name specified so that CloudFormation can differentiate between the task instance groups\\. \nAfter creating the cluster, you can only modify the mutable properties of `InstanceGroupConfig`, which are `AutoScalingPolicy` and `InstanceCount`\\. Modifying any other property results in cluster replacement\\.\n*Required*: No \n*Type*: List of [InstanceGroupConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "TaskInstanceGroups", "type": "array" }, "TerminationProtected": { @@ -69787,7 +71306,7 @@ "type": "string" }, "TimeoutDurationMinutes": { - "markdownDescription": "The spot provisioning timeout period in minutes\\. If Spot Instances are not provisioned within this time period, the `TimeOutAction` is taken\\. Minimum value is 5 and maximum value is 1440\\. The timeout applies only during initial provisioning, when the cluster is first created\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Spot provisioning timeout period in minutes\\. If Spot Instances are not provisioned within this time period, the `TimeOutAction` is taken\\. Minimum value is 5 and maximum value is 1440\\. The timeout applies only during initial provisioning, when the cluster is first created\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutDurationMinutes", "type": "number" } @@ -69837,7 +71356,7 @@ "type": "number" }, "VolumeType": { - "markdownDescription": "The volume type\\. Volume types supported are gp2, io1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The volume type\\. Volume types supported are gp3, gp2, io1, st1, sc1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumeType", "type": "string" } @@ -69984,11 +71503,11 @@ "properties": { "VolumeSpecification": { "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig.VolumeSpecification", - "markdownDescription": "EBS volume specifications such as volume type, IOPS, and size \\(GiB\\) that will be requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "EBS volume specifications such as volume type, IOPS, size \\(GiB\\) and throughput \\(MiB/s\\) that are requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VolumeSpecification" }, "VolumesPerInstance": { - "markdownDescription": "Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VolumesPerInstance", "type": "number" } @@ -70027,7 +71546,7 @@ }, "SpotSpecification": { "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig.SpotProvisioningSpecification", - "markdownDescription": "The launch specification for Spot Instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy\\. \n*Required*: No \n*Type*: [SpotProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy\\. \n*Required*: No \n*Type*: [SpotProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SpotSpecification" } }, @@ -70113,7 +71632,7 @@ "type": "string" }, "TimeoutDurationMinutes": { - "markdownDescription": "The spot provisioning timeout period in minutes\\. If Spot Instances are not provisioned within this time period, the `TimeOutAction` is taken\\. Minimum value is 5 and maximum value is 1440\\. The timeout applies only during initial provisioning, when the cluster is first created\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Spot provisioning timeout period in minutes\\. If Spot Instances are not provisioned within this time period, the `TimeOutAction` is taken\\. Minimum value is 5 and maximum value is 1440\\. The timeout applies only during initial provisioning, when the cluster is first created\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutDurationMinutes", "type": "number" } @@ -70138,7 +71657,7 @@ "type": "number" }, "VolumeType": { - "markdownDescription": "The volume type\\. Volume types supported are gp2, io1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The volume type\\. Volume types supported are gp3, gp2, io1, st1, sc1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VolumeType", "type": "string" } @@ -70390,11 +71909,11 @@ "properties": { "VolumeSpecification": { "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.VolumeSpecification", - "markdownDescription": "EBS volume specifications such as volume type, IOPS, and size \\(GiB\\) that will be requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "EBS volume specifications such as volume type, IOPS, size \\(GiB\\) and throughput \\(MiB/s\\) that are requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumeSpecification" }, "VolumesPerInstance": { - "markdownDescription": "Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumesPerInstance", "type": "number" } @@ -70565,7 +72084,7 @@ "type": "number" }, "VolumeType": { - "markdownDescription": "The volume type\\. Volume types supported are gp2, io1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The volume type\\. Volume types supported are gp3, gp2, io1, st1, sc1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumeType", "type": "string" } @@ -70820,7 +72339,7 @@ "additionalProperties": false, "properties": { "AuthMode": { - "markdownDescription": "Specifies whether the Studio authenticates users using AWS SSO or IAM\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IAM | SSO` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies whether the Studio authenticates users using IAM Identity Center or IAM\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IAM | SSO` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AuthMode", "type": "string" }, @@ -70960,7 +72479,7 @@ "additionalProperties": false, "properties": { "IdentityName": { - "markdownDescription": "The name of the user or group\\. For more information, see [UserName](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) and [DisplayName](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) in the *AWS SSO Identity Store API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the user or group\\. For more information, see [UserName](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) and [DisplayName](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) in the *IAM Identity Center Identity Store API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IdentityName", "type": "string" }, @@ -71095,7 +72614,7 @@ "properties": { "EksInfo": { "$ref": "#/definitions/AWS::EMRContainers::VirtualCluster.EksInfo", - "markdownDescription": "The information about the EKS cluster\\. \n*Required*: Yes \n*Type*: [EksInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-eksinfo.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The information about the Amazon EKS cluster\\. \n*Required*: Yes \n*Type*: [EksInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-eksinfo.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EksInfo" } }, @@ -71118,7 +72637,7 @@ "title": "Info" }, "Type": { - "markdownDescription": "The type of the container provider\\. EKS is the only supported type as of now\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `EKS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of the container provider\\. Amazon EKS is the only supported type as of now\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `EKS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -71180,51 +72699,75 @@ "additionalProperties": false, "properties": { "Architecture": { + "markdownDescription": "The CPU architecture type of the application\\. Allowed values: `X86_64` or `ARM64` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Architecture", "type": "string" }, "AutoStartConfiguration": { - "$ref": "#/definitions/AWS::EMRServerless::Application.AutoStartConfiguration" + "$ref": "#/definitions/AWS::EMRServerless::Application.AutoStartConfiguration", + "markdownDescription": "The configuration for an application to automatically start on job submission\\. \n*Required*: No \n*Type*: [AutoStartConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostartconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoStartConfiguration" }, "AutoStopConfiguration": { - "$ref": "#/definitions/AWS::EMRServerless::Application.AutoStopConfiguration" + "$ref": "#/definitions/AWS::EMRServerless::Application.AutoStopConfiguration", + "markdownDescription": "The configuration for an application to automatically stop after a certain amount of time being idle\\. \n*Required*: No \n*Type*: [AutoStopConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostopconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoStopConfiguration" }, "ImageConfiguration": { - "$ref": "#/definitions/AWS::EMRServerless::Application.ImageConfigurationInput" + "$ref": "#/definitions/AWS::EMRServerless::Application.ImageConfigurationInput", + "markdownDescription": "The image configuration applied to all worker types\\. \n*Required*: No \n*Type*: [ImageConfigurationInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-imageconfigurationinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImageConfiguration" }, "InitialCapacity": { "items": { "$ref": "#/definitions/AWS::EMRServerless::Application.InitialCapacityConfigKeyValuePair" }, + "markdownDescription": "The initial capacity of the application\\. \n*Required*: No \n*Type*: List of [InitialCapacityConfigKeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfigkeyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InitialCapacity", "type": "array" }, "MaximumCapacity": { - "$ref": "#/definitions/AWS::EMRServerless::Application.MaximumAllowedResources" + "$ref": "#/definitions/AWS::EMRServerless::Application.MaximumAllowedResources", + "markdownDescription": "The maximum capacity of the application\\. This is cumulative across all workers at any given point in time during the lifespan of the application is created\\. No new resources will be created once any one of the defined limits is hit\\. \n*Required*: No \n*Type*: [MaximumAllowedResources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-maximumallowedresources.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumCapacity" }, "Name": { + "markdownDescription": "The name of the application\\. \n*Minimum*: 1 \n*Maximum*: 64 \n*Pattern*: `^[A-Za-z0-9._\\\\/#-]+$` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "NetworkConfiguration": { - "$ref": "#/definitions/AWS::EMRServerless::Application.NetworkConfiguration" + "$ref": "#/definitions/AWS::EMRServerless::Application.NetworkConfiguration", + "markdownDescription": "The network configuration for customer VPC connectivity for the application\\. \n*Required*: No \n*Type*: [NetworkConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-networkconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkConfiguration" }, "ReleaseLabel": { + "markdownDescription": "The EMR release version associated with the application\\. \n*Minimum*: 1 \n*Maximum*: 64 \n*Pattern*: `^[A-Za-z0-9._/-]+$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ReleaseLabel", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags assigned to the application\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "Type": { + "markdownDescription": "The type of application, such as Spark or Hive\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" }, "WorkerTypeSpecifications": { "additionalProperties": false, + "markdownDescription": "The specification applied to each worker type\\. \n*Required*: No \n*Type*: Map of [WorkerTypeSpecificationInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workertypespecificationinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::EMRServerless::Application.WorkerTypeSpecificationInput" } }, + "title": "WorkerTypeSpecifications", "type": "object" } }, @@ -71259,6 +72802,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Enables the application to automatically start on job submission\\. Defaults to true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" } }, @@ -71268,9 +72813,13 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Enables the application to automatically stop after a certain amount of time being idle\\. Defaults to true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "IdleTimeoutMinutes": { + "markdownDescription": "The amount of idle time in minutes after which your application will automatically stop\\. Defaults to 15 minutes\\. \n*Minimum*: 1 \n*Maximum*: 10080 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IdleTimeoutMinutes", "type": "number" } }, @@ -71280,6 +72829,8 @@ "additionalProperties": false, "properties": { "ImageUri": { + "markdownDescription": "The URI of an image in the Amazon ECR registry\\. This field is required when you create a new application\\. If you leave this field blank in an update, Amazon EMR will remove the image configuration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImageUri", "type": "string" } }, @@ -71289,9 +72840,13 @@ "additionalProperties": false, "properties": { "WorkerConfiguration": { - "$ref": "#/definitions/AWS::EMRServerless::Application.WorkerConfiguration" + "$ref": "#/definitions/AWS::EMRServerless::Application.WorkerConfiguration", + "markdownDescription": "The resource configuration of the initial capacity configuration\\. \n*Required*: Yes \n*Type*: [WorkerConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workerconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WorkerConfiguration" }, "WorkerCount": { + "markdownDescription": "The number of workers in the initial capacity configuration\\. \n*Minimum*: 1 \n*Maximum*: 1000000 \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WorkerCount", "type": "number" } }, @@ -71305,10 +72860,14 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The worker type for an analytics framework\\. For Spark applications, the key can either be set to `Driver` or `Executor`\\. For Hive applications, it can be set to `HiveDriver` or `TezTask`\\. \n*Minimum*: 1 \n*Maximum*: 50 \n*Pattern*: `^[a-zA-Z]+[-_]*[a-zA-Z]+$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { - "$ref": "#/definitions/AWS::EMRServerless::Application.InitialCapacityConfig" + "$ref": "#/definitions/AWS::EMRServerless::Application.InitialCapacityConfig", + "markdownDescription": "The value for the initial capacity configuration per worker\\. \n*Required*: Yes \n*Type*: [InitialCapacityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value" } }, "required": [ @@ -71321,12 +72880,18 @@ "additionalProperties": false, "properties": { "Cpu": { + "markdownDescription": "The maximum allowed CPU for an application\\. \n*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(vCPU|vcpu|VCPU)?$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cpu", "type": "string" }, "Disk": { + "markdownDescription": "The maximum allowed disk for an application\\. \n*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(GB|gb|gB|Gb)$\"` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Disk", "type": "string" }, "Memory": { + "markdownDescription": "The maximum allowed resources for an application\\. \n*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(GB|gb|gB|Gb)?$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Memory", "type": "string" } }, @@ -71343,12 +72908,16 @@ "items": { "type": "string" }, + "markdownDescription": "The array of security group Ids for customer VPC connectivity\\. \n*Minimum*: 1 \n*Maximum*: 32 \n*Pattern*: `^[-0-9a-zA-Z]+` \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroupIds", "type": "array" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "The array of subnet Ids for customer VPC connectivity\\. \n*Minimum*: 1 \n*Maximum*: 32 \n*Pattern*: `^[-0-9a-zA-Z]+` \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetIds", "type": "array" } }, @@ -71358,12 +72927,18 @@ "additionalProperties": false, "properties": { "Cpu": { + "markdownDescription": "*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(vCPU|vcpu|VCPU)?$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cpu", "type": "string" }, "Disk": { + "markdownDescription": "*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(GB|gb|gB|Gb)$\"` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Disk", "type": "string" }, "Memory": { + "markdownDescription": "*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(GB|gb|gB|Gb)?$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Memory", "type": "string" } }, @@ -71377,7 +72952,9 @@ "additionalProperties": false, "properties": { "ImageConfiguration": { - "$ref": "#/definitions/AWS::EMRServerless::Application.ImageConfigurationInput" + "$ref": "#/definitions/AWS::EMRServerless::Application.ImageConfigurationInput", + "markdownDescription": "The image configuration for a worker type\\. \n*Required*: No \n*Type*: [ImageConfigurationInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-imageconfigurationinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImageConfiguration" } }, "type": "object" @@ -71466,6 +73043,8 @@ "type": "string" }, "IpDiscovery": { + "markdownDescription": "The network type you choose when modifying a cluster, either `ipv4` \\| `ipv6`\\. IPv6 is supported for workloads using Redis engine version 6\\.2 onward or Memcached engine version 1\\.6\\.6 on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ipv4 | ipv6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IpDiscovery", "type": "string" }, "LogDeliveryConfigurations": { @@ -71477,6 +73056,8 @@ "type": "array" }, "NetworkType": { + "markdownDescription": "Must be either `ipv4` \\| `ipv6` \\| `dual_stack`\\. IPv6 is supported for workloads using Redis engine version 6\\.2 onward or Memcached engine version 1\\.6\\.6 on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `dual_stack | ipv4 | ipv6` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NetworkType", "type": "string" }, "NotificationTopicArn": { @@ -71544,6 +73125,8 @@ "type": "array" }, "TransitEncryptionEnabled": { + "markdownDescription": "A flag that enables in\\-transit encryption when set to true\\. \n Only available when creating a cache cluster in an Amazon VPC using Memcached version 1\\.6\\.12 or later\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TransitEncryptionEnabled", "type": "boolean" }, "VpcSecurityGroupIds": { @@ -71741,7 +73324,7 @@ "items": { "$ref": "#/definitions/AWS::ElastiCache::GlobalReplicationGroup.RegionalConfiguration" }, - "markdownDescription": "The Amazon Regions that comprise the Global Datastore\\. \n*Required*: No \n*Type*: List of [RegionalConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Regions that comprise the Global Datastore\\. \n*Required*: No \n*Type*: List of [RegionalConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RegionalConfigurations", "type": "array" } @@ -71872,7 +73455,7 @@ "additionalProperties": false, "properties": { "CacheParameterGroupFamily": { - "markdownDescription": "The name of the cache parameter group family that this cache parameter group is compatible with\\. \nValid values are: `memcached1.4` \\| `memcached1.5` \\| `memcached1.6` \\| `redis2.6` \\| `redis2.8` \\| `redis3.2` \\| `redis4.0` \\| `redis5.0` \\| `redis6.x` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the cache parameter group family that this cache parameter group is compatible with\\. \nValid values are: `memcached1.4` \\| `memcached1.5` \\| `memcached1.6` \\| `redis2.6` \\| `redis2.8` \\| `redis3.2` \\| `redis4.0` \\| `redis5.0` \\| `redis6.x` \\| `redis7` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CacheParameterGroupFamily", "type": "string" }, @@ -71969,7 +73552,7 @@ "type": "boolean" }, "AuthToken": { - "markdownDescription": "**Reserved parameter\\.** The password used to access a password protected server\\. \n `AuthToken` can be specified only on replication groups where `TransitEncryptionEnabled` is `true`\\. For more information, see [Authenticating Users with the Redis AUTH Command](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html)\\. \nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`\\.\nPassword constraints: \n+ Must be only printable ASCII characters\\.\n+ Must be at least 16 characters and no more than 128 characters in length\\.\n+ Nonalphanumeric characters are restricted to \\(\\!, &, \\#, $, ^, <, >, \\-, \\)\\. \nFor more information, see [AUTH password](http://redis.io/commands/AUTH) at http://redis\\.io/commands/AUTH\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "**Reserved parameter\\.** The password used to access a password protected server\\. \n `AuthToken` can be specified only on replication groups where `TransitEncryptionEnabled` is `true`\\. For more information, see [Authenticating Users with the Redis AUTH Command](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html)\\. \nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`\\.\nPassword constraints: \n+ Must be only printable ASCII characters\\.\n+ Must be at least 16 characters and no more than 128 characters in length\\.\n+ Nonalphanumeric characters are restricted to \\(\\!, &, \\#, $, ^, <, >, \\-, \\)\\. \nFor more information, see [AUTH password](http://redis.io/commands/AUTH) at http://redis\\.io/commands/AUTH\\. \nIf ADDING the AuthToken, update requires [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "AuthToken", "type": "string" }, @@ -72012,7 +73595,7 @@ "type": "boolean" }, "Engine": { - "markdownDescription": "The name of the cache engine to be used for the clusters in this replication group\\. Must be Redis\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the cache engine to be used for the clusters in this replication group\\. The value must be set to `Redis`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Engine", "type": "string" }, @@ -72027,6 +73610,8 @@ "type": "string" }, "IpDiscovery": { + "markdownDescription": "The network type you choose when creating a replication group, either `ipv4` \\| `ipv6`\\. IPv6 is supported for workloads using Redis engine version 6\\.2 onward or Memcached engine version 1\\.6\\.6 on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ipv4 | ipv6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IpDiscovery", "type": "string" }, "KmsKeyId": { @@ -72048,6 +73633,8 @@ "type": "boolean" }, "NetworkType": { + "markdownDescription": "Must be either `ipv4` \\| `ipv6` \\| `dual_stack`\\. IPv6 is supported for workloads using Redis engine version 6\\.2 onward or Memcached engine version 1\\.6\\.6 on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `dual_stack | ipv4 | ipv6` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NetworkType", "type": "string" }, "NodeGroupConfiguration": { @@ -72156,18 +73743,20 @@ "type": "array" }, "TransitEncryptionEnabled": { - "markdownDescription": "A flag that enables in\\-transit encryption when set to `true`\\. \nYou cannot modify the value of `TransitEncryptionEnabled` after the cluster is created\\. To enable in\\-transit encryption on a cluster you must set `TransitEncryptionEnabled` to `true` when you create a cluster\\. \nThis parameter is valid only if the `Engine` parameter is `redis`, the `EngineVersion` parameter is `3.2.6` or `4.x` onward, and the cluster is being created in an Amazon VPC\\. \nIf you enable in\\-transit encryption, you must also specify a value for `CacheSubnetGroup`\\. \n **Required:** Only available when creating a replication group in an Amazon VPC using redis version `3.2.6` or `4.x` onward\\. \nDefault: `false` \nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A flag that enables in\\-transit encryption when set to `true`\\. \nYou cannot modify the value of `TransitEncryptionEnabled` after the cluster is created\\. To enable in\\-transit encryption on a cluster you must set `TransitEncryptionEnabled` to `true` when you create a cluster\\. \nThis parameter is valid only if the `Engine` parameter is `redis`, the `EngineVersion` parameter is `3.2.6` or `4.x` onward, and the cluster is being created in an Amazon VPC\\. \nIf you enable in\\-transit encryption, you must also specify a value for `CacheSubnetGroup`\\. \n **Required:** Only available when creating a replication group in an Amazon VPC using redis version `3.2.6` or `4.x` onward\\. \nDefault: `false` \nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TransitEncryptionEnabled", "type": "boolean" }, "TransitEncryptionMode": { + "markdownDescription": "A setting that allows you to migrate your clients to use in\\-transit encryption, with no downtime\\. \nWhen setting `TransitEncryptionEnabled` to `true`, you can set your `TransitEncryptionMode` to `preferred` in the same request, to allow both encrypted and unencrypted connections at the same time\\. Once you migrate all your Redis clients to use encrypted connections you can modify the value to `required` to allow encrypted connections only\\. \nSetting `TransitEncryptionMode` to `required` is a two\\-step process that requires you to first set the `TransitEncryptionMode` to `preferred`, after that you can set `TransitEncryptionMode` to `required`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `preferred | required` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TransitEncryptionMode", "type": "string" }, "UserGroupIds": { "items": { "type": "string" }, - "markdownDescription": "The list of user groups to associate with the replication group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of user group to associate with the replication group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UserGroupIds", "type": "array" } @@ -72591,7 +74180,9 @@ "type": "string" }, "AuthenticationMode": { - "$ref": "#/definitions/AWS::ElastiCache::User.AuthenticationMode" + "$ref": "#/definitions/AWS::ElastiCache::User.AuthenticationMode", + "markdownDescription": "Specifies the authentication mode to use\\. Below is an example of the possible JSON values:", + "title": "AuthenticationMode" }, "Engine": { "markdownDescription": "The current supported value is redis\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[a-zA-Z]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -72657,9 +74248,13 @@ "items": { "type": "string" }, + "markdownDescription": "Specifies the passwords to use for authentication if `Type` is set to `password`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Passwords", "type": "array" }, "Type": { + "markdownDescription": "Specifies the authentication type\\. Possible options are IAM authentication, password and no password\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `iam | no-password-required | password` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -72943,7 +74538,7 @@ }, "SourceBundle": { "$ref": "#/definitions/AWS::ElasticBeanstalk::ApplicationVersion.SourceBundle", - "markdownDescription": "The Amazon S3 bucket and key that identify the location of the source bundle for this version\\. \nThe Amazon S3 bucket must be in the same region as the environment\\.\n*Required*: Yes \n*Type*: [SourceBundle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-sourcebundle.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon S3 bucket and key that identify the location of the source bundle for this version\\. \nThe Amazon S3 bucket must be in the same region as the environment\\.\n*Required*: Yes \n*Type*: [SourceBundle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-sourcebundle.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SourceBundle" } }, @@ -73956,7 +75551,7 @@ "type": "string" }, "ClientSecret": { - "markdownDescription": "The OAuth 2\\.0 client secret\\. This parameter is required if you are creating a rule\\. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The OAuth 2\\.0 client secret\\. This parameter is required if you are creating a rule\\. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientSecret", "type": "string" }, @@ -73991,6 +75586,8 @@ "type": "string" }, "UseExistingClientSecret": { + "markdownDescription": "Indicates whether to use the existing client secret when modifying a rule\\. If you are creating a rule, you can omit this parameter or set it to false\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseExistingClientSecret", "type": "boolean" }, "UserInfoEndpoint": { @@ -74172,7 +75769,7 @@ "items": { "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerCertificate.Certificate" }, - "markdownDescription": "The certificate\\. You can specify one certificate per resource\\. \n*Required*: Yes \n*Type*: List of [Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The certificate\\. You can specify one certificate per resource\\. \n*Required*: Yes \n*Type*: List of [Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Certificates", "type": "array" }, @@ -74442,7 +76039,7 @@ "type": "string" }, "ClientSecret": { - "markdownDescription": "The OAuth 2\\.0 client secret\\. This parameter is required if you are creating a rule\\. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The OAuth 2\\.0 client secret\\. This parameter is required if you are creating a rule\\. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientSecret", "type": "string" }, @@ -74546,7 +76143,7 @@ "items": { "type": "string" }, - "markdownDescription": "One or more host names\\. The maximum size of each name is 128 characters\\. The comparison is case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf you specify multiple strings, the condition is satisfied if one of the strings matches the host name\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The host names\\. The maximum size of each name is 128 characters\\. The comparison is case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf you specify multiple strings, the condition is satisfied if one of the strings matches the host name\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -74565,7 +76162,7 @@ "items": { "type": "string" }, - "markdownDescription": "One or more strings to compare against the value of the HTTP header\\. The maximum size of each string is 128 characters\\. The comparison strings are case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf the same header appears multiple times in the request, we search them in order until a match is found\\. \nIf you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header\\. To require that all of the strings are a match, create one condition per string\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The strings to compare against the value of the HTTP header\\. The maximum size of each string is 128 characters\\. The comparison strings are case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf the same header appears multiple times in the request, we search them in order until a match is found\\. \nIf you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header\\. To require that all of the strings are a match, create one condition per string\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -74593,7 +76190,7 @@ "items": { "type": "string" }, - "markdownDescription": "One or more path patterns to compare against the request URL\\. The maximum size of each string is 128 characters\\. The comparison is case sensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf you specify multiple strings, the condition is satisfied if one of them matches the request URL\\. The path pattern is compared only to the path of the URL, not to its query string\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The path patterns to compare against the request URL\\. The maximum size of each string is 128 characters\\. The comparison is case sensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf you specify multiple strings, the condition is satisfied if one of them matches the request URL\\. The path pattern is compared only to the path of the URL, not to its query string\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -74607,7 +76204,7 @@ "items": { "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringKeyValue" }, - "markdownDescription": "One or more key/value pairs or values to find in the query string\\. The maximum size of each string is 128 characters\\. The comparison is case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. To search for a literal '\\*' or '?' character in a query string, you must escape these characters in `Values` using a '\\\\' character\\. \nIf you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string\\. \n*Required*: No \n*Type*: List of [QueryStringKeyValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key/value pairs or values to find in the query string\\. The maximum size of each string is 128 characters\\. The comparison is case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. To search for a literal '\\*' or '?' character in a query string, you must escape these characters in `Values` using a '\\\\' character\\. \nIf you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string\\. \n*Required*: No \n*Type*: List of [QueryStringKeyValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -74725,7 +76322,7 @@ "items": { "type": "string" }, - "markdownDescription": "One or more source IP addresses, in CIDR format\\. You can use both IPv4 and IPv6 addresses\\. Wildcards are not supported\\. \nIf you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks\\. This condition is not satisfied by the addresses in the X\\-Forwarded\\-For header\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The source IP addresses, in CIDR format\\. You can use both IPv4 and IPv6 addresses\\. Wildcards are not supported\\. \nIf you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks\\. This condition is not satisfied by the addresses in the X\\-Forwarded\\-For header\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -74886,7 +76483,7 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The name of the attribute\\. \nThe following attribute is supported by all load balancers: \n+ `deletion_protection.enabled` \\- Indicates whether deletion protection is enabled\\. The value is `true` or `false`\\. The default is `false`\\.\nThe following attributes are supported by both Application Load Balancers and Network Load Balancers: \n+ `access_logs.s3.enabled` \\- Indicates whether access logs are enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `access_logs.s3.bucket` \\- The name of the S3 bucket for the access logs\\. This attribute is required if access logs are enabled\\. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket\\.\n+ `access_logs.s3.prefix` \\- The prefix for the location in the S3 bucket for the access logs\\.\n+ `ipv6.deny_all_igw_traffic` \\- Blocks internet gateway \\(IGW\\) access to the load balancer\\. It is set to `false` for internet\\-facing load balancers and `true` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway\\.\nThe following attributes are supported by only Application Load Balancers: \n+ `idle_timeout.timeout_seconds` \\- The idle timeout value, in seconds\\. The valid range is 1\\-4000 seconds\\. The default is 60 seconds\\.\n+ `routing.http.desync_mitigation_mode` \\- Determines how the load balancer handles requests that might pose a security risk to your application\\. The possible values are `monitor`, `defensive`, and `strictest`\\. The default is `defensive`\\.\n+ `routing.http.drop_invalid_header_fields.enabled` \\- Indicates whether HTTP headers with invalid header fields are removed by the load balancer \\(`true`\\) or routed to targets \\(`false`\\)\\. The default is `false`\\.\n+ `routing.http.x_amzn_tls_version_and_cipher_suite.enabled` \\- Indicates whether the two headers \\(`x-amzn-tls-version` and `x-amzn-tls-cipher-suite`\\), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target\\. The `x-amzn-tls-version` header has information about the TLS protocol version negotiated with the client, and the `x-amzn-tls-cipher-suite` header has information about the cipher suite negotiated with the client\\. Both headers are in OpenSSL format\\. The possible values for the attribute are `true` and `false`\\. The default is `false`\\.\n+ `routing.http.xff_client_port.enabled` \\- Indicates whether the `X-Forwarded-For` header should preserve the source port that the client used to connect to the load balancer\\. The possible values are `true` and `false`\\. The default is `false`\\.\n+ `routing.http2.enabled` \\- Indicates whether HTTP/2 is enabled\\. The possible values are `true` and `false`\\. The default is `true`\\. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens\\.\n+ `waf.fail_open.enabled` \\- Indicates whether to allow a WAF\\-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF\\. The possible values are `true` and `false`\\. The default is `false`\\.\nThe following attribute is supported by Network Load Balancers and Gateway Load Balancers: \n+ `load_balancing.cross_zone.enabled` \\- Indicates whether cross\\-zone load balancing is enabled\\. The possible values are `true` and `false`\\. The default is `false`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the attribute\\. \nThe following attributes are supported by all load balancers: \n+ `deletion_protection.enabled` \\- Indicates whether deletion protection is enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `load_balancing.cross_zone.enabled` \\- Indicates whether cross\\-zone load balancing is enabled\\. The possible values are `true` and `false`\\. The default for Network Load Balancers and Gateway Load Balancers is `false`\\. The default for Application Load Balancers is `true`, and cannot be changed\\.\nThe following attributes are supported by both Application Load Balancers and Network Load Balancers: \n+ `access_logs.s3.enabled` \\- Indicates whether access logs are enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `access_logs.s3.bucket` \\- The name of the S3 bucket for the access logs\\. This attribute is required if access logs are enabled\\. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket\\.\n+ `access_logs.s3.prefix` \\- The prefix for the location in the S3 bucket for the access logs\\.\n+ `ipv6.deny_all_igw_traffic` \\- Blocks internet gateway \\(IGW\\) access to the load balancer\\. It is set to `false` for internet\\-facing load balancers and `true` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway\\.\nThe following attributes are supported by only Application Load Balancers: \n+ `idle_timeout.timeout_seconds` \\- The idle timeout value, in seconds\\. The valid range is 1\\-4000 seconds\\. The default is 60 seconds\\.\n+ `routing.http.desync_mitigation_mode` \\- Determines how the load balancer handles requests that might pose a security risk to your application\\. The possible values are `monitor`, `defensive`, and `strictest`\\. The default is `defensive`\\.\n+ `routing.http.drop_invalid_header_fields.enabled` \\- Indicates whether HTTP headers with invalid header fields are removed by the load balancer \\(`true`\\) or routed to targets \\(`false`\\)\\. The default is `false`\\.\n+ `routing.http.preserve_host_header.enabled` \\- Indicates whether the Application Load Balancer should preserve the `Host` header in the HTTP request and send it to the target without any change\\. The possible values are `true` and `false`\\. The default is `false`\\.\n+ `routing.http.x_amzn_tls_version_and_cipher_suite.enabled` \\- Indicates whether the two headers \\(`x-amzn-tls-version` and `x-amzn-tls-cipher-suite`\\), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target\\. The `x-amzn-tls-version` header has information about the TLS protocol version negotiated with the client, and the `x-amzn-tls-cipher-suite` header has information about the cipher suite negotiated with the client\\. Both headers are in OpenSSL format\\. The possible values for the attribute are `true` and `false`\\. The default is `false`\\.\n+ `routing.http.xff_client_port.enabled` \\- Indicates whether the `X-Forwarded-For` header should preserve the source port that the client used to connect to the load balancer\\. The possible values are `true` and `false`\\. The default is `false`\\.\n+ `routing.http.xff_header_processing.mode` \\- Enables you to modify, preserve, or remove the `X-Forwarded-For` header in the HTTP request before the Application Load Balancer sends the request to the target\\. The possible values are `append`, `preserve`, and `remove`\\. The default is `append`\\.\n + If the value is `append`, the Application Load Balancer adds the client IP address \\(of the last hop\\) to the `X-Forwarded-For` header in the HTTP request before it sends it to targets\\.\n + If the value is `preserve` the Application Load Balancer preserves the `X-Forwarded-For` header in the HTTP request, and sends it to targets without any change\\.\n + If the value is `remove`, the Application Load Balancer removes the `X-Forwarded-For` header in the HTTP request before it sends it to targets\\.\n+ `routing.http2.enabled` \\- Indicates whether HTTP/2 is enabled\\. The possible values are `true` and `false`\\. The default is `true`\\. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens\\.\n+ `waf.fail_open.enabled` \\- Indicates whether to allow a WAF\\-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF\\. The possible values are `true` and `false`\\. The default is `false`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, @@ -74968,7 +76565,7 @@ "type": "boolean" }, "HealthCheckIntervalSeconds": { - "markdownDescription": "The approximate amount of time, in seconds, between health checks of an individual target\\. If the target group protocol is HTTP or HTTPS, the default is 30 seconds\\. If the target group protocol is TCP, TLS, UDP, or TCP\\_UDP, the supported values are 10 and 30 seconds and the default is 30 seconds\\. If the target group protocol is GENEVE, the default is 10 seconds\\. If the target type is `lambda`, the default is 35 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `5` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The approximate amount of time, in seconds, between health checks of an individual target\\. The range is 5\\-300\\. If the target group protocol is TCP, TLS, UDP, TCP\\_UDP, HTTP or HTTPS, the default is 30 seconds\\. If the target group protocol is GENEVE, the default is 10 seconds\\. If the target type is `lambda`, the default is 35 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `5` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HealthCheckIntervalSeconds", "type": "number" }, @@ -74988,12 +76585,12 @@ "type": "string" }, "HealthCheckTimeoutSeconds": { - "markdownDescription": "The amount of time, in seconds, during which no response from a target means a failed health check\\. For target groups with a protocol of HTTP, HTTPS, or GENEVE, the default is 5 seconds\\. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks\\. If the target type is `lambda`, the default is 30 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `120` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of time, in seconds, during which no response from a target means a failed health check\\. The range is 2\u2013120 seconds\\. For target groups with a protocol of HTTP, the default is 6 seconds\\. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds\\. For target groups with a protocol of GENEVE, the default is 5 seconds\\. If the target type is `lambda`, the default is 30 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `120` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HealthCheckTimeoutSeconds", "type": "number" }, "HealthyThresholdCount": { - "markdownDescription": "The number of consecutive health checks successes required before considering an unhealthy target healthy\\. For target groups with a protocol of HTTP or HTTPS, the default is 5\\. For target groups with a protocol of TCP, TLS, or GENEVE, the default is 3\\. If the target type is `lambda`, the default is 5\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of consecutive health check successes required before considering a target healthy\\. The range is 2\\-10\\. If the target group protocol is TCP, TCP\\_UDP, UDP, TLS, HTTP or HTTPS, the default is 5\\. For target groups with a protocol of GENEVE, the default is 5\\. If the target type is `lambda`, the default is 5\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HealthyThresholdCount", "type": "number" }, @@ -75004,7 +76601,7 @@ }, "Matcher": { "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::TargetGroup.Matcher", - "markdownDescription": "\\[HTTP/HTTPS health checks\\] The HTTP or gRPC codes to use when checking for a successful response from a target\\. \n*Required*: No \n*Type*: [Matcher](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "\\[HTTP/HTTPS health checks\\] The HTTP or gRPC codes to use when checking for a successful response from a target\\. For target groups with a protocol of TCP, TCP\\_UDP, UDP or TLS the range is 200\\-599\\. For target groups with a protocol of HTTP or HTTPS, the range is 200\\-499\\. For target groups with a protocol of GENEVE, the range is 200\\-399\\. \n*Required*: No \n*Type*: [Matcher](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Matcher" }, "Name": { @@ -75057,7 +76654,7 @@ "type": "array" }, "UnhealthyThresholdCount": { - "markdownDescription": "The number of consecutive health check failures required before considering a target unhealthy\\. If the target group protocol is HTTP or HTTPS, the default is 2\\. If the target group protocol is TCP or TLS, this value must be the same as the healthy threshold count\\. If the target group protocol is GENEVE, the default is 3\\. If the target type is `lambda`, the default is 2\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of consecutive health check failures required before considering a target unhealthy\\. The range is 2\\-10\\. If the target group protocol is TCP, TCP\\_UDP, UDP, TLS, HTTP or HTTPS, the default is 2\\. For target groups with a protocol of GENEVE, the default is 2\\. If the target type is `lambda`, the default is 5\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UnhealthyThresholdCount", "type": "number" }, @@ -75098,7 +76695,7 @@ "type": "string" }, "HttpCode": { - "markdownDescription": "For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200\\. You can specify multiple values \\(for example, \"200,202\"\\) or a range of values \\(for example, \"200\\-299\"\\)\\. \nFor Network Load Balancers and Gateway Load Balancers, this must be \"200\u2013399\"\\. \nNote that when using shorthand syntax, some values such as commas need to be escaped\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200\\. You can specify multiple values \\(for example, \"200,202\"\\) or a range of values \\(for example, \"200\\-299\"\\)\\. \nFor Network Load Balancers, you can specify values between 200 and 599, with the default value being 200\\-399\\. You can specify multiple values \\(for example, \"200,202\"\\) or a range of values \\(for example, \"200\\-299\"\\)\\. \nFor Gateway Load Balancers, this must be \"200\u2013399\"\\. \nNote that when using shorthand syntax, some values such as commas need to be escaped\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HttpCode", "type": "string" } @@ -75109,7 +76706,7 @@ "additionalProperties": false, "properties": { "AvailabilityZone": { - "markdownDescription": "An Availability Zone or `all`\\. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer\\. \nThis parameter is not supported if the target type of the target group is `instance` or `alb`\\. \nIf the target type is `ip` and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional\\. If the IP address is outside the VPC, this parameter is required\\. \nWith an Application Load Balancer, if the target type is `ip` and the IP address is outside the VPC for the target group, the only supported value is `all`\\. \nIf the target type is `lambda`, this parameter is optional and the only supported value is `all`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An Availability Zone or `all`\\. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer\\. \nFor Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross\\-zone load balancing is off\\. Otherwise the parameter is ignored and treated as `all`\\. \nThis parameter is not supported if the target type of the target group is `instance` or `alb`\\. \nIf the target type is `ip` and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional\\. If the IP address is outside the VPC, this parameter is required\\. \nFor Application Load Balancer target groups with cross\\-zone load balancing off, if the target type is `ip` and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group\\. \nIf the target type is `lambda`, this parameter is optional and the only supported value is `all`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AvailabilityZone", "type": "string" }, @@ -75133,7 +76730,7 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The name of the attribute\\. \nThe following attribute is supported by all load balancers: \n+ `deregistration_delay.timeout_seconds` \\- The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from `draining` to `unused`\\. The range is 0\\-3600 seconds\\. The default value is 300 seconds\\. If the target is a Lambda function, this attribute is not supported\\.\nThe following attributes are supported by both Application Load Balancers and Network Load Balancers: \n+ `stickiness.enabled` \\- Indicates whether sticky sessions are enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `stickiness.type` \\- The type of sticky sessions\\. The possible values are `lb_cookie` and `app_cookie` for Application Load Balancers or `source_ip` for Network Load Balancers\\.\nThe following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address: \n+ `load_balancing.algorithm.type` \\- The load balancing algorithm determines how the load balancer selects targets when routing requests\\. The value is `round_robin` or `least_outstanding_requests`\\. The default is `round_robin`\\.\n+ `slow_start.duration_seconds` \\- The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group\\. After this time period ends, the target receives its full share of traffic\\. The range is 30\\-900 seconds \\(15 minutes\\)\\. The default is 0 seconds \\(disabled\\)\\.\n+ `stickiness.app_cookie.cookie_name` \\- Indicates the name of the application\\-based cookie\\. Names that start with the following prefixes are not allowed: `AWSALB`, `AWSALBAPP`, and `AWSALBTG`; they're reserved for use by the load balancer\\.\n+ `stickiness.app_cookie.duration_seconds` \\- The time period, in seconds, during which requests from a client should be routed to the same target\\. After this time period expires, the application\\-based cookie is considered stale\\. The range is 1 second to 1 week \\(604800 seconds\\)\\. The default value is 1 day \\(86400 seconds\\)\\.\n+ `stickiness.lb_cookie.duration_seconds` \\- The time period, in seconds, during which requests from a client should be routed to the same target\\. After this time period expires, the load balancer\\-generated cookie is considered stale\\. The range is 1 second to 1 week \\(604800 seconds\\)\\. The default value is 1 day \\(86400 seconds\\)\\.\nThe following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function: \n+ `lambda.multi_value_headers.enabled` \\- Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings\\. The value is `true` or `false`\\. The default is `false`\\. If the value is `false` and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client\\.\nThe following attributes are supported only by Network Load Balancers: \n+ `deregistration_delay.connection_termination.enabled` \\- Indicates whether the load balancer terminates connections at the end of the deregistration timeout\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `preserve_client_ip.enabled` \\- Indicates whether client IP preservation is enabled\\. The value is `true` or `false`\\. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS\\. Otherwise, the default is enabled\\. Client IP preservation cannot be disabled for UDP and TCP\\_UDP target groups\\.\n+ `proxy_protocol_v2.enabled` \\- Indicates whether Proxy Protocol version 2 is enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the attribute\\. \nThe following attributes are supported by all load balancers: \n+ `deregistration_delay.timeout_seconds` \\- The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from `draining` to `unused`\\. The range is 0\\-3600 seconds\\. The default value is 300 seconds\\. If the target is a Lambda function, this attribute is not supported\\.\n+ `stickiness.enabled` \\- Indicates whether target stickiness is enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `stickiness.type` \\- Indicates the type of stickiness\\. The possible values are:\n + `lb_cookie` and `app_cookie` for Application Load Balancers\\.\n + `source_ip` for Network Load Balancers\\.\n + `source_ip_dest_ip` and `source_ip_dest_ip_proto` for Gateway Load Balancers\\.\nThe following attributes are supported by Application Load Balancers and Network Load Balancers: \n+ `load_balancing.cross_zone.enabled` \\- Indicates whether cross zone load balancing is enabled\\. The value is `true`, `false` or `use_load_balancer_configuration`\\. The default is `use_load_balancer_configuration`\\.\n+ `target_group_health.dns_failover.minimum_healthy_targets.count` \\- The minimum number of targets that must be healthy\\. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones\\. The possible values are `off` or an integer from 1 to the maximum number of targets\\. The default is `off`\\.\n+ `target_group_health.dns_failover.minimum_healthy_targets.percentage` \\- The minimum percentage of targets that must be healthy\\. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones\\. The possible values are `off` or an integer from 1 to 100\\. The default is `off`\\.\n+ `target_group_health.unhealthy_state_routing.minimum_healthy_targets.count` \\- The minimum number of targets that must be healthy\\. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets\\. The possible values are 1 to the maximum number of targets\\. The default is 1\\.\n+ `target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage` \\- The minimum percentage of targets that must be healthy\\. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets\\. The possible values are `off` or an integer from 1 to 100\\. The default is `off`\\.\nThe following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address: \n+ `load_balancing.algorithm.type` \\- The load balancing algorithm determines how the load balancer selects targets when routing requests\\. The value is `round_robin` or `least_outstanding_requests`\\. The default is `round_robin`\\.\n+ `slow_start.duration_seconds` \\- The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group\\. After this time period ends, the target receives its full share of traffic\\. The range is 30\\-900 seconds \\(15 minutes\\)\\. The default is 0 seconds \\(disabled\\)\\.\n+ `stickiness.app_cookie.cookie_name` \\- Indicates the name of the application\\-based cookie\\. Names that start with the following prefixes are not allowed: `AWSALB`, `AWSALBAPP`, and `AWSALBTG`; they're reserved for use by the load balancer\\.\n+ `stickiness.app_cookie.duration_seconds` \\- The time period, in seconds, during which requests from a client should be routed to the same target\\. After this time period expires, the application\\-based cookie is considered stale\\. The range is 1 second to 1 week \\(604800 seconds\\)\\. The default value is 1 day \\(86400 seconds\\)\\.\n+ `stickiness.lb_cookie.duration_seconds` \\- The time period, in seconds, during which requests from a client should be routed to the same target\\. After this time period expires, the load balancer\\-generated cookie is considered stale\\. The range is 1 second to 1 week \\(604800 seconds\\)\\. The default value is 1 day \\(86400 seconds\\)\\. \nThe following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function: \n+ `lambda.multi_value_headers.enabled` \\- Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings\\. The value is `true` or `false`\\. The default is `false`\\. If the value is `false` and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client\\.\nThe following attributes are supported only by Network Load Balancers: \n+ `deregistration_delay.connection_termination.enabled` \\- Indicates whether the load balancer terminates connections at the end of the deregistration timeout\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `preserve_client_ip.enabled` \\- Indicates whether client IP preservation is enabled\\. The value is `true` or `false`\\. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS\\. Otherwise, the default is enabled\\. Client IP preservation cannot be disabled for UDP and TCP\\_UDP target groups\\.\n+ `proxy_protocol_v2.enabled` \\- Indicates whether Proxy Protocol version 2 is enabled\\. The value is `true` or `false`\\. The default is `false`\\. \nThe following attributes are supported only by Gateway Load Balancers: \n+ `target_failover.on_deregistration` \\- Indicates how the Gateway Load Balancer handles existing flows when a target is deregistered\\. The possible values are `rebalance` and `no_rebalance`\\. The default is `no_rebalance`\\. The two attributes \\(`target_failover.on_deregistration` and `target_failover.on_unhealthy`\\) can't be set independently\\. The value you set for both attributes must be the same\\. \n+ `target_failover.on_unhealthy` \\- Indicates how the Gateway Load Balancer handles existing flows when a target is unhealthy\\. The possible values are `rebalance` and `no_rebalance`\\. The default is `no_rebalance`\\. The two attributes \\(`target_failover.on_deregistration` and `target_failover.on_unhealthy`\\) cannot be set independently\\. The value you set for both attributes must be the same\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, @@ -75198,7 +76795,7 @@ }, "AdvancedSecurityOptions": { "$ref": "#/definitions/AWS::Elasticsearch::Domain.AdvancedSecurityOptionsInput", - "markdownDescription": "Specifies options for fine\\-grained access control\\. \n*Required*: No \n*Type*: [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies options for fine\\-grained access control\\. \n*Required*: No \n*Type*: [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "AdvancedSecurityOptions" }, "CognitoOptions": { @@ -75212,7 +76809,7 @@ "title": "DomainEndpointOptions" }, "DomainName": { - "markdownDescription": "A name for the OpenSearch Service domain\\. For valid values, see the [DomainName](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname) data type in the *Amazon OpenSearch Service Developer Guide*\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A name for the OpenSearch Service domain\\. For valid values, see the [DomainName](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname) data type in the *Amazon OpenSearch Service Developer Guide*\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DomainName", "type": "string" }, @@ -75297,6 +76894,8 @@ "additionalProperties": false, "properties": { "AnonymousAuthEnabled": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AnonymousAuthEnabled", "type": "boolean" }, "Enabled": { @@ -75326,17 +76925,17 @@ "type": "boolean" }, "IdentityPoolId": { - "markdownDescription": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. Required if you enable Cognito authentication\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdentityPoolId", "type": "string" }, "RoleArn": { - "markdownDescription": "The `AmazonESCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The `AmazonESCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool\\. Required if you enable Cognito authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RoleArn", "type": "string" }, "UserPoolId": { - "markdownDescription": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. Required if you enable Cognito authentication\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UserPoolId", "type": "string" } @@ -75358,12 +76957,12 @@ "additionalProperties": false, "properties": { "CustomEndpoint": { - "markdownDescription": "The fully qualified URL for your custom endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The fully qualified URL for your custom endpoint\\. Required if you enabled a custom endpoint for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomEndpoint", "type": "string" }, "CustomEndpointCertificateArn": { - "markdownDescription": "The AWS Certificate Manager ARN for your domain's SSL/TLS certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS Certificate Manager ARN for your domain's SSL/TLS certificate\\. Required if you enabled a custom endpoint for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomEndpointCertificateArn", "type": "string" }, @@ -75394,7 +76993,7 @@ "type": "boolean" }, "Iops": { - "markdownDescription": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. This property applies only to the Provisioned IOPS \\(SSD\\) EBS volume type\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. This property applies only to provisioned IOPS EBS volume types\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Iops", "type": "number" }, @@ -75445,7 +77044,7 @@ "type": "string" }, "WarmCount": { - "markdownDescription": "The number of warm nodes in the cluster\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of warm nodes in the cluster\\. Required if you enable warm storage\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WarmCount", "type": "number" }, @@ -75455,13 +77054,13 @@ "type": "boolean" }, "WarmType": { - "markdownDescription": "The instance type for the cluster's warm nodes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The instance type for the cluster's warm nodes\\. Required if you enable warm storage\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WarmType", "type": "string" }, "ZoneAwarenessConfig": { "$ref": "#/definitions/AWS::Elasticsearch::Domain.ZoneAwarenessConfig", - "markdownDescription": "Specifies zone awareness configuration options\\. Only use if `ZoneAwarenessEnabled` is `true`\\. \n*Required*: No \n*Type*: [ZoneAwarenessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies zone awareness configuration options\\. Only use if `ZoneAwarenessEnabled` is `true`\\. \n*Required*: Conditional \n*Type*: [ZoneAwarenessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ZoneAwarenessConfig" }, "ZoneAwarenessEnabled": { @@ -75481,7 +77080,7 @@ "type": "boolean" }, "KmsKeyId": { - "markdownDescription": "The KMS key ID\\. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The KMS key ID\\. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`\\. Required if you enable encryption at rest\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" } @@ -75492,7 +77091,7 @@ "additionalProperties": false, "properties": { "CloudWatchLogsLogGroupArn": { - "markdownDescription": "Specifies the CloudWatch log group to publish to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the CloudWatch log group to publish to\\. Required if you enable log publishing for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchLogsLogGroupArn", "type": "string" }, @@ -75508,17 +77107,17 @@ "additionalProperties": false, "properties": { "MasterUserARN": { - "markdownDescription": "ARN for the master user\\. Only specify if `InternalUserDatabaseEnabled` is false in `AdvancedSecurityOptions`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "ARN for the master user\\. Only specify if `InternalUserDatabaseEnabled` is false in `AdvancedSecurityOptions`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserARN", "type": "string" }, "MasterUserName": { - "markdownDescription": "Username for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Username for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserName", "type": "string" }, "MasterUserPassword": { - "markdownDescription": "Password for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Password for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserPassword", "type": "string" } @@ -75562,7 +77161,7 @@ "items": { "type": "string" }, - "markdownDescription": "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*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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*\\. \nRequired if you're creating your domain inside a VPC\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SubnetIds", "type": "array" } @@ -76893,7 +78492,7 @@ "items": { "$ref": "#/definitions/AWS::Events::Rule.Target" }, - "markdownDescription": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule\\. \nTargets are the resources that are invoked when a rule is triggered\\. \nEach rule can have up to five \\(5\\) targets associated with it at one time\\.\nYou can configure the following as targets for Events: \n+ [API destination](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) \n+ [API Gateway](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html) \n+ Batch job queue\n+ CloudWatch group\n+ CodeBuild project\n+ CodePipeline\n+ EC2 `CreateSnapshot` API call\n+ EC2 Image Builder\n+ EC2 `RebootInstances` API call\n+ EC2 `StopInstances` API call\n+ EC2 `TerminateInstances` API call\n+ ECS task\n+ [Event bus in a different account or Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html) \n+ [Event bus in the same account and Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html) \n+ Firehose delivery stream\n+ Glue workflow\n+ [Incident Manager response plan](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge) \n+ Inspector assessment template\n+ Kinesis stream\n+ Lambda function\n+ Redshift cluster\n+ SageMaker Pipeline\n+ SNS topic\n+ SQS queue\n+ Step Functions state machine\n+ Systems Manager Automation\n+ Systems Manager OpsItem\n+ Systems Manager Run Command\nCreating rules with built\\-in targets is supported only in the AWS Management Console\\. The built\\-in targets are `EC2 CreateSnapshot API call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`, and `EC2 TerminateInstances API call`\\. \nFor some target types, `PutTargets` provides target\\-specific parameters\\. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument\\. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field\\. \nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions\\. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource\\-based policies\\. For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets`\\. For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide*\\. \nIf another AWS account is in the same region and has granted you permission \\(using `PutPermission`\\), you can send events to that account\\. Set that account's event bus as a target of the rules in your account\\. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets`\\. If your account sends events to another account, your account is charged for each sent event\\. Each event sent to another account is charged as a custom event\\. The account receiving the event is not charged\\. For more information, see [Amazon EventBridge Pricing](http://aws.amazon.com/eventbridge/pricing/)\\. \n `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account\\.\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure\\. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*\\. \nFor more information about enabling cross\\-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html)\\. \n **Input**, **InputPath**, and **InputTransformer** are mutually exclusive and optional parameters of a target\\. When a rule is triggered due to a matched event: \n+ If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format \\(unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target\\)\\.\n+ If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant\\.\n+ If **InputPath** is specified in the form of JSONPath \\(for example, `$.detail`\\), then only the part of the event specified in the path is passed to the target \\(for example, only the detail part of the event is passed\\)\\.\n+ If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target\\.\nWhen you specify `InputPath` or `InputTransformer`, you must use JSON dot notation, not bracket notation\\. \nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked\\. Allow a short period of time for changes to take effect\\. \nThis action can partially fail if too many requests are made at the same time\\. If that happens, `FailedEntryCount` is non\\-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code\\. \n*Required*: No \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule\\. \nTargets are the resources that are invoked when a rule is triggered\\. \nThe maximum number of entries per request is 10\\. \nEach rule can have up to five \\(5\\) targets associated with it at one time\\.\nFor a list of services you can configure as targets for events, see [EventBridge targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html) in the *Amazon EventBridge User Guide*\\. \nCreating rules with built\\-in targets is supported only in the AWS Management Console\\. The built\\-in targets are: \n+ `Amazon EBS CreateSnapshot API call` \n+ `Amazon EC2 RebootInstances API call` \n+ `Amazon EC2 StopInstances API call` \n+ `Amazon EC2 TerminateInstances API call` \nFor some target types, `PutTargets` provides target\\-specific parameters\\. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument\\. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field\\. \nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions: \n+ For AWS Lambda and Amazon SNS resources, EventBridge relies on resource\\-based policies\\.\n+ For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets`\\.\nFor more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide*\\. \nIf another AWS account is in the same region and has granted you permission \\(using `PutPermission`\\), you can send events to that account\\. Set that account's event bus as a target of the rules in your account\\. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets`\\. If your account sends events to another account, your account is charged for each sent event\\. Each event sent to another account is charged as a custom event\\. The account receiving the event is not charged\\. For more information, see [Amazon EventBridge Pricing](http://aws.amazon.com/eventbridge/pricing/)\\. \n `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account\\.\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure\\. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*\\. \nFor more information about enabling cross\\-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html)\\. \n **Input**, **InputPath**, and **InputTransformer** are mutually exclusive and optional parameters of a target\\. When a rule is triggered due to a matched event: \n+ If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format \\(unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target\\)\\.\n+ If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant\\.\n+ If **InputPath** is specified in the form of JSONPath \\(for example, `$.detail`\\), then only the part of the event specified in the path is passed to the target \\(for example, only the detail part of the event is passed\\)\\.\n+ If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target\\.\nWhen you specify `InputPath` or `InputTransformer`, you must use JSON dot notation, not bracket notation\\. \nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked\\. Allow a short period of time for changes to take effect\\. \nThis action can partially fail if too many requests are made at the same time\\. If that happens, `FailedEntryCount` is non\\-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code\\. \n*Required*: No \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Targets", "type": "array" } @@ -77565,10 +79164,14 @@ "type": "string" }, "RemoveSegment": { + "markdownDescription": "Set this to `true` to remove the segment that is associated with this experiment\\. You can't use this parameter if the experiment is currently running\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RemoveSegment", "type": "boolean" }, "RunningStatus": { - "$ref": "#/definitions/AWS::Evidently::Experiment.RunningStatusObject" + "$ref": "#/definitions/AWS::Evidently::Experiment.RunningStatusObject", + "markdownDescription": "A structure that you can use to start and stop the experiment\\. \n*Required*: No \n*Type*: [RunningStatusObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RunningStatus" }, "SamplingRate": { "markdownDescription": "The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent\\. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature\\. \nThis is represented in thousandths of a percent\\. For example, specify 10,000 to allocate 10% of the available audience\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -77576,6 +79179,8 @@ "type": "number" }, "Segment": { + "markdownDescription": "Specifies an audience *segment* to use in the experiment\\. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment\\. \nFor more information, see [ Segment rule pattern syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments-syntax.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Segment", "type": "string" }, "Tags": { @@ -77639,7 +79244,7 @@ "type": "string" }, "EventPattern": { - "markdownDescription": "The EventBridge event pattern that defines how the metric is recorded\\. \nFor more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The EventBridge event pattern that defines how the metric is recorded\\. \nFor more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventPattern", "type": "string" }, @@ -77690,15 +79295,23 @@ "additionalProperties": false, "properties": { "AnalysisCompleteTime": { + "markdownDescription": "If you are using AWS CloudFormation to start the experiment, use this field to specify when the experiment is to end\\. The format is as a UNIX timestamp\\. For more information about this format, see [The Current Epoch Unix Timestamp](https://www.unixtimestamp.com/index.php)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AnalysisCompleteTime", "type": "string" }, "DesiredState": { + "markdownDescription": "If you are using AWS CloudFormation to stop this experiment, specify either `COMPLETED` or `CANCELLED` here to indicate how to classify this experiment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DesiredState", "type": "string" }, "Reason": { + "markdownDescription": "If you are using AWS CloudFormation to stop this experiment, this is an optional field that you can use to record why the experiment is being stopped or cancelled\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Reason", "type": "string" }, "Status": { + "markdownDescription": "To start the experiment now, specify `START` for this parameter\\. If this experiment is currently running and you want to stop it now, specify `STOP`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" } }, @@ -77911,7 +79524,7 @@ "type": "string" }, "VariationName": { - "markdownDescription": "A name for the variation\\. It can include up to 127 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A name for the variation\\. It can include up to 127 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VariationName", "type": "string" } @@ -77962,7 +79575,9 @@ "type": "string" }, "ExecutionStatus": { - "$ref": "#/definitions/AWS::Evidently::Launch.ExecutionStatusObject" + "$ref": "#/definitions/AWS::Evidently::Launch.ExecutionStatusObject", + "markdownDescription": "A structure that you can use to start and stop the launch\\. \n*Required*: No \n*Type*: [ExecutionStatusObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExecutionStatus" }, "Groups": { "items": { @@ -78045,12 +79660,18 @@ "additionalProperties": false, "properties": { "DesiredState": { + "markdownDescription": "If you are using AWS CloudFormation to stop this launch, specify either `COMPLETED` or `CANCELLED` here to indicate how to classify this experiment\\. If you omit this parameter, the default of `COMPLETED` is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DesiredState", "type": "string" }, "Reason": { + "markdownDescription": "If you are using AWS CloudFormation to stop this launch, this is an optional field that you can use to record why the launch is being stopped or cancelled\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Reason", "type": "string" }, "Status": { + "markdownDescription": "To start the launch now, specify `START` for this parameter\\. If this launch is currently running and you want to stop it now, specify `STOP`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" } }, @@ -78119,7 +79740,7 @@ "type": "string" }, "EventPattern": { - "markdownDescription": "The EventBridge event pattern that defines how the metric is recorded\\. \nFor more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The EventBridge event pattern that defines how the metric is recorded\\. \nFor more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventPattern", "type": "string" }, @@ -78150,15 +79771,21 @@ "additionalProperties": false, "properties": { "EvaluationOrder": { + "markdownDescription": "A number indicating the order to use to evaluate segment overrides, if there are more than one\\. Segment overrides with lower numbers are evaluated first\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EvaluationOrder", "type": "number" }, "Segment": { + "markdownDescription": "The ARN of the segment to use for this override\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Segment", "type": "string" }, "Weights": { "items": { "$ref": "#/definitions/AWS::Evidently::Launch.GroupToWeight" }, + "markdownDescription": "The traffic allocation percentages among the feature variations to assign to this segment\\. This is a set of key\\-value pairs\\. The keys are variation names\\. The values represent the amount of traffic to allocate to that variation for this segment\\. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic\\. \n*Required*: Yes \n*Type*: List of [GroupToWeight](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-grouptoweight.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Weights", "type": "array" } }, @@ -78184,6 +79811,8 @@ "items": { "$ref": "#/definitions/AWS::Evidently::Launch.SegmentOverride" }, + "markdownDescription": "An array of structures that you can use to specify different traffic splits for one or more audience *segments*\\. A segment is a portion of your audience that share one or more characteristics\\. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age\\. \nFor more information, see [ Use segments to focus your audience](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html)\\. \n*Required*: No \n*Type*: List of [SegmentOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SegmentOverrides", "type": "array" }, "StartTime": { @@ -78234,7 +79863,9 @@ "additionalProperties": false, "properties": { "AppConfigResource": { - "$ref": "#/definitions/AWS::Evidently::Project.AppConfigResourceObject" + "$ref": "#/definitions/AWS::Evidently::Project.AppConfigResourceObject", + "markdownDescription": "Use this parameter if the project will use *client\\-side evaluation powered by AWS AppConfig*\\. Client\\-side evaluation allows your application to assign variations to user sessions locally instead of by calling the [EvaluateFeature](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) operation\\. This mitigates the latency and availability risks that come with an API call\\. For more information, see [ Use client\\-side evaluation \\- powered by AWS AppConfig\\.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-client-side-evaluation.html) \nThis parameter is a structure that contains information about the AWS AppConfig application that will be used as for client\\-side evaluation\\. \nTo create a project that uses client\\-side evaluation, you must have the `evidently:ExportProjectAsConfiguration` permission\\. \n*Required*: No \n*Type*: [AppConfigResourceObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-appconfigresourceobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppConfigResource" }, "DataDelivery": { "$ref": "#/definitions/AWS::Evidently::Project.DataDeliveryObject", @@ -78290,9 +79921,13 @@ "additionalProperties": false, "properties": { "ApplicationId": { + "markdownDescription": "The ID of the AWS AppConfig application to use for client\\-side evaluation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApplicationId", "type": "string" }, "EnvironmentId": { + "markdownDescription": "The ID of the AWS AppConfig environment to use for client\\-side evaluation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnvironmentId", "type": "string" } }, @@ -78373,18 +80008,26 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "An optional description for this segment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A name for the segment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Pattern": { + "markdownDescription": "The pattern to use for the segment\\. For more information about pattern syntax, see [ Segment rule pattern syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments-syntax.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pattern", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Assigns one or more tags \\(key\\-value pairs\\) to the feature\\. \nTags can help you organize and categorize your resources\\. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values\\. \nTags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters\\. \nYou can associate as many as 50 tags with a feature\\. \nFor more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -78540,6 +80183,8 @@ "additionalProperties": false, "properties": { "LogGroupArn": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogGroupArn", "type": "string" } }, @@ -78602,7 +80247,7 @@ "properties": { "CloudWatchLogsConfiguration": { "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.CloudWatchLogsConfiguration", - "markdownDescription": "The configuration for experiment logging to Amazon CloudWatch Logs\\. The supported field is `logGroupArn`\\. For example: \n`{\"logGroupArn\": \"aws:arn:logs:region_name:account_id:log-group:log_group_name\"}` \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The configuration for experiment logging to Amazon CloudWatch Logs\\. The supported field is `LogGroupArn`\\. For example: \n`{\"LogGroupArn\": \"aws:arn:logs:region_name:account_id:log-group:log_group_name\"}` \n*Required*: No \n*Type*: [CloudWatchLogsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-cloudwatchlogsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchLogsConfiguration" }, "LogSchemaVersion": { @@ -78612,7 +80257,7 @@ }, "S3Configuration": { "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.S3Configuration", - "markdownDescription": "The configuration for experiment logging to Amazon S3\\. The following fields are supported: \n+ `bucketName` \\- The name of the destination bucket\\.\n+ `prefix` \\- An optional bucket prefix\\.\nFor example: \n`{\"bucketName\": \"my-s3-bucket\", \"prefix\": \"log-folder\"}` \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The configuration for experiment logging to Amazon S3\\. The following fields are supported: \n+ `bucketName` \\- The name of the destination bucket\\.\n+ `prefix` \\- An optional bucket prefix\\.\nFor example: \n`{\"BucketName\": \"my-s3-bucket\", \"Prefix\": \"log-folder\"}` \n*Required*: No \n*Type*: [S3Configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-s3configuration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3Configuration" } }, @@ -78725,9 +80370,13 @@ "additionalProperties": false, "properties": { "BucketName": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketName", "type": "string" }, "Prefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Prefix", "type": "string" } }, @@ -78865,6 +80514,8 @@ "title": "IncludeMap" }, "PolicyDescription": { + "markdownDescription": "The definition of the AWS Network Firewall firewall policy\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyDescription", "type": "string" }, "PolicyName": { @@ -78881,6 +80532,8 @@ "items": { "type": "string" }, + "markdownDescription": "The unique identifiers of the resource sets used by the policy\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceSetIds", "type": "array" }, "ResourceTags": { @@ -78892,7 +80545,7 @@ "type": "array" }, "ResourceType": { - "markdownDescription": "The type of resource protected by or in scope of the policy\\. This is in the format shown in the [AWS Resource Types Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)\\. To apply this policy to multiple resource types, specify a resource type of `ResourceTypeList` and then specify the resource types in a `ResourceTypeList`\\. \nFor AWS WAF and Shield Advanced, example resource types include `AWS::ElasticLoadBalancingV2::LoadBalancer` and `AWS::CloudFront::Distribution`\\. For a security group common policy, valid values are `AWS::EC2::NetworkInterface` and `AWS::EC2::Instance`\\. For a security group content audit policy, valid values are `AWS::EC2::SecurityGroup`, `AWS::EC2::NetworkInterface`, and `AWS::EC2::Instance`\\. For a security group usage audit policy, the value is `AWS::EC2::SecurityGroup`\\. For an AWS Network Firewall policy or DNS Firewall policy, the value is `AWS::EC2::VPC`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of resource protected by or in scope of the policy\\. This is in the format shown in the [AWS Resource Types Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)\\. To apply this policy to multiple resource types, specify a resource type of `ResourceTypeList` and then specify the resource types in a `ResourceTypeList`\\. \nFor AWS WAF and Shield Advanced, example resource types include `AWS::ElasticLoadBalancingV2::LoadBalancer` and `AWS::CloudFront::Distribution`\\. For a security group common policy, valid values are `AWS::EC2::NetworkInterface` and `AWS::EC2::Instance`\\. For a security group content audit policy, valid values are `AWS::EC2::SecurityGroup`, `AWS::EC2::NetworkInterface`, and `AWS::EC2::Instance`\\. For a security group usage audit policy, the value is `AWS::EC2::SecurityGroup`\\. For an AWS Network Firewall policy or DNS Firewall policy, the value is `AWS::EC2::VPC`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceType", "type": "string" }, @@ -78978,6 +80631,8 @@ "additionalProperties": false, "properties": { "FirewallDeploymentModel": { + "markdownDescription": "Defines the deployment model to use for the firewall policy\\. To use a distributed model, set [PolicyOption](https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) to `NULL`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CENTRALIZED | DISTRIBUTED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FirewallDeploymentModel", "type": "string" } }, @@ -78990,10 +80645,14 @@ "additionalProperties": false, "properties": { "NetworkFirewallPolicy": { - "$ref": "#/definitions/AWS::FMS::Policy.NetworkFirewallPolicy" + "$ref": "#/definitions/AWS::FMS::Policy.NetworkFirewallPolicy", + "markdownDescription": "Defines the deployment model to use for the firewall policy\\. \n*Required*: No \n*Type*: [NetworkFirewallPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkFirewallPolicy" }, "ThirdPartyFirewallPolicy": { - "$ref": "#/definitions/AWS::FMS::Policy.ThirdPartyFirewallPolicy" + "$ref": "#/definitions/AWS::FMS::Policy.ThirdPartyFirewallPolicy", + "markdownDescription": "Defines the policy options for a third\\-party firewall policy\\. \n*Required*: No \n*Type*: [ThirdPartyFirewallPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-thirdpartyfirewallpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ThirdPartyFirewallPolicy" } }, "type": "object" @@ -79041,12 +80700,18 @@ "additionalProperties": false, "properties": { "ManagedServiceData": { + "markdownDescription": "Details about the service that are specific to the service type, in JSON format\\. \n+ Example: `DNS_FIREWALL`", + "title": "ManagedServiceData", "type": "string" }, "PolicyOption": { - "$ref": "#/definitions/AWS::FMS::Policy.PolicyOption" + "$ref": "#/definitions/AWS::FMS::Policy.PolicyOption", + "markdownDescription": "Contains the Network Firewall firewall policy options to configure a centralized deployment model\\. \n*Required*: No \n*Type*: [PolicyOption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-policyoption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyOption" }, "Type": { + "markdownDescription": "The service that the policy is using to protect the resources\\. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy\\. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy\\. This is an adjustable limit that you can increase by contacting AWS Support\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DNS_FIREWALL | IMPORT_NETWORK_FIREWALL | NETWORK_FIREWALL | SECURITY_GROUPS_COMMON | SECURITY_GROUPS_CONTENT_AUDIT | SECURITY_GROUPS_USAGE_AUDIT | SHIELD_ADVANCED | THIRD_PARTY_FIREWALL | WAF | WAFV2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -79059,6 +80724,8 @@ "additionalProperties": false, "properties": { "FirewallDeploymentModel": { + "markdownDescription": "Defines the deployment model to use for the third\\-party firewall policy\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CENTRALIZED | DISTRIBUTED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FirewallDeploymentModel", "type": "string" } }, @@ -79067,6 +80734,93 @@ ], "type": "object" }, + "AWS::FMS::ResourceSet": { + "additionalProperties": false, + "properties": { + "Condition": { + "type": "string" + }, + "DeletionPolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + }, + "DependsOn": { + "anyOf": [ + { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + { + "items": { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "type": "array" + } + ] + }, + "Metadata": { + "type": "object" + }, + "Properties": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "ResourceTypeList": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Resources": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "required": [ + "Name", + "ResourceTypeList" + ], + "type": "object" + }, + "Type": { + "enum": [ + "AWS::FMS::ResourceSet" + ], + "type": "string" + }, + "UpdateReplacePolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Properties" + ], + "type": "object" + }, "AWS::FSx::DataRepositoryAssociation": { "additionalProperties": false, "properties": { @@ -79103,27 +80857,41 @@ "additionalProperties": false, "properties": { "BatchImportMetaDataOnCreate": { + "markdownDescription": "A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created\\. The task runs if this flag is set to `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BatchImportMetaDataOnCreate", "type": "boolean" }, "DataRepositoryPath": { + "markdownDescription": "The path to the Amazon S3 data repository that will be linked to the file system\\. The path can be an S3 bucket or prefix in the format `s3://myBucket/myPrefix/`\\. This path specifies where in the S3 data repository files will be imported from or exported to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataRepositoryPath", "type": "string" }, "FileSystemId": { + "markdownDescription": "The ID of the file system on which the data repository association is configured\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemId", "type": "string" }, "FileSystemPath": { + "markdownDescription": "A path on the Amazon FSx for Lustre file system that points to a high\\-level directory \\(such as `/ns1/`\\) or subdirectory \\(such as `/ns1/subdir/`\\) that will be mapped 1\\-1 with `DataRepositoryPath`\\. The leading forward slash in the name is required\\. Two data repository associations cannot have overlapping file system paths\\. For example, if a data repository is associated with file system path `/ns1/`, then you cannot link another data repository with file system path `/ns1/ns2`\\. \nThis path specifies where in your file system files will be exported from or imported to\\. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory\\. \nIf you specify only a forward slash \\(`/`\\) as the file system path, you can link only one data repository to the file system\\. You can only specify \"/\" as the file system path for the first data repository associated with a file system\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4096` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,4096}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemPath", "type": "string" }, "ImportedFileChunkSize": { + "markdownDescription": "For files imported from a data repository, this value determines the stripe count and maximum amount of data per file \\(in MiB\\) stored on a single physical disk\\. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache\\. \nThe default chunk size is 1,024 MiB \\(1 GiB\\) and can go as high as 512,000 MiB \\(500 GiB\\)\\. Amazon S3 objects have a maximum size of 5 TB\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `512000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImportedFileChunkSize", "type": "number" }, "S3": { - "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation.S3" + "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation.S3", + "markdownDescription": "The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association\\. The configuration defines which file events \\(new, changed, or deleted files or directories\\) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository\\. \n*Required*: No \n*Type*: [S3](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-s3.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -79162,6 +80930,8 @@ "items": { "type": "string" }, + "markdownDescription": "The `AutoExportPolicy` can have the following event values: \n+ `NEW` \\- New files and directories are automatically exported to the data repository as they are added to the file system\\.\n+ `CHANGED` \\- Changes to files and directories on the file system are automatically exported to the data repository\\.\n+ `DELETED` \\- Files and directories are automatically deleted on the data repository when they are deleted on the file system\\.\nYou can define any combination of event types for your `AutoExportPolicy`\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Events", "type": "array" } }, @@ -79177,6 +80947,8 @@ "items": { "type": "string" }, + "markdownDescription": "The `AutoImportPolicy` can have the following event values: \n+ `NEW` \\- Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system\\.\n+ `CHANGED` \\- Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository\\.\n+ `DELETED` \\- Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository\\.\nYou can define any combination of event types for your `AutoImportPolicy`\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Events", "type": "array" } }, @@ -79189,10 +80961,14 @@ "additionalProperties": false, "properties": { "AutoExportPolicy": { - "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation.AutoExportPolicy" + "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation.AutoExportPolicy", + "markdownDescription": "Describes a data repository association's automatic export policy\\. The `AutoExportPolicy` defines the types of updated objects on the file system that will be automatically exported to the data repository\\. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file\\. \nThis `AutoExportPolicy` is supported only for Amazon FSx for Lustre file systems with the `Persistent_2` deployment type\\. \n*Required*: No \n*Type*: [AutoExportPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoexportpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoExportPolicy" }, "AutoImportPolicy": { - "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation.AutoImportPolicy" + "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation.AutoImportPolicy", + "markdownDescription": "Describes the data repository association's automatic import policy\\. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket\\. \nThe `AutoImportPolicy` is supported only for Amazon FSx for Lustre file systems with the `Persistent_2` deployment type\\. \n*Required*: No \n*Type*: [AutoImportPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoimportpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoImportPolicy" } }, "type": "object" @@ -79233,7 +81009,7 @@ "additionalProperties": false, "properties": { "BackupId": { - "markdownDescription": "The ID of the source backup\\. Specifies the backup that you are copying\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the file system backup that you are using to create a file system\\. For more information, see [CreateFileSystemFromBackup](https://docs.aws.amazon.com/fsx/latest/APIReference/API_CreateFileSystemFromBackup.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "BackupId", "type": "string" }, @@ -79248,13 +81024,13 @@ "type": "string" }, "KmsKeyId": { - "markdownDescription": "The ID of the AWS Key Management Service \\(AWS KMS\\) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and `PERSISTENT` Amazon FSx for Lustre file systems at rest\\. If this ID isn't specified, the Amazon FSx\\-managed key for your account is used\\. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using the Amazon FSx\\-managed key for your account\\. For more information, see [Encrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) in the * AWS Key Management Service API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the AWS Key Management Service \\(AWS KMS\\) key used to encrypt Amazon FSx file system data\\. Used as follows with Amazon FSx file system types: \n+ Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment types only\\.", "title": "KmsKeyId", "type": "string" }, "LustreConfiguration": { "$ref": "#/definitions/AWS::FSx::FileSystem.LustreConfiguration", - "markdownDescription": "The Lustre configuration for the file system being created\\. \nThe following parameters are not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation` to create a data repository association to link your Lustre file system to a data repository\\. \n+ `AutoImportPolicy` \n+ `ExportPath` \n+ `ImportedChunkSize` \n+ `ImportPath` \n*Required*: No \n*Type*: [LustreConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Lustre configuration for the file system being created\\. \nThe following parameters are not supported for file systems with the Lustre `Persistent_2` deployment type\\. \n+ `AutoImportPolicy` \n+ `ExportPath` \n+ `ImportedChunkSize` \n+ `ImportPath` \n*Required*: Conditional \n*Type*: [LustreConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LustreConfiguration" }, "OntapConfiguration": { @@ -79276,12 +81052,12 @@ "type": "array" }, "StorageCapacity": { - "markdownDescription": "Sets the storage capacity of the file system that you're creating\\. `StorageCapacity` is required if you are creating a new file system\\. Do not include `StorageCapacity` if you are creating a file system from a backup\\. \nFor Lustre file systems: \n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Sets the storage capacity of the file system that you're creating\\. `StorageCapacity` is required if you are creating a new file system\\. \n**FSx for Lustre file systems** \\- The amount of storage capacity that you can configure depends on the value that you set for `StorageType` and the Lustre `DeploymentType`, as follows: \n+ For `SCRATCH_2`, `PERSISTENT_2` and `PERSISTENT_1` deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB\\.\n+ For `PERSISTENT_1` HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems\\.\n+ For `SCRATCH_1` deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB\\.\n**FSx for ONTAP file systems** \\- The amount of storage capacity that you can configure is from 1024 GiB up to 196,608 GiB \\(192 TiB\\)\\. \n**FSx for OpenZFS file systems** \\- The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB \\(512 TiB\\)\\. If you are creating a file system from a backup, you can specify a storage capacity equal to or greater than the original file system's storage capacity\\. \n**FSx for Windows File Server file systems** \\- The amount of storage capacity that you can configure depends on the value that you set for `StorageType` as follows: \n+ For SSD storage, valid values are 32 GiB\\-65,536 GiB \\(64 TiB\\)\\.\n+ For HDD storage, valid values are 2000 GiB\\-65,536 GiB \\(64 TiB\\)\\.\n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StorageCapacity", "type": "number" }, "StorageType": { - "markdownDescription": "Sets the storage type for the file system that you're creating\\. Valid values are `SSD` and `HDD`\\. \n+ Set to `SSD` to use solid state drive storage\\. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types\\.\n+ Set to `HDD` to use hard disk drive storage\\. HDD is supported on `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types, and on `PERSISTENT` Lustre file system deployment types\\. \nDefault value is `SSD`\\. For more information, see [ Storage type options](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options) in the *FSx for Windows File Server User Guide* and [Multiple storage options](https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options) in the *FSx for Lustre User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HDD | SSD` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Sets the storage type for the file system that you're creating\\. Valid values are `SSD` and `HDD`\\. \n+ Set to `SSD` to use solid state drive storage\\. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types\\.\n+ Set to `HDD` to use hard disk drive storage\\. HDD is supported on `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types, and on `PERSISTENT_1` Lustre file system deployment types\\. \nDefault value is `SSD`\\. For more information, see [ Storage type options](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options) in the *FSx for Windows File Server User Guide* and [Multiple storage options](https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options) in the *FSx for Lustre User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HDD | SSD` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StorageType", "type": "string" }, @@ -79297,7 +81073,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags to associate with the file system\\. For more information, see [Tagging your Amazon EC2 resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the *Amazon EC2 User Guide*\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -79398,12 +81174,12 @@ "additionalProperties": false, "properties": { "AutoImportPolicy": { - "markdownDescription": "\\(Optional\\) Available with `Scratch` and `Persistent_1` deployment types\\. When you create your file system, your existing S3 objects appear as file and directory listings\\. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket\\. `AutoImportPolicy` can have the following values: \n+ `NONE` \\- \\(Default\\) AutoImport is off\\. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created\\. FSx does not update file and directory listings for any new or changed objects after choosing this option\\.\n+ `NEW` \\- AutoImport is on\\. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system\\. \n+ `NEW_CHANGED` \\- AutoImport is on\\. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option\\.\n+ `NEW_CHANGED_DELETED` \\- AutoImport is on\\. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket\\.\nFor more information, see [ Automatically import updates from your S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html)\\. \nThis parameter is not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation` to create a data repository association to link your Lustre file system to a data repository\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `NEW | NEW_CHANGED | NEW_CHANGED_DELETED | NONE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "\\(Optional\\) Available with `Scratch` and `Persistent_1` deployment types\\. When you create your file system, your existing S3 objects appear as file and directory listings\\. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket\\. `AutoImportPolicy` can have the following values: \n+ `NONE` \\- \\(Default\\) AutoImport is off\\. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created\\. FSx does not update file and directory listings for any new or changed objects after choosing this option\\.\n+ `NEW` \\- AutoImport is on\\. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system\\. \n+ `NEW_CHANGED` \\- AutoImport is on\\. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option\\.\n+ `NEW_CHANGED_DELETED` \\- AutoImport is on\\. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket\\.\nFor more information, see [ Automatically import updates from your S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html)\\. \nThis parameter is not supported for Lustre file systems using the `Persistent_2` deployment type\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `NEW | NEW_CHANGED | NEW_CHANGED_DELETED | NONE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutoImportPolicy", "type": "string" }, "AutomaticBackupRetentionDays": { - "markdownDescription": "The number of days to retain automatic backups\\. Setting this to 0 disables automatic backups\\. You can retain automatic backups for a maximum of 90 days\\. The default is 0\\. Only valid for use with `PERSISTENT_1` deployment types\\. For more information, see [Working with backups](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html) in the *Amazon FSx for Lustre User Guide*\\. \\(Default = 0\\) \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `90` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of days to retain automatic backups\\. Setting this property to `0` disables automatic backups\\. You can retain automatic backups for a maximum of 90 days\\. The default is `0`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutomaticBackupRetentionDays", "type": "number" }, @@ -79413,7 +81189,7 @@ "type": "boolean" }, "DailyAutomaticBackupStartTime": { - "markdownDescription": "A recurring daily time, in the format` HH:MM`\\. `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. For example, `05:00` specifies 5 AM daily\\. Only valid for use with `PERSISTENT_1` deployment types\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A recurring daily time, in the format `HH:MM`\\. `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. For example, `05:00` specifies 5 AM daily\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DailyAutomaticBackupStartTime", "type": "string" }, @@ -79423,27 +81199,27 @@ "type": "string" }, "DeploymentType": { - "markdownDescription": "\\(Optional\\) Choose `SCRATCH_1` and `SCRATCH_2` deployment types when you need temporary storage and shorter\\-term processing of data\\. The `SCRATCH_2` deployment type provides in\\-transit encryption of data and higher burst throughput capacity than `SCRATCH_1`\\. \nChoose `PERSISTENT_1` for longer\\-term storage and for throughput\\-focused workloads that aren\u2019t latency\\-sensitive\\. `PERSISTENT_1` supports encryption of data in transit, and is available in all AWS Regions in which FSx for Lustre is available\\. \nChoose `PERSISTENT_2` for longer\\-term storage and for latency\\-sensitive workloads that require the highest levels of IOPS/throughput\\. `PERSISTENT_2` supports SSD storage, and offers higher `PerUnitStorageThroughput` \\(up to 1000 MB/s/TiB\\)\\. `PERSISTENT_2` is available in a limited number of AWS Regions\\. For more information, and an up\\-to\\-date list of AWS Regions in which `PERSISTENT_2` is available, see [File system deployment options for FSx for Lustre](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types) in the *Amazon FSx for Lustre User Guide*\\. \nIf you choose `PERSISTENT_2`, and you set `FileSystemTypeVersion` to `2.10`, the `CreateFileSystem` operation fails\\.\nEncryption of data in transit is automatically turned on when you access `SCRATCH_2`, `PERSISTENT_1` and `PERSISTENT_2` file systems from Amazon EC2 instances that [support automatic encryption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data- protection.html) in the AWS Regions where they are available\\. For more information about encryption in transit for FSx for Lustre file systems, see [Encrypting data in transit](https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html) in the *Amazon FSx for Lustre User Guide*\\. \n\\(Default = `SCRATCH_1`\\) \n*Required*: No \n*Type*: String \n*Allowed values*: `PERSISTENT_1 | PERSISTENT_2 | SCRATCH_1 | SCRATCH_2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\(Optional\\) Choose `SCRATCH_1` and `SCRATCH_2` deployment types when you need temporary storage and shorter\\-term processing of data\\. The `SCRATCH_2` deployment type provides in\\-transit encryption of data and higher burst throughput capacity than `SCRATCH_1`\\. \nChoose `PERSISTENT_1` for longer\\-term storage and for throughput\\-focused workloads that aren\u2019t latency\\-sensitive\\. `PERSISTENT_1` supports encryption of data in transit, and is available in all AWS Regions in which FSx for Lustre is available\\. \nChoose `PERSISTENT_2` for longer\\-term storage and for latency\\-sensitive workloads that require the highest levels of IOPS/throughput\\. `PERSISTENT_2` supports SSD storage, and offers higher `PerUnitStorageThroughput` \\(up to 1000 MB/s/TiB\\)\\. `PERSISTENT_2` is available in a limited number of AWS Regions\\. For more information, and an up\\-to\\-date list of AWS Regions in which `PERSISTENT_2` is available, see [File system deployment options for FSx for Lustre](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types) in the *Amazon FSx for Lustre User Guide*\\. \nIf you choose `PERSISTENT_2`, and you set `FileSystemTypeVersion` to `2.10`, the `CreateFileSystem` operation fails\\.\nEncryption of data in transit is automatically turned on when you access `SCRATCH_2`, `PERSISTENT_1` and `PERSISTENT_2` file systems from Amazon EC2 instances that support automatic encryption in the AWS Regions where they are available\\. For more information about encryption in transit for FSx for Lustre file systems, see [Encrypting data in transit](https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html) in the *Amazon FSx for Lustre User Guide*\\. \n\\(Default = `SCRATCH_1`\\) \n*Required*: No \n*Type*: String \n*Allowed values*: `PERSISTENT_1 | PERSISTENT_2 | SCRATCH_1 | SCRATCH_2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DeploymentType", "type": "string" }, "DriveCacheType": { - "markdownDescription": "The type of drive cache used by `PERSISTENT_1` file systems that are provisioned with HDD storage devices\\. This parameter is required when storage type is HDD\\. Set this property to `READ` to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system\\. \nThis parameter is required when `StorageType` is set to `HDD`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | READ` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of drive cache used by `PERSISTENT_1` file systems that are provisioned with HDD storage devices\\. This parameter is required when storage type is HDD\\. Set this property to `READ` to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system\\. \nThis parameter is required when `StorageType` is set to `HDD` and `DeploymentType` is `PERSISTENT_1`\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `NONE | READ` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DriveCacheType", "type": "string" }, "ExportPath": { - "markdownDescription": "\\(Optional\\) Available with `Scratch` and `Persistent_1` deployment types\\. Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported\\. The path must use the same Amazon S3 bucket as specified in ImportPath\\. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system\\. If an `ExportPath` value is not provided, Amazon FSx sets a default export path, `s3://import-bucket/FSxLustre[creation-timestamp]`\\. The timestamp is in UTC format, for example `s3://import-bucket/FSxLustre20181105T222312Z`\\. \nThe Amazon S3 export bucket must be the same as the import bucket specified by `ImportPath`\\. If you specify only a bucket name, such as `s3://import-bucket`, you get a 1:1 mapping of file system objects to S3 bucket objects\\. This mapping means that the input data in S3 is overwritten on export\\. If you provide a custom prefix in the export path, such as `s3://import-bucket/[custom-optional-prefix]`, Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket\\. \nThis parameter is not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation` to create a data repository association to link your Lustre file system to a data repository\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\(Optional\\) Available with `Scratch` and `Persistent_1` deployment types\\. Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported\\. The path must use the same Amazon S3 bucket as specified in ImportPath\\. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system\\. If an `ExportPath` value is not provided, Amazon FSx sets a default export path, `s3://import-bucket/FSxLustre[creation-timestamp]`\\. The timestamp is in UTC format, for example `s3://import-bucket/FSxLustre20181105T222312Z`\\. \nThe Amazon S3 export bucket must be the same as the import bucket specified by `ImportPath`\\. If you specify only a bucket name, such as `s3://import-bucket`, you get a 1:1 mapping of file system objects to S3 bucket objects\\. This mapping means that the input data in S3 is overwritten on export\\. If you provide a custom prefix in the export path, such as `s3://import-bucket/[custom-optional-prefix]`, Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket\\. \nThis parameter is not supported for file systems using the `Persistent_2` deployment type\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ExportPath", "type": "string" }, "ImportPath": { - "markdownDescription": "\\(Optional\\) The path to the Amazon S3 bucket \\(including the optional prefix\\) that you're using as the data repository for your Amazon FSx for Lustre file system\\. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select\\. An example is `s3://import-bucket/optional-prefix`\\. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system\\. \nThis parameter is not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation`to create a data repository association to link your Lustre file system to a data repository\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\(Optional\\) The path to the Amazon S3 bucket \\(including the optional prefix\\) that you're using as the data repository for your Amazon FSx for Lustre file system\\. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select\\. An example is `s3://import-bucket/optional-prefix`\\. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system\\. \nThis parameter is not supported for Lustre file systems using the `Persistent_2` deployment type\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ImportPath", "type": "string" }, "ImportedFileChunkSize": { - "markdownDescription": "\\(Optional\\) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file \\(in MiB\\) stored on a single physical disk\\. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system\\. \nThe default chunk size is 1,024 MiB \\(1 GiB\\) and can go as high as 512,000 MiB \\(500 GiB\\)\\. Amazon S3 objects have a maximum size of 5 TB\\. \nThis parameter is not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation` to create a data repository association to link your Lustre file system to a data repository\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `512000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\(Optional\\) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file \\(in MiB\\) stored on a single physical disk\\. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system\\. \nThe default chunk size is 1,024 MiB \\(1 GiB\\) and can go as high as 512,000 MiB \\(500 GiB\\)\\. Amazon S3 objects have a maximum size of 5 TB\\. \nThis parameter is not supported for Lustre file systems using the `Persistent_2` deployment type\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `512000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ImportedFileChunkSize", "type": "number" }, @@ -79453,7 +81229,7 @@ "type": "number" }, "WeeklyMaintenanceStartTime": { - "markdownDescription": "\\(Optional\\) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A recurring weekly time, in the format `D:HH:MM`\\. \n `D` is the day of the week, for which 1 represents Monday and 7 represents Sunday\\. For further details, see [the ISO\\-8601 spec as described on Wikipedia](https://en.wikipedia.org/wiki/ISO_week_date)\\. \n `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. \nFor example, `1:05:00` specifies maintenance at 5 AM Monday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WeeklyMaintenanceStartTime", "type": "string" } @@ -79488,7 +81264,7 @@ "type": "string" }, "DeploymentType": { - "markdownDescription": "Specifies the FSx for ONTAP file system deployment type to use in creating the file system\\. `MULTI_AZ_1` is the supported ONTAP deployment type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `MULTI_AZ_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the FSx for ONTAP file system deployment type to use in creating the file system\\. \n+ `MULTI_AZ_1` \\- \\(Default\\) A high availability file system configured for Multi\\-AZ redundancy to tolerate temporary Availability Zone \\(AZ\\) unavailability\\. \n+ `SINGLE_AZ_1` \\- A file system configured for Single\\-AZ redundancy\\.\nFor information about the use cases for Multi\\-AZ and Single\\-AZ deployments, refer to [Choosing a file system deployment type](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-AZ.html)\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `MULTI_AZ_1 | SINGLE_AZ_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DeploymentType", "type": "string" }, @@ -79498,7 +81274,7 @@ "title": "DiskIopsConfiguration" }, "EndpointIpAddressRange": { - "markdownDescription": "Specifies the IP address range in which the endpoints to access your file system will be created\\. By default, Amazon FSx selects an unused IP address range for you from the 198\\.19\\.\\* range\\. \nThe Endpoint IP address range you select for your file system must exist outside the VPC's CIDR range and must be at least /30 or larger\\.\n*Required*: No \n*Type*: String \n*Minimum*: `9` \n*Maximum*: `17` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{9,17}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\(Multi\\-AZ only\\) Specifies the IP address range in which the endpoints to access your file system will be created\\. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198\\.19\\.\\* range\\. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC\u2019s primary CIDR range to use as the endpoint IP address range for the file system\\. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables\\. \n*Required*: No \n*Type*: String \n*Minimum*: `9` \n*Maximum*: `17` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{9,17}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EndpointIpAddressRange", "type": "string" }, @@ -79516,12 +81292,12 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies the virtual private cloud \\(VPC\\) route tables in which your file system's endpoints will be created\\. You should specify all VPC route tables associated with the subnets in which your clients are located\\. By default, Amazon FSx selects your VPC's default route table\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\(Multi\\-AZ only\\) Specifies the virtual private cloud \\(VPC\\) route tables in which your file system's endpoints will be created\\. You should specify all VPC route tables associated with the subnets in which your clients are located\\. By default, Amazon FSx selects your VPC's default route table\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RouteTableIds", "type": "array" }, "ThroughputCapacity": { - "markdownDescription": "Sets the throughput capacity for the file system that you're creating\\. Valid values are 128, 256, 512, 1024, and 2048 MBps\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `4096` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Sets the throughput capacity for the file system that you're creating\\. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThroughputCapacity", "type": "number" }, @@ -79550,7 +81326,7 @@ "type": "boolean" }, "CopyTagsToVolumes": { - "markdownDescription": "A Boolean value indicating whether tags for the volume should be copied to snapshots\\. This value defaults to `false`\\. If it's set to `true`, all tags for the volume are copied to snapshots where the user doesn't specify tags\\. If this value is `true`, and you specify one or more tags, only the specified tags are copied to snapshots\\. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A Boolean value indicating whether tags for the file system should be copied to volumes\\. This value defaults to `false`\\. If it's set to `true`, all tags for the file system are copied to volumes where the user doesn't specify tags\\. If this value is `true`, and you specify one or more tags, only the specified tags are copied to volumes\\. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CopyTagsToVolumes", "type": "boolean" }, @@ -79560,7 +81336,7 @@ "type": "string" }, "DeploymentType": { - "markdownDescription": "Specifies the file system deployment type\\. Amazon FSx for OpenZFS supports `SINGLE_AZ_1`\\. `SINGLE_AZ_1` deployment type is configured for redundancy within a single Availability Zone\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SINGLE_AZ_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the file system deployment type\\. Single AZ deployment types are configured for redundancy within a single Availability Zone in an AWS Region \\. Valid values are the following: \n+ `SINGLE_AZ_1`\\- \\(Default\\) Creates file systems with throughput capacities of 64 \\- 4,096 MB/s\\. `Single_AZ_1` is available in all AWS Regions where Amazon FSx for OpenZFS is available, except US West \\(Oregon\\)\\.\n+ `SINGLE_AZ_2`\\- Creates file systems with throughput capacities of 160 \\- 10,240 MB/s using an NVMe L2ARC cache\\. `Single_AZ_2` is available only in the US East \\(N\\. Virginia\\), US East \\(Ohio\\), US West \\(Oregon\\), and Europe \\(Ireland\\) AWS Regions\\.\nFor more information, see: [Deployment type availability](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions) and [File system performance](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SINGLE_AZ_1 | SINGLE_AZ_2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DeploymentType", "type": "string" }, @@ -79573,6 +81349,8 @@ "items": { "type": "string" }, + "markdownDescription": "To delete a file system if there are child volumes present below the root volume, use the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`\\. If your file system has child volumes and you don't use this option, the delete request will fail\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Options", "type": "array" }, "RootVolumeConfiguration": { @@ -79581,7 +81359,7 @@ "title": "RootVolumeConfiguration" }, "ThroughputCapacity": { - "markdownDescription": "Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second \\(MB/s\\)\\. Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s\\. You pay for additional throughput capacity that you provision\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second \\(MB/s\\)\\. Valid values depend on the DeploymentType you choose, as follows: \n+ For `SINGLE_AZ_1`, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s\\.\n+ For `SINGLE_AZ_2`, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s\\.\nYou pay for additional throughput capacity that you provision\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThroughputCapacity", "type": "number" }, @@ -79623,13 +81401,15 @@ "type": "boolean" }, "RecordSizeKiB": { + "markdownDescription": "Specifies the record size of an OpenZFS root volume, in kibibytes \\(KiB\\)\\. Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB\\. The default is 128 KiB\\. Most workloads should use the default record size\\. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size\\. For additional guidance on setting a custom record size, see [ Tips for maximizing performance](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `4` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RecordSizeKiB", "type": "number" }, "UserAndGroupQuotas": { "items": { "$ref": "#/definitions/AWS::FSx::FileSystem.UserAndGroupQuotas" }, - "markdownDescription": "An object specifying how much storage users or groups can use on the volume\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html) of [UserAndGroupQuotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html) \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An object specifying how much storage users or groups can use on the volume\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html) of [UserAndGroupQuotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html) \n*Maximum*: `500` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "UserAndGroupQuotas", "type": "array" } @@ -79663,7 +81443,7 @@ "type": "string" }, "Password": { - "markdownDescription": "The password for the service account on your self\\-managed AD domain that Amazon FSx will use to join to your AD domain\\. We strongly suggest that you follow best practices and *do not* embed passwords in your CFN templates\\. \nThe recommended approach is to use AWS Secrets Manager to store your passwords\\. You can retrieve them for use in your templates using the `secretsmanager` dynamic reference\\. There are additional costs associated with using AWS Secrets Manager\\. To learn more, see [Secrets Manager secrets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) in the *AWS CloudFormation User Guide*\\. \nAlternatively, you can use the `NoEcho` property to obfuscate the password parameter value\\. For more information, see [Do Not Embed Credentials in Your Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html#creds) in the *AWS CloudFormation User Guide*\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^.{1,256}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The password for the service account on your self\\-managed AD domain that Amazon FSx will use to join to your AD domain\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^.{1,256}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Password", "type": "string" }, @@ -79700,7 +81480,7 @@ "additionalProperties": false, "properties": { "ActiveDirectoryId": { - "markdownDescription": "The ID for an existing AWS Managed Microsoft Active Directory \\(AD\\) instance that the file system should join when it's created\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `12` \n*Maximum*: `12` \n*Pattern*: `^d-[0-9a-f]{10}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID for an existing AWS Managed Microsoft Active Directory \\(AD\\) instance that the file system should join when it's created\\. Required if you are joining the file system to an existing AWS Managed Microsoft AD\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `12` \n*Maximum*: `12` \n*Pattern*: `^d-[0-9a-f]{10}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ActiveDirectoryId", "type": "string" }, @@ -79718,17 +81498,17 @@ "title": "AuditLogConfiguration" }, "AutomaticBackupRetentionDays": { - "markdownDescription": "The number of days to retain automatic backups\\. The default is to retain backups for 7 days\\. Setting this value to 0 disables the creation of automatic backups\\. The maximum retention period for backups is 90 days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `90` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of days to retain automatic backups\\. Setting this property to `0` disables automatic backups\\. You can retain automatic backups for a maximum of 90 days\\. The default is `0`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutomaticBackupRetentionDays", "type": "number" }, "CopyTagsToBackups": { - "markdownDescription": "A Boolean flag indicating whether tags for the file system should be copied to backups\\. This value defaults to false\\. If it's set to true, all tags for the file system are copied to all automatic and user\\-initiated backups where the user doesn't specify tags\\. If this value is true, and you specify one or more tags, only the specified tags are copied to backups\\. If you specify one or more tags when creating a user\\-initiated backup, no tags are copied from the file system, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A boolean flag indicating whether tags for the file system should be copied to backups\\. This value defaults to false\\. If it's set to true, all tags for the file system are copied to all automatic and user\\-initiated backups where the user doesn't specify tags\\. If this value is true, and you specify one or more tags, only the specified tags are copied to backups\\. If you specify one or more tags when creating a user\\-initiated backup, no tags are copied from the file system, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CopyTagsToBackups", "type": "boolean" }, "DailyAutomaticBackupStartTime": { - "markdownDescription": "The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A recurring daily time, in the format `HH:MM`\\. `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. For example, `05:00` specifies 5 AM daily\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DailyAutomaticBackupStartTime", "type": "string" }, @@ -79738,7 +81518,7 @@ "type": "string" }, "PreferredSubnetId": { - "markdownDescription": "Required when `DeploymentType` is set to `MULTI_AZ_1`\\. This specifies the subnet in which you want the preferred file server to be located\\. For in\\-AWS applications, we recommend that you launch your clients in the same Availability Zone \\(AZ\\) as your preferred file server to reduce cross\\-AZ data transfer costs and minimize latency\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Required when `DeploymentType` is set to `MULTI_AZ_1`\\. This specifies the subnet in which you want the preferred file server to be located\\. For in\\-AWS applications, we recommend that you launch your clients in the same availability zone as your preferred file server to reduce cross\\-availability zone data transfer costs and minimize latency\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PreferredSubnetId", "type": "string" }, @@ -79748,12 +81528,12 @@ "title": "SelfManagedActiveDirectoryConfiguration" }, "ThroughputCapacity": { - "markdownDescription": "Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second \\(MB/s\\), in 2 to the *n*th increments, between 2^3 \\(8\\) and 2^11 \\(2048\\)\\. \n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second \\(MB/s\\), in 2 to the *n*th increments, between 2^3 \\(8\\) and 2^11 \\(2048\\)\\. \n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThroughputCapacity", "type": "number" }, "WeeklyMaintenanceStartTime": { - "markdownDescription": "The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A recurring weekly time, in the format `D:HH:MM`\\. \n `D` is the day of the week, for which 1 represents Monday and 7 represents Sunday\\. For further details, see [the ISO\\-8601 spec as described on Wikipedia](https://en.wikipedia.org/wiki/ISO_week_date)\\. \n `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. \nFor example, `1:05:00` specifies maintenance at 5 AM Monday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WeeklyMaintenanceStartTime", "type": "string" } @@ -79799,15 +81579,21 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the snapshot\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `203` \n*Pattern*: `^[a-zA-Z0-9_:.-]{1,203}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "VolumeId": { + "markdownDescription": "The ID of the volume that the snapshot is of\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `23` \n*Maximum*: `23` \n*Pattern*: `^(fsvol-[0-9a-f]{17,})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VolumeId", "type": "string" } }, @@ -79874,24 +81660,36 @@ "additionalProperties": false, "properties": { "ActiveDirectoryConfiguration": { - "$ref": "#/definitions/AWS::FSx::StorageVirtualMachine.ActiveDirectoryConfiguration" + "$ref": "#/definitions/AWS::FSx::StorageVirtualMachine.ActiveDirectoryConfiguration", + "markdownDescription": "Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable\\. \n*Required*: No \n*Type*: [ActiveDirectoryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActiveDirectoryConfiguration" }, "FileSystemId": { + "markdownDescription": "Specifies the FSx for ONTAP file system on which to create the SVM\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemId", "type": "string" }, "Name": { + "markdownDescription": "The name of the SVM\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `47` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,47}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "RootVolumeSecurityStyle": { + "markdownDescription": "The security style of the root volume of the SVM\\. Specify one of the following values: \n+ `UNIX` if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account\\.\n+ `NTFS` if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account\\.\n+ `MIXED` if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `MIXED | NTFS | UNIX` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RootVolumeSecurityStyle", "type": "string" }, "SvmAdminPassword": { + "markdownDescription": "Specifies the password to use when logging on to the SVM using a secure shell \\(SSH\\) connection to the SVM's management endpoint\\. Doing so enables you to manage the SVM using the NetApp ONTAP CLI or REST API\\. If you do not specify a password, you can still use the file system's `fsxadmin` user to manage the SVM\\. For more information, see [ Managing SVMs using the NetApp ONTAP CLI](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html#vsadmin-ontap-cli) in the *FSx for ONTAP User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SvmAdminPassword", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -79926,10 +81724,14 @@ "additionalProperties": false, "properties": { "NetBiosName": { + "markdownDescription": "The NetBIOS name of the Active Directory computer object that will be created for your SVM\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `15` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NetBiosName", "type": "string" }, "SelfManagedActiveDirectoryConfiguration": { - "$ref": "#/definitions/AWS::FSx::StorageVirtualMachine.SelfManagedActiveDirectoryConfiguration" + "$ref": "#/definitions/AWS::FSx::StorageVirtualMachine.SelfManagedActiveDirectoryConfiguration", + "markdownDescription": "The configuration that Amazon FSx uses to join the ONTAP storage virtual machine \\(SVM\\) to your self\\-managed \\(including on\\-premises\\) Microsoft Active Directory \\(AD\\) directory\\. \n*Required*: No \n*Type*: [SelfManagedActiveDirectoryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SelfManagedActiveDirectoryConfiguration" } }, "type": "object" @@ -79941,21 +81743,33 @@ "items": { "type": "string" }, + "markdownDescription": "A list of up to three IP addresses of DNS servers or domain controllers in the self\\-managed AD directory\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DnsIps", "type": "array" }, "DomainName": { + "markdownDescription": "The fully qualified domain name of the self\\-managed AD directory, such as `corp.example.com`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DomainName", "type": "string" }, "FileSystemAdministratorsGroup": { + "markdownDescription": "\\(Optional\\) The name of the domain group whose members are granted administrative privileges for the file system\\. Administrative privileges include taking ownership of files and folders, setting audit controls \\(audit ACLs\\) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell\\. The group that you specify must already exist in your domain\\. If you don't provide one, your AD domain's Domain Admins group is used\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemAdministratorsGroup", "type": "string" }, "OrganizationalUnitDistinguishedName": { + "markdownDescription": "\\(Optional\\) The fully qualified distinguished name of the organizational unit within your self\\-managed AD directory\\. Amazon FSx only accepts OU as the direct parent of the file system\\. An example is `OU=FSx,DC=yourdomain,DC=corp,DC=com`\\. To learn more, see [RFC 2253](https://tools.ietf.org/html/rfc2253)\\. If none is provided, the FSx file system is created in the default location of your self\\-managed AD directory\\. \nOnly Organizational Unit \\(OU\\) objects can be the direct parent of the file system that you're creating\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2000` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,2000}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OrganizationalUnitDistinguishedName", "type": "string" }, "Password": { + "markdownDescription": "The password for the service account on your self\\-managed AD domain that Amazon FSx will use to join to your AD domain\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^.{1,256}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Password", "type": "string" }, "UserName": { + "markdownDescription": "The user name for the service account on your self\\-managed AD domain that Amazon FSx will use to join to your AD domain\\. This account must have the permission to join computers to the domain in the organizational unit provided in `OrganizationalUnitDistinguishedName`, or in the default location of your AD domain\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserName", "type": "string" } }, @@ -79997,24 +81811,36 @@ "additionalProperties": false, "properties": { "BackupId": { + "markdownDescription": "Specifies the ID of the volume backup to use to create a new volume\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BackupId", "type": "string" }, "Name": { + "markdownDescription": "The name of the volume\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `203` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,203}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "OntapConfiguration": { - "$ref": "#/definitions/AWS::FSx::Volume.OntapConfiguration" + "$ref": "#/definitions/AWS::FSx::Volume.OntapConfiguration", + "markdownDescription": "The configuration of an Amazon FSx for NetApp ONTAP volume\\. \n*Required*: No \n*Type*: [OntapConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OntapConfiguration" }, "OpenZFSConfiguration": { - "$ref": "#/definitions/AWS::FSx::Volume.OpenZFSConfiguration" + "$ref": "#/definitions/AWS::FSx::Volume.OpenZFSConfiguration", + "markdownDescription": "The configuration of an Amazon FSx for OpenZFS volume\\. \n*Required*: No \n*Type*: [OpenZFSConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OpenZFSConfiguration" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "VolumeType": { + "markdownDescription": "The type of the volume\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ONTAP | OPENZFS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VolumeType", "type": "string" } }, @@ -80048,12 +81874,16 @@ "additionalProperties": false, "properties": { "Clients": { + "markdownDescription": "A value that specifies who can mount the file system\\. You can provide a wildcard character \\(`*`\\), an IP address \\(`0.0.0.0`\\), or a CIDR address \\(`192.0.2.0/24`\\)\\. By default, Amazon FSx uses the wildcard character when specifying the client\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[ -~]{1,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Clients", "type": "string" }, "Options": { "items": { "type": "string" }, + "markdownDescription": "The options to use when mounting the file system\\. For a list of options that you can use with Network File System \\(NFS\\), see the [exports\\(5\\) \\- Linux man page](https://linux.die.net/man/5/exports)\\. When choosing your options, consider the following: \n+ `crossmnt` is used by default\\. If you don't specify `crossmnt` when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory\\.\n+ `sync` is used by default\\. If you instead specify `async`, the system acknowledges writes before writing to disk\\. If the system crashes before the writes are finished, you lose the unwritten data\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Options", "type": "array" } }, @@ -80070,6 +81900,8 @@ "items": { "$ref": "#/definitions/AWS::FSx::Volume.ClientConfigurations" }, + "markdownDescription": "A list of configuration objects that contain the client and options for mounting the OpenZFS file system\\. \n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports-clientconfigurations.html) of [ClientConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports-clientconfigurations.html) \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientConfigurations", "type": "array" } }, @@ -80082,31 +81914,49 @@ "additionalProperties": false, "properties": { "CopyTagsToBackups": { + "markdownDescription": "A boolean flag indicating whether tags for the volume should be copied to backups\\. This value defaults to false\\. If it's set to true, all tags for the volume are copied to all automatic and user\\-initiated backups where the user doesn't specify tags\\. If this value is true, and you specify one or more tags, only the specified tags are copied to backups\\. If you specify one or more tags when creating a user\\-initiated backup, no tags are copied from the volume, regardless of this value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CopyTagsToBackups", "type": "string" }, "JunctionPath": { + "markdownDescription": "Specifies the location in the SVM's namespace where the volume is mounted\\. The `JunctionPath` must have a leading forward slash, such as `/vol3`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "JunctionPath", "type": "string" }, "OntapVolumeType": { + "markdownDescription": "Specifies the type of volume you are creating\\. Valid values are the following: \n+ `RW` specifies a read/write volume\\. `RW` is the default\\.\n+ `DP` specifies a data\\-protection volume\\. A `DP` volume is read\\-only and can be used as the destination of a NetApp SnapMirror relationship\\.\nFor more information, see [Volume types](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types) in the *Amazon FSx for NetApp ONTAP User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DP | RW` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OntapVolumeType", "type": "string" }, "SecurityStyle": { + "markdownDescription": "Specifies the security style for the volume\\. If a volume's security style is not specified, it is automatically set to the root volume's security style\\. The security style determines the type of permissions that FSx for ONTAP uses to control data access\\. For more information, see [Volume security style](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style) in the *Amazon FSx for NetApp ONTAP User Guide*\\. Specify one of the following values: \n+ `UNIX` if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account\\. \n+ `NTFS` if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account\\.\n+ `MIXED` if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `MIXED | NTFS | UNIX` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityStyle", "type": "string" }, "SizeInMegabytes": { + "markdownDescription": "Specifies the size of the volume, in megabytes \\(MB\\), that you are creating\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SizeInMegabytes", "type": "string" }, "SnapshotPolicy": { + "markdownDescription": "Specifies the snapshot policy for the volume\\. There are three built\\-in snapshot policies: \n+ `default`: This is the default policy\\. A maximum of six hourly snapshots taken five minutes past the hour\\. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight\\. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight\\.\n+ `default-1weekly`: This policy is the same as the `default` policy except that it only retains one snapshot from the weekly schedule\\.\n+ `none`: This policy does not take any snapshots\\. This policy can be assigned to volumes to prevent automatic snapshots from being taken\\.\nYou can also provide the name of a custom policy that you created with the ONTAP CLI or REST API\\. \nFor more information, see [Snapshot policies](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies) in the *Amazon FSx for NetApp ONTAP User Guide*\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SnapshotPolicy", "type": "string" }, "StorageEfficiencyEnabled": { + "markdownDescription": "Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageEfficiencyEnabled", "type": "string" }, "StorageVirtualMachineId": { + "markdownDescription": "Specifies the ONTAP SVM in which to create the volume\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `21` \n*Maximum*: `21` \n*Pattern*: `^(svm-[0-9a-f]{17,})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StorageVirtualMachineId", "type": "string" }, "TieringPolicy": { - "$ref": "#/definitions/AWS::FSx::Volume.TieringPolicy" + "$ref": "#/definitions/AWS::FSx::Volume.TieringPolicy", + "markdownDescription": "Describes the data tiering policy for an ONTAP volume\\. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns\\. \nValid tiering policies are the following: \n+ `SNAPSHOT_ONLY` \\- \\(Default value\\) moves cold snapshots to the capacity pool storage tier\\.\n+ `AUTO` \\- moves cold user data and snapshots to the capacity pool storage tier based on your access patterns\\.\n+ `ALL` \\- moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier\\.\n+ `NONE` \\- keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier\\.\n*Required*: No \n*Type*: [TieringPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-tieringpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TieringPolicy" } }, "required": [ @@ -80119,45 +81969,67 @@ "additionalProperties": false, "properties": { "CopyTagsToSnapshots": { + "markdownDescription": "A Boolean value indicating whether tags for the volume should be copied to snapshots\\. This value defaults to `false`\\. If it's set to `true`, all tags for the volume are copied to snapshots where the user doesn't specify tags\\. If this value is `true`, and you specify one or more tags, only the specified tags are copied to snapshots\\. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CopyTagsToSnapshots", "type": "boolean" }, "DataCompressionType": { + "markdownDescription": "Specifies the method used to compress the data on the volume\\. The compression type is `NONE` by default\\. \n+ `NONE` \\- Doesn't compress the data on the volume\\. `NONE` is the default\\.\n+ `ZSTD` \\- Compresses the data in the volume using the Zstandard \\(ZSTD\\) compression algorithm\\. Compared to LZ4, Z\\-Standard provides a better compression ratio to minimize on\\-disk storage utilization\\.\n+ `LZ4` \\- Compresses the data in the volume using the LZ4 compression algorithm\\. Compared to Z\\-Standard, LZ4 is less compute\\-intensive and delivers higher write throughput speeds\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `LZ4 | NONE | ZSTD` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataCompressionType", "type": "string" }, "NfsExports": { "items": { "$ref": "#/definitions/AWS::FSx::Volume.NfsExports" }, + "markdownDescription": "The configuration object for mounting a Network File System \\(NFS\\) file system\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports.html) of [NfsExports](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NfsExports", "type": "array" }, "Options": { "items": { "type": "string" }, + "markdownDescription": "To delete the volume's child volumes, snapshots, and clones, use the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Options", "type": "array" }, "OriginSnapshot": { - "$ref": "#/definitions/AWS::FSx::Volume.OriginSnapshot" + "$ref": "#/definitions/AWS::FSx::Volume.OriginSnapshot", + "markdownDescription": "The configuration object that specifies the snapshot to use as the origin of the data for the volume\\. \n*Required*: No \n*Type*: [OriginSnapshot](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-originsnapshot.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OriginSnapshot" }, "ParentVolumeId": { + "markdownDescription": "The ID of the volume to use as the parent volume of the volume that you are creating\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `23` \n*Maximum*: `23` \n*Pattern*: `^(fsvol-[0-9a-f]{17,})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ParentVolumeId", "type": "string" }, "ReadOnly": { + "markdownDescription": "A Boolean value indicating whether the volume is read\\-only\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReadOnly", "type": "boolean" }, "RecordSizeKiB": { + "markdownDescription": "Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes \\(KiB\\)\\. Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB\\. The default is 128 KiB\\. We recommend using the default setting for the majority of use cases\\. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads \\(small record size\\) or media streaming workloads \\(large record size\\)\\. For additional guidance on when to set a custom record size, see [ ZFS Record size](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `4` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RecordSizeKiB", "type": "number" }, "StorageCapacityQuotaGiB": { + "markdownDescription": "Sets the maximum storage size in gibibytes \\(GiB\\) for the volume\\. You can specify a quota that is larger than the storage on the parent volume\\. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume\\. To guarantee quota space, you must also set `StorageCapacityReservationGiB`\\. To *not* specify a storage capacity quota, set this to `-1`\\. \nFor more information, see [Volume properties](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `-1` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageCapacityQuotaGiB", "type": "number" }, "StorageCapacityReservationGiB": { + "markdownDescription": "Specifies the amount of storage in gibibytes \\(GiB\\) to reserve from the parent volume\\. Setting `StorageCapacityReservationGiB` guarantees that the specified amount of storage space on the parent volume will always be available for the volume\\. You can't reserve more storage than the parent volume has\\. To *not* specify a storage capacity reservation, set this to `0` or `-1`\\. For more information, see [Volume properties](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `-1` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageCapacityReservationGiB", "type": "number" }, "UserAndGroupQuotas": { "items": { "$ref": "#/definitions/AWS::FSx::Volume.UserAndGroupQuotas" }, + "markdownDescription": "An object specifying how much storage users or groups can use on the volume\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-userandgroupquotas.html) of [UserAndGroupQuotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-userandgroupquotas.html) \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserAndGroupQuotas", "type": "array" } }, @@ -80170,9 +82042,13 @@ "additionalProperties": false, "properties": { "CopyStrategy": { + "markdownDescription": "The strategy used when copying data from the snapshot to the new volume\\. \n+ `CLONE` \\- The new volume references the data in the origin snapshot\\. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput\\. However, the origin snapshot can't be deleted if there is a volume using its copied data\\. \n+ `FULL_COPY` \\- Copies all data from the snapshot to the new volume\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CLONE | FULL_COPY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CopyStrategy", "type": "string" }, "SnapshotARN": { + "markdownDescription": "Specifies the snapshot to use when creating an OpenZFS volume from a snapshot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SnapshotARN", "type": "string" } }, @@ -80186,9 +82062,13 @@ "additionalProperties": false, "properties": { "CoolingPeriod": { + "markdownDescription": "Specifies the number of days that user data in a volume must remain inactive before it is considered \"cold\" and moved to the capacity pool\\. Used with the `AUTO` and `SNAPSHOT_ONLY` tiering policies\\. Enter a whole number between 2 and 183\\. Default values are 31 days for `AUTO` and 2 days for `SNAPSHOT_ONLY`\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `183` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CoolingPeriod", "type": "number" }, "Name": { + "markdownDescription": "Specifies the tiering policy used to transition data\\. Default value is `SNAPSHOT_ONLY`\\. \n+ `SNAPSHOT_ONLY` \\- moves cold snapshots to the capacity pool storage tier\\.\n+ `AUTO` \\- moves cold user data and snapshots to the capacity pool storage tier based on your access patterns\\.\n+ `ALL` \\- moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier\\.\n+ `NONE` \\- keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ALL | AUTO | NONE | SNAPSHOT_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -80198,12 +82078,18 @@ "additionalProperties": false, "properties": { "Id": { + "markdownDescription": "The ID of the user or group\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id", "type": "number" }, "StorageCapacityQuotaGiB": { + "markdownDescription": "The amount of storage that the user or group can use in gibibytes \\(GiB\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageCapacityQuotaGiB", "type": "number" }, "Type": { + "markdownDescription": "A value that specifies whether the quota applies to a user or group\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `GROUP | USER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -80407,7 +82293,7 @@ "additionalProperties": false, "properties": { "DataFrequency": { - "markdownDescription": "The frequency of data collection\\. This parameter is required for RELATED\\_TIME\\_SERIES datasets\\. \nValid intervals are Y \\(Year\\), M \\(Month\\), W \\(Week\\), D \\(Day\\), H \\(Hour\\), 30min \\(30 minutes\\), 15min \\(15 minutes\\), 10min \\(10 minutes\\), 5min \\(5 minutes\\), and 1min \\(1 minute\\)\\. For example, \"D\" indicates every day and \"15min\" indicates every 15 minutes\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `5` \n*Pattern*: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The frequency of data collection\\. This parameter is required for RELATED\\_TIME\\_SERIES datasets\\. \nValid intervals are an integer followed by Y \\(Year\\), M \\(Month\\), W \\(Week\\), D \\(Day\\), H \\(Hour\\), and min \\(Minute\\)\\. For example, \"1D\" indicates every day and \"15min\" indicates every 15 minutes\\. You cannot specify a value that would overlap with the next larger frequency\\. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour\\. The valid values for each frequency are the following: \n+ Minute \\- 1\\-59\n+ Hour \\- 1\\-23\n+ Day \\- 1\\-6\n+ Week \\- 1\\-4\n+ Month \\- 1\\-11\n+ Year \\- 1\nThus, if you want every other week forecasts, specify \"2W\"\\. Or, if you want quarterly forecasts, you specify \"3M\"\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `5` \n*Pattern*: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataFrequency", "type": "string" }, @@ -80428,19 +82314,19 @@ }, "EncryptionConfig": { "$ref": "#/definitions/AWS::Forecast::Dataset.EncryptionConfig", - "markdownDescription": "A Key Management Service \\(KMS\\) key and the Identity and Access Management \\(IAM\\) role that Amazon Forecast can assume to access the key\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A Key Management Service \\(KMS\\) key and the Identity and Access Management \\(IAM\\) role that Amazon Forecast can assume to access the key\\. \n*Required*: No \n*Type*: [EncryptionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-encryptionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EncryptionConfig" }, "Schema": { "$ref": "#/definitions/AWS::Forecast::Dataset.Schema", - "markdownDescription": "The schema for the dataset\\. The schema attributes and their order must match the fields in your data\\. The dataset `Domain` and `DatasetType` that you choose determine the minimum required fields in your training data\\. For information about the required fields for a specific dataset domain and type, see [Dataset Domains and Dataset Types](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html)\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The schema for the dataset\\. The schema attributes and their order must match the fields in your data\\. The dataset `Domain` and `DatasetType` that you choose determine the minimum required fields in your training data\\. For information about the required fields for a specific dataset domain and type, see [Dataset Domains and Dataset Types](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html)\\. \n*Required*: Yes \n*Type*: [Schema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-schema.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Schema" }, "Tags": { "items": { "$ref": "#/definitions/AWS::Forecast::Dataset.TagsItems" }, - "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [TagsItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-tagsitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -80478,9 +82364,13 @@ "additionalProperties": false, "properties": { "AttributeName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AttributeName", "type": "string" }, "AttributeType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AttributeType", "type": "string" } }, @@ -80490,9 +82380,13 @@ "additionalProperties": false, "properties": { "KmsKeyArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the KMS key\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:aws:kms:.*:key/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyArn", "type": "string" }, "RoleArn": { + "markdownDescription": "The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key\\. \nPassing a role across AWS accounts is not allowed\\. If you pass a role that isn't in your account, you get an `InvalidInputException` error\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:([a-z\\d-]+):forecast:.*:.*:.+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" } }, @@ -80505,6 +82399,8 @@ "items": { "$ref": "#/definitions/AWS::Forecast::Dataset.AttributesItems" }, + "markdownDescription": "An array of attributes specifying the name and type of each field in a dataset\\. \n*Required*: No \n*Type*: List of [AttributesItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-attributesitems.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Attributes", "type": "array" } }, @@ -80514,9 +82410,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -81815,13 +83715,13 @@ "type": "string" }, "OperatingSystem": { - "markdownDescription": "The operating system that the game server binaries are built to run on\\. This value determines the type of fleet resources that you can use for this build\\. If your game build contains multiple executables, they all must run on the same operating system\\. If an operating system is not specified when creating a build, Amazon GameLift uses the default value \\(WINDOWS\\_2012\\)\\. This value cannot be changed later\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AMAZON_LINUX | AMAZON_LINUX_2 | WINDOWS_2012` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The operating system that you built the game server binaries to run on\\. This value determines the type of fleet resources that you can use for this build\\. If your game build contains multiple executables, they all must run on the same operating system\\. If an operating system is not specified when creating a build, GameLift uses the default value \\(WINDOWS\\_2012\\)\\. This value cannot be changed later\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AMAZON_LINUX | AMAZON_LINUX_2 | WINDOWS_2012` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "OperatingSystem", "type": "string" }, "StorageLocation": { "$ref": "#/definitions/AWS::GameLift::Build.StorageLocation", - "markdownDescription": "Information indicating where your game build files are stored\\. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own\\. The storage location must specify an Amazon S3 bucket name and key\\. The location must also specify a role ARN that you set up to allow Amazon Web Services to access your Amazon S3 bucket\\. The S3 bucket and your new build must be in the same Region\\. \nIf a `StorageLocation` is specified, the size of your file can be found in your Amazon S3 bucket\\. Amazon Web Services will report a `SizeOnDisk` of 0\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Information indicating where your game build files are stored\\. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own\\. The storage location must specify an Amazon S3 bucket name and key\\. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket\\. The S3 bucket and your new build must be in the same Region\\. \nIf a `StorageLocation` is specified, the size of your file can be found in your Amazon S3 bucket\\. Amazon GameLift will report a `SizeOnDisk` of 0\\. \n*Required*: No \n*Type*: [StorageLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StorageLocation" }, "Version": { @@ -81856,15 +83756,23 @@ "additionalProperties": false, "properties": { "Bucket": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Bucket", "type": "string" }, "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" }, "ObjectVersion": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ObjectVersion", "type": "string" }, "RoleArn": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RoleArn", "type": "string" } }, @@ -81911,7 +83819,9 @@ "additionalProperties": false, "properties": { "AnywhereConfiguration": { - "$ref": "#/definitions/AWS::GameLift::Fleet.AnywhereConfiguration" + "$ref": "#/definitions/AWS::GameLift::Fleet.AnywhereConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AnywhereConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-anywhereconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AnywhereConfiguration" }, "BuildId": { "markdownDescription": "A unique identifier for a build to be deployed on the new fleet\\. If you are deploying the fleet with a custom game build, you must specify this property\\. The build must have been successfully uploaded to Amazon GameLift and be in a `READY` status\\. This fleet setting cannot be changed once the fleet is created\\. \n*Required*: Conditional \n*Type*: String \n*Pattern*: `^build-\\S+|^arn:.*:build\\/build-\\S+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -81920,14 +83830,16 @@ }, "CertificateConfiguration": { "$ref": "#/definitions/AWS::GameLift::Fleet.CertificateConfiguration", - "markdownDescription": "Prompts GameLift to generate a TLS/SSL certificate for the fleet\\. TLS certificates are used for encrypting traffic between game clients and the game servers that are running on GameLift\\. By default, the `CertificateConfiguration` is set to `DISABLED`\\. This property cannot be changed after the fleet is created\\. \nNote: This feature requires the AWS Certificate Manager \\(ACM\\) service, which is not available in all AWS regions\\. When working in a region that does not support this feature, a fleet creation request with certificate generation fails with a 4xx error\\. \n*Required*: No \n*Type*: [CertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Prompts GameLift to generate a TLS/SSL certificate for the fleet\\. GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift\\. By default, the `CertificateConfiguration` is `DISABLED`\\. You can't change this property after you create the fleet\\. \n AWS Certificate Manager \\(ACM\\) certificates expire after 13 months\\. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet\\. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition\\. \nACM isn't available in all AWS regions\\. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error\\. For more information about the supported Regions, see [Supported Regions](https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html) in the * AWS Certificate Manager User Guide*\\.\n*Required*: No \n*Type*: [CertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CertificateConfiguration" }, "ComputeType": { + "markdownDescription": "The type of compute resource used to host your game servers\\. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ANYWHERE | EC2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ComputeType", "type": "string" }, "Description": { - "markdownDescription": "A human\\-readable description of the fleet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description for the fleet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -81945,7 +83857,7 @@ "type": "array" }, "EC2InstanceType": { - "markdownDescription": "The GameLift\\-supported Amazon EC2 instance type to use for all fleet instances\\. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity\\. See [Amazon Elastic Compute Cloud Instance Types](http://aws.amazon.com/ec2/instance-types/) for detailed descriptions of Amazon EC2 instance types\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | t2.large | t2.medium | t2.micro | t2.small` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The GameLift\\-supported Amazon EC2 instance type to use for all fleet instances\\. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity\\. See [Amazon Elastic Compute Cloud Instance Types](http://aws.amazon.com/ec2/instance-types/) for detailed descriptions of Amazon EC2 instance types\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.xlarge | t2.large | t2.medium | t2.micro | t2.small` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EC2InstanceType", "type": "string" }, @@ -81986,7 +83898,7 @@ "type": "number" }, "Name": { - "markdownDescription": "A descriptive label that is associated with a fleet\\. Fleet names do not need to be unique\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A descriptive label that is associated with a fleet\\. Fleet names do not need to be unique\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -82001,7 +83913,7 @@ "type": "string" }, "PeerVpcId": { - "markdownDescription": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet\\. The VPC must be in the same Region as your fleet\\. To look up a VPC ID, use the [VPC Dashboard](https://console.aws.amazon.com/vpc/) in the AWS Management Console\\. Learn more about VPC peering in [VPC Peering with GameLift Fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet\\. The VPC must be in the same Region as your fleet\\. To look up a VPC ID, use the [VPC Dashboard](https://console.aws.amazon.com/vpc/) in the AWS Management Console\\. Learn more about VPC peering in [VPC Peering with GameLift Fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PeerVpcId", "type": "string" }, @@ -82051,6 +83963,8 @@ "additionalProperties": false, "properties": { "Cost": { + "markdownDescription": "The cost to run your fleet per hour\\. GameLift uses the provided cost of your fleet to balance usage in queues\\. For more information about queues, see [Setting up queues](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) in the *Amazon GameLift Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `11` \n*Pattern*: `^\\d{1,5}(?:\\.\\d{1,5})?$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cost", "type": "string" } }, @@ -82135,7 +84049,7 @@ "additionalProperties": false, "properties": { "Location": { - "markdownDescription": "An AWS Region code, such as `us-west-2`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-z]+(-([a-z]+|\\d))*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An AWS Region code, such as `us-west-2`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[A-Za-z0-9\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Location", "type": "string" }, @@ -82154,7 +84068,7 @@ "additionalProperties": false, "properties": { "NewGameSessionsPerCreator": { - "markdownDescription": "The maximum number of game sessions that an individual can create during the policy period\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A policy that puts limits on the number of game sessions that a player can create within a specified span of time\\. With this policy, you can control players' ability to consume available resources\\. \nThe policy is evaluated when a player tries to create a new game session\\. On receiving a `CreateGameSession` request, GameLift checks that the player \\(identified by `CreatorId`\\) has created fewer than game session limit in the specified time period\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NewGameSessionsPerCreator", "type": "number" }, @@ -82299,7 +84213,7 @@ "type": "number" }, "RoleArn": { - "markdownDescription": "The Amazon Resource Name \\([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)\\) for an IAM role that allows Amazon Web Services to access your Amazon EC2 Auto Scaling groups\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^arn:.*:role\\/[\\w+=,.@-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)\\) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^arn:.*:role\\/[\\w+=,.@-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RoleArn", "type": "string" }, @@ -82458,7 +84372,7 @@ "additionalProperties": false, "properties": { "CustomEventData": { - "markdownDescription": "Information to be added to all events that are related to this game session queue\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Information to be added to all events that are related to this game session queue\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomEventData", "type": "string" }, @@ -82542,7 +84456,7 @@ "additionalProperties": false, "properties": { "DestinationArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) that is assigned to fleet or fleet alias\\. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9:/-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) that is assigned to fleet or fleet alias\\. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9:/-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DestinationArn", "type": "string" } @@ -82637,12 +84551,16 @@ "additionalProperties": false, "properties": { "LocationName": { + "markdownDescription": "The location's name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[A-Za-z0-9\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LocationName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -82733,7 +84651,7 @@ "type": "string" }, "Description": { - "markdownDescription": "A descriptive label that is associated with matchmaking configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description for the matchmaking configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -82964,7 +84882,7 @@ }, "StorageLocation": { "$ref": "#/definitions/AWS::GameLift::Script.S3Location", - "markdownDescription": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored\\. The storage location must specify the Amazon S3 bucket name, the zip file name \\(the \"key\"\\), and a role ARN that allows Amazon Web Services to access the Amazon S3 storage location\\. The S3 bucket must be in the same Region where you want to create a new script\\. By default, Amazon Web Services uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the `ObjectVersion` parameter to specify an earlier version\\. \n*Required*: Yes \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored\\. The storage location must specify the Amazon S3 bucket name, the zip file name \\(the \"key\"\\), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location\\. The S3 bucket must be in the same Region where you want to create a new script\\. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the `ObjectVersion` parameter to specify an earlier version\\. \n*Required*: Yes \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StorageLocation" }, "Tags": { @@ -83011,7 +84929,7 @@ "additionalProperties": false, "properties": { "Bucket": { - "markdownDescription": "An Amazon S3 bucket identifier\\. This is the name of the S3 bucket\\. \nGameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot \\(\\.\\)\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An Amazon S3 bucket identifier\\. Thename of the S3 bucket\\. \nGameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot \\(\\.\\)\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Bucket", "type": "string" }, @@ -83021,12 +84939,12 @@ "type": "string" }, "ObjectVersion": { - "markdownDescription": "The version of the file, if object versioning is turned on for the bucket\\. Amazon Web Services uses this information when retrieving files from an S3 bucket that you own\\. Use this parameter to specify a specific version of the file\\. If not set, the latest version of the file is retrieved\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the file, if object versioning is turned on for the bucket\\. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own\\. Use this parameter to specify a specific version of the file\\. If not set, the latest version of the file is retrieved\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ObjectVersion", "type": "string" }, "RoleArn": { - "markdownDescription": "The Amazon Resource Name \\([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)\\) for an IAM role that allows Amazon Web Services to access the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)\\) for an IAM role that allows Amazon GameLift to access the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RoleArn", "type": "string" } @@ -83079,7 +84997,7 @@ "type": "boolean" }, "IpAddressType": { - "markdownDescription": "The value for the address type must be IPv4\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IPV4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The IP address type that an accelerator supports\\. For a standard accelerator, the value can be IPV4 or DUAL\\_STACK\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DUAL_STACK | IPV4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IpAddressType", "type": "string" }, @@ -83092,7 +85010,7 @@ "type": "array" }, "Name": { - "markdownDescription": "The name of the accelerator\\. The name must contain only alphanumeric characters or hyphens \\(\\-\\), and must not begin or end with a hyphen\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the accelerator\\. The name must contain only alphanumeric characters or hyphens \\(\\-\\), and must not begin or end with a hyphen\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -83208,7 +85126,7 @@ "items": { "$ref": "#/definitions/AWS::GlobalAccelerator::EndpointGroup.PortOverride" }, - "markdownDescription": "Allows you to override the destination ports used to route traffic to an endpoint\\. Using a port override lets you to map a list of external destination ports \\(that your users send traffic to\\) to a list of internal destination ports that you want an application endpoint to receive traffic on\\. \n*Required*: No \n*Type*: List of [PortOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-portoverride.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Allows you to override the destination ports used to route traffic to an endpoint\\. Using a port override lets you map a list of external destination ports \\(that your users send traffic to\\) to a list of internal destination ports that you want an application endpoint to receive traffic on\\. \n*Required*: No \n*Type*: List of [PortOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-portoverride.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PortOverrides", "type": "array" }, @@ -83488,7 +85406,7 @@ "type": "boolean" }, "ContainsHeader": { - "markdownDescription": "Indicates whether the CSV file contains a header\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether the CSV file contains a header\\. \nA value of `UNKNOWN` specifies that the classifier will detect whether the CSV file contains headings\\. \nA value of `PRESENT` specifies that the CSV file contains headings\\. \nA value of `ABSENT` specifies that the CSV file does not contain headings\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContainsHeader", "type": "string" }, @@ -83679,7 +85597,7 @@ "type": "object" }, "ConnectionType": { - "markdownDescription": "The type of the connection\\. Currently, these types are supported: \n+ `JDBC` \\- Designates a connection to a database through Java Database Connectivity \\(JDBC\\)\\.\n+ `KAFKA` \\- Designates a connection to an Apache Kafka streaming platform\\.\n+ `MONGODB` \\- Designates a connection to a MongoDB document database\\.\n+ `NETWORK` \\- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment \\(Amazon VPC\\)\\.\nSFTP is not supported\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of the connection\\. Currently, these types are supported: \n+ `JDBC` \\- Designates a connection to a database through Java Database Connectivity \\(JDBC\\)\\.", "title": "ConnectionType", "type": "string" }, @@ -83697,7 +85615,7 @@ "type": "array" }, "Name": { - "markdownDescription": "The name of the connection\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the connection\\. Connection will not function as expected without a name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -83775,7 +85693,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of UTF\\-8 strings that specify the custom classifiers that are associated with the crawler\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of UTF\\-8 strings that specify the names of custom classifiers that are associated with the crawler\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Classifiers", "type": "array" }, @@ -83821,7 +85739,7 @@ }, "SchemaChangePolicy": { "$ref": "#/definitions/AWS::Glue::Crawler.SchemaChangePolicy", - "markdownDescription": "The policy that specifies update and delete behaviors for the crawler\\. \n*Required*: No \n*Type*: [SchemaChangePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The policy that specifies update and delete behaviors for the crawler\\. The policy tells the crawler what to do in the event that it detects a change in a table that already exists in the customer's database at the time of the crawl\\. The `SchemaChangePolicy` does not affect whether or how new tables and partitions are added\\. New tables and partitions are always created regardless of the `SchemaChangePolicy` on a crawler\\. \nThe SchemaChangePolicy consists of two components, `UpdateBehavior` and `DeleteBehavior`\\. \n*Required*: No \n*Type*: [SchemaChangePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SchemaChangePolicy" }, "TablePrefix": { @@ -83957,12 +85875,12 @@ "type": "string" }, "DlqEventQueueArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A valid Amazon dead\\-letter SQS ARN\\. For example, `arn:aws:sqs:region:account:deadLetterQueue`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DlqEventQueueArn", "type": "string" }, "EventQueueArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A valid Amazon SQS ARN\\. For example, `arn:aws:sqs:region:account:sqs`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventQueueArn", "type": "string" }, @@ -84002,12 +85920,12 @@ "additionalProperties": false, "properties": { "DeleteBehavior": { - "markdownDescription": "The deletion behavior when the crawler finds a deleted object\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The deletion behavior when the crawler finds a deleted object\\. \nA value of `LOG` specifies that if a table or partition is found to no longer exist, do not delete it, only log that it was found to no longer exist\\. \nA value of `DELETE_FROM_DATABASE` specifies that if a table or partition is found to have been removed, delete it from the database\\. \nA value of `DEPRECATE_IN_DATABASE` specifies that if a table has been found to no longer exist, to add a property to the table that says \"DEPRECATED\" and includes a timestamp with the time of deprecation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeleteBehavior", "type": "string" }, "UpdateBehavior": { - "markdownDescription": "The update behavior when the crawler finds a changed schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The update behavior when the crawler finds a changed schema\\. \nA value of `LOG` specifies that if a table or a partition already exists, and a change is detected, do not update it, only log that a change was detected\\. Add new tables and new partitions \\(including on existing tables\\)\\. \nA value of `UPDATE_IN_DATABASE` specifies that if a table or partition already exists, and a change is detected, update it\\. Add new tables and partitions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UpdateBehavior", "type": "string" } @@ -84288,7 +86206,7 @@ "items": { "$ref": "#/definitions/AWS::Glue::Database.PrincipalPrivileges" }, - "markdownDescription": "Creates a set of default permissions on the table for principals\\. \n*Required*: No \n*Type*: List of [PrincipalPrivileges](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-principalprivileges.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Creates a set of default permissions on the table for principals\\. Used by AWS Lake Formation\\. Not used in the normal course of AWS Glue operations\\. \n*Required*: No \n*Type*: List of [PrincipalPrivileges](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-principalprivileges.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CreateTableDefaultPermissions", "type": "array" }, @@ -84518,7 +86436,7 @@ "additionalProperties": false, "properties": { "AllocatedCapacity": { - "markdownDescription": "The number of capacity units that are allocated to this job\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This parameter is no longer supported\\. Use `MaxCapacity` instead\\. \nThe number of capacity units that are allocated to this job\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllocatedCapacity", "type": "number" }, @@ -84543,6 +86461,8 @@ "type": "string" }, "ExecutionClass": { + "markdownDescription": "Indicates whether the job is run with a standard or flexible execution class\\. The standard execution class is ideal for time\\-sensitive workloads that require fast job startup and dedicated resources\\. \nThe flexible execution class is appropriate for time\\-insensitive jobs whose start and completion times may vary\\. \nOnly jobs with AWS Glue version 3\\.0 and above and command type `glueetl` will be allowed to set `ExecutionClass` to `FLEX`\\. The flexible execution class is available for Spark jobs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExecutionClass", "type": "string" }, "ExecutionProperty": { @@ -84576,6 +86496,8 @@ "type": "string" }, "NonOverridableArguments": { + "markdownDescription": "Non\\-overridable arguments for this job, specified as name\\-value pairs\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NonOverridableArguments", "type": "object" }, "NotificationProperty": { @@ -84675,7 +86597,7 @@ "type": "string" }, "PythonVersion": { - "markdownDescription": "The Python version being used to execute a Python shell job\\. Allowed values are 2 or 3\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Python version being used to execute a Python shell job\\. Allowed values are 3 or 3\\.9\\. Version 2 is deprecated\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PythonVersion", "type": "string" }, @@ -85749,7 +87671,7 @@ "additionalProperties": false, "properties": { "CloudWatchEncryptionMode": { - "markdownDescription": "The encryption mode to use for CloudWatch data\\. \n*Required*: No \n*Type*: String \n*Allowed Values*: `DISABLED | SSE-KMS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The encryption mode to use for CloudWatch data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchEncryptionMode", "type": "string" }, @@ -85786,7 +87708,7 @@ "additionalProperties": false, "properties": { "JobBookmarksEncryptionMode": { - "markdownDescription": "The encryption mode to use for job bookmarks data\\. \n*Required*: No \n*Type*: String \n*Allowed Values*: `DISABLED | CSE-KMS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The encryption mode to use for job bookmarks data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "JobBookmarksEncryptionMode", "type": "string" }, @@ -85807,7 +87729,7 @@ "type": "string" }, "S3EncryptionMode": { - "markdownDescription": "The encryption mode to use for Amazon S3 data\\. \n*Required*: No \n*Type*: String \n*Allowed Values*: `DISABLED | SSE-KMS | SSE-S3`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The encryption mode to use for Amazon S3 data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3EncryptionMode", "type": "string" } @@ -85855,7 +87777,7 @@ "additionalProperties": false, "properties": { "CatalogId": { - "markdownDescription": "The ID of the Data Catalog in which to create the `Table`\\. If none is supplied, the AWS account ID is used by default\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the Data Catalog in which to create the `Table`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CatalogId", "type": "string" }, @@ -86147,7 +88069,7 @@ "type": "string" }, "Owner": { - "markdownDescription": "The table owner\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The table owner\\. Included for Apache Hive compatibility\\. Not used in the normal course of AWS Glue operations\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Owner", "type": "string" }, @@ -86175,7 +88097,7 @@ "title": "StorageDescriptor" }, "TableType": { - "markdownDescription": "The type of this table \\(`EXTERNAL_TABLE`, `VIRTUAL_VIEW`, etc\\.\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of this table\\. AWS Glue will create tables with the `EXTERNAL_TABLE` type\\. Other services, such as Athena, may create tables with additional table types\\. \n AWS Glue related table types: \nEXTERNAL\\_TABLE \nHive compatible attribute \\- indicates a non\\-Hive managed table\\. \nGOVERNED \nUsed by AWS Lake Formation\\. The AWS Glue Data Catalog understands `GOVERNED`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TableType", "type": "string" }, @@ -86185,12 +88107,12 @@ "title": "TargetTable" }, "ViewExpandedText": { - "markdownDescription": "If the table is a view, the expanded text of the view; otherwise `null`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Included for Apache Hive compatibility\\. Not used in the normal course of AWS Glue operations\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ViewExpandedText", "type": "string" }, "ViewOriginalText": { - "markdownDescription": "If the table is a view, the original text of the view; otherwise `null`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Included for Apache Hive compatibility\\. Not used in the normal course of AWS Glue operations\\. If the table is a `VIRTUAL_VIEW`, certain Athena configuration encoded in base64\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ViewOriginalText", "type": "string" } @@ -86246,7 +88168,9 @@ "type": "string" }, "EventBatchingCondition": { - "$ref": "#/definitions/AWS::Glue::Trigger.EventBatchingCondition" + "$ref": "#/definitions/AWS::Glue::Trigger.EventBatchingCondition", + "markdownDescription": "Batch condition that must be met \\(specified number of events received or batch time window expired\\) before EventBridge event trigger fires\\. \n*Required*: No \n*Type*: [EventBatchingCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-eventbatchingcondition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventBatchingCondition" }, "Name": { "markdownDescription": "The name of the trigger\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -86274,7 +88198,7 @@ "type": "object" }, "Type": { - "markdownDescription": "The type of trigger that this is\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of trigger that this is\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" }, @@ -86382,9 +88306,13 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "BatchWindow": { + "markdownDescription": "Window of time in seconds after which EventBridge event trigger fires\\. Window starts when first event is received\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchWindow", "type": "number" } }, @@ -86469,6 +88397,8 @@ "type": "string" }, "MaxConcurrentRuns": { + "markdownDescription": "You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs\\. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxConcurrentRuns", "type": "number" }, "Name": { @@ -86540,58 +88470,86 @@ "additionalProperties": false, "properties": { "AccountAccessType": { + "markdownDescription": "Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization\\. If this is `ORGANIZATION`, the `workspaceOrganizationalUnits` parameter specifies which organizational units the workspace can access\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CURRENT_ACCOUNT | ORGANIZATION` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccountAccessType", "type": "string" }, "AuthenticationProviders": { "items": { "type": "string" }, + "markdownDescription": "Specifies whether this workspace uses SAML 2\\.0, AWS IAM Identity Center \\(successor to AWS Single Sign\\-On\\), or both to authenticate users for using the Grafana console within a workspace\\. For more information, see [User authentication in Amazon Managed Grafana](https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AuthenticationProviders", "type": "array" }, "ClientToken": { + "markdownDescription": "A unique, case\\-sensitive, user\\-provided identifier to ensure the idempotency of the request\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[!-~]{1,64}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ClientToken", "type": "string" }, "DataSources": { "items": { "type": "string" }, + "markdownDescription": "Specifies the AWS data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources\\. \nThis list is only used when the workspace was created through the AWS console, and the `permissionType` is `SERVICE_MANAGED`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSources", "type": "array" }, "Description": { + "markdownDescription": "The user\\-defined description of the workspace\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the workspace\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9-._~]{1,255}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "NotificationDestinations": { "items": { "type": "string" }, + "markdownDescription": "The AWS notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotificationDestinations", "type": "array" }, "OrganizationRoleName": { + "markdownDescription": "The name of the IAM role that is used to access resources through Organizations\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationRoleName", "type": "string" }, "OrganizationalUnits": { "items": { "type": "string" }, + "markdownDescription": "Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationalUnits", "type": "array" }, "PermissionType": { + "markdownDescription": "If this is `SERVICE_MANAGED`, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use AWS data sources and notification channels\\. \nIf this is `CUSTOMER_MANAGED`, you must manage those roles and permissions yourself\\. \nIf you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other AWS accounts in the organization, this parameter must be set to `CUSTOMER_MANAGED`\\. \nFor more information about converting between customer and service managed, see [Managing permissions for data sources and notification channels](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html)\\. For more information about the roles and permissions that must be managed for customer managed workspaces, see [Amazon Managed Grafana permissions and policies for AWS data sources and notification channels](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html) \n*Required*: No \n*Type*: String \n*Allowed values*: `CUSTOMER_MANAGED | SERVICE_MANAGED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PermissionType", "type": "string" }, "RoleArn": { + "markdownDescription": "The IAM role that grants permissions to the AWS resources that the workspace will view data from\\. This role must already exist\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "SamlConfiguration": { - "$ref": "#/definitions/AWS::Grafana::Workspace.SamlConfiguration" + "$ref": "#/definitions/AWS::Grafana::Workspace.SamlConfiguration", + "markdownDescription": "If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the `Admin` and `Editor` roles in the workspace\\. \n*Required*: No \n*Type*: [SamlConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SamlConfiguration" }, "StackSetName": { + "markdownDescription": "The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StackSetName", "type": "string" }, "VpcConfiguration": { - "$ref": "#/definitions/AWS::Grafana::Workspace.VpcConfiguration" + "$ref": "#/definitions/AWS::Grafana::Workspace.VpcConfiguration", + "markdownDescription": "The configuration for connecting to data sources in a private VPC \\(Amazon Virtual Private Cloud\\)\\. \n*Required*: No \n*Type*: [VpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-vpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcConfiguration" } }, "type": "object" @@ -86620,21 +88578,33 @@ "additionalProperties": false, "properties": { "Email": { + "markdownDescription": "The name of the attribute within the SAML assertion to use as the email names for SAML users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Email", "type": "string" }, "Groups": { + "markdownDescription": "The name of the attribute within the SAML assertion to use as the user full \"friendly\" names for user groups\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Groups", "type": "string" }, "Login": { + "markdownDescription": "The name of the attribute within the SAML assertion to use as the login names for SAML users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Login", "type": "string" }, "Name": { + "markdownDescription": "The name of the attribute within the SAML assertion to use as the user full \"friendly\" names for SAML users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Org": { + "markdownDescription": "The name of the attribute within the SAML assertion to use as the user full \"friendly\" names for the users' organizations\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Org", "type": "string" }, "Role": { + "markdownDescription": "The name of the attribute within the SAML assertion to use as the user roles\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Role", "type": "string" } }, @@ -86644,9 +88614,13 @@ "additionalProperties": false, "properties": { "Url": { + "markdownDescription": "The URL of the location containing the IdP metadata\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Url", "type": "string" }, "Xml": { + "markdownDescription": "The full IdP metadata, in XML format\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Xml", "type": "string" } }, @@ -86659,12 +88633,16 @@ "items": { "type": "string" }, + "markdownDescription": "A list of groups from the SAML assertion attribute to grant the Grafana `Admin` role to\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Admin", "type": "array" }, "Editor": { "items": { "type": "string" }, + "markdownDescription": "A list of groups from the SAML assertion attribute to grant the Grafana `Editor` role to\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Editor", "type": "array" } }, @@ -86677,19 +88655,29 @@ "items": { "type": "string" }, + "markdownDescription": "Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace\\. If this is empty, all organizations in the assertion attribute have access\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowedOrganizations", "type": "array" }, "AssertionAttributes": { - "$ref": "#/definitions/AWS::Grafana::Workspace.AssertionAttributes" + "$ref": "#/definitions/AWS::Grafana::Workspace.AssertionAttributes", + "markdownDescription": "A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace\\. \n*Required*: No \n*Type*: [AssertionAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssertionAttributes" }, "IdpMetadata": { - "$ref": "#/definitions/AWS::Grafana::Workspace.IdpMetadata" + "$ref": "#/definitions/AWS::Grafana::Workspace.IdpMetadata", + "markdownDescription": "A structure containing the identity provider \\(IdP\\) metadata used to integrate the identity provider with this workspace\\. \n*Required*: Yes \n*Type*: [IdpMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-idpmetadata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IdpMetadata" }, "LoginValidityDuration": { + "markdownDescription": "How long a sign\\-on session by a SAML user is valid, before the user has to sign on again\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LoginValidityDuration", "type": "number" }, "RoleValues": { - "$ref": "#/definitions/AWS::Grafana::Workspace.RoleValues" + "$ref": "#/definitions/AWS::Grafana::Workspace.RoleValues", + "markdownDescription": "A structure containing arrays that map group names in the SAML assertion to the Grafana `Admin` and `Editor` roles in the workspace\\. \n*Required*: No \n*Type*: [RoleValues](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-rolevalues.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleValues" } }, "required": [ @@ -86704,12 +88692,16 @@ "items": { "type": "string" }, + "markdownDescription": "The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect\\. Duplicates not allowed\\. \n*Array Members*: Minimum number of 1 items\\. Maximum number of 5 items\\. \n*Length*: Minimum length of 0\\. Maximum length of 255\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroupIds", "type": "array" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect\\. Duplicates not allowed\\. \n*Array Members*: Minimum number of 2 items\\. Maximum number of 6 items\\. \n*Length*: Minimum length of 0\\. Maximum length of 255\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetIds", "type": "array" } }, @@ -89285,12 +91277,12 @@ "additionalProperties": false, "properties": { "DependencyType": { - "markdownDescription": "The type of this dependency\\. Choose from the following options: \n+ `SOFT` \u2013 The component doesn't restart if the dependency changes state\\.\n+ `HARD` \u2013 The component restarts if the dependency changes state\\.\nDefault: `HARD` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of this dependency\\. Choose from the following options: \n+ `SOFT` \u2013 The component doesn't restart if the dependency changes state\\.\n+ `HARD` \u2013 The component restarts if the dependency changes state\\.\nDefault: `HARD` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DependencyType", "type": "string" }, "VersionRequirement": { - "markdownDescription": "The component version requirement for the component dependency\\. \nAWS IoT Greengrass uses semantic version constraints\\. For more information, see [Semantic Versioning](https://semver.org/)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The component version requirement for the component dependency\\. \nAWS IoT Greengrass uses semantic version constraints\\. For more information, see [Semantic Versioning](https://semver.org/)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VersionRequirement", "type": "string" } @@ -89302,7 +91294,7 @@ "properties": { "Attributes": { "additionalProperties": true, - "markdownDescription": "A dictionary of attributes for the platform\\. The software defines the `os` and `platform` by default\\. You can specify additional platform attributes for a core device when you deploy the Greengrass nucleus component\\. For more information, see the [Greengrass nucleus component](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A dictionary of attributes for the platform\\. The AWS IoT Greengrass Core software defines the `os` and `platform` by default\\. You can specify additional platform attributes for a core device when you deploy the AWS IoT Greengrass nucleus component\\. For more information, see the [AWS IoT Greengrass nucleus component](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -89429,7 +91421,7 @@ "title": "LinuxProcessParams" }, "MaxIdleTimeInSeconds": { - "markdownDescription": "The maximum amount of time in seconds that a non\\-pinned Lambda function can idle before the software stops its process\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum amount of time in seconds that a non\\-pinned Lambda function can idle before the AWS IoT Greengrass Core software stops its process\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaxIdleTimeInSeconds", "type": "number" }, @@ -89439,12 +91431,12 @@ "type": "number" }, "MaxQueueSize": { - "markdownDescription": "The maximum size of the message queue for the Lambda function component\\. The Greengrass core device stores messages in a FIFO \\(first\\-in\\-first\\-out\\) queue until it can run the Lambda function to consume each message\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum size of the message queue for the Lambda function component\\. The AWS IoT Greengrass core device stores messages in a FIFO \\(first\\-in\\-first\\-out\\) queue until it can run the Lambda function to consume each message\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaxQueueSize", "type": "number" }, "Pinned": { - "markdownDescription": "Whether or not the Lambda function is pinned, or long\\-lived\\. \n+ A pinned Lambda function starts when the starts and keeps running in its own container\\.\n+ A non\\-pinned Lambda function starts only when it receives a work item and exists after it idles for `maxIdleTimeInSeconds`\\. If the function has multiple work items, the software creates multiple instances of the function\\.\nDefault: `true` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Whether or not the Lambda function is pinned, or long\\-lived\\. \n+ A pinned Lambda function starts when the AWS IoT Greengrass Core starts and keeps running in its own container\\.\n+ A non\\-pinned Lambda function starts only when it receives a work item and exists after it idles for `maxIdleTimeInSeconds`\\. If the function has multiple work items, the AWS IoT Greengrass Core software creates multiple instances of the function\\.\nDefault: `true` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Pinned", "type": "boolean" }, @@ -89477,7 +91469,7 @@ }, "ComponentLambdaParameters": { "$ref": "#/definitions/AWS::GreengrassV2::ComponentVersion.LambdaExecutionParameters", - "markdownDescription": "The system and runtime parameters for the Lambda function as it runs on the Greengrass core device\\. \n*Required*: No \n*Type*: [LambdaExecutionParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The system and runtime parameters for the Lambda function as it runs on the AWS IoT Greengrass core device\\. \n*Required*: No \n*Type*: [LambdaExecutionParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ComponentLambdaParameters" }, "ComponentName": { @@ -89585,32 +91577,44 @@ "properties": { "Components": { "additionalProperties": false, + "markdownDescription": "The components to deploy\\. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component\\. \n*Required*: No \n*Type*: Map of [ComponentDeploymentSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::GreengrassV2::Deployment.ComponentDeploymentSpecification" } }, + "title": "Components", "type": "object" }, "DeploymentName": { + "markdownDescription": "The name of the deployment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DeploymentName", "type": "string" }, "DeploymentPolicies": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentPolicies" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentPolicies", + "markdownDescription": "The deployment policies for the deployment\\. These policies define how the deployment updates components and handles failure\\. \n*Required*: No \n*Type*: [DeploymentPolicies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DeploymentPolicies" }, "IotJobConfiguration": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentIoTJobConfiguration" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentIoTJobConfiguration", + "markdownDescription": "The job configuration for the deployment configuration\\. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration\\. \n*Required*: No \n*Type*: [DeploymentIoTJobConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IotJobConfiguration" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Application\\-specific metadata to attach to the deployment\\. You can use tags in IAM policies to control access to AWS IoT Greengrass resources\\. You can also use tags to categorize your resources\\. For more information, see [Tag your AWS IoT Greengrass Version 2 resources](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in the *AWS IoT Greengrass V2 Developer Guide*\\. \nThis `Json` property type is processed as a map of key\\-value pairs\\. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates\\.", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "TargetArn": { + "markdownDescription": "The ARN of the target AWS IoT thing or thing group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TargetArn", "type": "string" } }, @@ -89644,12 +91648,16 @@ "additionalProperties": false, "properties": { "Merge": { + "markdownDescription": "A serialized JSON string that contains the configuration object to merge to target devices\\. The core device merges this configuration with the component's existing configuration\\. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration\\. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object\\. For more information, see [Merge configuration updates](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#merge-configuration-update) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Merge", "type": "string" }, "Reset": { "items": { "type": "string" }, + "markdownDescription": "The list of configuration nodes to reset to default values on target devices\\. Use JSON pointers to specify each node to reset\\. JSON pointers start with a forward slash \\(`/`\\) and use forward slashes to separate the key for each level in the object\\. For more information, see the [JSON pointer specification](https://tools.ietf.org/html/rfc6901) and [Reset configuration updates](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#reset-configuration-update) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Reset", "type": "array" } }, @@ -89659,13 +91667,19 @@ "additionalProperties": false, "properties": { "ComponentVersion": { + "markdownDescription": "The version of the component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ComponentVersion", "type": "string" }, "ConfigurationUpdate": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.ComponentConfigurationUpdate" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.ComponentConfigurationUpdate", + "markdownDescription": "The configuration updates to deploy for the component\\. You can define reset updates and merge updates\\. A reset updates the keys that you specify to the default configuration for the component\\. A merge updates the core device's component configuration with the keys and values that you specify\\. The AWS IoT Greengrass Core software applies reset updates before it applies merge updates\\. For more information, see [Update component configuration](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html)\\. \n*Required*: No \n*Type*: [ComponentConfigurationUpdate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentconfigurationupdate.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConfigurationUpdate" }, "RunWith": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.ComponentRunWith" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.ComponentRunWith", + "markdownDescription": "The system user and group that the software uses to run component processes on the core device\\. If you omit this parameter, the software uses the system user and group that you configure for the core device\\. For more information, see [Configure the user and group that run components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: [ComponentRunWith](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentrunwith.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RunWith" } }, "type": "object" @@ -89674,12 +91688,18 @@ "additionalProperties": false, "properties": { "PosixUser": { + "markdownDescription": "The POSIX system user and \\(optional\\) group to use to run this component\\. Specify the user and group separated by a colon \\(`:`\\) in the following format: `user:group`\\. The group is optional\\. If you don't specify a group, the AWS IoT Greengrass Core software uses the primary user for the group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PosixUser", "type": "string" }, "SystemResourceLimits": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.SystemResourceLimits" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.SystemResourceLimits", + "markdownDescription": "The system resource limits to apply to this component's process on the core device\\. AWS IoT Greengrass supports this feature only on Linux core devices\\. \nIf you omit this parameter, the AWS IoT Greengrass Core software uses the default system resource limits that you configure on the AWS IoT Greengrass nucleus component\\. For more information, see [ Configure system resource limits for components ](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits)\\. \n*Required*: No \n*Type*: [SystemResourceLimits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-systemresourcelimits.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SystemResourceLimits" }, "WindowsUser": { + "markdownDescription": "The Windows user to use to run this component on Windows core devices\\. The user must exist on each Windows core device, and its name and password must be in the LocalSystem account's Credentials Manager instance\\. \nIf you omit this parameter, the AWS IoT Greengrass Core software uses the default Windows user that you configure on the AWS IoT Greengrass nucleus component\\. For more information, see [Configure the user and group that run components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "WindowsUser", "type": "string" } }, @@ -89689,9 +91709,13 @@ "additionalProperties": false, "properties": { "Action": { + "markdownDescription": "Whether or not to notify components and wait for components to become safe to update\\. Choose from the following options: \n+ `NOTIFY_COMPONENTS` \u2013 The deployment notifies each component before it stops and updates that component\\. Components can use the [SubscribeToComponentUpdates](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates) IPC operation to receive these notifications\\. Then, components can respond with the [DeferComponentUpdate](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate) IPC operation\\. For more information, see the [Create deployments](https://docs.aws.amazon.com/greengrass/v2/latest/developerguide/create-deployments.html) in the *AWS IoT Greengrass V2 Developer Guide*\\.\n+ `SKIP_NOTIFY_COMPONENTS` \u2013 The deployment doesn't notify components or wait for them to be safe to update\\.\nDefault: `NOTIFY_COMPONENTS` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Action", "type": "string" }, "TimeoutInSeconds": { + "markdownDescription": "The amount of time in seconds that each component on a device has to report that it's safe to update\\. If the component waits for longer than this timeout, then the deployment proceeds on the device\\. \nDefault: `60` \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TimeoutInSeconds", "type": "number" } }, @@ -89701,6 +91725,8 @@ "additionalProperties": false, "properties": { "TimeoutInSeconds": { + "markdownDescription": "The amount of time in seconds that a component can validate its configuration updates\\. If the validation time exceeds this timeout, then the deployment proceeds for the device\\. \nDefault: `30` \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TimeoutInSeconds", "type": "number" } }, @@ -89710,13 +91736,19 @@ "additionalProperties": false, "properties": { "AbortConfig": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobAbortConfig" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobAbortConfig", + "markdownDescription": "The stop configuration for the job\\. This configuration defines when and how to stop a job rollout\\. \n*Required*: No \n*Type*: [IoTJobAbortConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AbortConfig" }, "JobExecutionsRolloutConfig": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobExecutionsRolloutConfig" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobExecutionsRolloutConfig", + "markdownDescription": "The rollout configuration for the job\\. This configuration defines the rate at which the job rolls out to the fleet of target devices\\. \n*Required*: No \n*Type*: [IoTJobExecutionsRolloutConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "JobExecutionsRolloutConfig" }, "TimeoutConfig": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobTimeoutConfig" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobTimeoutConfig", + "markdownDescription": "The timeout configuration for the job\\. This configuration defines the amount of time each device has to complete the job\\. \n*Required*: No \n*Type*: [IoTJobTimeoutConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobtimeoutconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TimeoutConfig" } }, "type": "object" @@ -89725,12 +91757,18 @@ "additionalProperties": false, "properties": { "ComponentUpdatePolicy": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentComponentUpdatePolicy" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentComponentUpdatePolicy", + "markdownDescription": "The component update policy for the configuration deployment\\. This policy defines when it's safe to deploy the configuration to devices\\. \n*Required*: No \n*Type*: [DeploymentComponentUpdatePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ComponentUpdatePolicy" }, "ConfigurationValidationPolicy": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentConfigurationValidationPolicy" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentConfigurationValidationPolicy", + "markdownDescription": "The configuration validation policy for the configuration deployment\\. This policy defines how long each component has to validate its configure updates\\. \n*Required*: No \n*Type*: [DeploymentConfigurationValidationPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentconfigurationvalidationpolicy.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConfigurationValidationPolicy" }, "FailureHandlingPolicy": { + "markdownDescription": "The failure handling policy for the configuration deployment\\. This policy defines what to do if the deployment fails\\. \nDefault: `ROLLBACK` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FailureHandlingPolicy", "type": "string" } }, @@ -89743,6 +91781,8 @@ "items": { "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobAbortCriteria" }, + "markdownDescription": "The list of criteria that define when and how to cancel the configuration deployment\\. \n*Required*: Yes \n*Type*: List of [IoTJobAbortCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortcriteria.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CriteriaList", "type": "array" } }, @@ -89755,15 +91795,23 @@ "additionalProperties": false, "properties": { "Action": { + "markdownDescription": "The action to perform when the criteria are met\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Action", "type": "string" }, "FailureType": { + "markdownDescription": "The type of job deployment failure that can cancel a job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FailureType", "type": "string" }, "MinNumberOfExecutedThings": { + "markdownDescription": "The minimum number of things that receive the configuration before the job can cancel\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MinNumberOfExecutedThings", "type": "number" }, "ThresholdPercentage": { + "markdownDescription": "The minimum percentage of `failureType` failures that occur before the job can cancel\\. \nThis parameter supports up to two digits after the decimal \\(for example, you can specify `10.9` or `10.99`, but not `10.999`\\)\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ThresholdPercentage", "type": "number" } }, @@ -89779,9 +91827,13 @@ "additionalProperties": false, "properties": { "ExponentialRate": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobExponentialRolloutRate" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobExponentialRolloutRate", + "markdownDescription": "The exponential rate to increase the job rollout rate\\. \n*Required*: No \n*Type*: [IoTJobExponentialRolloutRate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExponentialRate" }, "MaximumPerMinute": { + "markdownDescription": "The maximum number of devices that receive a pending job notification, per minute\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaximumPerMinute", "type": "number" } }, @@ -89791,13 +91843,19 @@ "additionalProperties": false, "properties": { "BaseRatePerMinute": { + "markdownDescription": "The minimum number of devices that receive a pending job notification, per minute, when the job starts\\. This parameter defines the initial rollout rate of the job\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BaseRatePerMinute", "type": "number" }, "IncrementFactor": { + "markdownDescription": "The exponential factor to increase the rollout rate for the job\\. \nThis parameter supports up to one digit after the decimal \\(for example, you can specify `1.5`, but not `1.55`\\)\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IncrementFactor", "type": "number" }, "RateIncreaseCriteria": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobRateIncreaseCriteria" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobRateIncreaseCriteria", + "markdownDescription": "The criteria to increase the rollout rate for the job\\. \n*Required*: Yes \n*Type*: [IoTJobRateIncreaseCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobrateincreasecriteria.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RateIncreaseCriteria" } }, "required": [ @@ -89811,9 +91869,13 @@ "additionalProperties": false, "properties": { "NumberOfNotifiedThings": { + "markdownDescription": "The number of devices to receive the job notification before the rollout rate increases\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NumberOfNotifiedThings", "type": "number" }, "NumberOfSucceededThings": { + "markdownDescription": "The number of devices to successfully run the configuration job before the rollout rate increases\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NumberOfSucceededThings", "type": "number" } }, @@ -89823,6 +91885,8 @@ "additionalProperties": false, "properties": { "InProgressTimeoutInMinutes": { + "markdownDescription": "The amount of time, in minutes, that devices have to complete the job\\. The timer starts when the job status is set to `IN_PROGRESS`\\. If the job status doesn't change to a terminal state before the time expires, then the job status is set to `TIMED_OUT`\\. \nThe timeout interval must be between 1 minute and 7 days \\(10080 minutes\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InProgressTimeoutInMinutes", "type": "number" } }, @@ -89832,9 +91896,13 @@ "additionalProperties": false, "properties": { "Cpus": { + "markdownDescription": "The maximum amount of CPU time that a component's processes can use on the core device\\. A core device's total CPU time is equivalent to the device's number of CPU cores\\. For example, on a core device with 4 CPU cores, you can set this value to 2 to limit the component's processes to 50 percent usage of each CPU core\\. On a device with 1 CPU core, you can set this value to 0\\.25 to limit the component's processes to 25 percent usage of the CPU\\. If you set this value to a number greater than the number of CPU cores, the AWS IoT Greengrass Core software doesn't limit the component's CPU usage\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Cpus", "type": "number" }, "Memory": { + "markdownDescription": "The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on the core device\\. For more information, see [Configure system resource limits for components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Memory", "type": "number" } }, @@ -90222,9 +92290,13 @@ "additionalProperties": false, "properties": { "ContactPostPassDurationSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContactPostPassDurationSeconds", "type": "number" }, "ContactPrePassDurationSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContactPrePassDurationSeconds", "type": "number" }, "EndpointDetails": { @@ -90526,6 +92598,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags to be added to a new detector resource\\. Each tag consists of a key and an optional value, both of which you define\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -90564,7 +92638,9 @@ "title": "Kubernetes" }, "MalwareProtection": { - "$ref": "#/definitions/AWS::GuardDuty::Detector.CFNMalwareProtectionConfiguration" + "$ref": "#/definitions/AWS::GuardDuty::Detector.CFNMalwareProtectionConfiguration", + "markdownDescription": "Describes whether Malware Protection will be enabled as a data source\\. \n*Required*: No \n*Type*: [CFNMalwareProtectionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnmalwareprotectionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MalwareProtection" }, "S3Logs": { "$ref": "#/definitions/AWS::GuardDuty::Detector.CFNS3LogsConfiguration", @@ -90600,7 +92676,9 @@ "additionalProperties": false, "properties": { "ScanEc2InstanceWithFindings": { - "$ref": "#/definitions/AWS::GuardDuty::Detector.CFNScanEc2InstanceWithFindingsConfiguration" + "$ref": "#/definitions/AWS::GuardDuty::Detector.CFNScanEc2InstanceWithFindingsConfiguration", + "markdownDescription": "Describes the configuration of Malware Protection for EC2 instances with findings\\. \n*Required*: No \n*Type*: [CFNScanEc2InstanceWithFindingsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnscanec2instancewithfindingsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ScanEc2InstanceWithFindings" } }, "type": "object" @@ -90620,6 +92698,8 @@ "additionalProperties": false, "properties": { "EbsVolumes": { + "markdownDescription": "Describes the configuration for scanning EBS volumes as data source\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EbsVolumes", "type": "boolean" } }, @@ -90666,7 +92746,7 @@ "type": "string" }, "Description": { - "markdownDescription": "The description of the filter\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the filter\\. Valid special characters include period \\(\\.\\), underscore \\(\\_\\), dash \\(\\-\\), and whitespace\\. The new line character is considered to be an invalid input for description\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -90681,12 +92761,12 @@ "title": "FindingCriteria" }, "Name": { - "markdownDescription": "The name of the filter\\. Minimum length of 3\\. Maximum length of 64\\. Valid characters include alphanumeric characters, dot \\(\\.\\), underscore \\(\\_\\), and dash \\(\\-\\)\\. Spaces are not allowed\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the filter\\. Valid characters include period \\(\\.\\), underscore \\(\\_\\), dash \\(\\-\\), and alphanumeric characters\\. A whitespace is considered to be an invalid character\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, "Rank": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the position of the filter in the list of current filters\\. Also specifies the order in which this filter is applied to the findings\\. The minimum value for this property is 1 and the maximum is 100\\. \nBy default, filters may not be created in the same order as they are ranked\\. To ensure that the filters are created in the expected order, you can use an optional attribute, [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html), with the following syntax: `\"DependsOn\":[ \"ObjectName\" ]`\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Rank", "type": "number" }, @@ -90694,6 +92774,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags to be added to a new filter resource\\. Each tag consists of a key and an optional value, both of which you define\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -90743,15 +92825,23 @@ "items": { "type": "string" }, + "markdownDescription": "Represents an *equal* **** condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Equals", "type": "array" }, "GreaterThan": { + "markdownDescription": "Represents a *greater than* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GreaterThan", "type": "number" }, "GreaterThanOrEqual": { + "markdownDescription": "Represents a *greater than or equal* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GreaterThanOrEqual", "type": "number" }, "Gt": { + "markdownDescription": "Represents a *greater than* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Gt", "type": "number" }, "Gte": { @@ -90760,9 +92850,13 @@ "type": "number" }, "LessThan": { + "markdownDescription": "Represents a *less than* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LessThan", "type": "number" }, "LessThanOrEqual": { + "markdownDescription": "Represents a *less than or equal* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LessThanOrEqual", "type": "number" }, "Lt": { @@ -90787,6 +92881,8 @@ "items": { "type": "string" }, + "markdownDescription": "Represents a *not equal* **** condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotEquals", "type": "array" } }, @@ -90864,7 +92960,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The user\\-friendly name to identify the IPSet\\. \n Allowed characters are alphanumerics, spaces, hyphens \\(\\-\\), and underscores \\(\\_\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user\\-friendly name to identify the IPSet\\. \n Allowed characters are alphanumeric, whitespace, dash \\(\\-\\), and underscores \\(\\_\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -90872,6 +92968,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags to be added to a new IP set resource\\. Each tag consists of a key and an optional value, both of which you define\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -91140,6 +93238,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags to be added to a new threat list resource\\. Each tag consists of a key and an optional value, both of which you define\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -91266,9 +93366,13 @@ "additionalProperties": false, "properties": { "Nanos": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Nanos", "type": "number" }, "Seconds": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Seconds", "type": "string" } }, @@ -91921,7 +94025,7 @@ "type": "object" }, "Description": { - "markdownDescription": "A description of the role that you provide\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Pattern*: `[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description of the role that you provide\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -91934,7 +94038,7 @@ "type": "array" }, "MaxSessionDuration": { - "markdownDescription": "The maximum session duration \\(in seconds\\) that you want to set for the specified role\\. If you do not specify a value for this setting, the default maximum of one hour is applied\\. This setting can have a value from 1 hour to 12 hours\\. \nAnyone who assumes the role from the or API can use the `DurationSeconds` API parameter or the `duration-seconds` CLI parameter to request a longer session\\. The `MaxSessionDuration` setting determines the maximum duration that can be requested using the `DurationSeconds` parameter\\. If users don't specify a value for the `DurationSeconds` parameter, their security credentials are valid for one hour by default\\. This applies when you use the `AssumeRole*` API operations or the `assume-role*` CLI operations but does not apply when you use those operations to create a console URL\\. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `3600` \n*Maximum*: `43200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum session duration \\(in seconds\\) that you want to set for the specified role\\. If you do not specify a value for this setting, the default value of one hour is applied\\. This setting can have a value from 1 hour to 12 hours\\. \nAnyone who assumes the role from the AWS CLI or API can use the `DurationSeconds` API parameter or the `duration-seconds` AWS CLI parameter to request a longer session\\. The `MaxSessionDuration` setting determines the maximum duration that can be requested using the `DurationSeconds` parameter\\. If users don't specify a value for the `DurationSeconds` parameter, their security credentials are valid for one hour by default\\. This applies when you use the `AssumeRole*` API operations or the `assume-role*` AWS CLI operations but does not apply when you use those operations to create a console URL\\. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `3600` \n*Maximum*: `43200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxSessionDuration", "type": "number" }, @@ -91952,7 +94056,7 @@ "items": { "$ref": "#/definitions/AWS::IAM::Role.Policy" }, - "markdownDescription": "Adds or updates an inline policy document that is embedded in the specified IAM role\\. \nWhen you embed an inline policy in a role, the inline policy is used as part of the role's access \\(permissions\\) policy\\. The role's trust policy is created at the same time as the role\\. You can update a role's trust policy later\\. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html)\\. \nA role can also have an attached managed policy\\. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*\\. \nFor information about limits on the number of inline policies that you can embed with a role, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*\\. \nIf an external policy \\(such as `AWS::IAM::Policy` or `AWS::IAM::ManagedPolicy`\\) has a `Ref` to a role and if a resource \\(such as `AWS::ECS::Service`\\) also has a `Ref` to the same role, add a `DependsOn` attribute to the resource to make the resource depend on the external policy\\. This dependency ensures that the role's policy is available throughout the resource's lifecycle\\. For example, when you delete a stack with an `AWS::ECS::Service` resource, the `DependsOn` attribute ensures that AWS CloudFormation deletes the `AWS::ECS::Service` resource before deleting its role's policy\\.\n*Required*: No \n*Type*: List of [Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Adds or updates an inline policy document that is embedded in the specified IAM role\\. \nWhen you embed an inline policy in a role, the inline policy is used as part of the role's access \\(permissions\\) policy\\. The role's trust policy is created at the same time as the role\\. You can update a role's trust policy later\\. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html)\\. \nA role can also have an attached managed policy\\. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*\\. \nFor information about limits on the number of inline policies that you can embed with a role, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*\\. \nIf an external policy \\(such as `AWS::IAM::Policy` or `AWS::IAM::ManagedPolicy`\\) has a `Ref` to a role and if a resource \\(such as `AWS::ECS::Service`\\) also has a `Ref` to the same role, add a `DependsOn` attribute to the resource to make the resource depend on the external policy\\. This dependency ensures that the role's policy is available throughout the resource's lifecycle\\. For example, when you delete a stack with an `AWS::ECS::Service` resource, the `DependsOn` attribute ensures that AWS CloudFormation deletes the `AWS::ECS::Service` resource before deleting its role's policy\\.\n*Required*: No \n*Type*: List of [Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Policies", "type": "array" }, @@ -92000,7 +94104,7 @@ "additionalProperties": false, "properties": { "PolicyDocument": { - "markdownDescription": "The policy document\\. \n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `131072` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The entire contents of the policy that defines permissions\\. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json)\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PolicyDocument", "type": "object" }, @@ -92233,7 +94337,7 @@ "type": "string" }, "Description": { - "markdownDescription": "The description of the role\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Pattern*: `[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the role\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" } @@ -92326,7 +94430,7 @@ "type": "string" }, "PermissionsBoundary": { - "markdownDescription": "The ARN of the policy that is used to set the permissions boundary for the user\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN of the managed policy that is used to set the permissions boundary for the user\\. \nA permissions boundary policy defines the maximum permissions that identity\\-based policies can grant to an entity, but does not grant permissions\\. Permissions boundaries do not define the maximum permissions that a resource\\-based policy can grant to an entity\\. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*\\. \nFor more information about policy types, see [Policy types ](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PermissionsBoundary", "type": "string" }, @@ -92334,7 +94438,7 @@ "items": { "$ref": "#/definitions/AWS::IAM::User.Policy" }, - "markdownDescription": "Adds or updates an inline policy document that is embedded in the specified IAM user\\. To view AWS::IAM::User snippets, see [Declaring an IAM User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user)\\. \nThe name of each policy for a role, user, or group must be unique\\. If you don't choose unique names, updates to the IAM identity will fail\\. \nFor information about limits on the number of inline policies that you can embed in a user, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: List of [Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Adds or updates an inline policy document that is embedded in the specified IAM user\\. To view AWS::IAM::User snippets, see [Declaring an IAM User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user)\\. \nThe name of each policy for a role, user, or group must be unique\\. If you don't choose unique names, updates to the IAM identity will fail\\. \nFor information about limits on the number of inline policies that you can embed in a user, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: List of [Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Policies", "type": "array" }, @@ -92397,7 +94501,7 @@ "additionalProperties": false, "properties": { "PolicyDocument": { - "markdownDescription": "The policy document\\. \n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `131072` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The entire contents of the policy that defines permissions\\. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json)\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PolicyDocument", "type": "object" }, @@ -92641,7 +94745,7 @@ "type": "array" }, "Type": { - "markdownDescription": "The channel type, which determines the allowable resolution and bitrate\\. *If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately\\.* Valid values: \n+ `STANDARD`: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions\\. Resolution can be up to 1080p and bitrate can be up to 8\\.5 Mbps\\. Audio is transcoded only for renditions 360p and below; above that, audio is passed through\\.\n+ `BASIC`: delivers the original input to viewers\\. The viewer\u2019s video\\-quality choice is limited to the original input\\. Resolution can be up to 480p and bitrate can be up to 1\\.5 Mbps\\.\n*Default*: `STANDARD` \n*Required*: No \n*Type*: String \n*Allowed values*: `BASIC | STANDARD` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The channel type, which determines the allowable resolution and bitrate\\. *If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately\\.* Valid values: \n+ `STANDARD`: Video is transcoded: multiple qualities are generated from the original input to automatically give viewers the best experience for their devices and network conditions\\. Transcoding allows higher playback quality across a range of download speeds\\. Resolution can be up to 1080p and bitrate can be up to 8\\.5 Mbps\\. Audio is transcoded only for renditions 360p and below; above that, audio is passed through\\.\n+ `BASIC`: Video is transmuxed: Amazon IVS delivers the original input to viewers\\. The viewer\u2019s video\\-quality choice is limited to the original input\\. Resolution can be up to 1080p and bitrate can be up to 1\\.5 Mbps for 480p and up to 3\\.5 Mbps for resolutions between 480p and 1080p\\.\n*Default*: `STANDARD` \n*Required*: No \n*Type*: String \n*Allowed values*: `ADVANCED_HD | ADVANCED_SD | BASIC | STANDARD` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" } @@ -92709,7 +94813,7 @@ "type": "string" }, "PublicKeyMaterial": { - "markdownDescription": "The public portion of a customer\\-generated key pair\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The public portion of a customer\\-generated key pair\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PublicKeyMaterial", "type": "string" }, @@ -92790,6 +94894,8 @@ "type": "string" }, "RecordingReconnectWindowSeconds": { + "markdownDescription": "If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together\\. \n*Default*: `0` \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `300` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RecordingReconnectWindowSeconds", "type": "number" }, "Tags": { @@ -92990,12 +95096,18 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A string containing the description of the group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "DisplayName": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DisplayName", "type": "string" }, "IdentityStoreId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IdentityStoreId", "type": "string" } }, @@ -93062,13 +95174,19 @@ "additionalProperties": false, "properties": { "GroupId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GroupId", "type": "string" }, "IdentityStoreId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IdentityStoreId", "type": "string" }, "MemberId": { - "$ref": "#/definitions/AWS::IdentityStore::GroupMembership.MemberId" + "$ref": "#/definitions/AWS::IdentityStore::GroupMembership.MemberId", + "markdownDescription": "An object containing the identifier of a group member\\. Setting `MemberId`'s `UserId` field to a specific User's ID indicates we should consider that User as a group member\\. \n*Required*: Yes \n*Type*: [MemberId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-groupmembership-memberid.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MemberId" } }, "required": [ @@ -93103,6 +95221,8 @@ "additionalProperties": false, "properties": { "UserId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserId", "type": "string" } }, @@ -93147,22 +95267,22 @@ "additionalProperties": false, "properties": { "ChangeDescription": { - "markdownDescription": "A change description of the component\\. For example `initial version`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The change description of the component\\. Describes what change has been made in this version, or what makes this version different from other versions of this component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ChangeDescription", "type": "string" }, "Data": { - "markdownDescription": "The data of the component\\. For example, `name: HelloWorldTestingDocument\\ndescription: This is hello world testing document.\\nschemaVersion: 1.0\\n\\nphases:\\n - name: test\\n steps:\\n - name: HelloWorldStep\\n action: ExecuteBash\\n inputs:\\n commands:\\n - echo \\\"Hello World! Test.\\\"\\n`\\. See Examples below for the schema for creating a component using Data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Component `data` contains inline YAML document content for the component\\. Alternatively, you can specify the `uri` of a YAML document file stored in Amazon S3\\. However, you cannot specify both properties\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16000` \n*Pattern*: `[^\\x00]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Data", "type": "string" }, "Description": { - "markdownDescription": "The description of the component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Describes the contents of the component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Description", "type": "string" }, "KmsKeyId": { - "markdownDescription": "The KMS key identifier used to encrypt the component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the KMS key that is used to encrypt this component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" }, @@ -93172,7 +95292,7 @@ "type": "string" }, "Platform": { - "markdownDescription": "The platform of the component\\. For example, `Windows`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Linux | Windows` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The operating system platform of the component\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Linux | Windows` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Platform", "type": "string" }, @@ -93186,7 +95306,7 @@ }, "Tags": { "additionalProperties": true, - "markdownDescription": "The tags associated with the component\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The tags that apply to the component\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -93201,7 +95321,7 @@ "type": "string" }, "Version": { - "markdownDescription": "The component version\\. For example, `1.0.0`\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[0-9]+\\.[0-9]+\\.[0-9]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The component version\\. For example, `1.0.0`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Version", "type": "string" } @@ -93273,7 +95393,7 @@ "items": { "$ref": "#/definitions/AWS::ImageBuilder::ContainerRecipe.ComponentConfiguration" }, - "markdownDescription": "Components for build and test that are included in the container recipe\\. \n*Required*: Yes \n*Type*: List of [ComponentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Build and test components that are included in the container recipe\\. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination\\. \n*Required*: Yes \n*Type*: List of [ComponentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Components", "type": "array" }, @@ -93298,7 +95418,7 @@ "type": "string" }, "ImageOsVersionOverride": { - "markdownDescription": "Specifies the operating system version for the source image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the operating system version for the base image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ImageOsVersionOverride", "type": "string" }, @@ -93323,7 +95443,7 @@ "type": "string" }, "PlatformOverride": { - "markdownDescription": "Specifies the operating system platform when you use a custom source image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the operating system platform when you use a custom base image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PlatformOverride", "type": "string" }, @@ -93397,6 +95517,8 @@ "items": { "$ref": "#/definitions/AWS::ImageBuilder::ContainerRecipe.ComponentParameter" }, + "markdownDescription": "A group of parameter settings that Image Builder uses to configure the component for a specific recipe\\. \n*Required*: No \n*Type*: List of [ComponentParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Parameters", "type": "array" } }, @@ -93406,12 +95528,16 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the component parameter to set\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[^\\x00]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Value": { "items": { "type": "string" }, + "markdownDescription": "Sets the value for the named component parameter\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "array" } }, @@ -93625,29 +95751,41 @@ "properties": { "AmiTags": { "additionalProperties": true, + "markdownDescription": "The tags to apply to AMIs distributed to this Region\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "AmiTags", "type": "object" }, "Description": { + "markdownDescription": "The description of the AMI distribution configuration\\. Minimum and maximum length are in characters\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "KmsKeyId": { + "markdownDescription": "The KMS key identifier used to encrypt the distributed image\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "LaunchPermissionConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.LaunchPermissionConfiguration" + "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.LaunchPermissionConfiguration", + "markdownDescription": "Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances\\. \n*Required*: No \n*Type*: [LaunchPermissionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LaunchPermissionConfiguration" }, "Name": { + "markdownDescription": "The name of the output AMI\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `127` \n*Pattern*: `^[-_A-Za-z0-9{][-_A-Za-z0-9\\s:{}\\.]+[-_A-Za-z0-9}]$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "TargetAccountIds": { "items": { "type": "string" }, + "markdownDescription": "The ID of an account to which you want to distribute an image\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1536` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetAccountIds", "type": "array" } }, @@ -93660,13 +95798,19 @@ "items": { "type": "string" }, + "markdownDescription": "Tags that are attached to the container distribution configuration\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContainerTags", "type": "array" }, "Description": { + "markdownDescription": "The description of the container distribution configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "TargetRepository": { - "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.TargetContainerRepository" + "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.TargetContainerRepository", + "markdownDescription": "The destination repository for the container distribution configuration\\. \n*Required*: No \n*Type*: [TargetContainerRepository](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-targetcontainerrepository.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetRepository" } }, "type": "object" @@ -93676,18 +95820,20 @@ "properties": { "AmiDistributionConfiguration": { "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.AmiDistributionConfiguration", - "markdownDescription": "The specific AMI settings, such as launch permissions and AMI tags\\. For details, see example schema below\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The specific AMI settings, such as launch permissions and AMI tags\\. For details, see example schema below\\. \n*Required*: No \n*Type*: [AmiDistributionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-amidistributionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AmiDistributionConfiguration" }, "ContainerDistributionConfiguration": { "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.ContainerDistributionConfiguration", - "markdownDescription": "Container distribution settings for encryption, licensing, and sharing in a specific Region\\. For details, see example schema below\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Container distribution settings for encryption, licensing, and sharing in a specific Region\\. For details, see example schema below\\. \n*Required*: No \n*Type*: [ContainerDistributionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-containerdistributionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContainerDistributionConfiguration" }, "FastLaunchConfigurations": { "items": { "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.FastLaunchConfiguration" }, + "markdownDescription": "The Windows faster\\-launching configurations to use for AMI distribution\\. \n*Required*: No \n*Type*: List of [FastLaunchConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html) \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FastLaunchConfigurations", "type": "array" }, "LaunchTemplateConfigurations": { @@ -93721,19 +95867,29 @@ "additionalProperties": false, "properties": { "AccountId": { + "markdownDescription": "The owner account ID for the fast\\-launch enabled Windows AMI\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[0-9]{12}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccountId", "type": "string" }, "Enabled": { + "markdownDescription": "A Boolean that represents the current state of faster launching for the Windows AMI\\. Set to `true` to start using Windows faster launching, or `false` to stop using it\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "LaunchTemplate": { - "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.FastLaunchLaunchTemplateSpecification" + "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.FastLaunchLaunchTemplateSpecification", + "markdownDescription": "The launch template that the fast\\-launch enabled Windows AMI uses when it launches Windows instances to create pre\\-provisioned snapshots\\. \n*Required*: No \n*Type*: [FastLaunchLaunchTemplateSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LaunchTemplate" }, "MaxParallelLaunches": { + "markdownDescription": "The maximum number of parallel instances that are launched for creating resources\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxParallelLaunches", "type": "number" }, "SnapshotConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.FastLaunchSnapshotConfiguration" + "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.FastLaunchSnapshotConfiguration", + "markdownDescription": "Configuration settings for managing the number of snapshots that are created from pre\\-provisioned instances for the Windows AMI when faster launching is enabled\\. \n*Required*: No \n*Type*: [FastLaunchSnapshotConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchsnapshotconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SnapshotConfiguration" } }, "type": "object" @@ -93742,12 +95898,18 @@ "additionalProperties": false, "properties": { "LaunchTemplateId": { + "markdownDescription": "The ID of the launch template to use for faster launching for a Windows AMI\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^lt-[a-z0-9-_]{17}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LaunchTemplateId", "type": "string" }, "LaunchTemplateName": { + "markdownDescription": "The name of the launch template to use for faster launching for a Windows AMI\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LaunchTemplateName", "type": "string" }, "LaunchTemplateVersion": { + "markdownDescription": "The version of the launch template to use for faster launching for a Windows AMI\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LaunchTemplateVersion", "type": "string" } }, @@ -93757,6 +95919,8 @@ "additionalProperties": false, "properties": { "TargetResourceCount": { + "markdownDescription": "The number of pre\\-provisioned snapshots to keep on hand for a fast\\-launch enabled Windows AMI\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetResourceCount", "type": "number" } }, @@ -93769,24 +95933,32 @@ "items": { "type": "string" }, + "markdownDescription": "The ARN for an AWS Organization that you want to share your AMI with\\. For more information, see [What is AWS Organizations?](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationArns", "type": "array" }, "OrganizationalUnitArns": { "items": { "type": "string" }, + "markdownDescription": "The ARN for an AWS Organizations organizational unit \\(OU\\) that you want to share your AMI with\\. For more information about key concepts for AWS Organizations, see [AWS Organizations terminology and concepts](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationalUnitArns", "type": "array" }, "UserGroups": { "items": { "type": "string" }, + "markdownDescription": "The name of the group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserGroups", "type": "array" }, "UserIds": { "items": { "type": "string" }, + "markdownDescription": "The AWS account ID\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1536` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserIds", "type": "array" } }, @@ -93817,9 +95989,13 @@ "additionalProperties": false, "properties": { "RepositoryName": { + "markdownDescription": "The name of the container repository where the output container image is stored\\. This name is prefixed by the repository location\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RepositoryName", "type": "string" }, "Service": { + "markdownDescription": "Specifies the service in which this image was registered\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ECR` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Service", "type": "string" } }, @@ -93871,7 +96047,7 @@ "type": "string" }, "EnhancedImageMetadataEnabled": { - "markdownDescription": "Collects additional information about the image being created, including the operating system \\(OS\\) version and package list\\. This information is used to enhance the overall experience of using EC2 Image Builder\\. Enabled by default\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Indicates whether Image Builder collects additional information about the image, such as the operating system \\(OS\\) version and package list\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EnhancedImageMetadataEnabled", "type": "boolean" }, @@ -93881,7 +96057,9 @@ "type": "string" }, "ImageScanningConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::Image.ImageScanningConfiguration" + "$ref": "#/definitions/AWS::ImageBuilder::Image.ImageScanningConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ImageScanningConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagescanningconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ImageScanningConfiguration" }, "ImageTestsConfiguration": { "$ref": "#/definitions/AWS::ImageBuilder::Image.ImageTestsConfiguration", @@ -93938,9 +96116,13 @@ "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContainerTags", "type": "array" }, "RepositoryName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RepositoryName", "type": "string" } }, @@ -93950,9 +96132,13 @@ "additionalProperties": false, "properties": { "EcrConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::Image.EcrConfiguration" + "$ref": "#/definitions/AWS::ImageBuilder::Image.EcrConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [EcrConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-ecrconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EcrConfiguration" }, "ImageScanningEnabled": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ImageScanningEnabled", "type": "boolean" } }, @@ -93967,7 +96153,7 @@ "type": "boolean" }, "TimeoutMinutes": { - "markdownDescription": "The maximum time in minutes that tests are permitted to run\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `1440` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum time in minutes that tests are permitted to run\\. \nThe timeoutMinutes attribute is not currently active\\. This value is ignored\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `1440` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TimeoutMinutes", "type": "number" } @@ -94035,7 +96221,9 @@ "type": "string" }, "ImageScanningConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration" + "$ref": "#/definitions/AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ImageScanningConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-imagescanningconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImageScanningConfiguration" }, "ImageTestsConfiguration": { "$ref": "#/definitions/AWS::ImageBuilder::ImagePipeline.ImageTestsConfiguration", @@ -94108,9 +96296,13 @@ "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContainerTags", "type": "array" }, "RepositoryName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RepositoryName", "type": "string" } }, @@ -94120,9 +96312,13 @@ "additionalProperties": false, "properties": { "EcrConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::ImagePipeline.EcrConfiguration" + "$ref": "#/definitions/AWS::ImageBuilder::ImagePipeline.EcrConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [EcrConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-ecrconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EcrConfiguration" }, "ImageScanningEnabled": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImageScanningEnabled", "type": "boolean" } }, @@ -94137,7 +96333,7 @@ "type": "boolean" }, "TimeoutMinutes": { - "markdownDescription": "The maximum time in minutes that tests are permitted to run\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `1440` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum time in minutes that tests are permitted to run\\. \nThe timeoutMinutes attribute is not currently active\\. This value is ignored\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `1440` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutMinutes", "type": "number" } @@ -94148,7 +96344,7 @@ "additionalProperties": false, "properties": { "PipelineExecutionStartCondition": { - "markdownDescription": "The condition configures when the pipeline should trigger a new image build\\. When the `pipelineExecutionStartCondition` is set to `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE`, and you use semantic version filters on the source image or components in your image recipe, Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter\\. When it is set to `EXPRESSION_MATCH_ONLY`, it will build a new image every time the CRON expression matches the current time\\. For semantic version syntax, see [CreateComponent](https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html) in the * Image Builder API Reference*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE | EXPRESSION_MATCH_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The condition configures when the pipeline should trigger a new image build\\. When the `pipelineExecutionStartCondition` is set to `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE`, and you use semantic version filters on the base image or components in your image recipe, Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter\\. When it is set to `EXPRESSION_MATCH_ONLY`, it will build a new image every time the CRON expression matches the current time\\. For semantic version syntax, see [CreateComponent](https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html) in the * Image Builder API Reference*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE | EXPRESSION_MATCH_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PipelineExecutionStartCondition", "type": "string" }, @@ -94227,7 +96423,7 @@ "type": "string" }, "ParentImage": { - "markdownDescription": "The parent image of the image recipe\\. The string must be either an Image ARN \\(SemVers is ok\\) or an AMI ID\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The parent image of the image recipe\\. The string must be either an Image ARN or an AMI ID\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ParentImage", "type": "string" }, @@ -94310,7 +96506,7 @@ "items": { "$ref": "#/definitions/AWS::ImageBuilder::ImageRecipe.ComponentParameter" }, - "markdownDescription": "A group of parameter settings that are used to configure the component for a specific recipe\\. \n*Required*: No \n*Type*: List of [ComponentParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-componentparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A group of parameter settings that Image Builder uses to configure the component for a specific recipe\\. \n*Required*: No \n*Type*: List of [ComponentParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-componentparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Parameters", "type": "array" } @@ -94573,7 +96769,7 @@ "additionalProperties": false, "properties": { "HttpPutResponseHopLimit": { - "markdownDescription": "Limit the number of hops that an instance metadata request can traverse to reach its destination\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Limit the number of hops that an instance metadata request can traverse to reach its destination\\. The default is one hop\\. However, if HTTP tokens are required, container image builds need a minimum of two hops\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HttpPutResponseHopLimit", "type": "number" }, @@ -95295,7 +97491,7 @@ "additionalProperties": false, "properties": { "Comparison": { - "markdownDescription": "The operator to use when comparing values in the filter \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operator to use when comparing values in the filter\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Comparison", "type": "string" }, @@ -95709,10 +97905,14 @@ "title": "DeviceCertificateSharedCheck" }, "IntermediateCaRevokedForActiveDeviceCertificatesCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" + "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration", + "markdownDescription": "*Required*: No \n*Type*: [AuditCheckConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntermediateCaRevokedForActiveDeviceCertificatesCheck" }, "IoTPolicyPotentialMisConfigurationCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" + "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration", + "markdownDescription": "*Required*: No \n*Type*: [AuditCheckConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IoTPolicyPotentialMisConfigurationCheck" }, "IotPolicyOverlyPermissiveCheck": { "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration", @@ -95830,7 +98030,7 @@ "type": "string" }, "EnableCachingForHttp": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableCachingForHttp", "type": "boolean" }, @@ -95931,30 +98131,46 @@ "additionalProperties": false, "properties": { "AutoRegistrationStatus": { + "markdownDescription": "Whether the CA certificate is configured for auto registration of device certificates\\. Valid values are \"ENABLE\" and \"DISABLE\"\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoRegistrationStatus", "type": "string" }, "CACertificatePem": { + "markdownDescription": "The certificate data in PEM format\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CACertificatePem", "type": "string" }, "CertificateMode": { + "markdownDescription": "The mode of the CA\\. \nAll the device certificates that are registered using this CA will be registered in the same mode as the CA\\. For more information about certificate mode for device certificates, see [certificate mode](https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode)\\. \nValid values are \"DEFAULT\" and \"SNI\\_ONLY\"\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CertificateMode", "type": "string" }, "RegistrationConfig": { - "$ref": "#/definitions/AWS::IoT::CACertificate.RegistrationConfig" + "$ref": "#/definitions/AWS::IoT::CACertificate.RegistrationConfig", + "markdownDescription": "Information about the registration configuration\\. \n*Required*: No \n*Type*: [RegistrationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-cacertificate-registrationconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RegistrationConfig" }, "RemoveAutoRegistration": { + "markdownDescription": "If true, removes auto registration\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RemoveAutoRegistration", "type": "boolean" }, "Status": { + "markdownDescription": "The status of the CA certificate\\. \nValid values are \"ACTIVE\" and \"INACTIVE\"\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "VerificationCertificatePem": { + "markdownDescription": "The private key verification certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VerificationCertificatePem", "type": "string" } }, @@ -95989,12 +98205,18 @@ "additionalProperties": false, "properties": { "RoleArn": { + "markdownDescription": "The ARN of the role\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "TemplateBody": { + "markdownDescription": "The template body\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TemplateBody", "type": "string" }, "TemplateName": { + "markdownDescription": "The name of the provisioning template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TemplateName", "type": "string" } }, @@ -96041,7 +98263,7 @@ "type": "string" }, "CertificateMode": { - "markdownDescription": "Specifies which mode of certificate registration to use with this resource\\. Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI\\_ONLY with CertificatePem, and Default with CertificateSigningRequest\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies which mode of certificate registration to use with this resource\\. Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI\\_ONLY with CertificatePem, and Default with CertificateSigningRequest\\. \n`DEFAULT`: A certificate in `DEFAULT` mode is either generated by AWS IoT Core or registered with an issuer certificate authority \\(CA\\)\\. Devices with certificates in `DEFAULT` mode aren't required to send the Server Name Indication \\(SNI\\) extension when connecting to AWS IoT Core\\. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to AWS IoT Core\\. \n`SNI_ONLY`: A certificate in `SNI_ONLY` mode is registered without an issuer CA\\. Devices with certificates in `SNI_ONLY` mode must send the SNI extension when connecting to AWS IoT Core\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CertificateMode", "type": "string" }, @@ -96577,7 +98799,7 @@ "properties": { "AbortConfig": { "$ref": "#/definitions/AWS::IoT::JobTemplate.AbortConfig", - "markdownDescription": "The criteria that determine when and how a job abort takes place\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The criteria that determine when and how a job abort takes place\\. \n*Required*: No \n*Type*: [AbortConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AbortConfig" }, "Description": { @@ -96602,12 +98824,12 @@ }, "JobExecutionsRetryConfig": { "$ref": "#/definitions/AWS::IoT::JobTemplate.JobExecutionsRetryConfig", - "markdownDescription": "Allows you to create the criteria to retry a job\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Allows you to create the criteria to retry a job\\. \n*Required*: No \n*Type*: [JobExecutionsRetryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsretryconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "JobExecutionsRetryConfig" }, "JobExecutionsRolloutConfig": { "$ref": "#/definitions/AWS::IoT::JobTemplate.JobExecutionsRolloutConfig", - "markdownDescription": "Allows you to create a staged rollout of a job\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Allows you to create a staged rollout of a job\\. \n*Required*: No \n*Type*: [JobExecutionsRolloutConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsrolloutconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "JobExecutionsRolloutConfig" }, "JobTemplateId": { @@ -96617,7 +98839,7 @@ }, "PresignedUrlConfig": { "$ref": "#/definitions/AWS::IoT::JobTemplate.PresignedUrlConfig", - "markdownDescription": "Configuration for pre\\-signed S3 URLs\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Configuration for pre\\-signed S3 URLs\\. \n*Required*: No \n*Type*: [PresignedUrlConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-presignedurlconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PresignedUrlConfig" }, "Tags": { @@ -96630,7 +98852,7 @@ }, "TimeoutConfig": { "$ref": "#/definitions/AWS::IoT::JobTemplate.TimeoutConfig", - "markdownDescription": "Specifies the amount of time each device has to finish its execution of the job\\. A timer is started when the job execution status is set to `IN_PROGRESS`\\. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to `TIMED_OUT`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the amount of time each device has to finish its execution of the job\\. A timer is started when the job execution status is set to `IN_PROGRESS`\\. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to `TIMED_OUT`\\. \n*Required*: No \n*Type*: [TimeoutConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-timeoutconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TimeoutConfig" } }, @@ -96668,6 +98890,8 @@ "items": { "$ref": "#/definitions/AWS::IoT::JobTemplate.AbortCriteria" }, + "markdownDescription": "The list of criteria that determine when and how to abort the job\\. \n*Required*: Yes \n*Type*: List of [AbortCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CriteriaList", "type": "array" } }, @@ -96680,15 +98904,23 @@ "additionalProperties": false, "properties": { "Action": { + "markdownDescription": "The type of job action to take to initiate the job abort\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Action", "type": "string" }, "FailureType": { + "markdownDescription": "The type of job execution failures that can initiate a job abort\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FailureType", "type": "string" }, "MinNumberOfExecutedThings": { + "markdownDescription": "The minimum number of things which must receive job execution notifications before the job can be aborted\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MinNumberOfExecutedThings", "type": "number" }, "ThresholdPercentage": { + "markdownDescription": "The minimum percentage of job execution failures that must occur to initiate the job abort\\. \n AWS IoT Core supports up to two digits after the decimal \\(for example, 10\\.9 and 10\\.99, but not 10\\.999\\)\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ThresholdPercentage", "type": "number" } }, @@ -96704,13 +98936,19 @@ "additionalProperties": false, "properties": { "BaseRatePerMinute": { + "markdownDescription": "The minimum number of things that will be notified of a pending job, per minute at the start of job rollout\\. This parameter allows you to define the initial rate of rollout\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BaseRatePerMinute", "type": "number" }, "IncrementFactor": { + "markdownDescription": "The exponential factor to increase the rate of rollout for a job\\. \n AWS IoT Core supports up to one digit after the decimal \\(for example, 1\\.5, but not 1\\.55\\)\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IncrementFactor", "type": "number" }, "RateIncreaseCriteria": { - "$ref": "#/definitions/AWS::IoT::JobTemplate.RateIncreaseCriteria" + "$ref": "#/definitions/AWS::IoT::JobTemplate.RateIncreaseCriteria", + "markdownDescription": "The criteria to initiate the increase in rate of rollout for a job\\. \n*Required*: Yes \n*Type*: [RateIncreaseCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-rateincreasecriteria.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RateIncreaseCriteria" } }, "required": [ @@ -96727,6 +98965,8 @@ "items": { "$ref": "#/definitions/AWS::IoT::JobTemplate.RetryCriteria" }, + "markdownDescription": "The list of criteria that determines how many retries are allowed for each failure type for a job\\. \n*Required*: No \n*Type*: List of [RetryCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-retrycriteria.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetryCriteriaList", "type": "array" } }, @@ -96736,9 +98976,13 @@ "additionalProperties": false, "properties": { "ExponentialRolloutRate": { - "$ref": "#/definitions/AWS::IoT::JobTemplate.ExponentialRolloutRate" + "$ref": "#/definitions/AWS::IoT::JobTemplate.ExponentialRolloutRate", + "markdownDescription": "Allows you to create an exponential rate of rollout for a job\\. \n*Required*: No \n*Type*: [ExponentialRolloutRate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-exponentialrolloutrate.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExponentialRolloutRate" }, "MaximumPerMinute": { + "markdownDescription": "The maximum number of things that will be notified of a pending job, per minute\\. This parameter allows you to create a staged rollout\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaximumPerMinute", "type": "number" } }, @@ -96748,9 +98992,13 @@ "additionalProperties": false, "properties": { "ExpiresInSec": { + "markdownDescription": "How long \\(in seconds\\) pre\\-signed URLs are valid\\. Valid values are 60 \\- 3600, the default value is 3600 seconds\\. Pre\\-signed URLs are generated when Jobs receives an MQTT request for the job document\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExpiresInSec", "type": "number" }, "RoleArn": { + "markdownDescription": "The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored\\. The role must also grant permission for IoT to download the files\\. \nFor information about addressing the confused deputy problem, see [cross\\-service confused deputy prevention](https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html) in the * AWS IoT Core developer guide*\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RoleArn", "type": "string" } }, @@ -96763,9 +99011,13 @@ "additionalProperties": false, "properties": { "NumberOfNotifiedThings": { + "markdownDescription": "The threshold for number of notified things that will initiate the increase in rate of rollout\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NumberOfNotifiedThings", "type": "number" }, "NumberOfSucceededThings": { + "markdownDescription": "The threshold for number of succeeded things that will initiate the increase in rate of rollout\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NumberOfSucceededThings", "type": "number" } }, @@ -96775,9 +99027,13 @@ "additionalProperties": false, "properties": { "FailureType": { + "markdownDescription": "The type of job execution failures that can initiate a job retry\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailureType", "type": "string" }, "NumberOfRetries": { + "markdownDescription": "The number of retries allowed for a failure type for the job\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NumberOfRetries", "type": "number" } }, @@ -96787,6 +99043,8 @@ "additionalProperties": false, "properties": { "InProgressTimeoutInMinutes": { + "markdownDescription": "Specifies the amount of time, in minutes, this device has to finish execution of this job\\. The timeout interval can be anywhere between 1 minute and 7 days \\(1 to 10080 minutes\\)\\. The in progress timer can't be updated and will apply to all job executions for the job\\. Whenever a job execution remains in the IN\\_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal `TIMED_OUT` status\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InProgressTimeoutInMinutes", "type": "number" } }, @@ -96836,7 +99094,7 @@ "type": "string" }, "DefaultLogLevel": { - "markdownDescription": "The default log level\\.Valid Values: `DEBUG | INFO | ERROR | WARN | DISABLED` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The default log level\\. Valid Values: `DEBUG | INFO | ERROR | WARN | DISABLED` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DefaultLogLevel", "type": "string" }, @@ -97130,7 +99388,7 @@ "additionalProperties": false, "properties": { "PolicyDocument": { - "markdownDescription": "The JSON document that describes the policy\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The JSON document that describes the policy\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PolicyDocument", "type": "object" }, @@ -97313,6 +99571,8 @@ "type": "string" }, "TemplateType": { + "markdownDescription": "The type of the provisioning template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TemplateType", "type": "string" } }, @@ -97474,18 +99734,26 @@ "additionalProperties": false, "properties": { "CredentialDurationSeconds": { + "markdownDescription": "The number of seconds for which the credential is valid\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CredentialDurationSeconds", "type": "number" }, "RoleAlias": { + "markdownDescription": "The role alias\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RoleAlias", "type": "string" }, "RoleArn": { + "markdownDescription": "The role ARN\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -98240,7 +100508,9 @@ "title": "Lambda" }, "Location": { - "$ref": "#/definitions/AWS::IoT::TopicRule.LocationAction" + "$ref": "#/definitions/AWS::IoT::TopicRule.LocationAction", + "markdownDescription": "Sends device location data to [Amazon Location Service](https://docs.aws.amazon.com/location/latest/developerguide/welcome.html)\\. \n*Required*: No \n*Type*: [LocationAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Location" }, "OpenSearch": { "$ref": "#/definitions/AWS::IoT::TopicRule.OpenSearchAction", @@ -98386,6 +100656,8 @@ "additionalProperties": false, "properties": { "BatchMode": { + "markdownDescription": "Indicates whether batches of log records will be extracted and uploaded into CloudWatch\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchMode", "type": "boolean" }, "LogGroupName": { @@ -98812,21 +101084,33 @@ "additionalProperties": false, "properties": { "DeviceId": { + "markdownDescription": "The unique ID of the device providing the location data\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeviceId", "type": "string" }, "Latitude": { + "markdownDescription": "A string that evaluates to a double value that represents the latitude of the device's location\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Latitude", "type": "string" }, "Longitude": { + "markdownDescription": "A string that evaluates to a double value that represents the longitude of the device's location\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Longitude", "type": "string" }, "RoleArn": { + "markdownDescription": "The IAM role that grants permission to write to the Amazon Location resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "Timestamp": { - "$ref": "#/definitions/AWS::IoT::TopicRule.Timestamp" + "$ref": "#/definitions/AWS::IoT::TopicRule.Timestamp", + "markdownDescription": "The time that the location data was sampled\\. The default value is the time the MQTT message was processed\\. \n*Required*: No \n*Type*: [Timestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestamp.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Timestamp" }, "TrackerName": { + "markdownDescription": "The name of the tracker resource in Amazon Location in which the location is updated\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrackerName", "type": "string" } }, @@ -98932,7 +101216,9 @@ "additionalProperties": false, "properties": { "Headers": { - "$ref": "#/definitions/AWS::IoT::TopicRule.RepublishActionHeaders" + "$ref": "#/definitions/AWS::IoT::TopicRule.RepublishActionHeaders", + "markdownDescription": "MQTT Version 5\\.0 headers information\\. For more information, see [MQTT](https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html) in the IoT Core Developer Guide\\. \n*Required*: No \n*Type*: [RepublishActionHeaders](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Headers" }, "Qos": { "markdownDescription": "The Quality of Service \\(QoS\\) level to use when republishing messages\\. The default value is 0\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -98960,24 +101246,36 @@ "additionalProperties": false, "properties": { "ContentType": { + "markdownDescription": "A UTF\\-8 encoded string that describes the content of the publishing message\\. \nFor more information, see [ Content Type](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901118) in the MQTT Version 5\\.0 specification\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContentType", "type": "string" }, "CorrelationData": { + "markdownDescription": "The base64\\-encoded binary data used by the sender of the request message to identify which request the response message is for\\. \nFor more information, see [ Correlation Data](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901115) in the MQTT Version 5\\.0 specification\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n This binary data must be base64\\-encoded\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CorrelationData", "type": "string" }, "MessageExpiry": { + "markdownDescription": "A user\\-defined integer value that represents the message expiry interval at the broker\\. If the messages haven't been sent to the subscribers within that interval, the message expires and is removed\\. The value of `messageExpiry` represents the number of seconds before it expires\\. For more information about the limits of `messageExpiry`, see [Message broker and protocol limits and quotas](https://docs.aws.amazon.com/general/latest/gr/iot-core.html#limits_iot) in the IoT Core Reference Guide\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageExpiry", "type": "string" }, "PayloadFormatIndicator": { + "markdownDescription": "An `Enum` string value that indicates whether the payload is formatted as UTF\\-8\\. \nValid values are `UNSPECIFIED_BYTES` and `UTF8_DATA`\\. \nFor more information, see [ Payload Format Indicator](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111) from the MQTT Version 5\\.0 specification\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PayloadFormatIndicator", "type": "string" }, "ResponseTopic": { + "markdownDescription": "A UTF\\-8 encoded string that's used as the topic name for a response message\\. The response topic is used to describe the topic to which the receiver should publish as part of the request\\-response flow\\. The topic must not contain wildcard characters\\. \nFor more information, see [ Response Topic](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901114) in the MQTT Version 5\\.0 specification\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResponseTopic", "type": "string" }, "UserProperties": { "items": { "$ref": "#/definitions/AWS::IoT::TopicRule.UserProperty" }, + "markdownDescription": "An array of key\\-value pairs that you define in the MQTT5 header\\. \n*Required*: No \n*Type*: List of [UserProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-userproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserProperties", "type": "array" } }, @@ -99119,9 +101417,13 @@ "additionalProperties": false, "properties": { "Unit": { + "markdownDescription": "The precision of the timestamp value that results from the expression described in `value`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Unit", "type": "string" }, "Value": { + "markdownDescription": "An expression that returns a long epoch time value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -99257,9 +101559,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "A key to be specified in `UserProperty`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "A value to be specified in `UserProperty`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -99475,7 +101781,7 @@ "title": "CustomerManagedS3" }, "ServiceManagedS3": { - "markdownDescription": "Used to store channel data in an S3 bucket managed by AWS IoT Analytics\\. You can't change the choice of S3 storage after the data store is created\\. \n*Required*: No \n*Type*: [ServiceManagedS3](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-servicemanageds3.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Used to store channel data in an S3 bucket managed by AWS IoT Analytics\\. You can't change the choice of S3 storage after the data store is created\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceManagedS3", "type": "object" } @@ -100258,7 +102564,7 @@ "title": "IotSiteWiseMultiLayerStorage" }, "ServiceManagedS3": { - "markdownDescription": "Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service\\. The choice of service\\-managed or customer\\-managed S3 storage cannot be changed after creation of the data store\\. \n*Required*: No \n*Type*: [ServiceManagedS3](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-servicemanageds3.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service\\. The choice of service\\-managed or customer\\-managed S3 storage cannot be changed after creation of the data store\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceManagedS3", "type": "object" } @@ -100269,7 +102575,7 @@ "additionalProperties": false, "properties": { "JsonConfiguration": { - "markdownDescription": "Contains the configuration information of the JSON format\\. \n*Required*: No \n*Type*: [JsonConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-jsonconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains the configuration information of the JSON format\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "JsonConfiguration", "type": "object" }, @@ -100835,7 +103141,7 @@ "properties": { "SuiteDefinitionConfiguration": { "$ref": "#/definitions/AWS::IoTCoreDeviceAdvisor::SuiteDefinition.SuiteDefinitionConfiguration", - "markdownDescription": "The configuration of the Suite Definition\\. Listed below are the required elements of the `SuiteDefinitionConfiguration`\\. \n**devicePermissionRoleArn** \nThe device permission arn\\. \nThis is a required element\\. \n**Type:** String \n**devices** \nThe list of configured devices under test\\. For more information on devices under test, see [DeviceUnderTest](http://amazonaws.com/iot/latest/apireference/API_iotdeviceadvisor_DeviceUnderTest.html) \nNot a required element\\. \n**Type:** List of devices under test \n**intendedForQualification** \nThe tests intended for qualification in a suite\\. \nNot a required element\\. \n**Type:** Boolean \n**rootGroup** \nThe test suite root group\\. For more information on creating and using root groups see the [Device Advisor workflow](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html)\\. \nThis is a required element\\. \n**Type:** String \n**suiteDefinitionName** \nThe Suite Definition Configuration name\\. \nThis is a required element\\. \n**Type:** String\n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The configuration of the Suite Definition\\. Listed below are the required elements of the `SuiteDefinitionConfiguration`\\. \n**devicePermissionRoleArn** \nThe device permission arn\\. \nThis is a required element\\. \n**Type:** String \n**devices** \nThe list of configured devices under test\\. For more information on devices under test, see [DeviceUnderTest](http://amazonaws.com/iot/latest/apireference/API_iotdeviceadvisor_DeviceUnderTest.html) \nNot a required element\\. \n**Type:** List of devices under test \n**intendedForQualification** \nThe tests intended for qualification in a suite\\. \nNot a required element\\. \n**Type:** Boolean \n**rootGroup** \nThe test suite root group\\. For more information on creating and using root groups see the [Device Advisor workflow](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html)\\. \nThis is a required element\\. \n**Type:** String \n**suiteDefinitionName** \nThe Suite Definition Configuration name\\. \nThis is a required element\\. \n**Type:** String\n*Required*: Yes \n*Type*: [SuiteDefinitionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuiteDefinitionConfiguration" }, "Tags": { @@ -100877,9 +103183,13 @@ "additionalProperties": false, "properties": { "CertificateArn": { + "markdownDescription": "Lists devices certificate ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertificateArn", "type": "string" }, "ThingArn": { + "markdownDescription": "Lists devices thing ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ThingArn", "type": "string" } }, @@ -100889,21 +103199,31 @@ "additionalProperties": false, "properties": { "DevicePermissionRoleArn": { + "markdownDescription": "Gets the device permission ARN\\. This is a required parameter\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DevicePermissionRoleArn", "type": "string" }, "Devices": { "items": { "$ref": "#/definitions/AWS::IoTCoreDeviceAdvisor::SuiteDefinition.DeviceUnderTest" }, + "markdownDescription": "Gets the devices configured\\. \n*Required*: No \n*Type*: List of [DeviceUnderTest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-deviceundertest.html) \n*Maximum*: `2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Devices", "type": "array" }, "IntendedForQualification": { + "markdownDescription": "Gets the tests intended for qualification in a suite\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntendedForQualification", "type": "boolean" }, "RootGroup": { + "markdownDescription": "Gets the test suite root group\\. This is a required parameter\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RootGroup", "type": "string" }, "SuiteDefinitionName": { + "markdownDescription": "Gets the suite definition name\\. This is a required parameter\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SuiteDefinitionName", "type": "string" } }, @@ -100949,33 +103269,51 @@ "additionalProperties": false, "properties": { "AlarmCapabilities": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmCapabilities" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmCapabilities", + "markdownDescription": "Contains the configuration information of alarm state changes\\. \n*Required*: No \n*Type*: [AlarmCapabilities](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmCapabilities" }, "AlarmEventActions": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmEventActions" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmEventActions", + "markdownDescription": "Contains information about one or more alarm actions\\. \n*Required*: No \n*Type*: [AlarmEventActions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmeventactions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmEventActions" }, "AlarmModelDescription": { + "markdownDescription": "The description of the alarm model\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmModelDescription", "type": "string" }, "AlarmModelName": { + "markdownDescription": "The name of the alarm model\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9_-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AlarmModelName", "type": "string" }, "AlarmRule": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmRule" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmRule", + "markdownDescription": "Defines when your alarm is invoked\\. \n*Required*: Yes \n*Type*: [AlarmRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmRule" }, "Key": { + "markdownDescription": "An input attribute used as a key to create an alarm\\. AWS IoT Events routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^((`[\\w\\- ]+`)|([\\w\\-]+))(\\.((`[\\w- ]+`)|([\\w\\-]+)))*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" }, "RoleArn": { + "markdownDescription": "The ARN of the IAM role that allows the alarm to perform actions and access AWS resources\\. For more information, see [Amazon Resource Names \\(ARNs\\)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "Severity": { + "markdownDescription": "A non\\-negative integer that reflects the severity level of the alarm\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Severity", "type": "number" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of key\\-value pairs that contain metadata for the alarm model\\. The tags help you manage the alarm model\\. For more information, see [Tagging your AWS IoT Events resources](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the * AWS IoT Events Developer Guide*\\. \nYou can create up to 50 tags for one alarm model\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -101010,6 +103348,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "The value must be `TRUE` or `FALSE`\\. If `TRUE`, you receive a notification when the alarm state changes\\. You must choose to acknowledge the notification before the alarm state can return to `NORMAL`\\. If `FALSE`, you won't receive notifications\\. The alarm automatically changes to the `NORMAL` state when the input property value returns to the specified range\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" } }, @@ -101019,31 +103359,49 @@ "additionalProperties": false, "properties": { "DynamoDB": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.DynamoDB" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.DynamoDB", + "markdownDescription": "Defines an action to write to the Amazon DynamoDB table that you created\\. The standard action payload contains all the information about the detector model instance and the event that triggered the action\\. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html)\\. One column of the DynamoDB table receives all attribute\\-value pairs in the payload that you specify\\. \nYou must use expressions for all parameters in `DynamoDBAction`\\. The expressions accept literals, operators, functions, references, and substitution templates\\.", + "title": "DynamoDB" }, "DynamoDBv2": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.DynamoDBv2" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.DynamoDBv2", + "markdownDescription": "Defines an action to write to the Amazon DynamoDB table that you created\\. The default action payload contains all the information about the detector model instance and the event that triggered the action\\. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html)\\. A separate column of the DynamoDB table receives one attribute\\-value pair in the payload that you specify\\. \nYou must use expressions for all parameters in `DynamoDBv2Action`\\. The expressions accept literals, operators, functions, references, and substitution templates\\.", + "title": "DynamoDBv2" }, "Firehose": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Firehose" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Firehose", + "markdownDescription": "Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream\\. \n*Required*: No \n*Type*: [Firehose](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Firehose" }, "IotEvents": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.IotEvents" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.IotEvents", + "markdownDescription": "Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action\\. \n*Required*: No \n*Type*: [IotEvents](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IotEvents" }, "IotSiteWise": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.IotSiteWise" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.IotSiteWise", + "markdownDescription": "Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise\\. \nYou must use expressions for all parameters in `IotSiteWiseAction`\\. The expressions accept literals, operators, functions, references, and substitutions templates\\.", + "title": "IotSiteWise" }, "IotTopicPublish": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.IotTopicPublish" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.IotTopicPublish", + "markdownDescription": "Information required to publish the MQTT message through the AWS IoT message broker\\. \n*Required*: No \n*Type*: [IotTopicPublish](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IotTopicPublish" }, "Lambda": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Lambda" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Lambda", + "markdownDescription": "Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action\\. \n*Required*: No \n*Type*: [Lambda](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Lambda" }, "Sns": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Sns" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Sns", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Sns](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sns" }, "Sqs": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Sqs" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Sqs", + "markdownDescription": "Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue\\. \n*Required*: No \n*Type*: [Sqs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sqs" } }, "type": "object" @@ -101052,10 +103410,14 @@ "additionalProperties": false, "properties": { "AcknowledgeFlow": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AcknowledgeFlow" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AcknowledgeFlow", + "markdownDescription": "Specifies whether to get notified for alarm state changes\\. \n*Required*: No \n*Type*: [AcknowledgeFlow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-acknowledgeflow.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AcknowledgeFlow" }, "InitializationConfiguration": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.InitializationConfiguration" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.InitializationConfiguration", + "markdownDescription": "Specifies the default alarm state\\. The configuration applies to all alarms that were created based on this alarm model\\. \n*Required*: No \n*Type*: [InitializationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-initializationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InitializationConfiguration" } }, "type": "object" @@ -101067,6 +103429,8 @@ "items": { "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmAction" }, + "markdownDescription": "Specifies one or more supported actions to receive notifications when the alarm state changes\\. \n*Required*: No \n*Type*: List of [AlarmAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmActions", "type": "array" } }, @@ -101076,7 +103440,9 @@ "additionalProperties": false, "properties": { "SimpleRule": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.SimpleRule" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.SimpleRule", + "markdownDescription": "A rule that compares an input property value to a threshold value with a comparison operator\\. \n*Required*: No \n*Type*: [SimpleRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SimpleRule" } }, "type": "object" @@ -101085,9 +103451,13 @@ "additionalProperties": false, "properties": { "OffsetInNanos": { + "markdownDescription": "The nanosecond offset converted from `timeInSeconds`\\. The valid range is between 0\\-999999999\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OffsetInNanos", "type": "string" }, "TimeInSeconds": { + "markdownDescription": "The timestamp, in seconds, in the Unix epoch format\\. The valid range is between 1\\-31556889864403199\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TimeInSeconds", "type": "string" } }, @@ -101100,13 +103470,19 @@ "additionalProperties": false, "properties": { "Quality": { + "markdownDescription": "The quality of the asset property value\\. The value must be `'GOOD'`, `'BAD'`, or `'UNCERTAIN'`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Quality", "type": "string" }, "Timestamp": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AssetPropertyTimestamp" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AssetPropertyTimestamp", + "markdownDescription": "The timestamp associated with the asset property value\\. The default is the current event time\\. \n*Required*: No \n*Type*: [AssetPropertyTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Timestamp" }, "Value": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AssetPropertyVariant" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AssetPropertyVariant", + "markdownDescription": "The value to send to an asset property\\. \n*Required*: Yes \n*Type*: [AssetPropertyVariant](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value" } }, "required": [ @@ -101118,15 +103494,23 @@ "additionalProperties": false, "properties": { "BooleanValue": { + "markdownDescription": "The asset property value is a Boolean value that must be `'TRUE'` or `'FALSE'`\\. You must use an expression, and the evaluated result should be a Boolean value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BooleanValue", "type": "string" }, "DoubleValue": { + "markdownDescription": "The asset property value is a double\\. You must use an expression, and the evaluated result should be a double\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DoubleValue", "type": "string" }, "IntegerValue": { + "markdownDescription": "The asset property value is an integer\\. You must use an expression, and the evaluated result should be an integer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntegerValue", "type": "string" }, "StringValue": { + "markdownDescription": "The asset property value is a string\\. You must use an expression, and the evaluated result should be a string\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StringValue", "type": "string" } }, @@ -101136,33 +103520,53 @@ "additionalProperties": false, "properties": { "HashKeyField": { + "markdownDescription": "The name of the hash key \\(also called the partition key\\)\\. The `hashKeyField` value must match the partition key of the target DynamoDB table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HashKeyField", "type": "string" }, "HashKeyType": { + "markdownDescription": "The data type for the hash key \\(also called the partition key\\)\\. You can specify the following values: \n+ `'STRING'` \\- The hash key is a string\\.\n+ `'NUMBER'` \\- The hash key is a number\\.\nIf you don't specify `hashKeyType`, the default value is `'STRING'`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HashKeyType", "type": "string" }, "HashKeyValue": { + "markdownDescription": "The value of the hash key \\(also called the partition key\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HashKeyValue", "type": "string" }, "Operation": { + "markdownDescription": "The type of operation to perform\\. You can specify the following values: \n+ `'INSERT'` \\- Insert data as a new item into the DynamoDB table\\. This item uses the specified hash key as a partition key\\. If you specified a range key, the item uses the range key as a sort key\\.\n+ `'UPDATE'` \\- Update an existing item of the DynamoDB table with new data\\. This item's partition key must match the specified hash key\\. If you specified a range key, the range key must match the item's sort key\\.\n+ `'DELETE'` \\- Delete an existing item of the DynamoDB table\\. This item's partition key must match the specified hash key\\. If you specified a range key, the range key must match the item's sort key\\.\nIf you don't specify this parameter, AWS IoT Events triggers the `'INSERT'` operation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Operation", "type": "string" }, "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "Information needed to configure the payload\\. \nBy default, AWS IoT Events generates a standard payload in JSON for any action\\. This action payload contains all attribute\\-value pairs that have the information about the detector model instance and the event triggered the action\\. To configure the action payload, you can use `contentExpression`\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" }, "PayloadField": { + "markdownDescription": "The name of the DynamoDB column that receives the action payload\\. \nIf you don't specify this parameter, the name of the DynamoDB column is `payload`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PayloadField", "type": "string" }, "RangeKeyField": { + "markdownDescription": "The name of the range key \\(also called the sort key\\)\\. The `rangeKeyField` value must match the sort key of the target DynamoDB table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RangeKeyField", "type": "string" }, "RangeKeyType": { + "markdownDescription": "The data type for the range key \\(also called the sort key\\), You can specify the following values: \n+ `'STRING'` \\- The range key is a string\\.\n+ `'NUMBER'` \\- The range key is number\\.\nIf you don't specify `rangeKeyField`, the default value is `'STRING'`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RangeKeyType", "type": "string" }, "RangeKeyValue": { + "markdownDescription": "The value of the range key \\(also called the sort key\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RangeKeyValue", "type": "string" }, "TableName": { + "markdownDescription": "The name of the DynamoDB table\\. The `tableName` value must match the table name of the target DynamoDB table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TableName", "type": "string" } }, @@ -101177,9 +103581,13 @@ "additionalProperties": false, "properties": { "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" }, "TableName": { + "markdownDescription": "The name of the DynamoDB table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TableName", "type": "string" } }, @@ -101192,12 +103600,18 @@ "additionalProperties": false, "properties": { "DeliveryStreamName": { + "markdownDescription": "The name of the Kinesis Data Firehose delivery stream where the data is written\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeliveryStreamName", "type": "string" }, "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" }, "Separator": { + "markdownDescription": "A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream\\. Valid values are: '\\\\n' \\(newline\\), '\\\\t' \\(tab\\), '\\\\r\\\\n' \\(Windows newline\\), ',' \\(comma\\)\\. \n*Required*: No \n*Type*: String \n*Pattern*: `([\\n\\t])|(\\r\\n)|(,)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Separator", "type": "string" } }, @@ -101210,6 +103624,8 @@ "additionalProperties": false, "properties": { "DisabledOnInitialization": { + "markdownDescription": "The value must be `TRUE` or `FALSE`\\. If `FALSE`, all alarm instances created based on the alarm model are activated\\. The default value is `TRUE`\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DisabledOnInitialization", "type": "boolean" } }, @@ -101222,10 +103638,14 @@ "additionalProperties": false, "properties": { "InputName": { + "markdownDescription": "The name of the AWS IoT Events input where the data is sent\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputName", "type": "string" }, "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "You can configure the action payload when you send a message to an AWS IoT Events input\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" } }, "required": [ @@ -101237,19 +103657,29 @@ "additionalProperties": false, "properties": { "AssetId": { + "markdownDescription": "The ID of the asset that has the specified property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssetId", "type": "string" }, "EntryId": { + "markdownDescription": "A unique identifier for this entry\\. You can use the entry ID to track which data entry causes an error in case of failure\\. The default is a new unique identifier\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EntryId", "type": "string" }, "PropertyAlias": { + "markdownDescription": "The alias of the asset property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PropertyAlias", "type": "string" }, "PropertyId": { + "markdownDescription": "The ID of the asset property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PropertyId", "type": "string" }, "PropertyValue": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AssetPropertyValue" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AssetPropertyValue", + "markdownDescription": "The value to send to the asset property\\. This value contains timestamp, quality, and value \\(TQV\\) information\\. \n*Required*: No \n*Type*: [AssetPropertyValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PropertyValue" } }, "type": "object" @@ -101258,10 +103688,14 @@ "additionalProperties": false, "properties": { "MqttTopic": { + "markdownDescription": "The MQTT topic of the message\\. You can use a string expression that includes variables \\(`$variable.`\\) and input values \\(`$input..`\\) as the topic string\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MqttTopic", "type": "string" }, "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "You can configure the action payload when you publish a message to an AWS IoT Core topic\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" } }, "required": [ @@ -101273,10 +103707,14 @@ "additionalProperties": false, "properties": { "FunctionArn": { + "markdownDescription": "The ARN of the Lambda function that is executed\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FunctionArn", "type": "string" }, "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "You can configure the action payload when you send a message to a Lambda function\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" } }, "required": [ @@ -101288,9 +103726,13 @@ "additionalProperties": false, "properties": { "ContentExpression": { + "markdownDescription": "The content of the payload\\. You can use a string expression that includes quoted strings \\(`''`\\), variables \\(`$variable.`\\), input values \\(`$input..`\\), string concatenations, and quoted strings that contain `${}` as the content\\. The recommended maximum size of a content expression is 1 KB\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContentExpression", "type": "string" }, "Type": { + "markdownDescription": "The value of the payload type can be either `STRING` or `JSON`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `JSON | STRING` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -101304,12 +103746,18 @@ "additionalProperties": false, "properties": { "ComparisonOperator": { + "markdownDescription": "The comparison operator\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `EQUAL | GREATER | GREATER_OR_EQUAL | LESS | LESS_OR_EQUAL | NOT_EQUAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ComparisonOperator", "type": "string" }, "InputProperty": { + "markdownDescription": "The value on the left side of the comparison operator\\. You can specify an AWS IoT Events input attribute as an input property\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputProperty", "type": "string" }, "Threshold": { + "markdownDescription": "The value on the right side of the comparison operator\\. You can enter a number or specify an AWS IoT Events input attribute\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Threshold", "type": "string" } }, @@ -101324,9 +103772,13 @@ "additionalProperties": false, "properties": { "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "You can configure the action payload when you send a message as an Amazon SNS push notification\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" }, "TargetArn": { + "markdownDescription": "The ARN of the Amazon SNS target where the message is sent\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetArn", "type": "string" } }, @@ -101339,12 +103791,18 @@ "additionalProperties": false, "properties": { "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "You can configure the action payload when you send a message to an Amazon SQS queue\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" }, "QueueUrl": { + "markdownDescription": "The URL of the SQS queue where the data is written\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "QueueUrl", "type": "string" }, "UseBase64": { + "markdownDescription": "Set this to TRUE if you want the data to be base\\-64 encoded before it is written to the queue\\. Otherwise, set this to FALSE\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseBase64", "type": "boolean" } }, @@ -102325,60 +104783,92 @@ "additionalProperties": false, "properties": { "Action": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Action", "type": "string" }, "CollectionScheme": { - "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.CollectionScheme" + "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.CollectionScheme", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [CollectionScheme](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CollectionScheme" }, "Compression": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Compression", "type": "string" }, "DataExtraDimensions": { "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataExtraDimensions", "type": "array" }, "Description": { + "markdownDescription": "The description of the campaign\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "DiagnosticsMode": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DiagnosticsMode", "type": "string" }, "ExpiryTime": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExpiryTime", "type": "string" }, "Name": { + "markdownDescription": "The name of a campaign\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z\\d\\-_:]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "PostTriggerCollectionDuration": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PostTriggerCollectionDuration", "type": "number" }, "Priority": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Priority", "type": "number" }, "SignalCatalogArn": { + "markdownDescription": "The ARN of the signal catalog associated with the campaign\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SignalCatalogArn", "type": "string" }, "SignalsToCollect": { "items": { "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.SignalInformation" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [SignalInformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SignalsToCollect", "type": "array" }, "SpoolingMode": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SpoolingMode", "type": "string" }, "StartTime": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StartTime", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TargetArn": { + "markdownDescription": "The ARN of a vehicle or fleet to which the campaign is deployed\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TargetArn", "type": "string" } }, @@ -102416,10 +104906,14 @@ "additionalProperties": false, "properties": { "ConditionBasedCollectionScheme": { - "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.ConditionBasedCollectionScheme" + "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.ConditionBasedCollectionScheme", + "markdownDescription": "Information about a collection scheme that uses a simple logical expression to recognize what data to collect\\. \n*Required*: No \n*Type*: [ConditionBasedCollectionScheme](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConditionBasedCollectionScheme" }, "TimeBasedCollectionScheme": { - "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.TimeBasedCollectionScheme" + "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.TimeBasedCollectionScheme", + "markdownDescription": "Information about a collection scheme that uses a time period to decide how often to collect data\\. \n*Required*: No \n*Type*: [TimeBasedCollectionScheme](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedcollectionscheme.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TimeBasedCollectionScheme" } }, "type": "object" @@ -102428,15 +104922,23 @@ "additionalProperties": false, "properties": { "ConditionLanguageVersion": { + "markdownDescription": "Specifies the version of the conditional expression language\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConditionLanguageVersion", "type": "number" }, "Expression": { + "markdownDescription": "The logical expression used to recognize what data to collect\\. For example, `$variable.Vehicle.OutsideAirTemperature >= 105.0`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Expression", "type": "string" }, "MinimumTriggerIntervalMs": { + "markdownDescription": "The minimum duration of time between two triggering events to collect data, in milliseconds\\. \nIf a signal changes often, you might want to collect data at a slower rate\\.\n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MinimumTriggerIntervalMs", "type": "number" }, "TriggerMode": { + "markdownDescription": "Whether to collect data for all triggering events \\(`ALWAYS`\\)\\. Specify \\(`RISING_EDGE`\\), or specify only when the condition first evaluates to false\\. For example, triggering on \"AirbagDeployed\"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS | RISING_EDGE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TriggerMode", "type": "string" } }, @@ -102449,12 +104951,18 @@ "additionalProperties": false, "properties": { "MaxSampleCount": { + "markdownDescription": "The maximum number of samples to collect\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxSampleCount", "type": "number" }, "MinimumSamplingIntervalMs": { + "markdownDescription": "The minimum duration of time \\(in milliseconds\\) between two triggering events to collect data\\. \nIf a signal changes often, you might want to collect data at a slower rate\\.\n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MinimumSamplingIntervalMs", "type": "number" }, "Name": { + "markdownDescription": "The name of the signal\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `150` \n*Pattern*: `[\\w|*|-]+(\\.[\\w|*|-]+)*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -102467,6 +104975,8 @@ "additionalProperties": false, "properties": { "PeriodMs": { + "markdownDescription": "The time period \\(in milliseconds\\) to decide how often to collect data\\. For example, if the time period is `60000`, the Edge Agent software collects data once every minute\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PeriodMs", "type": "number" } }, @@ -102511,33 +105021,47 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A brief description of the decoder manifest\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "ModelManifestArn": { + "markdownDescription": "The ARN of a vehicle model \\(model manifest\\) associated with the decoder manifest\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelManifestArn", "type": "string" }, "Name": { + "markdownDescription": "The name of the decoder manifest\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "NetworkInterfaces": { "items": { "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.NetworkInterfacesItems" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [NetworkInterfacesItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkInterfaces", "type": "array" }, "SignalDecoders": { "items": { "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.SignalDecodersItems" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [SignalDecodersItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-signaldecodersitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SignalDecoders", "type": "array" }, "Status": { + "markdownDescription": "The state of the decoder manifest\\. If the status is `ACTIVE`, the decoder manifest can't be edited\\. If the status is marked `DRAFT`, you can edit the decoder manifest\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | DRAFT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -102572,12 +105096,18 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The unique name of the interface\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ProtocolName": { + "markdownDescription": "The name of the communication protocol for the interface\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ProtocolName", "type": "string" }, "ProtocolVersion": { + "markdownDescription": "The version of the communication protocol for the interface\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ProtocolVersion", "type": "string" } }, @@ -102590,27 +105120,43 @@ "additionalProperties": false, "properties": { "Factor": { + "markdownDescription": "A multiplier used to decode the CAN message\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Factor", "type": "string" }, "IsBigEndian": { + "markdownDescription": "Whether the byte ordering of a CAN message is big\\-endian\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsBigEndian", "type": "string" }, "IsSigned": { + "markdownDescription": "Whether the message data is specified as a signed value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsSigned", "type": "string" }, "Length": { + "markdownDescription": "How many bytes of data are in the message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Length", "type": "string" }, "MessageId": { + "markdownDescription": "The ID of the message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageId", "type": "string" }, "Name": { + "markdownDescription": "The name of the signal\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Offset": { + "markdownDescription": "Indicates where data appears in the CAN message\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Offset", "type": "string" }, "StartBit": { + "markdownDescription": "Indicates the beginning of the CAN message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StartBit", "type": "string" } }, @@ -102629,15 +105175,23 @@ "additionalProperties": false, "properties": { "CanInterface": { - "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.CanInterface" + "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.CanInterface", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [CanInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CanInterface" }, "InterfaceId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InterfaceId", "type": "string" }, "ObdInterface": { - "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.ObdInterface" + "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.ObdInterface", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ObdInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObdInterface" }, "Type": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -102651,24 +105205,38 @@ "additionalProperties": false, "properties": { "DtcRequestIntervalSeconds": { + "markdownDescription": "The maximum number message requests per diagnostic trouble code per second\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DtcRequestIntervalSeconds", "type": "string" }, "HasTransmissionEcu": { + "markdownDescription": "Whether the vehicle has a transmission control module \\(TCM\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HasTransmissionEcu", "type": "string" }, "Name": { + "markdownDescription": "The name of the interface\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ObdStandard": { + "markdownDescription": "The standard OBD II PID\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObdStandard", "type": "string" }, "PidRequestIntervalSeconds": { + "markdownDescription": "The maximum number message requests per second\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PidRequestIntervalSeconds", "type": "string" }, "RequestMessageId": { + "markdownDescription": "The ID of the message requesting vehicle data\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RequestMessageId", "type": "string" }, "UseExtendedIds": { + "markdownDescription": "Whether to use extended IDs in the message\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseExtendedIds", "type": "string" } }, @@ -102682,30 +105250,48 @@ "additionalProperties": false, "properties": { "BitMaskLength": { + "markdownDescription": "The number of bits to mask in a message\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BitMaskLength", "type": "string" }, "BitRightShift": { + "markdownDescription": "The number of positions to shift bits in the message\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BitRightShift", "type": "string" }, "ByteLength": { + "markdownDescription": "The length of a message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ByteLength", "type": "string" }, "Offset": { + "markdownDescription": "Indicates where data appears in the message\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Offset", "type": "string" }, "Pid": { + "markdownDescription": "The diagnostic code used to request data from a vehicle for this signal\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pid", "type": "string" }, "PidResponseLength": { + "markdownDescription": "The length of the requested data\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PidResponseLength", "type": "string" }, "Scaling": { + "markdownDescription": "A multiplier used to decode the message\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Scaling", "type": "string" }, "ServiceMode": { + "markdownDescription": "The mode of operation \\(diagnostic service\\) in a message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceMode", "type": "string" }, "StartByte": { + "markdownDescription": "Indicates the beginning of the message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StartByte", "type": "string" } }, @@ -102724,18 +105310,28 @@ "additionalProperties": false, "properties": { "CanSignal": { - "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.CanSignal" + "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.CanSignal", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [CanSignal](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CanSignal" }, "FullyQualifiedName": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FullyQualifiedName", "type": "string" }, "InterfaceId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InterfaceId", "type": "string" }, "ObdSignal": { - "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.ObdSignal" + "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.ObdSignal", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ObdSignal](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObdSignal" }, "Type": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -102782,18 +105378,26 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A brief description of the fleet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Id": { + "markdownDescription": "The unique ID of the fleet\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z0-9:_-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Id", "type": "string" }, "SignalCatalogArn": { + "markdownDescription": "The ARN of the signal catalog associated with the fleet\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SignalCatalogArn", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -102860,27 +105464,39 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A brief description of the vehicle model\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the vehicle model\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Nodes": { "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Nodes", "type": "array" }, "SignalCatalogArn": { + "markdownDescription": "The ARN of the signal catalog associated with the vehicle model\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SignalCatalogArn", "type": "string" }, "Status": { + "markdownDescription": "The state of the vehicle model\\. If the status is `ACTIVE`, the vehicle model can't be edited\\. If the status is `DRAFT`, you can edit the vehicle model\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | DRAFT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -102947,24 +105563,34 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the signal catalog\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "NodeCounts": { - "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.NodeCounts" + "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.NodeCounts", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [NodeCounts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NodeCounts" }, "Nodes": { "items": { "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Node" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Node](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Nodes", "type": "array" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -102997,27 +105623,43 @@ "items": { "type": "string" }, + "markdownDescription": "A list of possible values an actuator can take\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowedValues", "type": "array" }, "AssignedValue": { + "markdownDescription": "A specified value for the actuator\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssignedValue", "type": "string" }, "DataType": { + "markdownDescription": "The specified data type of the actuator\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BOOLEAN | BOOLEAN_ARRAY | DOUBLE | DOUBLE_ARRAY | FLOAT | FLOAT_ARRAY | INT16 | INT16_ARRAY | INT32 | INT32_ARRAY | INT64 | INT64_ARRAY | INT8 | INT8_ARRAY | STRING | STRING_ARRAY | UINT16 | UINT16_ARRAY | UINT32 | UINT32_ARRAY | UINT64 | UINT64_ARRAY | UINT8 | UINT8_ARRAY | UNIX_TIMESTAMP | UNIX_TIMESTAMP_ARRAY | UNKNOWN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType", "type": "string" }, "Description": { + "markdownDescription": "A brief description of the actuator\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "FullyQualifiedName": { + "markdownDescription": "The fully qualified name of the actuator\\. For example, the fully qualified name of an actuator might be `Vehicle.Front.Left.Door.Lock`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FullyQualifiedName", "type": "string" }, "Max": { + "markdownDescription": "The specified possible maximum value of an actuator\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Max", "type": "number" }, "Min": { + "markdownDescription": "The specified possible minimum value of an actuator\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Min", "type": "number" }, "Unit": { + "markdownDescription": "The scientific unit for the actuator\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Unit", "type": "string" } }, @@ -103034,30 +105676,48 @@ "items": { "type": "string" }, + "markdownDescription": "A list of possible values an attribute can be assigned\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowedValues", "type": "array" }, "AssignedValue": { + "markdownDescription": "A specified value for the attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssignedValue", "type": "string" }, "DataType": { + "markdownDescription": "The specified data type of the attribute\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BOOLEAN | BOOLEAN_ARRAY | DOUBLE | DOUBLE_ARRAY | FLOAT | FLOAT_ARRAY | INT16 | INT16_ARRAY | INT32 | INT32_ARRAY | INT64 | INT64_ARRAY | INT8 | INT8_ARRAY | STRING | STRING_ARRAY | UINT16 | UINT16_ARRAY | UINT32 | UINT32_ARRAY | UINT64 | UINT64_ARRAY | UINT8 | UINT8_ARRAY | UNIX_TIMESTAMP | UNIX_TIMESTAMP_ARRAY | UNKNOWN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType", "type": "string" }, "DefaultValue": { + "markdownDescription": "The default value of the attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultValue", "type": "string" }, "Description": { + "markdownDescription": "A brief description of the attribute\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "FullyQualifiedName": { + "markdownDescription": "The fully qualified name of the attribute\\. For example, the fully qualified name of an attribute might be `Vehicle.Body.Engine.Type`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FullyQualifiedName", "type": "string" }, "Max": { + "markdownDescription": "The specified possible maximum value of the attribute\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Max", "type": "number" }, "Min": { + "markdownDescription": "The specified possible minimum value of the attribute\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Min", "type": "number" }, "Unit": { + "markdownDescription": "The scientific unit for the attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Unit", "type": "string" } }, @@ -103071,9 +105731,13 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A brief description of the branch\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "FullyQualifiedName": { + "markdownDescription": "The fully qualified name of the branch\\. For example, the fully qualified name of a branch might be `Vehicle.Body.Engine`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FullyQualifiedName", "type": "string" } }, @@ -103086,16 +105750,24 @@ "additionalProperties": false, "properties": { "Actuator": { - "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Actuator" + "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Actuator", + "markdownDescription": "Information about a node specified as an actuator\\. \nAn actuator is a digital representation of a vehicle device\\.\n*Required*: No \n*Type*: [Actuator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Actuator" }, "Attribute": { - "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Attribute" + "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Attribute", + "markdownDescription": "Information about a node specified as an attribute\\. \nAn attribute represents static information about a vehicle\\.\n*Required*: No \n*Type*: [Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Attribute" }, "Branch": { - "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Branch" + "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Branch", + "markdownDescription": "Information about a node specified as a branch\\. \nA group of signals that are defined in a hierarchical structure\\.\n*Required*: No \n*Type*: [Branch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Branch" }, "Sensor": { - "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Sensor" + "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Sensor", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Sensor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sensor" } }, "type": "object" @@ -103104,18 +105776,28 @@ "additionalProperties": false, "properties": { "TotalActuators": { + "markdownDescription": "The total number of nodes in a vehicle network that represent actuators\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TotalActuators", "type": "number" }, "TotalAttributes": { + "markdownDescription": "The total number of nodes in a vehicle network that represent attributes\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TotalAttributes", "type": "number" }, "TotalBranches": { + "markdownDescription": "The total number of nodes in a vehicle network that represent branches\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TotalBranches", "type": "number" }, "TotalNodes": { + "markdownDescription": "The total number of nodes in a vehicle network\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TotalNodes", "type": "number" }, "TotalSensors": { + "markdownDescription": "The total number of nodes in a vehicle network that represent sensors\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TotalSensors", "type": "number" } }, @@ -103128,24 +105810,38 @@ "items": { "type": "string" }, + "markdownDescription": "A list of possible values a sensor can take\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowedValues", "type": "array" }, "DataType": { + "markdownDescription": "The specified data type of the sensor\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BOOLEAN | BOOLEAN_ARRAY | DOUBLE | DOUBLE_ARRAY | FLOAT | FLOAT_ARRAY | INT16 | INT16_ARRAY | INT32 | INT32_ARRAY | INT64 | INT64_ARRAY | INT8 | INT8_ARRAY | STRING | STRING_ARRAY | UINT16 | UINT16_ARRAY | UINT32 | UINT32_ARRAY | UINT64 | UINT64_ARRAY | UINT8 | UINT8_ARRAY | UNIX_TIMESTAMP | UNIX_TIMESTAMP_ARRAY | UNKNOWN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType", "type": "string" }, "Description": { + "markdownDescription": "A brief description of a sensor\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "FullyQualifiedName": { + "markdownDescription": "The fully qualified name of the sensor\\. For example, the fully qualified name of a sensor might be `Vehicle.Body.Engine.Battery`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FullyQualifiedName", "type": "string" }, "Max": { + "markdownDescription": "The specified possible maximum value of the sensor\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Max", "type": "number" }, "Min": { + "markdownDescription": "The specified possible minimum value of the sensor\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Min", "type": "number" }, "Unit": { + "markdownDescription": "The scientific unit of measurement for data collected by the sensor\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Unit", "type": "string" } }, @@ -103191,30 +105887,42 @@ "additionalProperties": false, "properties": { "AssociationBehavior": { + "markdownDescription": "An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CreateIotThing | ValidateIotThingExists` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssociationBehavior", "type": "string" }, "Attributes": { "additionalProperties": true, + "markdownDescription": "Static information about a vehicle in a key\\-value pair\\. For example: `\"engine Type\"` : `\"v6\"` \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Attributes", "type": "object" }, "DecoderManifestArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of a decoder manifest associated with the vehicle to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DecoderManifestArn", "type": "string" }, "ModelManifestArn": { + "markdownDescription": "The ARN of the vehicle model \\(model manifest\\) to create the vehicle from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelManifestArn", "type": "string" }, "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Metadata which can be used to manage the vehicle\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -103283,7 +105991,7 @@ "properties": { "AccessPolicyIdentity": { "$ref": "#/definitions/AWS::IoTSiteWise::AccessPolicy.AccessPolicyIdentity", - "markdownDescription": "The identity for this access policy\\. Choose an AWS SSO user, an AWS SSO group, or an IAM user\\. \n*Required*: Yes \n*Type*: [AccessPolicyIdentity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identity for this access policy\\. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user\\. \n*Required*: Yes \n*Type*: [AccessPolicyIdentity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessPolicyIdentity" }, "AccessPolicyPermission": { @@ -103340,7 +106048,7 @@ }, "User": { "$ref": "#/definitions/AWS::IoTSiteWise::AccessPolicy.User", - "markdownDescription": "The AWS SSO user to which this access policy maps\\. \n*Required*: No \n*Type*: [User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The IAM Identity Center user to which this access policy maps\\. \n*Required*: No \n*Type*: [User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "User" } }, @@ -103453,6 +106161,8 @@ "additionalProperties": false, "properties": { "AssetDescription": { + "markdownDescription": "A description for the asset\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssetDescription", "type": "string" }, "AssetHierarchies": { @@ -103551,11 +106261,13 @@ "type": "string" }, "NotificationState": { - "markdownDescription": "The MQTT notification state \\(enabled or disabled\\) for this asset property\\. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic\\. For more information, see [Interacting with other services](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) in the *AWS IoT SiteWise User Guide*\\. \nIf you omit this parameter, the notification state is set to `DISABLED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The MQTT notification state \\(`ENABLED` or `DISABLED`\\) for this asset property\\. When the notification state is `ENABLED`, AWS IoT SiteWise publishes property value updates to a unique MQTT topic\\. For more information, see [Interacting with other services](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) in the *AWS IoT SiteWise User Guide*\\. \nIf you omit this parameter, the notification state is set to `DISABLED`\\. \nYou must use all caps for the NotificationState parameter\\. If you use lower case letters, you will receive a schema validation error\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NotificationState", "type": "string" }, "Unit": { + "markdownDescription": "The unit \\(such as `Newtons` or `RPM`\\) of the asset property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Unit", "type": "string" } }, @@ -103752,7 +106464,7 @@ }, "Type": { "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.PropertyType", - "markdownDescription": "Contains a property type, which can be one of `attribute`, `measurement`, `metric`, or `transform`\\. \n*Required*: Yes \n*Type*: [PropertyType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains a property type, which can be one of `Attribute`, `Measurement`, `Metric`, or `Transform`\\. \n*Required*: Yes \n*Type*: [PropertyType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type" }, "Unit": { @@ -104211,7 +106923,7 @@ "properties": { "Alarms": { "$ref": "#/definitions/AWS::IoTSiteWise::Portal.Alarms", - "markdownDescription": "Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal\\. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range\\. For more information, see [Monitoring with alarms](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the * AWS IoT SiteWise Application Guide*\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal\\. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range\\. For more information, see [Monitoring with alarms](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the * AWS IoT SiteWise Application Guide*\\. \n*Required*: No \n*Type*: [Alarms](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Alarms" }, "NotificationSenderEmail": { @@ -104220,7 +106932,7 @@ "type": "string" }, "PortalAuthMode": { - "markdownDescription": "The service to use to authenticate users to the portal\\. Choose from the following options: \n+ `SSO` \u2013 The portal uses AWS Single Sign\\-On to authenticate users and manage user permissions\\. Before you can create a portal that uses AWS SSO, you must enable AWS SSO\\. For more information, see [Enabling AWS SSO](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) in the *AWS IoT SiteWise User Guide*\\. This option is only available in AWS Regions other than the China Regions\\.\n+ `IAM` \u2013 The portal uses AWS Identity and Access Management \\(IAM\\) to authenticate users and manage user permissions\\.\nYou can't change this value after you create a portal\\. \nDefault: `SSO` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The service to use to authenticate users to the portal\\. Choose from the following options: \n+ `SSO` \u2013 The portal uses AWS IAM Identity Center \\(successor to AWS Single Sign\\-On\\) to authenticate users and manage user permissions\\. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center\\. For more information, see [Enabling IAM Identity Center](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) in the *AWS IoT SiteWise User Guide*\\. This option is only available in AWS Regions other than the China Regions\\.\n+ `IAM` \u2013 The portal uses AWS Identity and Access Management \\(IAM\\) to authenticate users and manage user permissions\\.\nYou can't change this value after you create a portal\\. \nDefault: `SSO` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PortalAuthMode", "type": "string" }, @@ -104285,9 +106997,13 @@ "additionalProperties": false, "properties": { "AlarmRoleArn": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmRoleArn", "type": "string" }, "NotificationLambdaArn": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotificationLambdaArn", "type": "string" } }, @@ -104423,14 +107139,10 @@ "additionalProperties": false, "properties": { "CompatibleNamespaceVersion": { - "markdownDescription": "The version of the user's namespace against which the workflow was validated\\. Use this value in your system instance\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "title": "CompatibleNamespaceVersion", "type": "number" }, "Definition": { - "$ref": "#/definitions/AWS::IoTThingsGraph::FlowTemplate.DefinitionDocument", - "markdownDescription": "A workflow's definition document\\. \n*Required*: Yes \n*Type*: [DefinitionDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotthingsgraph-flowtemplate-definitiondocument.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "title": "Definition" + "$ref": "#/definitions/AWS::IoTThingsGraph::FlowTemplate.DefinitionDocument" } }, "required": [ @@ -104463,13 +107175,9 @@ "additionalProperties": false, "properties": { "Language": { - "markdownDescription": "The language used to define the entity\\. `GRAPHQL` is the only valid value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "title": "Language", "type": "string" }, "Text": { - "markdownDescription": "The GraphQL text that defines the entity\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "title": "Text", "type": "string" } }, @@ -104515,57 +107223,75 @@ "additionalProperties": false, "properties": { "ComponentTypeId": { + "markdownDescription": "The ID of the component type\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ComponentTypeId", "type": "string" }, "Description": { + "markdownDescription": "The description of the component type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "ExtendsFrom": { "items": { "type": "string" }, + "markdownDescription": "The name of the parent component type that this component type extends\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExtendsFrom", "type": "array" }, "Functions": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to the functions in the component type\\. Each string in the mapping must be unique to this object\\. \nFor information on the FunctionResponse object see the [FunctionResponse](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_FunctionResponse.html) API reference\\. \n*Required*: No \n*Type*: Map of [Function](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-function.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.Function" } }, + "title": "Functions", "type": "object" }, "IsSingleton": { + "markdownDescription": "A boolean value that specifies whether an entity can have more than one component of this type\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsSingleton", "type": "boolean" }, "PropertyDefinitions": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to the property definitions in the component type\\. Each string in the mapping must be unique to this object\\. \nFor information about the PropertyDefinitionResponse object, see the [PropertyDefinitionResponse](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyDefinitionResponse.html) API reference\\. \n*Required*: No \n*Type*: Map of [PropertyDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.PropertyDefinition" } }, + "title": "PropertyDefinitions", "type": "object" }, "PropertyGroups": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to the property groups in the component type\\. Each string in the mapping must be unique to this object\\. \n*Required*: No \n*Type*: Map of [PropertyGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertygroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.PropertyGroup" } }, + "title": "PropertyGroups", "type": "object" }, "Tags": { "additionalProperties": true, + "markdownDescription": "The ComponentType tags\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "WorkspaceId": { + "markdownDescription": "The ID of the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "WorkspaceId", "type": "string" } }, @@ -104600,10 +107326,14 @@ "additionalProperties": false, "properties": { "IsNative": { + "markdownDescription": "A boolean value that specifies whether the data connector is native to IoT TwinMaker\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsNative", "type": "boolean" }, "Lambda": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.LambdaFunction" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.LambdaFunction", + "markdownDescription": "The Lambda function associated with the data connector\\. \n*Required*: No \n*Type*: [LambdaFunction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-lambdafunction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Lambda" } }, "type": "object" @@ -104615,18 +107345,28 @@ "items": { "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataValue" }, + "markdownDescription": "The allowed values for this data type\\. \n*Required*: No \n*Type*: List of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowedValues", "type": "array" }, "NestedType": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataType" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataType", + "markdownDescription": "The nested type in the data type\\. \n*Required*: No \n*Type*: [DataType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-componenttype-datatype.html#aws-properties-iottwinmaker-componenttype-datatype) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NestedType" }, "Relationship": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.Relationship" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.Relationship", + "markdownDescription": "A relationship that associates a component with another component\\. \n*Required*: No \n*Type*: [Relationship](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-relationship.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Relationship" }, "Type": { + "markdownDescription": "The underlying type of the data type\\. \nValid Values: `RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "UnitOfMeasure": { + "markdownDescription": "The unit of measure used in this data type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UnitOfMeasure", "type": "string" } }, @@ -104639,39 +107379,57 @@ "additionalProperties": false, "properties": { "BooleanValue": { + "markdownDescription": "A boolean value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BooleanValue", "type": "boolean" }, "DoubleValue": { + "markdownDescription": "A double value\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DoubleValue", "type": "number" }, "Expression": { + "markdownDescription": "An expression that produces the value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Expression", "type": "string" }, "IntegerValue": { + "markdownDescription": "An integer value\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntegerValue", "type": "number" }, "ListValue": { "items": { "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataValue" }, + "markdownDescription": "A list of multiple values\\. \n*Required*: No \n*Type*: List of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-componenttype-datavalue.html#aws-properties-iottwinmaker-componenttype-datavalue) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ListValue", "type": "array" }, "LongValue": { + "markdownDescription": "A long value\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LongValue", "type": "number" }, "MapValue": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to multiple `DataValue` objects\\. \n*Required*: No \n*Type*: Map of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-componenttype-datavalue.html#aws-properties-iottwinmaker-componenttype-datavalue) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataValue" } }, + "title": "MapValue", "type": "object" }, "RelationshipValue": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.RelationshipValue" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.RelationshipValue", + "markdownDescription": "A value that relates a component to another component\\. \n*Required*: No \n*Type*: [RelationshipValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-relationshipvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RelationshipValue" }, "StringValue": { + "markdownDescription": "A string value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StringValue", "type": "string" } }, @@ -104681,9 +107439,13 @@ "additionalProperties": false, "properties": { "Code": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Code", "type": "string" }, "Message": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Message", "type": "string" } }, @@ -104693,15 +107455,21 @@ "additionalProperties": false, "properties": { "ImplementedBy": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataConnector" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataConnector", + "markdownDescription": "The data connector\\. \n*Required*: No \n*Type*: [DataConnector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-dataconnector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImplementedBy" }, "RequiredProperties": { "items": { "type": "string" }, + "markdownDescription": "The required properties of the function\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RequiredProperties", "type": "array" }, "Scope": { + "markdownDescription": "The scope of the function\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Scope", "type": "string" } }, @@ -104711,6 +107479,8 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "The Lambda function ARN\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Arn", "type": "string" } }, @@ -104724,29 +107494,43 @@ "properties": { "Configurations": { "additionalProperties": true, + "markdownDescription": "A mapping that specifies configuration information about the property\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Configurations", "type": "object" }, "DataType": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataType" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataType", + "markdownDescription": "*Required*: No \n*Type*: [DataType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datatype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType" }, "DefaultValue": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataValue" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataValue", + "markdownDescription": "A boolean value that specifies whether the property ID comes from an external data store\\. \n*Required*: No \n*Type*: [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultValue" }, "IsExternalId": { + "markdownDescription": "A boolean value that specifies whether the property ID comes from an external data store\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsExternalId", "type": "boolean" }, "IsRequiredInEntity": { + "markdownDescription": "A boolean value that specifies whether the property is required in an entity\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsRequiredInEntity", "type": "boolean" }, "IsStoredExternally": { + "markdownDescription": "A boolean value that specifies whether the property is stored externally\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsStoredExternally", "type": "boolean" }, "IsTimeSeries": { + "markdownDescription": "A boolean value that specifies whether the property consists of time series data\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsTimeSeries", "type": "boolean" } }, @@ -104756,12 +107540,16 @@ "additionalProperties": false, "properties": { "GroupType": { + "markdownDescription": "The group type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GroupType", "type": "string" }, "PropertyNames": { "items": { "type": "string" }, + "markdownDescription": "The property names\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PropertyNames", "type": "array" } }, @@ -104771,9 +107559,13 @@ "additionalProperties": false, "properties": { "RelationshipType": { + "markdownDescription": "The type of the relationship\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RelationshipType", "type": "string" }, "TargetComponentTypeId": { + "markdownDescription": "The ID of the target component type associated with this relationship\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetComponentTypeId", "type": "string" } }, @@ -104783,9 +107575,13 @@ "additionalProperties": false, "properties": { "TargetComponentName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetComponentName", "type": "string" }, "TargetEntityId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetEntityId", "type": "string" } }, @@ -104795,9 +107591,13 @@ "additionalProperties": false, "properties": { "Error": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.Error" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.Error", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Error](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-error.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Error" }, "State": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "State", "type": "string" } }, @@ -104840,35 +107640,49 @@ "properties": { "Components": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to the components in the entity\\. Each string in the mapping must be unique to this object\\. \nFor information on the component object see the [component](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ComponentResponse.html) API reference\\. \n*Required*: No \n*Type*: Map of [Component](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Component" } }, + "title": "Components", "type": "object" }, "Description": { + "markdownDescription": "The description of the entity\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "EntityId": { + "markdownDescription": "The entity ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EntityId", "type": "string" }, "EntityName": { + "markdownDescription": "The entity name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EntityName", "type": "string" }, "ParentEntityId": { + "markdownDescription": "The ID of the parent entity\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ParentEntityId", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Metadata that you can use to manage the entity\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "WorkspaceId": { + "markdownDescription": "The ID of the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "WorkspaceId", "type": "string" } }, @@ -104903,37 +107717,51 @@ "additionalProperties": false, "properties": { "ComponentName": { + "markdownDescription": "The name of the component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ComponentName", "type": "string" }, "ComponentTypeId": { + "markdownDescription": "The ID of the ComponentType\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ComponentTypeId", "type": "string" }, "DefinedIn": { + "markdownDescription": "The name of the property definition set in the request\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefinedIn", "type": "string" }, "Description": { + "markdownDescription": "The description of the component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Properties": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to the properties to set in the component type\\. Each string in the mapping must be unique to this object\\. \n*Required*: No \n*Type*: Map of [Property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-property.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Property" } }, + "title": "Properties", "type": "object" }, "PropertyGroups": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to the property groups in the component type\\. Each string in the mapping must be unique to this object\\. \n*Required*: No \n*Type*: Map of [PropertyGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-propertygroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.PropertyGroup" } }, + "title": "PropertyGroups", "type": "object" }, "Status": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Status" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Status", + "markdownDescription": "The status of the component\\. \n*Required*: No \n*Type*: [Status](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-status.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status" } }, "type": "object" @@ -104945,18 +107773,28 @@ "items": { "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowedValues", "type": "array" }, "NestedType": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataType" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataType", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DataType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-entity-datatype.html#aws-properties-iottwinmaker-entity-datatype) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NestedType" }, "Relationship": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Relationship" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Relationship", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Relationship](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-relationship.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Relationship" }, "Type": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "UnitOfMeasure": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UnitOfMeasure", "type": "string" } }, @@ -104966,39 +107804,57 @@ "additionalProperties": false, "properties": { "BooleanValue": { + "markdownDescription": "A boolean value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BooleanValue", "type": "boolean" }, "DoubleValue": { + "markdownDescription": "A double value\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DoubleValue", "type": "number" }, "Expression": { + "markdownDescription": "An expression that produces the value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Expression", "type": "string" }, "IntegerValue": { + "markdownDescription": "An integer value\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntegerValue", "type": "number" }, "ListValue": { "items": { "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue" }, + "markdownDescription": "A list of multiple values\\. \n*Required*: No \n*Type*: List of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-entity-datavalue.html#aws-properties-iottwinmaker-entity-datavalue) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ListValue", "type": "array" }, "LongValue": { + "markdownDescription": "A long value\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LongValue", "type": "number" }, "MapValue": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to multiple DataValue objects\\. \n*Required*: No \n*Type*: Map of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-entity-datavalue.html#aws-properties-iottwinmaker-entity-datavalue) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue" } }, + "title": "MapValue", "type": "object" }, "RelationshipValue": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.RelationshipValue" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.RelationshipValue", + "markdownDescription": "A value that relates a component to another component\\. \n*Required*: No \n*Type*: [RelationshipValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-relationshipvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RelationshipValue" }, "StringValue": { + "markdownDescription": "A string value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StringValue", "type": "string" } }, @@ -105009,38 +107865,58 @@ "properties": { "Configuration": { "additionalProperties": true, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Configuration", "type": "object" }, "DataType": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataType" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataType", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DataType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datatype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType" }, "DefaultValue": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultValue" }, "IsExternalId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsExternalId", "type": "boolean" }, "IsFinal": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsFinal", "type": "boolean" }, "IsImported": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsImported", "type": "boolean" }, "IsInherited": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsInherited", "type": "boolean" }, "IsRequiredInEntity": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsRequiredInEntity", "type": "boolean" }, "IsStoredExternally": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsStoredExternally", "type": "boolean" }, "IsTimeSeries": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsTimeSeries", "type": "boolean" } }, @@ -105050,9 +107926,13 @@ "additionalProperties": false, "properties": { "Code": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Code", "type": "string" }, "Message": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Message", "type": "string" } }, @@ -105062,10 +107942,14 @@ "additionalProperties": false, "properties": { "Definition": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Definition" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Definition", + "markdownDescription": "An object that specifies information about a property\\. \n*Required*: No \n*Type*: [Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-definition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Definition" }, "Value": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue", + "markdownDescription": "An object that contains information about a value for a time series property\\. \n*Required*: No \n*Type*: [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value" } }, "type": "object" @@ -105074,12 +107958,16 @@ "additionalProperties": false, "properties": { "GroupType": { + "markdownDescription": "The group type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GroupType", "type": "string" }, "PropertyNames": { "items": { "type": "string" }, + "markdownDescription": "The property names\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PropertyNames", "type": "array" } }, @@ -105089,9 +107977,13 @@ "additionalProperties": false, "properties": { "RelationshipType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RelationshipType", "type": "string" }, "TargetComponentTypeId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetComponentTypeId", "type": "string" } }, @@ -105101,9 +107993,13 @@ "additionalProperties": false, "properties": { "TargetComponentName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetComponentName", "type": "string" }, "TargetEntityId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetEntityId", "type": "string" } }, @@ -105113,9 +108009,13 @@ "additionalProperties": false, "properties": { "Error": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Error" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Error", + "markdownDescription": "The error message\\. \n*Required*: No \n*Type*: [Error](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-error.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Error" }, "State": { + "markdownDescription": "The current state of the entity, component, component type, or workspace\\. \nValid Values: `CREATING | UPDATING | DELETING | ACTIVE | ERROR` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "State", "type": "string" } }, @@ -105160,27 +108060,39 @@ "items": { "type": "string" }, + "markdownDescription": "A list of capabilities that the scene uses to render\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Capabilities", "type": "array" }, "ContentLocation": { + "markdownDescription": "The relative path that specifies the location of the content definition file\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContentLocation", "type": "string" }, "Description": { + "markdownDescription": "The description of this scene\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "SceneId": { + "markdownDescription": "The scene ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SceneId", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "The ComponentType tags\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "WorkspaceId": { + "markdownDescription": "The ID of the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "WorkspaceId", "type": "string" } }, @@ -105248,21 +108160,29 @@ "additionalProperties": false, "properties": { "SyncRole": { + "markdownDescription": "The SyncJob IAM role\\. This IAM role is used by the sync job to read from the syncSource, and create, update or delete the corresponding resources\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SyncRole", "type": "string" }, "SyncSource": { + "markdownDescription": "The sync source\\. \nCurrently the only supported syncSoucre is `SITEWISE`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SyncSource", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Metadata you can use to manage the SyncJob\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "WorkspaceId": { + "markdownDescription": "The ID of the workspace that contains the sync job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "WorkspaceId", "type": "string" } }, @@ -105330,24 +108250,34 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the workspace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Role": { + "markdownDescription": "The ARN of the execution role associated with the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Role", "type": "string" }, "S3Location": { + "markdownDescription": "The ARN of the S3 bucket where resources associated with the workspace are stored\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3Location", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Metadata that you can use to manage the workspace\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "WorkspaceId": { + "markdownDescription": "The ID of the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "WorkspaceId", "type": "string" } }, @@ -105570,6 +108500,8 @@ "items": { "type": "number" }, + "markdownDescription": "The list of values that make up the FactoryPresetFreqs value\\. \n*Required*: No \n*Type*: List of Integer \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FactoryPresetFreqsList", "type": "array" }, "MacVersion": { @@ -105613,15 +108545,23 @@ "type": "string" }, "RxDataRate2": { + "markdownDescription": "The RXDataRate2 value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RxDataRate2", "type": "number" }, "RxDelay1": { + "markdownDescription": "The RXDelay1 value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RxDelay1", "type": "number" }, "RxDrOffset1": { + "markdownDescription": "The RXDROffset1 value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `7` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RxDrOffset1", "type": "number" }, "RxFreq2": { + "markdownDescription": "The RXFreq2 value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1000000` \n*Maximum*: `16700000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RxFreq2", "type": "number" }, "Supports32BitFCnt": { @@ -105944,30 +108884,42 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "Name of the network analyzer configuration\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags to attach to the specified resource\\. Tags are metadata that you can use to manage a resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Tags", "type": "array" }, "TraceContent": { - "$ref": "#/definitions/AWS::IoTWireless::NetworkAnalyzerConfiguration.TraceContent" + "$ref": "#/definitions/AWS::IoTWireless::NetworkAnalyzerConfiguration.TraceContent", + "markdownDescription": "Trace content for your wireless gateway and wireless device resources\\. \n*Required*: No \n*Type*: [TraceContent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-networkanalyzerconfiguration-tracecontent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TraceContent" }, "WirelessDevices": { "items": { "type": "string" }, + "markdownDescription": "Wireless device resources to add to the network analyzer configuration\\. Provide the `WirelessDeviceId` of the resource to add in the input array\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `250` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WirelessDevices", "type": "array" }, "WirelessGateways": { "items": { "type": "string" }, + "markdownDescription": "Wireless gateway resources to add to the network analyzer configuration\\. Provide the `WirelessGatewayId` of the resource to add in the input array\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WirelessGateways", "type": "array" } }, @@ -106001,9 +108953,13 @@ "additionalProperties": false, "properties": { "LogLevel": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogLevel", "type": "string" }, "WirelessDeviceFrameInfo": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WirelessDeviceFrameInfo", "type": "string" } }, @@ -106115,12 +109071,18 @@ "additionalProperties": false, "properties": { "AmazonId": { + "markdownDescription": "The Sidewalk Amazon ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AmazonId", "type": "string" }, "Arn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Arn", "type": "string" }, "Fingerprint": { + "markdownDescription": "The fingerprint of the Sidewalk application server private key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `64` \n*Maximum*: `64` \n*Pattern*: `[a-fA-F0-9]{64}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Fingerprint", "type": "string" } }, @@ -106350,7 +109312,7 @@ "additionalProperties": false, "properties": { "AutoCreateTasks": { - "markdownDescription": "Whether to automatically create tasks using this task definition for all gateways with the specified current version\\. If `false`, the task must me created by calling `CreateWirelessGatewayTask`\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Whether to automatically create tasks using this task definition for all gateways with the specified current version\\. If `false`, the task must be created by calling `CreateWirelessGatewayTask`\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutoCreateTasks", "type": "boolean" }, @@ -106843,6 +109805,8 @@ "type": "string" }, "ThingName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ThingName", "type": "string" } }, @@ -106928,7 +109892,7 @@ "additionalProperties": false, "properties": { "AliasName": { - "markdownDescription": "Specifies the alias name\\. This value must begin with `alias/` followed by a name, such as `alias/ExampleAlias`\\. \nIf you change the value of a `Replacement` property, such as `AliasName`, the existing alias is deleted and a new alias is created for the specified KMS key\\. This change can disrupt applications that use the alias\\. It can also allow or deny access to a KMS key affected by attribute\\-based access control \\(ABAC\\)\\.\nThe alias must be string of 1\\-256 characters\\. It can contain only alphanumeric characters, forward slashes \\(/\\), underscores \\(\\_\\), and dashes \\(\\-\\)\\. The alias name cannot begin with `alias/aws/`\\. The `alias/aws/` prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)\\. \n*Pattern*: `alias/^[a-zA-Z0-9/_-]+$` \n*Minimum*: `1` \n*Maximum*: `256` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the alias name\\. This value must begin with `alias/` followed by a name, such as `alias/ExampleAlias`\\. \nIf you change the value of the `AliasName` property, the existing alias is deleted and a new alias is created for the specified KMS key\\. This change can disrupt applications that use the alias\\. It can also allow or deny access to a KMS key affected by attribute\\-based access control \\(ABAC\\)\\.\nThe alias must be string of 1\\-256 characters\\. It can contain only alphanumeric characters, forward slashes \\(/\\), underscores \\(\\_\\), and dashes \\(\\-\\)\\. The alias name cannot begin with `alias/aws/`\\. The `alias/aws/` prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)\\. \n*Pattern*: `^alias/[a-zA-Z0-9/_-]+$` \n*Minimum*: `1` \n*Maximum*: `256` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AliasName", "type": "string" }, @@ -107006,7 +109970,7 @@ "type": "string" }, "EnableKeyRotation": { - "markdownDescription": "Enables automatic rotation of the key material for the specified KMS key\\. By default, automatic key rotation is not enabled\\. \nAWS KMS does not support automatic key rotation on asymmetric KMS keys\\. For asymmetric KMS keys, omit the `EnableKeyRotation` property or set it to `false`\\. \nWhen you enable automatic rotation, AWS KMS automatically creates new key material for the KMS key 365 days after the enable \\(or reenable\\) date and every 365 days thereafter\\. AWS KMS retains all key material until you delete the KMS key\\. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *AWS Key Management Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Enables automatic rotation of the key material for the specified KMS key\\. By default, automatic key rotation is not enabled\\. \nAWS KMS supports automatic rotation only for symmetric encryption KMS keys \\(`KeySpec` = `SYMMETRIC_DEFAULT`\\)\\. For asymmetric KMS keys and HMAC KMS keys, omit the `EnableKeyRotation` property or set it to `false`\\. \nTo enable automatic key rotation of the key material for a multi\\-Region KMS key, set `EnableKeyRotation` to `true` on the primary key \\(created by using `AWS::KMS::Key`\\)\\. AWS KMS copies the rotation status to all replica keys\\. For details, see [Rotating multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *AWS Key Management Service Developer Guide*\\. \nWhen you enable automatic rotation, AWS KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter\\. AWS KMS retains all key material until you delete the KMS key\\. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *AWS Key Management Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableKeyRotation", "type": "boolean" }, @@ -107016,22 +109980,22 @@ "type": "boolean" }, "KeyPolicy": { - "markdownDescription": "The key policy that authorizes use of the KMS key\\. The key policy must conform to the following rules\\. \n+ The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key\\. This reduces the risk that the KMS key becomes unmanageable\\. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the * *AWS Key Management Service Developer Guide* *\\.\n+ Each statement in the key policy must contain one or more principals\\. The principals in the key policy must exist and be visible to AWS KMS\\. When you create a new AWS principal \\(for example, an IAM user or role\\), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS\\. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide*\\.\n+ The key policy size limit is 32 kilobytes \\(32768 bytes\\)\\.\nIf you are unsure of which policy to use, consider the *default key policy*\\. This is the key policy that AWS KMS applies to KMS keys that are created by using the CreateKey API with no specified key policy\\. It gives the AWS account that owns the key permission to perform all operations on the key\\. It also allows you write IAM policies to authorize access to the key\\. For details, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *AWS Key Management Service Developer Guide*\\. \n*Minimum*: `1` \n*Maximum*: `32768` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key policy that authorizes use of the KMS key\\. The key policy must conform to the following rules\\. \n+ The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key\\. This reduces the risk that the KMS key becomes unmanageable\\. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the * *AWS Key Management Service Developer Guide* *\\.\n+ Each statement in the key policy must contain one or more principals\\. The principals in the key policy must exist and be visible to AWS KMS\\. When you create a new AWS principal \\(for example, an IAM user or role\\), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS\\. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide*\\.\nIf you are unsure of which policy to use, consider the *default key policy*\\. This is the key policy that AWS KMS applies to KMS keys that are created by using the CreateKey API with no specified key policy\\. It gives the AWS account that owns the key permission to perform all operations on the key\\. It also allows you write IAM policies to authorize access to the key\\. For details, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *AWS Key Management Service Developer Guide*\\. \nA key policy document can include only the following characters: \n+ Printable ASCII characters\n+ Printable characters in the Basic Latin and Latin\\-1 Supplement character set\n+ The tab \\(`\\u0009`\\), line feed \\(`\\u000A`\\), and carriage return \\(`\\u000D`\\) special characters\n*Minimum*: `1` \n*Maximum*: `32768` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeyPolicy", "type": "object" }, "KeySpec": { - "markdownDescription": "Specifies the type of KMS key to create\\. The default value, `SYMMETRIC_DEFAULT`, creates a KMS key with a 256\\-bit symmetric key for encryption and decryption\\. For help choosing a key spec for your KMS key, see [How to choose Your KMS key configuration](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *AWS Key Management Service Developer Guide*\\. \nThe `KeySpec` property determines whether the KMS key contains a symmetric key or an asymmetric key pair\\. It also determines the encryption algorithms or signing algorithms that the KMS key supports\\. You can't change the `KeySpec` after the KMS key is created\\. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy\\. For more information, see [kms:EncryptionAlgorithm](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm) or [kms:Signing Algorithm](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm) in the *AWS Key Management Service Developer Guide*\\. \nIf you change the `KeySpec` of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified `KeySpec` value\\. While the scheduled deletion is pending, you can't use the existing KMS key\\. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted\\.\n[AWS services that are integrated with AWS KMS](http://aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric KMS keys to protect your data\\. These services do not support asymmetric KMS keys\\. For help determining whether a KMS key is symmetric or asymmetric, see [Identifying Symmetric and Asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *AWS Key Management Service Developer Guide*\\.\nAWS KMS supports the following key specs for KMS keys: \n+ Symmetric key \\(default\\)\n + `SYMMETRIC_DEFAULT` \\(AES\\-256\\-GCM\\)\n+ Asymmetric RSA key pairs\n + `RSA_2048`\n + `RSA_3072`\n + `RSA_4096`\n+ Asymmetric NIST\\-recommended elliptic curve key pairs\n + `ECC_NIST_P256` \\(secp256r1\\)\n + `ECC_NIST_P384` \\(secp384r1\\)\n + `ECC_NIST_P521` \\(secp521r1\\)\n+ Other asymmetric elliptic curve key pairs\n + `ECC_SECG_P256K1` \\(secp256k1\\), commonly used for cryptocurrencies\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the type of KMS key to create\\. The default value, `SYMMETRIC_DEFAULT`, creates a KMS key with a 256\\-bit symmetric key for encryption and decryption\\. In China Regions, `SYMMETRIC_DEFAULT` creates a 128\\-bit symmetric key that uses SM4 encryption\\. You can't change the `KeySpec` value after the KMS key is created\\. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *AWS Key Management Service Developer Guide*\\. \nThe `KeySpec` property determines the type of key material in the KMS key and the algorithms that the KMS key supports\\. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy\\. For more information, see [AWS KMS condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *AWS Key Management Service Developer Guide*\\. \nIf you change the value of the `KeySpec` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html)\\. This prevents you from accidentally deleting a KMS key by changing an immutable property value\\.\n[AWS services that are integrated with AWS KMS](http://aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data\\. These services do not support encryption with asymmetric KMS keys\\. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *AWS Key Management Service Developer Guide*\\.\n AWS KMS supports the following key specs for KMS keys: \n+ Symmetric encryption key \\(default\\)\n + `SYMMETRIC_DEFAULT` \\(AES\\-256\\-GCM\\)\n+ HMAC keys \\(symmetric\\)\n + `HMAC_224` \n + `HMAC_256` \n + `HMAC_384` \n + `HMAC_512` \n+ Asymmetric RSA key pairs\n + `RSA_2048` \n + `RSA_3072` \n + `RSA_4096` \n+ Asymmetric NIST\\-recommended elliptic curve key pairs\n + `ECC_NIST_P256` \\(secp256r1\\)\n + `ECC_NIST_P384` \\(secp384r1\\)\n + `ECC_NIST_P521` \\(secp521r1\\)\n+ Other asymmetric elliptic curve key pairs\n + `ECC_SECG_P256K1` \\(secp256k1\\), commonly used for cryptocurrencies\\.\n+ SM2 key pairs \\(China Regions only\\)\n + `SM2`\n*Required*: No \n*Type*: String \n*Allowed values*: `ECC_NIST_P256 | ECC_NIST_P384 | ECC_NIST_P521 | ECC_SECG_P256K1 | HMAC_224 | HMAC_256 | HMAC_384 | HMAC_512 | RSA_2048 | RSA_3072 | RSA_4096 | SM2 | SYMMETRIC_DEFAULT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeySpec", "type": "string" }, "KeyUsage": { - "markdownDescription": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key\\. The default value is `ENCRYPT_DECRYPT`\\. This property is required only for asymmetric KMS keys\\. You can't change the `KeyUsage` value after the KMS key is created\\. \nIf you change the `KeyUsage` of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified `KeyUsage` value\\. While the scheduled deletion is pending, you can't use the existing KMS key\\. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted\\.\nSelect only one valid value\\. \n+ For symmetric KMS keys, omit the property or specify `ENCRYPT_DECRYPT`\\.\n+ For asymmetric KMS keys with RSA key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY`\\.\n+ For asymmetric KMS keys with ECC key material, specify `SIGN_VERIFY`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ENCRYPT_DECRYPT | SIGN_VERIFY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key\\. The default value is `ENCRYPT_DECRYPT`\\. This property is required for asymmetric KMS keys and HMAC KMS keys\\. You can't change the `KeyUsage` value after the KMS key is created\\. \nIf you change the value of the `KeyUsage` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html)\\. This prevents you from accidentally deleting a KMS key by changing an immutable property value\\.\nSelect only one valid value\\. \n+ For symmetric encryption KMS keys, omit the property or specify `ENCRYPT_DECRYPT`\\.\n+ For asymmetric KMS keys with RSA key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY`\\.\n+ For asymmetric KMS keys with ECC key material, specify `SIGN_VERIFY`\\.\n+ For asymmetric KMS keys with SM2 \\(China Regions only\\) key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY`\\.\n+ For HMAC KMS keys, specify `GENERATE_VERIFY_MAC`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ENCRYPT_DECRYPT | GENERATE_VERIFY_MAC | SIGN_VERIFY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeyUsage", "type": "string" }, "MultiRegion": { - "markdownDescription": "Creates a multi\\-Region primary key that you can replicate in other AWS Regions\\. \nIf you change the `MultiRegion` property of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified `Multi-Region` value\\. While the scheduled deletion is pending, you can't use the existing KMS key\\. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted\\.\nFor a multi\\-Region key, set to this property to `true`\\. For a single\\-Region key, omit this property or set it to `false`\\. The default value is `false`\\. \n*Multi\\-Region keys* are an AWS KMS feature that lets you create multiple interoperable KMS keys in different AWS Regions\\. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross\\-Region call or exposing the plaintext data\\. For more information, see [Multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide*\\. \nYou can create a symmetric or asymmetric multi\\-Region key, and you can create a multi\\-Region key with imported key material\\. However, you cannot create a multi\\-Region key in a custom key store\\. \nTo create a replica of this primary key in a different AWS Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region\\. Specify the key ARN of this primary key\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Creates a multi\\-Region primary key that you can replicate in other AWS Regions\\. You can't change the `MultiRegion` value after the KMS key is created\\. \nFor a list of AWS Regions in which multi\\-Region keys are supported, see [Multi\\-Region keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide*\\. \nIf you change the value of the `MultiRegion` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html)\\. This prevents you from accidentally deleting a KMS key by changing an immutable property value\\.\nFor a multi\\-Region key, set to this property to `true`\\. For a single\\-Region key, omit this property or set it to `false`\\. The default value is `false`\\. \n*Multi\\-Region keys* are an AWS KMS feature that lets you create multiple interoperable KMS keys in different AWS Regions\\. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross\\-Region call or exposing the plaintext data\\. For more information, see [Multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide*\\. \nYou can create a symmetric encryption, HMAC, or asymmetric multi\\-Region KMS key, and you can create a multi\\-Region key with imported key material\\. However, you cannot create a multi\\-Region key in a custom key store\\. \nTo create a replica of this primary key in a different AWS Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region\\. Specify the key ARN of this primary key\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MultiRegion", "type": "boolean" }, @@ -107121,12 +110085,12 @@ "type": "boolean" }, "KeyPolicy": { - "markdownDescription": "The key policy that authorizes use of the replica key\\. \nThe key policy is not a shared property of multi\\-Region keys\\. You can specify the same key policy or a different key policy for each key in a set of related multi\\-Region keys\\. AWS KMS does not synchronize this property\\. \nThe key policy must conform to the following rules\\. \n+ The key policy must give the caller [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) permission on the KMS key\\. This reduces the risk that the KMS key becomes unmanageable\\. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the * *AWS Key Management Service Developer Guide* *\\.\n+ Each statement in the key policy must contain one or more principals\\. The principals in the key policy must exist and be visible to AWS KMS\\. When you create a new AWSprincipal \\(for example, an IAM user or role\\), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS\\. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide*\\.\n+ The key policy size limit is 32 kilobytes \\(32768 bytes\\)\\.\n*Minimum*: `1` \n*Maximum*: `32768` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key policy that authorizes use of the replica key\\. \nThe key policy is not a shared property of multi\\-Region keys\\. You can specify the same key policy or a different key policy for each key in a set of related multi\\-Region keys\\. AWS KMS does not synchronize this property\\. \nThe key policy must conform to the following rules\\. \n+ The key policy must give the caller [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) permission on the KMS key\\. This reduces the risk that the KMS key becomes unmanageable\\. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the * *AWS Key Management Service Developer Guide* *\\.\n+ Each statement in the key policy must contain one or more principals\\. The principals in the key policy must exist and be visible to AWS KMS\\. When you create a new AWSprincipal \\(for example, an IAM user or role\\), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS\\. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide*\\.\nA key policy document can include only the following characters: \n+ Printable ASCII characters from the space character \\(`\\u0020`\\) through the end of the ASCII character range\\.\n+ Printable characters in the Basic Latin and Latin\\-1 Supplement character set \\(through `\\u00FF`\\)\\.\n+ The tab \\(`\\u0009`\\), line feed \\(`\\u000A`\\), and carriage return \\(`\\u000D`\\) special characters\n*Minimum*: `1` \n*Maximum*: `32768` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeyPolicy", "type": "object" }, "PendingWindowInDays": { - "markdownDescription": "Specifies the number of days in the waiting period before AWS KMS deletes a replica key that has been removed from a CloudFormation stack\\. Enter a value between 7 and 30 days\\. The default value is 30 days\\. \nWhen you remove a replica key from a CloudFormation stack, AWS KMS schedules the replica key for deletion and starts the mandatory waiting period\\. The `PendingWindowInDays` property determines the length of waiting period\\. During the waiting period, the key state of replica key is `Pending Deletion`, which prevents it from being used in cryptographic operations\\. When the waiting period expires, AWS KMS permanently deletes the replica key\\. \nYou cannot use a CloudFormation template to cancel deletion of the replica after you remove it from the stack, regardless of the waiting period\\. However, if you specify a replica key in your template that is based on the same primary key as the original replica key, CloudFormation creates a new replica key with the same key ID, key material, and other shared properties of the original replica key\\. This new replica key can decrypt ciphertext that was encrypted under the original replica key, or any related multi\\-Region key\\. \nFor detailed information about deleting multi\\-Region keys, see [Deleting multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide*\\. \nFor information about the `PendingDeletion` key state, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide*\\. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide*\\. \n*Minimum*: 7 \n*Maximum*: 30 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the number of days in the waiting period before AWS KMS deletes a replica key that has been removed from a CloudFormation stack\\. Enter a value between 7 and 30 days\\. The default value is 30 days\\. \nWhen you remove a replica key from a CloudFormation stack, AWS KMS schedules the replica key for deletion and starts the mandatory waiting period\\. The `PendingWindowInDays` property determines the length of waiting period\\. During the waiting period, the key state of replica key is `Pending Deletion`, which prevents it from being used in cryptographic operations\\. When the waiting period expires, AWS KMS permanently deletes the replica key\\. \nIf the KMS key is a multi\\-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted\\. Otherwise, the waiting period begins immediately\\. \nYou cannot use a CloudFormation template to cancel deletion of the replica after you remove it from the stack, regardless of the waiting period\\. However, if you specify a replica key in your template that is based on the same primary key as the original replica key, CloudFormation creates a new replica key with the same key ID, key material, and other shared properties of the original replica key\\. This new replica key can decrypt ciphertext that was encrypted under the original replica key, or any related multi\\-Region key\\. \nFor detailed information about deleting multi\\-Region keys, see [Deleting multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide*\\. \nFor information about the `PendingDeletion` key state, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide*\\. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide*\\. \n*Minimum*: 7 \n*Maximum*: 30 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PendingWindowInDays", "type": "number" }, @@ -107261,7 +110225,7 @@ "items": { "$ref": "#/definitions/AWS::KafkaConnect::Connector.Plugin" }, - "markdownDescription": "Specifies which plugins were used for this connector\\. \n*Required*: Yes \n*Type*: List of [Plugin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-plugin.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies which plugin to use for the connector\\. You must specify a single\\-element list\\. Amazon MSK Connect does not currently support specifying multiple plugins\\. \n*Required*: Yes \n*Type*: List of [Plugin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-plugin.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Plugins", "type": "array" }, @@ -107687,21 +110651,21 @@ "properties": { "CustomDocumentEnrichmentConfiguration": { "$ref": "#/definitions/AWS::Kendra::DataSource.CustomDocumentEnrichmentConfiguration", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [CustomDocumentEnrichmentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configuration information for altering document metadata and content during the document ingestion process\\. \n*Required*: No \n*Type*: [CustomDocumentEnrichmentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomDocumentEnrichmentConfiguration" }, "DataSourceConfiguration": { "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceConfiguration", - "markdownDescription": "Configuration information for an Amazon Kendra data source\\. The contents of the configuration depend on the type of data source\\. You can only specify one type of data source in the configuration\\. Choose from one of the following data sources\\. \n+ Amazon S3\n+ Confluence\n+ Custom\n+ Database\n+ Microsoft OneDrive\n+ Microsoft SharePoint \n+ Salesforce\n+ ServiceNow\nYou can't specify the `Configuration` parameter when the `Type` parameter is set to `CUSTOM`\\. \nThe `Configuration` parameter is required for all other data sources\\. \n*Required*: No \n*Type*: [DataSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configuration information for an Amazon Kendra data source\\. The contents of the configuration depend on the type of data source\\. You can only specify one type of data source in the configuration\\. \nYou can't specify the `Configuration` parameter when the `Type` parameter is set to `CUSTOM`\\. \nThe `Configuration` parameter is required for all other data sources\\. \n*Required*: No \n*Type*: [DataSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataSourceConfiguration" }, "Description": { - "markdownDescription": "A description of the data source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description for the data source connector\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "IndexId": { - "markdownDescription": "The identifier of the index that should be associated with this data source\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of the index you want to use with the data source connector\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IndexId", "type": "string" }, @@ -107729,7 +110693,7 @@ "type": "array" }, "Type": { - "markdownDescription": "The type of the data source\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONFLUENCE | CUSTOM | DATABASE | FSX | GOOGLEDRIVE | ONEDRIVE | S3 | SALESFORCE | SERVICENOW | SHAREPOINT | SLACK | WEBCRAWLER | WORKDOCS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of the data source\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALFRESCO | BOX | CONFLUENCE | CUSTOM | DATABASE | FSX | GITHUB | GOOGLEDRIVE | JIRA | ONEDRIVE | QUIP | S3 | SALESFORCE | SERVICENOW | SHAREPOINT | SLACK | TEMPLATE | WEBCRAWLER | WORKDOCS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -107804,7 +110768,7 @@ "type": "string" }, "DocumentIdColumnName": { - "markdownDescription": "The column that provides the document's unique identifier\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The column that provides the document's identifier\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DocumentIdColumnName", "type": "string" }, @@ -107841,7 +110805,7 @@ "type": "array" }, "CrawlAttachments": { - "markdownDescription": "Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to index attachments of pages and blogs in Confluence\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrawlAttachments", "type": "boolean" } @@ -107929,7 +110893,7 @@ "items": { "type": "string" }, - "markdownDescription": ">A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence\\. Content that matches the patterns are excluded from the index\\. Content that doesn't match the patterns is included in the index\\. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence\\. Content that matches the patterns are excluded from the index\\. Content that doesn't match the patterns is included in the index\\. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExclusionPatterns", "type": "array" }, @@ -107947,7 +110911,7 @@ "title": "PageConfiguration" }, "SecretArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the key\\-value pairs required to connect to your Confluence server\\. The secret must contain a JSON structure with the following keys: \n+ username\u2014The user name or email address of a user with administrative privileges for the Confluence server\\.\n+ password\u2014The password associated with the user logging in to the Confluence server\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the user name and password required to connect to the Confluence instance\\. If you use Confluence Cloud, you use a generated API token as the password\\. \nYou can also provide authentication credentials in the form of a personal access token\\. For more information, see [Using a Confluence data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretArn", "type": "string" }, @@ -107962,7 +110926,7 @@ "title": "SpaceConfiguration" }, "Version": { - "markdownDescription": "Specifies the version of the Confluence installation that you are connecting to\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CLOUD | SERVER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version or the type of Confluence installation to connect to\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CLOUD | SERVER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" }, @@ -107986,7 +110950,7 @@ "items": { "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluencePageToIndexFieldMapping" }, - "markdownDescription": ">Maps attributes or field names of Confluence pages to Amazon Kendra index field names\\. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields\\. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. The Confluence data source field names must exist in your Confluence custom metadata\\. \nIf you specify the `PageFieldMappings` parameter, you must specify at least one field mapping\\. \n*Required*: No \n*Type*: List of [ConfluencePageToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html) \n*Maximum*: `12` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Maps attributes or field names of Confluence pages to Amazon Kendra index field names\\. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields\\. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. The Confluence data source field names must exist in your Confluence custom metadata\\. \nIf you specify the `PageFieldMappings` parameter, you must specify at least one field mapping\\. \n*Required*: No \n*Type*: List of [ConfluencePageToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html) \n*Maximum*: `12` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PageFieldMappings", "type": "array" } @@ -108022,12 +110986,12 @@ "additionalProperties": false, "properties": { "CrawlArchivedSpaces": { - "markdownDescription": "Specifies whether Amazon Kendra should index archived spaces\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to index archived spaces\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrawlArchivedSpaces", "type": "boolean" }, "CrawlPersonalSpaces": { - "markdownDescription": "Specifies whether Amazon Kendra should index personal spaces\\. Users can add restrictions to items in personal spaces\\. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results\\. For more information, see [Filtering on user context](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to index personal spaces\\. You can add restrictions to items in personal spaces\\. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results\\. For more information, see [Filtering on user context](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrawlPersonalSpaces", "type": "boolean" }, @@ -108364,7 +111328,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of strings\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of strings\\. The default maximum length or number of strings is 10\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StringListValue", "type": "array" }, @@ -108499,7 +111463,7 @@ "additionalProperties": false, "properties": { "DisableLocalGroups": { - "markdownDescription": "A Boolean value that specifies whether local groups are disabled \\(`True`\\) or enabled \\(`False`\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to disable local groups information\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DisableLocalGroups", "type": "boolean" }, @@ -108533,7 +111497,7 @@ "title": "OneDriveUsers" }, "SecretArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive\\. The user named should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive\\. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretArn", "type": "string" }, @@ -108732,7 +111696,7 @@ "title": "KnowledgeArticleConfiguration" }, "SecretArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance\\. The secret must contain a JSON structure with the following keys: \n+ authenticationUrl \\- The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token\\. \n+ consumerKey \\- The application public key generated when you created your Salesforce application\\.\n+ consumerSecret \\- The application private key generated when you created your Salesforce application\\.\n+ password \\- The password associated with the user logging in to the Salesforce instance\\.\n+ securityToken \\- The token associated with the user account logging in to the Salesforce instance\\.\n+ username \\- The user name of the user logging in to the Salesforce instance\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance\\. The secret must contain a JSON structure with the following keys: \n+ authenticationUrl \\- The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token\\. \n+ consumerKey \\- The application public key generated when you created your Salesforce application\\.\n+ consumerSecret \\- The application private key generated when you created your Salesforce application\\.\n+ password \\- The password associated with the user logging in to the Salesforce instance\\.\n+ securityToken \\- The token associated with the user logging in to the Salesforce instance\\.\n+ username \\- The user name of the user logging in to the Salesforce instance\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretArn", "type": "string" }, @@ -108907,7 +111871,7 @@ "additionalProperties": false, "properties": { "AuthenticationType": { - "markdownDescription": "The type of authentication used to connect to the ServiceNow instance\\. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the `SecretArn` field\\. When you choose `OAUTH2`, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to\\. \nWhen you use `OAUTH2` authentication, you must generate a token and a client secret using the ServiceNow console\\. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HTTP_BASIC | OAUTH2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of authentication used to connect to the ServiceNow instance\\. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the `SecretArn` field\\. If you choose `OAUTH2`, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password\\. \nWhen you use `OAUTH2` authentication, you must generate a token and a client secret using the ServiceNow console\\. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HTTP_BASIC | OAUTH2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthenticationType", "type": "string" }, @@ -108922,7 +111886,7 @@ "title": "KnowledgeArticleConfiguration" }, "SecretArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance\\. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret\\. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretArn", "type": "string" }, @@ -108948,7 +111912,7 @@ "additionalProperties": false, "properties": { "CrawlAttachments": { - "markdownDescription": "Indicates whether Amazon Kendra should index attachments to knowledge articles\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to index attachments to knowledge articles\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrawlAttachments", "type": "boolean" }, @@ -109001,7 +111965,7 @@ "additionalProperties": false, "properties": { "CrawlAttachments": { - "markdownDescription": "Indicates whether Amazon Kendra should crawl attachments to the service catalog items\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to index attachments to service catalog items\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrawlAttachments", "type": "boolean" }, @@ -109049,12 +112013,12 @@ "additionalProperties": false, "properties": { "CrawlAttachments": { - "markdownDescription": "`TRUE` to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, `FALSE`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to index document attachments\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrawlAttachments", "type": "boolean" }, "DisableLocalGroups": { - "markdownDescription": "A Boolean value that specifies whether local groups are disabled \\(`True`\\) or enabled \\(`False`\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to disable local groups information\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DisableLocalGroups", "type": "boolean" }, @@ -109075,7 +112039,7 @@ "items": { "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMapping" }, - "markdownDescription": "A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index\\. You must first create the index fields using the [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateIndex.html) operation before you map SharePoint attributes\\. For more information, see [Mapping Data Source Fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. \n*Required*: No \n*Type*: List of [DataSourceToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields\\. You must first create the index fields using the [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateIndex.html) operation before you map SharePoint attributes\\. For more information, see [Mapping Data Source Fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. \n*Required*: No \n*Type*: List of [DataSourceToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldMappings", "type": "array" }, @@ -109083,17 +112047,17 @@ "items": { "type": "string" }, - "markdownDescription": "A list of regular expression patterns to include certain documents in your SharePoint\\. Documents that match the patterns are included in the index\\. Documents that don't match the patterns are excluded from the index\\. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index\\. \nThe regex is applied to the display URL of the SharePoint document\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of regular expression patterns to include certain documents in your SharePoint\\. Documents that match the patterns are included in the index\\. Documents that don't match the patterns are excluded from the index\\. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index\\. \nThe regex applies to the display URL of the SharePoint document\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InclusionPatterns", "type": "array" }, "SecretArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of credentials stored in AWS Secrets Manager\\. The credentials should be a user/password pair\\. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials\\. For more information, see [Using a Microsoft SharePoint Data Source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html)\\. For more information about AWS Secrets Manager see [ What Is AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) in the * AWS Secrets Manager * user guide\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance\\. For more information, see [Microsoft SharePoint](https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretArn", "type": "string" }, "SharePointVersion": { - "markdownDescription": "The version of Microsoft SharePoint that you are using as a data source\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SHAREPOINT_2013 | SHAREPOINT_2016 | SHAREPOINT_ONLINE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of Microsoft SharePoint that you use\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SHAREPOINT_2013 | SHAREPOINT_2016 | SHAREPOINT_2019 | SHAREPOINT_ONLINE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SharePointVersion", "type": "string" }, @@ -109106,7 +112070,7 @@ "items": { "type": "string" }, - "markdownDescription": "The URLs of the Microsoft SharePoint site that contains the documents that should be indexed\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Microsoft SharePoint site URLs for the documents you want to index\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Urls", "type": "array" }, @@ -109184,7 +112148,7 @@ "properties": { "AuthenticationConfiguration": { "$ref": "#/definitions/AWS::Kendra::DataSource.WebCrawlerAuthenticationConfiguration", - "markdownDescription": "Configuration information required to connect to websites using authentication\\. \nYou can connect to websites using basic authentication of user name and password\\. \nYou must provide the website host name and port number\\. For example, the host name of https://a\\.example\\.com/page1\\.html is \"a\\.example\\.com\" and the port is 443, the standard port for HTTPS\\. You use a secret in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) to store your authentication credentials\\. \n*Required*: No \n*Type*: [WebCrawlerAuthenticationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerauthenticationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configuration information required to connect to websites using authentication\\. \nYou can connect to websites using basic authentication of user name and password\\. You use a secret in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) to store your authentication credentials\\. \nYou must provide the website host name and port number\\. For example, the host name of https://a\\.example\\.com/page1\\.html is \"a\\.example\\.com\" and the port is 443, the standard port for HTTPS\\. \n*Required*: No \n*Type*: [WebCrawlerAuthenticationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerauthenticationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthenticationConfiguration" }, "CrawlDepth": { @@ -109378,7 +112342,7 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "A description of the FAQ\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A description for the FAQ\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Description", "type": "string" }, @@ -109502,11 +112466,11 @@ "properties": { "CapacityUnits": { "$ref": "#/definitions/AWS::Kendra::Index.CapacityUnitsConfiguration", - "markdownDescription": "Specifies capacity units configured for your index\\. You can add and remove capacity units to tune an index to your requirements\\. You can set capacity units only for Enterprise edition indexes\\. \n*Required*: No \n*Type*: [CapacityUnitsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [CapacityUnitsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CapacityUnits" }, "Description": { - "markdownDescription": "A description of the index\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description for the index\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -109519,7 +112483,7 @@ "type": "array" }, "Edition": { - "markdownDescription": "Indicates whether the index is a enterprise edition index or a developer edition index\\. Valid values are `DEVELOPER_EDITION` and `ENTERPRISE_EDITION`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DEVELOPER_EDITION | ENTERPRISE_EDITION` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Indicates whether the index is a Enterprise Edition index or a Developer Edition index\\. Valid values are `DEVELOPER_EDITION` and `ENTERPRISE_EDITION`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DEVELOPER_EDITION | ENTERPRISE_EDITION` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Edition", "type": "string" }, @@ -109547,7 +112511,7 @@ "type": "array" }, "UserContextPolicy": { - "markdownDescription": "The user context policy\\. \nATTRIBUTE\\_FILTER \n+ All indexed content is searchable and displayable for all users\\. If there is an access control list, it is ignored\\. You can filter on user and group attributes\\.\nUSER\\_TOKEN \n+ Enables SSO and token\\-based user access control\\. All documents with no access control and all documents accessible to the user will be searchable and displayable\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user context policy\\. \nATTRIBUTE\\_FILTER \n+ All indexed content is searchable and displayable for all users\\. If you want to filter search results on user context, you can use the attribute filters of `_user_id` and `_group_ids` or you can provide user and group information in `UserContext`\\.\nUSER\\_TOKEN \n+ Enables token\\-based user access control to filter search results on user context\\. All documents with no access control and all documents accessible to the user will be searchable and displayable\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UserContextPolicy", "type": "string" }, @@ -109592,12 +112556,12 @@ "additionalProperties": false, "properties": { "QueryCapacityUnits": { - "markdownDescription": "The amount of extra query capacity for an index and [GetQuerySuggestions](https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) capacity\\. \nA single extra capacity unit for an index provides 0\\.1 queries per second or approximately 8,000 queries per day\\. \n `GetQuerySuggestions` capacity is five times the provisioned query capacity for an index, or the base capacity of 2\\.5 calls per second, whichever is higher\\. For example, the base capacity for an index is 0\\.1 queries per second, and `GetQuerySuggestions` capacity has a base of 2\\.5 calls per second\\. If you add another 0\\.1 queries per second to total 0\\.2 queries per second for an index, the `GetQuerySuggestions` capacity is 2\\.5 calls per second \\(higher than five times 0\\.2 queries per second\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of extra query capacity for an index and [GetQuerySuggestions](https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) capacity\\. \nA single extra capacity unit for an index provides 0\\.1 queries per second or approximately 8,000 queries per day\\. You can add up to 100 extra capacity units\\. \n `GetQuerySuggestions` capacity is five times the provisioned query capacity for an index, or the base capacity of 2\\.5 calls per second, whichever is higher\\. For example, the base capacity for an index is 0\\.1 queries per second, and `GetQuerySuggestions` capacity has a base of 2\\.5 calls per second\\. If you add another 0\\.1 queries per second to total 0\\.2 queries per second for an index, the `GetQuerySuggestions` capacity is 2\\.5 calls per second \\(higher than five times 0\\.2 queries per second\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "QueryCapacityUnits", "type": "number" }, "StorageCapacityUnits": { - "markdownDescription": "The amount of extra storage capacity for an index\\. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of extra storage capacity for an index\\. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first\\. You can add up to 100 extra capacity units\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StorageCapacityUnits", "type": "number" } @@ -109618,7 +112582,7 @@ }, "Relevance": { "$ref": "#/definitions/AWS::Kendra::Index.Relevance", - "markdownDescription": "Provides manual tuning parameters to determine how the field affects the search results\\. \n*Required*: No \n*Type*: [Relevance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides tuning parameters to determine how the field affects the search results\\. \n*Required*: No \n*Type*: [Relevance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Relevance" }, "Search": { @@ -109729,7 +112693,7 @@ "items": { "$ref": "#/definitions/AWS::Kendra::Index.ValueImportanceItem" }, - "markdownDescription": "An array of key\\-value pairs that contains an array of values that should be given a different boost when they appear in the search result list\\. For example, if you are boosting query terms that match the department field in the result, query terms that match the department field are boosted in the result\\. You can add entries from the department field to boost documents with those values higher\\. \nFor example, you can add entries to the map with names of departments\\. If you add \"HR\", 5 and \"Legal\",3 those departments are given special attention when they appear in the metadata of a document\\. \n*Required*: No \n*Type*: List of [ValueImportanceItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-valueimportanceitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of key\\-value pairs for different boosts when they appear in the search result list\\. For example, if you want to boost query terms that match the \"department\" field in the result, query terms that match this field are boosted in the result\\. You can add entries from the department field to boost documents with those values higher\\. \nFor example, you can add entries to the map with names of departments\\. If you add \"HR\", 5 and \"Legal\",3 those departments are given special attention when they appear in the metadata of a document\\. \n*Required*: No \n*Type*: List of [ValueImportanceItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-valueimportanceitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ValueImportanceItems", "type": "array" } @@ -109755,7 +112719,7 @@ "type": "boolean" }, "Sortable": { - "markdownDescription": "Indicates that the field can be used to sort the search results\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether the field can be used to sort the results of a query\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Sortable", "type": "boolean" } @@ -109766,7 +112730,7 @@ "additionalProperties": false, "properties": { "KmsKeyId": { - "markdownDescription": "The identifier of the AWS KMScustomer master key \\(CMK\\)\\. Amazon Kendra doesn't support asymmetric CMKs\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The identifier of the AWS KMS key\\. Amazon Kendra doesn't support asymmetric keys\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" } @@ -109793,12 +112757,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The document metadata value that receives the search boost\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The document metadata value used for the search boost\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Value": { - "markdownDescription": "The boost value that a document receives when the key is part of the metadata of a document\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The boost value for a document when the key is part of the metadata of a document\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "number" } @@ -109841,18 +112805,26 @@ "additionalProperties": false, "properties": { "CapacityUnits": { - "$ref": "#/definitions/AWS::KendraRanking::ExecutionPlan.CapacityUnitsConfiguration" + "$ref": "#/definitions/AWS::KendraRanking::ExecutionPlan.CapacityUnitsConfiguration", + "markdownDescription": "You can set additional capacity units to meet the needs of your rescore execution plan\\. You are given a single capacity unit by default\\. If you want to use the default capacity, you don't set additional capacity units\\. For more information on the default capacity and additional capacity units, see [Adjusting capacity](https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html)\\. \n*Required*: No \n*Type*: [CapacityUnitsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendraranking-executionplan-capacityunitsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CapacityUnits" }, "Description": { + "markdownDescription": "A description for the rescore execution plan\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1000` \n*Pattern*: `^\\P{C}*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A name for the rescore execution plan\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000` \n*Pattern*: `[a-zA-Z0-9][a-zA-Z0-9_-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of key\\-value pairs that identify or categorize your rescore execution plan\\. You can also use tags to help control access to the rescore execution plan\\. Tag keys and values can consist of Unicode letters, digits, white space\\. They can also consist of underscore, period, colon, equal, plus, and asperand\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -109886,6 +112858,8 @@ "additionalProperties": false, "properties": { "RescoreCapacityUnits": { + "markdownDescription": "The amount of extra capacity for your rescore execution plan\\. \nA single extra capacity unit for a rescore execution plan provides 0\\.01 rescore requests per second\\. You can add up to 1000 extra capacity units\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RescoreCapacityUnits", "type": "number" } }, @@ -110060,7 +113034,7 @@ "type": "string" }, "StreamARN": { - "markdownDescription": "The ARN of the stream with which you registered the consumer\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:aws.*:kinesis:.*:\\d{12}:stream/.+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the stream with which you registered the consumer\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:aws.*:kinesis:.*:\\d{12}:stream/\\S+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StreamARN", "type": "string" } @@ -110890,7 +113864,9 @@ "type": "string" }, "ApplicationMaintenanceConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration" + "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ApplicationMaintenanceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationmaintenanceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApplicationMaintenanceConfiguration" }, "ApplicationMode": { "markdownDescription": "To create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`\\. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `INTERACTIVE | STREAMING` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -110903,10 +113879,12 @@ "type": "string" }, "RunConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.RunConfiguration" + "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.RunConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [RunConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-runconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RunConfiguration" }, "RuntimeEnvironment": { - "markdownDescription": "The runtime environment for the application\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FLINK-1_11 | FLINK-1_13 | FLINK-1_6 | FLINK-1_8 | SQL-1_0 | ZEPPELIN-FLINK-1_0 | ZEPPELIN-FLINK-2_0` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The runtime environment for the application\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FLINK-1_11 | FLINK-1_13 | FLINK-1_15 | FLINK-1_6 | FLINK-1_8 | SQL-1_0 | ZEPPELIN-FLINK-1_0 | ZEPPELIN-FLINK-2_0` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RuntimeEnvironment", "type": "string" }, @@ -111003,6 +113981,8 @@ "items": { "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.VpcConfiguration" }, + "markdownDescription": "The array of descriptions of VPC configurations available to the application\\. \n*Required*: No \n*Type*: List of [VpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-vpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcConfigurations", "type": "array" }, "ZeppelinApplicationConfiguration": { @@ -111017,6 +113997,8 @@ "additionalProperties": false, "properties": { "ApplicationMaintenanceWindowStartTime": { + "markdownDescription": "Specifies the start time of the maintence window\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApplicationMaintenanceWindowStartTime", "type": "string" } }, @@ -111029,9 +114011,13 @@ "additionalProperties": false, "properties": { "ApplicationRestoreType": { + "markdownDescription": "Specifies how the application should be restored\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `RESTORE_FROM_CUSTOM_SNAPSHOT | RESTORE_FROM_LATEST_SNAPSHOT | SKIP_RESTORE_FROM_SNAPSHOT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApplicationRestoreType", "type": "string" }, "SnapshotName": { + "markdownDescription": "The identifier of an existing snapshot of application state to use to restart an application\\. The application uses this value if `RESTORE_FROM_CUSTOM_SNAPSHOT` is specified for the `ApplicationRestoreType`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SnapshotName", "type": "string" } }, @@ -111212,6 +114198,8 @@ "additionalProperties": false, "properties": { "AllowNonRestoredState": { + "markdownDescription": "When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program\\. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data\\. For more information, see [ Allowing Non\\-Restored State](https://ci.apache.org/projects/flink/flink-docs-release-1.8/ops/state/savepoints.html#allowing-non-restored-state) in the [Apache Flink documentation](https://ci.apache.org/projects/flink/flink-docs-release-1.8/)\\. \nThis value defaults to `false`\\. If you update your application without specifying this parameter, `AllowNonRestoredState` will be set to `false`, even if it was previously set to `true`\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowNonRestoredState", "type": "boolean" } }, @@ -111479,7 +114467,7 @@ }, "PropertyMap": { "additionalProperties": true, - "markdownDescription": "Describes the value of an application execution property key\\-value pair\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Describes the value of an application execution property key\\-value pair\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -111539,10 +114527,14 @@ "additionalProperties": false, "properties": { "ApplicationRestoreConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.ApplicationRestoreConfiguration" + "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.ApplicationRestoreConfiguration", + "markdownDescription": "Describes the restore behavior of a restarting application\\. \n*Required*: No \n*Type*: [ApplicationRestoreConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationrestoreconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApplicationRestoreConfiguration" }, "FlinkRunConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.FlinkRunConfiguration" + "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.FlinkRunConfiguration", + "markdownDescription": "Describes the starting parameters for a Flink\\-based Kinesis Data Analytics application\\. \n*Required*: No \n*Type*: [FlinkRunConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkrunconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FlinkRunConfiguration" } }, "type": "object" @@ -111551,7 +114543,7 @@ "additionalProperties": false, "properties": { "BasePath": { - "markdownDescription": "The base path for the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `[a-zA-Z0-9/!-_.*'()]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The base path for the S3 bucket\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `[a-zA-Z0-9/!-_.*'()]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BasePath", "type": "string" }, @@ -111570,12 +114562,12 @@ "additionalProperties": false, "properties": { "BucketARN": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the S3 bucket containing the application code\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the S3 bucket containing the application code\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BucketARN", "type": "string" }, "FileKey": { - "markdownDescription": "The file key for the object containing the application code\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The file key for the object containing the application code\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FileKey", "type": "string" }, @@ -111612,12 +114604,16 @@ "items": { "type": "string" }, + "markdownDescription": "The array of [SecurityGroup](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html) IDs used by the VPC configuration\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroupIds", "type": "array" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "The array of [Subnet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) IDs used by the VPC configuration\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `16` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetIds", "type": "array" } }, @@ -112189,7 +115185,9 @@ "additionalProperties": false, "properties": { "AmazonOpenSearchServerlessDestinationConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AmazonOpenSearchServerlessDestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AmazonOpenSearchServerlessDestinationConfiguration" }, "AmazonopensearchserviceDestinationConfiguration": { "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonopensearchserviceDestinationConfiguration", @@ -112281,9 +115279,13 @@ "additionalProperties": false, "properties": { "IntervalInSeconds": { + "markdownDescription": "Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination\\. The default value is 300 \\(5 minutes\\)\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `900` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntervalInSeconds", "type": "number" }, "SizeInMBs": { + "markdownDescription": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination\\. The default value is 5\\. \nWe recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds\\. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SizeInMBs", "type": "number" } }, @@ -112293,34 +115295,54 @@ "additionalProperties": false, "properties": { "BufferingHints": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessBufferingHints" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessBufferingHints", + "markdownDescription": "The buffering options\\. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used\\. \n*Required*: No \n*Type*: [AmazonOpenSearchServerlessBufferingHints](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BufferingHints" }, "CloudWatchLoggingOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [CloudWatchLoggingOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CloudWatchLoggingOptions" }, "CollectionEndpoint": { + "markdownDescription": "The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `https:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CollectionEndpoint", "type": "string" }, "IndexName": { + "markdownDescription": "The Serverless offering for Amazon OpenSearch Service index name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `80` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IndexName", "type": "string" }, "ProcessingConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ProcessingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ProcessingConfiguration" }, "RetryOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessRetryOptions" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessRetryOptions", + "markdownDescription": "The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service\\. The default value is 300 \\(5 minutes\\)\\. \n*Required*: No \n*Type*: [AmazonOpenSearchServerlessRetryOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetryOptions" }, "RoleARN": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `arn:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleARN", "type": "string" }, "S3BackupMode": { + "markdownDescription": "Defines how documents should be delivered to Amazon S3\\. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService\\-failed/ appended to the key prefix\\. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService\\-failed/ appended to the prefix\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AllDocuments | FailedDocumentsOnly` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3BackupMode", "type": "string" }, "S3Configuration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [S3DestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3Configuration" }, "VpcConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.VpcConfiguration" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.VpcConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VpcConfiguration" } }, "required": [ @@ -112334,6 +115356,8 @@ "additionalProperties": false, "properties": { "DurationInSeconds": { + "markdownDescription": "After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery \\(including the first attempt\\)\\. After this time has elapsed, the failed documents are written to Amazon S3\\. Default value is 300 seconds \\(5 minutes\\)\\. A value of 0 \\(zero\\) results in no retries\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `7200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DurationInSeconds", "type": "number" } }, @@ -113129,7 +116153,7 @@ "additionalProperties": false, "properties": { "ParameterName": { - "markdownDescription": "The name of the parameter\\. Currently the following default values are supported: 3 for `NumberOfRetries`, 60 for the `BufferIntervalInSeconds`, and 3 for the `BufferSizeInMBs`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BufferIntervalInSeconds | BufferSizeInMBs | Delimiter | JsonParsingEngine | LambdaArn | MetadataExtractionQuery | NumberOfRetries | RoleArn | SubRecordType` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the parameter\\. Currently the following default values are supported: 3 for `NumberOfRetries` and 60 for the `BufferIntervalInSeconds`\\. The `BufferSizeInMBs` ranges between 0\\.2 MB and up to 3MB\\. The default buffering hint is 1MB for all destinations, except Splunk\\. For Splunk, the default buffering hint is 256 KB\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BufferIntervalInSeconds | BufferSizeInMBs | Delimiter | JsonParsingEngine | LambdaArn | MetadataExtractionQuery | NumberOfRetries | RoleArn | SubRecordType` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ParameterName", "type": "string" }, @@ -113649,24 +116673,38 @@ "items": { "type": "string" }, + "markdownDescription": "An array of UTF\\-8 strings\\. A list of column names\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ColumnNames", "type": "array" }, "ColumnWildcard": { - "$ref": "#/definitions/AWS::LakeFormation::DataCellsFilter.ColumnWildcard" + "$ref": "#/definitions/AWS::LakeFormation::DataCellsFilter.ColumnWildcard", + "markdownDescription": "A wildcard with exclusions\\. You must specify either a `ColumnNames` list or the `ColumnWildCard`\\. \n*Required*: No \n*Type*: [ColumnWildcard](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-columnwildcard.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ColumnWildcard" }, "DatabaseName": { + "markdownDescription": "UTF\\-8 string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nA database in the Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatabaseName", "type": "string" }, "Name": { + "markdownDescription": "UTF\\-8 string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nThe name given by the user to the data filter cell\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "RowFilter": { - "$ref": "#/definitions/AWS::LakeFormation::DataCellsFilter.RowFilter" + "$ref": "#/definitions/AWS::LakeFormation::DataCellsFilter.RowFilter", + "markdownDescription": "A PartiQL predicate\\. \n*Required*: No \n*Type*: [RowFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-rowfilter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RowFilter" }, "TableCatalogId": { + "markdownDescription": "Catalog id string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nThe ID of the catalog to which the table belongs\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableCatalogId", "type": "string" }, "TableName": { + "markdownDescription": "UTF\\-8 string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nA table in the database\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableName", "type": "string" } }, @@ -113706,6 +116744,8 @@ "items": { "type": "string" }, + "markdownDescription": "Excludes column names\\. Any column with this name will be excluded\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExcludedColumnNames", "type": "array" } }, @@ -113715,9 +116755,13 @@ "additionalProperties": false, "properties": { "AllRowsWildcard": { + "markdownDescription": "A wildcard for all rows\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AllRowsWildcard", "type": "object" }, "FilterExpression": { + "markdownDescription": "A filter expression\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FilterExpression", "type": "string" } }, @@ -113767,6 +116811,8 @@ "items": { "type": "string" }, + "markdownDescription": "An array of UTF\\-8 strings\\. \nA list of the resource\\-owning account IDs that the caller's account can use to share their user access details \\(user ARNs\\)\\. The user ARNs can be logged in the resource owner's CloudTrail log\\. You may want to specify this property when you are in a high\\-trust boundary, such as the same team or company\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrustedResourceOwners", "type": "array" } }, @@ -113860,7 +116906,7 @@ "items": { "type": "string" }, - "markdownDescription": "Indicates whether to grant the ability to grant permissions \\(as a subset of permissions granted\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates the ability to grant permissions \\(as a subset of permissions granted\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PermissionsWithGrantOption", "type": "array" }, @@ -113926,12 +116972,12 @@ "additionalProperties": false, "properties": { "CatalogId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CatalogId", "type": "string" }, "S3Resource": { - "markdownDescription": "Currently not supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) that uniquely identifies the data location resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3Resource", "type": "string" } @@ -113942,7 +116988,7 @@ "additionalProperties": false, "properties": { "CatalogId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CatalogId", "type": "string" }, @@ -113974,7 +117020,7 @@ }, "TableWithColumnsResource": { "$ref": "#/definitions/AWS::LakeFormation::Permissions.TableWithColumnsResource", - "markdownDescription": "Currently not supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [TableWithColumnsResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A structure for a table with columns object\\. This object is only used when granting a SELECT permission\\. \n*Required*: No \n*Type*: [TableWithColumnsResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TableWithColumnsResource" } }, @@ -113984,7 +117030,7 @@ "additionalProperties": false, "properties": { "CatalogId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CatalogId", "type": "string" }, @@ -114015,7 +117061,7 @@ "additionalProperties": false, "properties": { "CatalogId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CatalogId", "type": "string" }, @@ -114081,25 +117127,35 @@ "additionalProperties": false, "properties": { "Catalog": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, the account ID\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Catalog", "type": "string" }, "Permissions": { "items": { "type": "string" }, + "markdownDescription": "The permissions granted or revoked\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Permissions", "type": "array" }, "PermissionsWithGrantOption": { "items": { "type": "string" }, + "markdownDescription": "Indicates the ability to grant permissions \\(as a subset of permissions granted\\)\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PermissionsWithGrantOption", "type": "array" }, "Principal": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DataLakePrincipal" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DataLakePrincipal", + "markdownDescription": "The principal to be granted a permission\\. \n*Required*: Yes \n*Type*: [DataLakePrincipal](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalakeprincipal.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Principal" }, "Resource": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.Resource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.Resource", + "markdownDescription": "The resource to be granted or revoked permissions\\. \n*Required*: Yes \n*Type*: [Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Resource" } }, "required": [ @@ -114138,6 +117194,8 @@ "items": { "type": "string" }, + "markdownDescription": "Excludes column names\\. Any column with this name will be excluded\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExcludedColumnNames", "type": "array" } }, @@ -114147,15 +117205,23 @@ "additionalProperties": false, "properties": { "DatabaseName": { + "markdownDescription": "A database in the Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatabaseName", "type": "string" }, "Name": { + "markdownDescription": "The name given by the user to the data filter cell\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "TableCatalogId": { + "markdownDescription": "The ID of the catalog to which the table belongs\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableCatalogId", "type": "string" }, "TableName": { + "markdownDescription": "The name of the table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableName", "type": "string" } }, @@ -114171,6 +117237,8 @@ "additionalProperties": false, "properties": { "DataLakePrincipalIdentifier": { + "markdownDescription": "An identifier for the AWS Lake Formation principal\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataLakePrincipalIdentifier", "type": "string" } }, @@ -114180,9 +117248,13 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog where the location is registered with AWS Lake Formation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "ResourceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) that uniquely identifies the data location resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceArn", "type": "string" } }, @@ -114196,9 +117268,13 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "Name": { + "markdownDescription": "The name of the database resource\\. Unique to the Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -114212,12 +117288,16 @@ "additionalProperties": false, "properties": { "TagKey": { + "markdownDescription": "The key\\-name for the LF\\-tag\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagKey", "type": "string" }, "TagValues": { "items": { "type": "string" }, + "markdownDescription": "A list of possible values of the corresponding `TagKey` of an LF\\-tag key\\-value pair\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagValues", "type": "array" } }, @@ -114227,15 +117307,21 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog where the location is registered with Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "TagKey": { + "markdownDescription": "The key\\-name for the LF\\-tag\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagKey", "type": "string" }, "TagValues": { "items": { "type": "string" }, + "markdownDescription": "A list of possible values for the corresponding `TagKey` of an LF\\-tag key\\-value pair\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagValues", "type": "array" } }, @@ -114250,15 +117336,21 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "Expression": { "items": { "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.LFTag" }, + "markdownDescription": "A list of LF\\-tag conditions that apply to the resource's LF\\-tag policy\\. \n*Required*: Yes \n*Type*: List of [LFTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftag.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Expression", "type": "array" }, "ResourceType": { + "markdownDescription": "The resource type for which the LF\\-tag policy applies\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceType", "type": "string" } }, @@ -114273,28 +117365,44 @@ "additionalProperties": false, "properties": { "Catalog": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, the account ID\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Catalog", "type": "object" }, "DataCellsFilter": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DataCellsFilterResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DataCellsFilterResource", + "markdownDescription": "A data cell filter\\. \n*Required*: No \n*Type*: [DataCellsFilterResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataCellsFilter" }, "DataLocation": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DataLocationResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DataLocationResource", + "markdownDescription": "The location of an Amazon S3 path where permissions are granted or revoked\\. \n*Required*: No \n*Type*: [DataLocationResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalocationresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataLocation" }, "Database": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DatabaseResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DatabaseResource", + "markdownDescription": "The database for the resource\\. Unique to the Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database permissions to a principal\\. \n*Required*: No \n*Type*: [DatabaseResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-databaseresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Database" }, "LFTag": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.LFTagKeyResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.LFTagKeyResource", + "markdownDescription": "The LF\\-tag key and values attached to a resource\\. \n*Required*: No \n*Type*: [LFTagKeyResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LFTag" }, "LFTagPolicy": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.LFTagPolicyResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.LFTagPolicyResource", + "markdownDescription": "A list of LF\\-tag conditions that define a resource's LF\\-tag policy\\. \n*Required*: No \n*Type*: [LFTagPolicyResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LFTagPolicy" }, "Table": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.TableResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.TableResource", + "markdownDescription": "The table for the resource\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: No \n*Type*: [TableResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Table" }, "TableWithColumns": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.TableWithColumnsResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.TableWithColumnsResource", + "markdownDescription": "The table with columns for the resource\\. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3\\. \n*Required*: No \n*Type*: [TableWithColumnsResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableWithColumns" } }, "type": "object" @@ -114303,15 +117411,23 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "DatabaseName": { + "markdownDescription": "The name of the database for the table\\. Unique to a Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatabaseName", "type": "string" }, "Name": { + "markdownDescription": "The name of the table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "TableWildcard": { + "markdownDescription": "A wildcard object representing every table under a database\\. \nAt least one of `TableResource$Name` or `TableResource$TableWildcard` is required\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableWildcard", "type": "object" } }, @@ -114325,21 +117441,31 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog where the location is registered with AWS Lake Formation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "ColumnNames": { "items": { "type": "string" }, + "markdownDescription": "The list of column names for the table\\. At least one of `ColumnNames` or `ColumnWildcard` is required\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ColumnNames", "type": "array" }, "ColumnWildcard": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.ColumnWildcard" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.ColumnWildcard", + "markdownDescription": "A wildcard specified by a `ColumnWildcard` object\\. At least one of `ColumnNames` or `ColumnWildcard` is required\\. \n*Required*: No \n*Type*: [ColumnWildcard](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-columnwildcard.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ColumnWildcard" }, "DatabaseName": { + "markdownDescription": "The name of the database for the table with columns resource\\. Unique to the Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatabaseName", "type": "string" }, "Name": { + "markdownDescription": "The name of the table resource\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -114464,15 +117590,21 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "Catalog id string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nThe identifier for the Data Catalog\\. By default, the account ID\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "TagKey": { + "markdownDescription": "UTF\\-8 string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nThe key\\-name for the LF\\-tag\\. \nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagKey", "type": "string" }, "TagValues": { "items": { "type": "string" }, + "markdownDescription": "An array of UTF\\-8 strings, not less than 1 or more than 50 strings\\. \n A list of possible values of the corresponding `TagKey` of an LF\\-tag key\\-value pair\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TagValues", "type": "array" } }, @@ -114542,10 +117674,14 @@ "items": { "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.LFTagPair" }, + "markdownDescription": "A structure containing an LF\\-tag key\\-value pair\\. \n*Required*: Yes \n*Type*: List of [LFTagPair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LFTags", "type": "array" }, "Resource": { - "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.Resource" + "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.Resource", + "markdownDescription": "UTF\\-8 string \\(valid values: `DATABASE | TABLE`\\)\\. \nThe resource for which the LF\\-tag policy applies\\. \n*Required*: Yes \n*Type*: [Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-resource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Resource" } }, "required": [ @@ -114579,9 +117715,13 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, it should be the account ID of the caller\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "Name": { + "markdownDescription": "The name of the database resource\\. Unique to the Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -114595,15 +117735,21 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "TagKey": { + "markdownDescription": "The key\\-name for the LF\\-tag\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagKey", "type": "string" }, "TagValues": { "items": { "type": "string" }, + "markdownDescription": "A list of possible values of the corresponding `TagKey` of an LF\\-tag key\\-value pair\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagValues", "type": "array" } }, @@ -114618,16 +117764,24 @@ "additionalProperties": false, "properties": { "Catalog": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, the account ID\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Catalog", "type": "object" }, "Database": { - "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.DatabaseResource" + "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.DatabaseResource", + "markdownDescription": "The database for the resource\\. Unique to the Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database permissions to a principal\\. \n*Required*: No \n*Type*: [DatabaseResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-databaseresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Database" }, "Table": { - "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.TableResource" + "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.TableResource", + "markdownDescription": "The table for the resource\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: No \n*Type*: [TableResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tableresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Table" }, "TableWithColumns": { - "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.TableWithColumnsResource" + "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.TableWithColumnsResource", + "markdownDescription": "The table with columns for the resource\\. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3\\. \n*Required*: No \n*Type*: [TableWithColumnsResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tablewithcolumnsresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableWithColumns" } }, "type": "object" @@ -114636,15 +117790,23 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "DatabaseName": { + "markdownDescription": "The name of the database for the table\\. Unique to a Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatabaseName", "type": "string" }, "Name": { + "markdownDescription": "The name of the table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "TableWildcard": { + "markdownDescription": "A wildcard object representing every table under a database\\.This is an object with no properties that effectively behaves as a true or false depending on whether not it is passed as a parameter\\. The valid inputs for a property with this type in either yaml or json is null or \\{\\}\\. \nAt least one of `TableResource$Name` or `TableResource$TableWildcard` is required\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableWildcard", "type": "object" } }, @@ -114658,18 +117820,26 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "A wildcard object representing every table under a database\\. \nAt least one of TableResource$Name or TableResource$TableWildcard is required\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "ColumnNames": { "items": { "type": "string" }, + "markdownDescription": "The list of column names for the table\\. At least one of `ColumnNames` or `ColumnWildcard` is required\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ColumnNames", "type": "array" }, "DatabaseName": { + "markdownDescription": "The name of the database for the table with columns resource\\. Unique to the Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatabaseName", "type": "string" }, "Name": { + "markdownDescription": "The name of the table resource\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -115673,7 +118843,7 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies parameters that you want to pass in with ENTRYPOINT\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies parameters that you want to pass in with ENTRYPOINT\\. You can specify a maximum of 1,500 parameters in the list\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Command", "type": "array" }, @@ -115681,12 +118851,12 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies the entry point to their application, which is typically the location of the runtime executable\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the entry point to their application, which is typically the location of the runtime executable\\. You can specify a maximum of 1,500 string entries in the list\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EntryPoint", "type": "array" }, "WorkingDirectory": { - "markdownDescription": "Specifies the working directory\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the working directory\\. The length of the directory string cannot exceed 1,000 characters\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WorkingDirectory", "type": "string" } @@ -116381,7 +119551,7 @@ }, "DataPrivacy": { "$ref": "#/definitions/AWS::Lex::Bot.DataPrivacy", - "markdownDescription": "Provides information on additional privacy protections Amazon Lex should use with the bot's data\\. \n*Required*: Yes \n*Type*: [DataPrivacy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dataprivacy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [DataPrivacy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dataprivacy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataPrivacy" }, "Description": { @@ -116395,7 +119565,7 @@ "type": "number" }, "Name": { - "markdownDescription": "The name of the field to filter the list of bots\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BotLocaleName` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the bot locale\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -116451,7 +119621,7 @@ "additionalProperties": false, "properties": { "AudioRecognitionStrategy": { - "markdownDescription": "Specifies that Amazon Lex should use slot values as a custom vocabulary when recognizing user utterances\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Enables using the slot values as a custom vocabulary for recognizing user utterances\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AudioRecognitionStrategy", "type": "string" } @@ -116462,12 +119632,12 @@ "additionalProperties": false, "properties": { "AllowAudioInput": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether audio input is allowed\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowAudioInput", "type": "boolean" }, "AllowDTMFInput": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether DTMF input is allowed\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowDTMFInput", "type": "boolean" } @@ -116483,16 +119653,16 @@ "properties": { "AudioSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.AudioSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AudioSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiospecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the settings on audio input\\. \n*Required*: No \n*Type*: [AudioSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiospecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AudioSpecification" }, "DTMFSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.DTMFSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DTMFSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dtmfspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the settings on DTMF input\\. \n*Required*: No \n*Type*: [DTMFSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dtmfspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DTMFSpecification" }, "StartTimeoutMs": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Time for which a bot waits before assuming that the customer isn't going to speak or press a key\\. This timeout is shared between Audio and DTMF inputs\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartTimeoutMs", "type": "number" } @@ -116525,7 +119695,7 @@ "title": "Destination" }, "Enabled": { - "markdownDescription": "Specifies whether audio logging is enabled for the bot\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether audio logging in enabled for the bot\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -116540,12 +119710,12 @@ "additionalProperties": false, "properties": { "EndTimeoutMs": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Time for which a bot waits after the customer stops speaking to assume the utterance is finished\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EndTimeoutMs", "type": "number" }, "MaxLengthMs": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxLengthMs", "type": "number" } @@ -116561,11 +119731,11 @@ "properties": { "CodeHookSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.CodeHookSpecification", - "markdownDescription": "Specifies the Lambda function to use in this locale\\. \n*Required*: No \n*Type*: [CodeHookSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-codehookspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the Lambda function that should be used in the locale\\. \n*Required*: No \n*Type*: [CodeHookSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-codehookspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CodeHookSpecification" }, "Enabled": { - "markdownDescription": "Specifies whether the locale is enabled for the bot\\. If the value is false, the locale isn't available for use\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether the locale is enabled for the bot\\. If the value is `false`, the locale isn't available for use\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -116622,7 +119792,7 @@ "type": "string" }, "NluConfidenceThreshold": { - "markdownDescription": "Determines the threshold where Amazon Lex will insert the AMAZON\\.FallbackIntent, AMAZON\\.KendraSearchIntent, or both when returning alternative intents\\. You must configure an AMAZON\\.FallbackIntent\\. AMAZON\\.KendraSearchIntent is only inserted if it is configured for the bot\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the threshold where Amazon Lex will insert the `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents\\. You must configure an `AMAZON.FallbackIntent`\\. `AMAZON.KendraSearchIntent` is only inserted if it is configured for the bot\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NluConfidenceThreshold", "type": "number" }, @@ -116636,7 +119806,7 @@ }, "VoiceSettings": { "$ref": "#/definitions/AWS::Lex::Bot.VoiceSettings", - "markdownDescription": "Identifies the Amazon Polly voice used for audio interaction with the user\\. \n*Required*: No \n*Type*: [VoiceSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-voicesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Defines settings for using an Amazon Polly voice to communicate with a user\\. \n*Required*: No \n*Type*: [VoiceSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-voicesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VoiceSettings" } }, @@ -116650,7 +119820,7 @@ "additionalProperties": false, "properties": { "Text": { - "markdownDescription": "The text that appears on the button\\. Use this to tell the user the value that is returned when they choose this button\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The text that appears on the button\\. Use this to tell the user what value is returned when they choose this button\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Text", "type": "string" }, @@ -116670,12 +119840,12 @@ "additionalProperties": false, "properties": { "CloudWatchLogGroupArn": { - "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of the log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchLogGroupArn", "type": "string" }, "LogPrefix": { - "markdownDescription": "Specifies the prefix of the log stream name within the log group that you specified\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The prefix of the log stream name within the log group that you specified \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogPrefix", "type": "string" } @@ -116704,7 +119874,7 @@ "additionalProperties": false, "properties": { "ExpressionString": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The expression string that is evaluated\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExpressionString", "type": "string" } @@ -116719,22 +119889,22 @@ "properties": { "Condition": { "$ref": "#/definitions/AWS::Lex::Bot.Condition", - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [Condition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-condition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains the expression to evaluate\\. If the condition is true, the branch's actions are taken\\. \n*Required*: Yes \n*Type*: [Condition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-condition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Condition" }, "Name": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the branch\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "NextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The next step in the conversation\\. \n*Required*: Yes \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NextStep" }, "Response": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Response" } }, @@ -116752,17 +119922,17 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalBranch" }, - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: List of [ConditionalBranch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalbranch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches\\. A conditional branch is made up of a condition, a response and a next step\\. The response and next step are executed when the condition is true\\. \n*Required*: Yes \n*Type*: List of [ConditionalBranch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalbranch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConditionalBranches", "type": "array" }, "DefaultBranch": { "$ref": "#/definitions/AWS::Lex::Bot.DefaultConditionalBranch", - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [DefaultConditionalBranch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-defaultconditionalbranch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The conditional branch that should be followed when the conditions for other branches are not satisfied\\. A conditional branch is made up of a condition, a response and a next step\\. \n*Required*: Yes \n*Type*: [DefaultConditionalBranch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-defaultconditionalbranch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DefaultBranch" }, "IsActive": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether a conditional branch is active\\. When `IsActive` is false, the conditions are not evaluated\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsActive", "type": "boolean" } @@ -116781,7 +119951,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.AudioLogSetting" }, - "markdownDescription": "Specifies the Amazon S3 settings for logging audio to an S3 bucket\\. \n*Required*: No \n*Type*: List of [AudioLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiologsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon S3 settings for logging audio to an S3 bucket\\. \n*Required*: No \n*Type*: List of [AudioLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiologsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AudioLogSettings", "type": "array" }, @@ -116789,7 +119959,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.TextLogSetting" }, - "markdownDescription": "Specifies settings to enable text conversation logs\\. You specify the Amazon CloudWatch Logs log group and whether logs should be stored for an alias\\. \n*Required*: No \n*Type*: List of [TextLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textlogsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon CloudWatch Logs settings for logging text and metadata\\. \n*Required*: No \n*Type*: List of [TextLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textlogsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextLogSettings", "type": "array" } @@ -116850,22 +120020,22 @@ "additionalProperties": false, "properties": { "DeletionCharacter": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The DTMF character that clears the accumulated DTMF digits and immediately ends the input\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeletionCharacter", "type": "string" }, "EndCharacter": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The DTMF character that immediately ends input\\. If the user does not press this character, the input ends after the end timeout\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EndCharacter", "type": "string" }, "EndTimeoutMs": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "How long the bot should wait after the last DTMF character input before assuming that the input has concluded\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EndTimeoutMs", "type": "number" }, "MaxLength": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum number of DTMF digits allowed in an utterance\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxLength", "type": "number" } @@ -116882,7 +120052,7 @@ "additionalProperties": false, "properties": { "ChildDirected": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act \\(COPPA\\) by specifying `true` or `false` in the `childDirected` field\\. By specifying `true` in the `childDirected` field, you confirm that your use of Amazon Lex **is** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA\\. By specifying `false` in the `childDirected` field, you confirm that your use of Amazon Lex **is not** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA\\. You may not specify a default value for the `childDirected` field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA\\. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA\\. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the [Amazon Lex FAQ](http://aws.amazon.com/lex/faqs#data-security)\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ChildDirected", "type": "boolean" } @@ -116897,12 +120067,12 @@ "properties": { "NextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The next step in the conversation\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NextStep" }, "Response": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Response" } }, @@ -116912,17 +120082,17 @@ "additionalProperties": false, "properties": { "SlotToElicit": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SlotToElicit", "type": "string" }, "SuppressNextMessage": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When true the next message for the intent is not used\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuppressNextMessage", "type": "boolean" }, "Type": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action that the bot should execute\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" } @@ -116936,23 +120106,23 @@ "additionalProperties": false, "properties": { "EnableCodeHookInvocation": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether a Lambda function should be invoked for the dialog\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableCodeHookInvocation", "type": "boolean" }, "InvocationLabel": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A label that indicates the dialog step from which the dialog code hook is happening\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InvocationLabel", "type": "string" }, "IsActive": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether a dialog code hook is used when the intent is activated\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsActive", "type": "boolean" }, "PostCodeHookSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.PostDialogCodeHookInvocationSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [PostDialogCodeHookInvocationSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains the responses and actions that Amazon Lex takes after the Lambda function is complete\\. \n*Required*: Yes \n*Type*: [PostDialogCodeHookInvocationSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PostCodeHookSpecification" } }, @@ -116967,7 +120137,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "Indicates whether an intent uses the dialog code hook during a conversation with a user\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Enables the dialog code hook so that it processes user requests\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -116982,19 +120152,19 @@ "properties": { "DialogAction": { "$ref": "#/definitions/AWS::Lex::Bot.DialogAction", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Defines the action that the bot executes at runtime when the conversation reaches this step\\. \n*Required*: No \n*Type*: [DialogAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DialogAction" }, "Intent": { "$ref": "#/definitions/AWS::Lex::Bot.IntentOverride", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [IntentOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Override settings to configure the intent state\\. \n*Required*: No \n*Type*: [IntentOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Intent" }, "SessionAttributes": { "items": { "$ref": "#/definitions/AWS::Lex::Bot.SessionAttribute" }, - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [SessionAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sessionattribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Map of key/value pairs representing session\\-specific context information\\. It contains application information passed between Amazon Lex and a client application\\. \n*Required*: No \n*Type*: List of [SessionAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sessionattribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SessionAttributes", "type": "array" } @@ -117005,12 +120175,12 @@ "additionalProperties": false, "properties": { "EnableCodeHookInvocation": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether a Lambda function should be invoked for the dialog\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableCodeHookInvocation", "type": "boolean" }, "InvocationLabel": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A label that indicates the dialog step from which the dialog code hook is happening\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InvocationLabel", "type": "string" } @@ -117035,7 +120205,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "Indicates whether a Lambda function should be invoked for fulfill a specific intent\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether a Lambda function should be invoked to fulfill a specific intent\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, @@ -117045,7 +120215,7 @@ "title": "FulfillmentUpdatesSpecification" }, "IsActive": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether the fulfillment code hook is used\\. When `active` is false, the code hook doesn't run\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsActive", "type": "boolean" }, @@ -117077,7 +120247,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.MessageGroup" }, - "markdownDescription": "One to 5 message groups that contain start messages\\. Amazon Lex chooses one of the messages to play to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "1 \\- 5 message groups that contain start messages\\. Amazon Lex chooses one of the messages to play to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageGroups", "type": "array" } @@ -117097,7 +120267,7 @@ "type": "boolean" }, "FrequencyInSeconds": { - "markdownDescription": "The frequency that a message is sent to the user\\. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user\\. If the fulfillment Lambda function returns before the first period ends, an update message is not played to the user\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The frequency that a message is sent to the user\\. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user\\. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FrequencyInSeconds", "type": "number" }, @@ -117105,7 +120275,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.MessageGroup" }, - "markdownDescription": "One to 5 message groups that contain update messages\\. Amazon Lex chooses one of the messages to play to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "1 \\- 5 message groups that contain update messages\\. Amazon Lex chooses one of the messages to play to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageGroups", "type": "array" } @@ -117120,7 +120290,7 @@ "additionalProperties": false, "properties": { "Active": { - "markdownDescription": "Determines whether fulfillment updates are sent to the user\\. When this field is true, updates are sent\\. \nIf the active field is set to true, the `startResponse`, `updateResponse`, and `timeoutInSeconds` fields are required\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether fulfillment updates are sent to the user\\. When this field is true, updates are sent\\. \nIf the `active` field is set to true, the `startResponse`, `updateResponse`, and `timeoutInSeconds` fields are required\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Active", "type": "boolean" }, @@ -117160,17 +120330,17 @@ "additionalProperties": false, "properties": { "KmsKeyArn": { - "markdownDescription": "The AWS Key Management Service key required to decrypt the contents of the grammar, if any\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS KMS key required to decrypt the contents of the grammar, if any\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KmsKeyArn", "type": "string" }, "S3BucketName": { - "markdownDescription": "The name of the S3 bucket that contains the grammar source\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the Amazon S3 bucket that contains the grammar source\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3BucketName", "type": "string" }, "S3ObjectKey": { - "markdownDescription": "The path to the grammar in the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The path to the grammar in the Amazon S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3ObjectKey", "type": "string" } @@ -117188,7 +120358,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.Button" }, - "markdownDescription": "A list of buttons that should be displayed on the response card\\. The arrangement of the buttons is determined by the platform that displays the buttons\\. \n*Required*: No \n*Type*: List of [Button](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-button.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of buttons that should be displayed on the response card\\. The arrangement of the buttons is determined by the platform that displays the button\\. \n*Required*: No \n*Type*: List of [Button](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-button.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Buttons", "type": "array" }, @@ -117218,22 +120388,22 @@ "properties": { "CodeHook": { "$ref": "#/definitions/AWS::Lex::Bot.DialogCodeHookInvocationSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CodeHook" }, "Conditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides a list of conditional branches\\. Branches are evaluated in the order that they are entered in the list\\. The first branch with a condition that evaluates to true is executed\\. The last branch in the list is the default branch\\. The default branch should not have any condition expression\\. The default branch is executed if no other branch has a matching condition\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Conditional" }, "InitialResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InitialResponse" }, "NextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The next step in the conversation\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NextStep" } }, @@ -117273,7 +120443,7 @@ }, "InitialResponseSetting": { "$ref": "#/definitions/AWS::Lex::Bot.InitialResponseSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [InitialResponseSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-initialresponsesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots\\. \n*Required*: No \n*Type*: [InitialResponseSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-initialresponsesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InitialResponseSetting" }, "InputContexts": { @@ -117296,7 +120466,7 @@ }, "KendraConfiguration": { "$ref": "#/definitions/AWS::Lex::Bot.KendraConfiguration", - "markdownDescription": "Configuration information required to use the AMAZON\\.KendraSearchIntent intent to connect to an Amazon Kendra index\\. The AMAZON\\.KendraSearchIntent intent is called when Amazon Lex can't determine another intent to invoke\\. \n*Required*: No \n*Type*: [KendraConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides configuration information for the `AMAZON.KendraSearchIntent` intent\\. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance\\. \n*Required*: No \n*Type*: [KendraConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KendraConfiguration" }, "Name": { @@ -117357,17 +120527,17 @@ }, "Conditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches associated with the intent's closing response\\. These branches are executed when the `nextStep` attribute is set to `EvalutateConditional`\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Conditional" }, "IsActive": { - "markdownDescription": "Specifies whether an intent's closing response is used\\. When this field is false, the closing response isn't sent to the user and no closing input from the user is used\\. If the IsActive field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether an intent's closing response is used\\. When this field is false, the closing response isn't sent to the user\\. If the `IsActive` field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsActive", "type": "boolean" }, "NextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot executes after playing the intent's closing response\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NextStep" } }, @@ -117378,67 +120548,67 @@ "properties": { "CodeHook": { "$ref": "#/definitions/AWS::Lex::Bot.DialogCodeHookInvocationSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The `DialogCodeHookInvocationSetting` object associated with intent's confirmation step\\. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is `InvokeDialogCodeHook`\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CodeHook" }, "ConfirmationConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the intent is closed\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConfirmationConditional" }, "ConfirmationNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot executes when the customer confirms the intent\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConfirmationNextStep" }, "ConfirmationResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConfirmationResponse" }, "DeclinationConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the intent is declined\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeclinationConditional" }, "DeclinationNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot executes when the customer declines the intent\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeclinationNextStep" }, "DeclinationResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "When the user answers \"no\" to the question defined in PromptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When the user answers \"no\" to the question defined in `promptSpecification`, Amazon Lex responds with this response to acknowledge that the intent was canceled\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeclinationResponse" }, "ElicitationCodeHook": { "$ref": "#/definitions/AWS::Lex::Bot.ElicitationCodeHookInvocationSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ElicitationCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The `DialogCodeHookInvocationSetting` used when the code hook is invoked during confirmation prompt retries\\. \n*Required*: No \n*Type*: [ElicitationCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ElicitationCodeHook" }, "FailureConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides a list of conditional branches\\. Branches are evaluated in the order that they are entered in the list\\. The first branch with a condition that evaluates to true is executed\\. The last branch in the list is the default branch\\. The default branch should not have any condition expression\\. The default branch is executed if no other branch has a matching condition\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureConditional" }, "FailureNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The next step to take in the conversation if the confirmation step fails\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureNextStep" }, "FailureResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input when the intent confirmation fails\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureResponse" }, "IsActive": { - "markdownDescription": "Specifies whether the intent's confirmation is sent to the user\\. When this field is false, confirmation and declination responses aren't sent and processing continues as if the responses aren't present\\. If the active field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the intent's confirmation is sent to the user\\. When this field is false, confirmation and declination responses aren't sent\\. If the `IsActive` field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsActive", "type": "boolean" }, "PromptSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.PromptSpecification", - "markdownDescription": "Prompts the user to confirm the intent\\. This question should have a yes or no answer\\. \n*Required*: Yes \n*Type*: [PromptSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Prompts the user to confirm the intent\\. This question should have a yes or no answer\\. \nAmazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment\\. For example, with the `OrderPizza` intent, you might want to confirm that the order is correct before placing it\\. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information\\. \n*Required*: Yes \n*Type*: [PromptSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PromptSpecification" } }, @@ -117451,7 +120621,7 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the intent\\. Only required when you're switching intents\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -117459,7 +120629,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.SlotValueOverrideMap" }, - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [SlotValueOverrideMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverridemap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A map of all of the slot value overrides for the intent\\. The name of the slot maps to the value of the slot\\. Slots that are not included in the map aren't overridden\\. \n*Required*: No \n*Type*: List of [SlotValueOverrideMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverridemap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Slots", "type": "array" } @@ -117470,17 +120640,17 @@ "additionalProperties": false, "properties": { "KendraIndex": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon Kendra index that you want the AMAZON\\.KendraSearchIntent intent to search\\. The index must be in the same account and Region as the Amazon Lex bot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon Kendra index that you want the `AMAZON.KendraSearchIntent` intent to search\\. The index must be in the same account and Region as the Amazon Lex bot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KendraIndex", "type": "string" }, "QueryFilterString": { - "markdownDescription": "A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query\\. The filter is in the format defined by Amazon Kendra\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query\\. The filter is in the format defined by Amazon Kendra\\. For more information, see [Filtering queries](https://docs.aws.amazon.com/kendra/latest/dg/filtering.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "QueryFilterString", "type": "string" }, "QueryFilterStringEnabled": { - "markdownDescription": "Determines whether the AMAZON\\.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether the `AMAZON.KendraSearchIntent` intent uses a custom query string to query the Amazon Kendra index\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "QueryFilterStringEnabled", "type": "boolean" } @@ -117494,12 +120664,12 @@ "additionalProperties": false, "properties": { "CodeHookInterfaceVersion": { - "markdownDescription": "Specifies the version of the request\\-response that you want Amazon Lex to use to invoke your Lambda function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the request\\-response that you want Amazon Lex to use to invoke your Lambda function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CodeHookInterfaceVersion", "type": "string" }, "LambdaArn": { - "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of the Lambda function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Lambda function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LambdaArn", "type": "string" } @@ -117530,7 +120700,7 @@ }, "SSMLMessage": { "$ref": "#/definitions/AWS::Lex::Bot.SSMLMessage", - "markdownDescription": "A message in Speech Synthesis Markup Language \\(SSML\\) format\\. \n*Required*: No \n*Type*: [SSMLMessage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-ssmlmessage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A message in Speech Synthesis Markup Language \\(SSML\\)\\. \n*Required*: No \n*Type*: [SSMLMessage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-ssmlmessage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SSMLMessage" } }, @@ -117562,7 +120732,7 @@ "additionalProperties": false, "properties": { "AllowMultipleValues": { - "markdownDescription": "Indicates whether a slot can return multiple values\\. When true, the slot may return more than one value in a response\\. When false, the slot returns only a single value\\. If AllowMultipleValues is not set, the default value is false\\. \nMulti\\-value slots are only available in the en\\-US locale\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether a slot can return multiple values\\. When `true`, the slot may return more than one value in a response\\. When `false`, the slot returns only a single value\\. \nMulti\\-value slots are only available in the en\\-US locale\\. If you set this value to `true` in any other locale, Amazon Lex throws a `ValidationException`\\. \nIf the `allowMutlipleValues` is not set, the default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowMultipleValues", "type": "boolean" } @@ -117573,7 +120743,7 @@ "additionalProperties": false, "properties": { "ObfuscationSettingType": { - "markdownDescription": "Value that determines whether Amazon Lex obscures slot values in conversation logs\\. The default is to obscure the values\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Value that determines whether Amazon Lex obscures slot values in conversation logs\\. The default is to obscure the values\\. The valid values are `None` and `DefaultObfuscation.` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ObfuscationSettingType", "type": "string" } @@ -117628,47 +120798,47 @@ "properties": { "FailureConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureConditional" }, "FailureNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureNextStep" }, "FailureResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input when the code hook fails\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureResponse" }, "SuccessConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the dialog code hook finishes successfully\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuccessConditional" }, "SuccessNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifics the next step the bot runs after the dialog code hook finishes successfully\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuccessNextStep" }, "SuccessResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond when the code hook succeeds\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuccessResponse" }, "TimeoutConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate if the code hook times out\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutConditional" }, "TimeoutNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot runs when the code hook times out\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutNextStep" }, "TimeoutResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond to the user input when the code hook times out\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutResponse" } }, @@ -117679,12 +120849,12 @@ "properties": { "FailureConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureConditional" }, "FailureNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureNextStep" }, "FailureResponse": { @@ -117694,12 +120864,12 @@ }, "SuccessConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the fulfillment code hook finishes successfully\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuccessConditional" }, "SuccessNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuccessNextStep" }, "SuccessResponse": { @@ -117709,12 +120879,12 @@ }, "TimeoutConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate if the fulfillment code hook times out\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutConditional" }, "TimeoutNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot runs when the fulfillment code hook times out\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutNextStep" }, "TimeoutResponse": { @@ -117729,23 +120899,23 @@ "additionalProperties": false, "properties": { "AllowInterrupt": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether the user can interrupt a speech prompt attempt from the bot\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowInterrupt", "type": "boolean" }, "AllowedInputTypes": { "$ref": "#/definitions/AWS::Lex::Bot.AllowedInputTypes", - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [AllowedInputTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-allowedinputtypes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates the allowed input types of the prompt attempt\\. \n*Required*: Yes \n*Type*: [AllowedInputTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-allowedinputtypes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowedInputTypes" }, "AudioAndDTMFInputSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.AudioAndDTMFInputSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AudioAndDTMFInputSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audioanddtmfinputspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the settings on audio and DTMF input\\. \n*Required*: No \n*Type*: [AudioAndDTMFInputSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audioanddtmfinputspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AudioAndDTMFInputSpecification" }, "TextInputSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.TextInputSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [TextInputSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textinputspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the settings on text input\\. \n*Required*: No \n*Type*: [TextInputSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textinputspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextInputSpecification" } }, @@ -117763,7 +120933,7 @@ "type": "boolean" }, "MaxRetries": { - "markdownDescription": "The maximum number of times the bot tries to elicit a response from the user using this prompt \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum number of times the bot tries to elicit a response from the user using this prompt\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxRetries", "type": "number" }, @@ -117771,18 +120941,18 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.MessageGroup" }, - "markdownDescription": "A collection of responses that Amazon Lex can send to the user\\. Amazon Lex chooses the actual response to send at runtime\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A collection of messages that Amazon Lex can send to the user\\. Amazon Lex chooses the actual message to send at runtime\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageGroupsList", "type": "array" }, "MessageSelectionStrategy": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates how a message is selected from a message group among retries\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageSelectionStrategy", "type": "string" }, "PromptAttemptsSpecification": { "additionalProperties": false, - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Map of [PromptAttemptSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptattemptspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the advanced settings on each attempt of the prompt\\. \n*Required*: No \n*Type*: Map of [PromptAttemptSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptattemptspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::Lex::Bot.PromptAttemptSpecification" @@ -117824,17 +120994,17 @@ "additionalProperties": false, "properties": { "KmsKeyArn": { - "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of an AWS Key Management Service key for encrypting audio log files stored in an Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Key Management Service \\(KMS\\) key for encrypting audio log files stored in an Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KmsKeyArn", "type": "string" }, "LogPrefix": { - "markdownDescription": "Specifies the Amazon S3 prefix to assign to audio log files\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The S3 prefix to assign to audio log files\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogPrefix", "type": "string" }, "S3BucketArn": { - "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of the Amazon S3 bucket where audio files are stored\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an Amazon S3 bucket where audio log files are stored\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3BucketArn", "type": "string" } @@ -117888,7 +121058,7 @@ "additionalProperties": false, "properties": { "Utterance": { - "markdownDescription": "The sample utterance that Amazon Lex uses to build its machine\\-learning model to recognize intents\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A sample utterance that invokes an intent or respond to a slot elicitation prompt\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Utterance", "type": "string" } @@ -117916,7 +121086,7 @@ "additionalProperties": false, "properties": { "DetectSentiment": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DetectSentiment", "type": "boolean" } @@ -117930,12 +121100,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the session attribute\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Value": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The session\\-specific context information for the session attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -117949,17 +121119,17 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "A description of the slot type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the slot\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "MultipleValuesSetting": { "$ref": "#/definitions/AWS::Lex::Bot.MultipleValuesSetting", - "markdownDescription": "Determines whether the slot can return multiple values to the application\\. \n*Required*: No \n*Type*: [MultipleValuesSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-multiplevaluessetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether a slot can return multiple values\\. \n*Required*: No \n*Type*: [MultipleValuesSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-multiplevaluessetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MultipleValuesSetting" }, "Name": { - "markdownDescription": "The name of the slot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name given to the slot\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^([0-9a-zA-Z][_-]?)+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -117975,7 +121145,7 @@ }, "ValueElicitationSetting": { "$ref": "#/definitions/AWS::Lex::Bot.SlotValueElicitationSetting", - "markdownDescription": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ OriginalValue \\- Returns the value entered by the user, if the user value is similar to a slot value\\.\n+ TopResolution \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the valueSelectionStrategy, the default is OriginalValue\\. \n*Required*: Yes \n*Type*: [SlotValueElicitationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueelicitationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ ORIGINAL\\_VALUE \\- Returns the value entered by the user, if the user value is similar to a slot value\\.\n+ TOP\\_RESOLUTION \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`\\. \n*Required*: Yes \n*Type*: [SlotValueElicitationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueelicitationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ValueElicitationSetting" } }, @@ -117991,42 +121161,42 @@ "properties": { "CaptureConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the slot value is captured\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CaptureConditional" }, "CaptureNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot runs when the slot value is captured before the code hook times out\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CaptureNextStep" }, "CaptureResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CaptureResponse" }, "CodeHook": { "$ref": "#/definitions/AWS::Lex::Bot.DialogCodeHookInvocationSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Code hook called after Amazon Lex successfully captures a slot value\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CodeHook" }, "ElicitationCodeHook": { "$ref": "#/definitions/AWS::Lex::Bot.ElicitationCodeHookInvocationSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ElicitationCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Code hook called when Amazon Lex doesn't capture a slot value\\. \n*Required*: No \n*Type*: [ElicitationCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ElicitationCodeHook" }, "FailureConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate when the slot value isn't captured\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureConditional" }, "FailureNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot runs when the slot value code is not recognized\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureNextStep" }, "FailureResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input when the slot fails to be captured\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureResponse" } }, @@ -118102,7 +121272,7 @@ "type": "string" }, "ParentSlotTypeSignature": { - "markdownDescription": "The built\\-in slot type used as a parent of this slot type\\. When you define a parent slot type, the new slot type has the configuration of the parent lot type\\. \nOnly AMAZON\\.AlphaNumeric is supported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The built\\-in slot type used as a parent of this slot type\\. When you define a parent slot type, the new slot type has the configuration of the parent lot type\\. \nOnly `AMAZON.AlphaNumeric` is supported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ParentSlotTypeSignature", "type": "string" }, @@ -118116,7 +121286,7 @@ }, "ValueSelectionSetting": { "$ref": "#/definitions/AWS::Lex::Bot.SlotValueSelectionSetting", - "markdownDescription": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ OriginalValue \\- Returns the value entered by the user, if the user value is similar to a slot value\\.\n+ TopResolution \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the valueSelectionStrategy, the default is OriginalValue\\. \n*Required*: No \n*Type*: [SlotValueSelectionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueselectionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ `ORIGINAL_VALUE` \\- Returns the value entered by the user, if the user value is similar to the slot value\\.\n+ `TOP_RESOLUTION` \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`\\. \n*Required*: No \n*Type*: [SlotValueSelectionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueselectionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ValueSelectionSetting" } }, @@ -118151,7 +121321,7 @@ "additionalProperties": false, "properties": { "InterpretedValue": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value that Amazon Lex determines for the slot\\. The actual value depends on the setting of the value selection strategy for the bot\\. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the `resolvedValues` list\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InterpretedValue", "type": "string" } @@ -118175,13 +121345,13 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.SampleUtterance" }, - "markdownDescription": "If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy\\. This is optional\\. In most cases Amazon Lex is capable of understanding user utterances\\. \n*Required*: No \n*Type*: List of [SampleUtterance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sampleutterance.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy\\. This is optional\\. In most cases, Amazon Lex is capable of understanding user utterances\\. \n*Required*: No \n*Type*: List of [SampleUtterance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sampleutterance.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SampleUtterances", "type": "array" }, "SlotCaptureSetting": { "$ref": "#/definitions/AWS::Lex::Bot.SlotCaptureSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [SlotCaptureSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user\\. \n*Required*: No \n*Type*: [SlotCaptureSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SlotCaptureSetting" }, "SlotConstraint": { @@ -118191,7 +121361,7 @@ }, "WaitAndContinueSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.WaitAndContinueSpecification", - "markdownDescription": "Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input\\. \n*Required*: No \n*Type*: [WaitAndContinueSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-waitandcontinuespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input\\. \n*Required*: No \n*Type*: [WaitAndContinueSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-waitandcontinuespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WaitAndContinueSpecification" } }, @@ -118204,20 +121374,20 @@ "additionalProperties": false, "properties": { "Shape": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When the shape value is `List`, it indicates that the `values` field contains a list of slot values\\. When the value is `Scalar`, it indicates that the `value` field contains a single value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Shape", "type": "string" }, "Value": { "$ref": "#/definitions/AWS::Lex::Bot.SlotValue", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [SlotValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The current value of the slot\\. \n*Required*: No \n*Type*: [SlotValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value" }, "Values": { "items": { "$ref": "#/definitions/AWS::Lex::Bot.SlotValueOverride" }, - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [SlotValueOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-lex-bot-slotvalueoverride.html#aws-properties-lex-bot-slotvalueoverride) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of one or more values that the user provided for the slot\\. For example, for a slot that elicits pizza toppings, the values might be \"pepperoni\" and \"pineapple\\.\" \n*Required*: No \n*Type*: List of [SlotValueOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-lex-bot-slotvalueoverride.html#aws-properties-lex-bot-slotvalueoverride) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -118228,13 +121398,13 @@ "additionalProperties": false, "properties": { "SlotName": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the slot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SlotName", "type": "string" }, "SlotValueOverride": { "$ref": "#/definitions/AWS::Lex::Bot.SlotValueOverride", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [SlotValueOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The SlotValueOverride object to which the slot name will be mapped\\. \n*Required*: No \n*Type*: [SlotValueOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SlotValueOverride" } }, @@ -118244,7 +121414,7 @@ "additionalProperties": false, "properties": { "Pattern": { - "markdownDescription": "A regular expression used to validate the value of a slot\\. \nUse a standard regular expression\\. Amazon Lex supports the following characters in the regular expression: \n+ A\\-Z, a\\-z\n+ 0\\-9\n+ Unicode characters \\(\"\\\\u\"\\)\nRepresent Unicode characters with four digits, for example \"\\]u0041\" or \"\\\\u005A\"\\. \nThe following regular expression operators are not supported: \n+ Infinite repeaters: \\*, \\+, or \\{x,\\} with no upper bound\n+ Wild card \\(\\.\\)\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A regular expression used to validate the value of a slot\\. \n Use a standard regular expression\\. Amazon Lex supports the following characters in the regular expression: \n+ A\\-Z, a\\-z\n+ 0\\-9\n+ Unicode characters \\(\"\\\\u\"\\)\n Represent Unicode characters with four digits, for example \"\\\\u0041\" or \"\\\\u005A\"\\. \n The following regular expression operators are not supported: \n+ Infinite repeaters: \\*, \\+, or \\{x,\\} with no upper bound\\.\n+ Wild card \\(\\.\\)\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Pattern", "type": "string" } @@ -118259,7 +121429,7 @@ "properties": { "AdvancedRecognitionSetting": { "$ref": "#/definitions/AWS::Lex::Bot.AdvancedRecognitionSetting", - "markdownDescription": "Specifies settings that enable advanced recognition settings for slot values\\. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances\\. \n*Required*: No \n*Type*: [AdvancedRecognitionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-advancedrecognitionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides settings that enable advanced recognition settings for slot values\\. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances\\. \n*Required*: No \n*Type*: [AdvancedRecognitionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-advancedrecognitionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdvancedRecognitionSetting" }, "RegexFilter": { @@ -118268,7 +121438,7 @@ "title": "RegexFilter" }, "ResolutionStrategy": { - "markdownDescription": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ ORIGINAL_VALUE \\- Returns the value entered by the user, if the user value is similar to a slot value\\.\n+ TOP_RESOLUTION \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the valueSelectionStrategy, the default is OriginalValue\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ `ORIGINAL_VALUE` \\- Returns the value entered by the user, if the user value is similar to the slot value\\.\n+ `TOP_RESOLUTION` \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResolutionStrategy", "type": "string" } @@ -118295,7 +121465,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.MessageGroup" }, - "markdownDescription": "A collection of responses that Amazon Lex can send to the user\\. Amazon Lex chooses the actual response to send at runtime\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageGroupsList", "type": "array" }, @@ -118345,7 +121515,7 @@ "additionalProperties": false, "properties": { "StartTimeoutMs": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Time for which a bot waits before re\\-prompting a customer for text input\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartTimeoutMs", "type": "number" } @@ -118360,7 +121530,7 @@ "properties": { "CloudWatch": { "$ref": "#/definitions/AWS::Lex::Bot.CloudWatchLogGroupLogDestination", - "markdownDescription": "Specifies the Amazon CloudWatch Logs log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: [CloudWatchLogGroupLogDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-cloudwatchloggrouplogdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: [CloudWatchLogGroupLogDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-cloudwatchloggrouplogdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatch" } }, @@ -118378,7 +121548,7 @@ "title": "Destination" }, "Enabled": { - "markdownDescription": "Specifies whether conversation logs should be stored for an alias\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether conversation logs should be stored for an alias\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -118393,12 +121563,12 @@ "additionalProperties": false, "properties": { "Engine": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user\\. For more information, see the [`engine` parameter of the `SynthesizeSpeech` operation](https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine) in the *Amazon Polly developer guide*\\. \nIf you do not specify a value, the default is `standard`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Engine", "type": "string" }, "VoiceId": { - "markdownDescription": "The Amazon Polly voice used for voice interaction with the user\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of the Amazon Polly voice to use\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VoiceId", "type": "string" } @@ -118417,7 +121587,7 @@ "title": "ContinueResponse" }, "IsActive": { - "markdownDescription": "Specifies whether the bot will wait for a user to respond\\. When this field is false, wait and continue responses for a slot aren't used and the bot expects an appropriate response within the configured timeout\\. If the IsActive field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the bot will wait for a user to respond\\. When this field is false, wait and continue responses for a slot aren't used\\. If the `IsActive` field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsActive", "type": "boolean" }, @@ -118477,7 +121647,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::BotAlias.BotAliasLocaleSettingsItem" }, - "markdownDescription": "Maps configuration information to a specific locale\\. You can use this parameter to specify a specific Lambda function to run different functions in different locales\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettings.html) of [BotAliasLocaleSettingsItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettingsitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettings.html) of [BotAliasLocaleSettingsItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettingsitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BotAliasLocaleSettings", "type": "array" }, @@ -118590,7 +121760,7 @@ "title": "CodeHookSpecification" }, "Enabled": { - "markdownDescription": "Determines whether the locale is enabled for the bot\\. If the value is false, the locale isn't available for use\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether the locale is enabled for the bot\\. If the value is `false`, the locale isn't available for use\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -118629,7 +121799,7 @@ "type": "string" }, "LogPrefix": { - "markdownDescription": "The prefix of the log stream name within the log group that you specified\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The prefix of the log stream name within the log group that you specified \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogPrefix", "type": "string" } @@ -118700,7 +121870,7 @@ "additionalProperties": false, "properties": { "KmsKeyArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Key Management Service key for encrypting audio log files stored in an S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Key Management Service \\(KMS\\) key for encrypting audio log files stored in an Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KmsKeyArn", "type": "string" }, @@ -118725,7 +121895,7 @@ "additionalProperties": false, "properties": { "DetectSentiment": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DetectSentiment", "type": "boolean" } @@ -119019,7 +122189,7 @@ "items": { "type": "string" }, - "markdownDescription": "The grant principals\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The grant principals\\. You can specify one of the following as an Amazon Resource Name \\(ARN\\): \n+ An AWS account, which includes only the account specified\\.\n+ An organizational unit \\(OU\\), which includes all accounts in the OU\\.\n+ An organization, which will include all accounts across your organization\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Principals", "type": "array" }, @@ -120272,9 +123442,13 @@ "additionalProperties": false, "properties": { "AvailabilityZone": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AvailabilityZone", "type": "string" }, "RegionName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RegionName", "type": "string" } }, @@ -120626,7 +123800,9 @@ "type": "string" }, "Location": { - "$ref": "#/definitions/AWS::Lightsail::Instance.Location" + "$ref": "#/definitions/AWS::Lightsail::Instance.Location", + "markdownDescription": "The location for the instance, such as the AWS Region and Availability Zone\\. \nThe `Location` property is read\\-only and should not be specified in a create instance or update instance request\\.\n*Required*: No \n*Type*: [Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-location.html) \n*Update requires*: Updates are not supported\\.", + "title": "Location" }, "Networking": { "$ref": "#/definitions/AWS::Lightsail::Instance.Networking", @@ -120634,7 +123810,9 @@ "title": "Networking" }, "State": { - "$ref": "#/definitions/AWS::Lightsail::Instance.State" + "$ref": "#/definitions/AWS::Lightsail::Instance.State", + "markdownDescription": "The status code and the state \\(for example, `running`\\) of the instance\\. \nThe `State` property is read\\-only and should not be specified in a create instance or update instance request\\.\n*Required*: No \n*Type*: [State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-state.html) \n*Update requires*: Updates are not supported\\.", + "title": "State" }, "Tags": { "items": { @@ -120994,6 +124172,8 @@ "type": "array" }, "TlsPolicyName": { + "markdownDescription": "The name of the TLS security policy for the load balancer\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\w[\\w\\-]*\\w` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TlsPolicyName", "type": "string" } }, @@ -121078,6 +124258,8 @@ "type": "string" }, "HttpsRedirectionEnabled": { + "markdownDescription": "A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HttpsRedirectionEnabled", "type": "boolean" }, "IsAttached": { @@ -121227,7 +124409,7 @@ "additionalProperties": false, "properties": { "CollectionName": { - "markdownDescription": "The name for the geofence collection\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A custom name for the geofence collection\\. \nRequirements: \n+ Contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\. \n+ Must be a unique geofence collection name\\.\n+ No spaces allowed\\. For example, `ExampleGeofenceCollection`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CollectionName", "type": "string" }, @@ -121237,7 +124419,7 @@ "type": "string" }, "KmsKeyId": { - "markdownDescription": "A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html)\\. Enter a key ID, key ARN, alias name, or alias ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html)\\. Enter a key ID, key ARN, alias name, or alias ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" } @@ -121305,7 +124487,7 @@ "properties": { "Configuration": { "$ref": "#/definitions/AWS::Location::Map.MapConfiguration", - "markdownDescription": "Specifies the map style selected from an available data provider\\. \n*Required*: Yes \n*Type*: [MapConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-map-mapconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the `MapConfiguration`, including the map style, for the map resource that you create\\. The map style defines the look of maps and the data provider for your map resource\\. \n*Required*: Yes \n*Type*: [MapConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-map-mapconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Configuration" }, "Description": { @@ -121314,7 +124496,7 @@ "type": "string" }, "MapName": { - "markdownDescription": "The name for the map resource\\. \nRequirements: \n+ Must contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique map resource name\\.\n+ No spaces allowed\\. For example, `ExampleMap`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name for the map resource\\. \nRequirements: \n+ Must contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\. \n+ Must be a unique map resource name\\. \n+ No spaces allowed\\. For example, `ExampleMap`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MapName", "type": "string" }, @@ -121355,7 +124537,7 @@ "additionalProperties": false, "properties": { "Style": { - "markdownDescription": "Specifies the map style selected from an available data provider\\. \nValid styles: `VectorEsriStreets`, `VectorEsriTopographic`, `VectorEsriNavigation`, `VectorEsriDarkGrayCanvas`, `VectorEsriLightGrayCanvas`, `VectorHereBerlin`\\. \nWhen using HERE as your data provider, and selecting the Style `VectorHereBerlin`, you may not use HERE Technologies maps for Asset Management\\. See the [AWS Service Terms](http://aws.amazon.com/service-terms/) for Amazon Location Service\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the map style selected from an available data provider\\. \nValid [Esri map styles](https://docs.aws.amazon.com/location/latest/developerguide/esri.html): \n+ `VectorEsriDarkGrayCanvas` \u2013 The Esri Dark Gray Canvas map style\\. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content\\. \n+ `RasterEsriImagery` \u2013 The Esri Imagery map style\\. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide\\. \n+ `VectorEsriLightGrayCanvas` \u2013 The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content\\. \n+ `VectorEsriTopographic` \u2013 The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style\\.\n+ `VectorEsriStreets` \u2013 The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style\\. The vector tile layer is similar in content and style to the World Street Map raster map\\.\n+ `VectorEsriNavigation` \u2013 The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices\\.\nValid [HERE Technologies map styles](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html): \n+ `VectorHereContrast` \u2013 The HERE Contrast \\(Berlin\\) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering\\.\n**Note** \nThe `VectorHereContrast` style has been renamed from `VectorHereBerlin`\\. `VectorHereBerlin` has been deprecated, but will continue to work in applications that use it\\.\n+ `VectorHereExplore` \u2013 A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features\\. It also now includes a fully designed map of Japan\\.\n+ `VectorHereExploreTruck` \u2013 A global map containing truck restrictions and attributes \\(e\\.g\\. width / height / HAZMAT\\) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics\\.\n+ `RasterHereExploreSatellite` \u2013 A global map containing high resolution satellite imagery\\.\n+ `HybridHereExploreSatellite` \u2013 A global map displaying the road network, street names, and city labels over satellite imagery\\. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved\\.\n**Note** \nHybrid styles use both vector and raster tiles when rendering the map that you see\\. This means that more tiles are retrieved than when using either vector or raster tiles alone\\. Your charges will include all tiles retrieved\\.\nValid [GrabMaps map styles](https://docs.aws.amazon.com/location/latest/developerguide/grab.html): \n+ `VectorGrabStandardLight` \u2013 The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia\\.\n+ `VectorGrabStandardDark` \u2013 The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia\\.\nGrab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific \\(Singapore\\) Region \\(`ap-southeast-1`\\)\\. For more information, see [GrabMaps countries and area covered](https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area)\\.\nValid [Open Data \\(Preview\\) map styles](https://docs.aws.amazon.com/location/latest/developerguide/open-data.html): \n+ `VectorOpenDataStandardLight` \u2013 The Open Data Standard Light \\(preview\\) map style provides a detailed basemap for the world suitable for website and mobile application use\\. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries\\.\n**Important** \nOpen Data maps is in preview\\. We may add, change, or remove features before announcing general availability\\. For more information, see [Open Data is in preview release](https://docs.aws.amazon.com/location/latest/developerguide/open-data.html#open-data-preview)\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Style", "type": "string" } @@ -121401,13 +124583,13 @@ "additionalProperties": false, "properties": { "DataSource": { - "markdownDescription": "Specifies the data provider of geospatial data\\. \nThis field is case\\-sensitive\\. Enter the valid values as shown\\. For example, entering `HERE` will return an error\\.\nValid values include: \n+ `Esri`\n+ `Here`\n**Important** \nPlace index resources using HERE as a data provider can't be used to [store](https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html) results for locations in Japan\\. For more information, see the [AWS Service Terms](http://aws.amazon.com/service-terms/) for Amazon Location Service\\.\nFor additional details on data providers, see the [Amazon Location Service data providers page](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the geospatial data provider for the new place index\\. \nThis field is case\\-sensitive\\. Enter the valid values as shown\\. For example, entering `HERE` returns an error\\.\nValid values include: \n+ `Esri` \u2013 For additional information about [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s coverage in your region of interest, see [Esri details on geocoding coverage](https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm)\\.\n+ `Grab` \u2013 Grab provides place index functionality for Southeast Asia\\. For additional information about [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/grab.html)' coverage, see [GrabMaps countries and areas covered](https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area)\\.\n+ `Here` \u2013 For additional information about [HERE Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)' coverage in your region of interest, see [HERE details on goecoding coverage](https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html)\\.\n**Important** \nIf you specify HERE Technologies \\(`Here`\\) as the data provider, you may not [store results](https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html) for locations in Japan\\. For more information, see the [AWS Service Terms](http://aws.amazon.com/service-terms/) for Amazon Location Service\\.\nFor additional information , see [Data providers](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) on the *Amazon Location Service Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DataSource", "type": "string" }, "DataSourceConfiguration": { "$ref": "#/definitions/AWS::Location::PlaceIndex.DataSourceConfiguration", - "markdownDescription": "Specifies the data storage option for requesting Places\\. \n*Required*: No \n*Type*: [DataSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-placeindex-datasourceconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the data storage option requesting Places\\. \n*Required*: No \n*Type*: [DataSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-placeindex-datasourceconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DataSourceConfiguration" }, "Description": { @@ -121416,7 +124598,7 @@ "type": "string" }, "IndexName": { - "markdownDescription": "The name of the place index resource\\. \nRequirements: \n+ Contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique place index resource name\\.\n+ No spaces allowed\\. For example, `ExamplePlaceIndex`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the place index resource\\. \nRequirements: \n+ Contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique place index resource name\\.\n+ No spaces allowed\\. For example, `ExamplePlaceIndex`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IndexName", "type": "string" }, @@ -121457,7 +124639,7 @@ "additionalProperties": false, "properties": { "IntendedUse": { - "markdownDescription": "Specifies how the results of an operation will be stored by the caller\\. \nValid values include: \n+ `SingleUse` specifies that the results won't be stored\\.\n+ `Storage` specifies that the result can be cached or stored in a database\\.\n**Important** \nPlace index resources using HERE as a data provider can't be configured to store results for locations in Japan when choosing `Storage` for the `IntendedUse` parameter\\.\nDefault value: `SingleUse` \n*Required*: No \n*Type*: String \n*Allowed values*: `SingleUse | Storage` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies how the results of an operation will be stored by the caller\\. \nValid values include: \n+ `SingleUse` specifies that the results won't be stored\\. \n+ `Storage` specifies that the result can be cached or stored in a database\\.\nDefault value: `SingleUse` \n*Required*: No \n*Type*: String \n*Allowed values*: `SingleUse | Storage` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IntendedUse", "type": "string" } @@ -121500,12 +124682,12 @@ "additionalProperties": false, "properties": { "CalculatorName": { - "markdownDescription": "The name of the route calculator resource\\. \nRequirements: \n+ Can use alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\) , hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique route calculator resource name\\.\n+ No spaces allowed\\. For example, `ExampleRouteCalculator`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the route calculator resource\\. \nRequirements: \n+ Can use alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\) , hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique Route calculator resource name\\.\n+ No spaces allowed\\. For example, `ExampleRouteCalculator`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CalculatorName", "type": "string" }, "DataSource": { - "markdownDescription": "Specifies the data provider of traffic and road network data\\. \nThis field is case\\-sensitive\\. Enter the valid values as shown\\. For example, entering `HERE` returns an error\\.\nValid values include: \n+ `Esri`\n+ `Here`\nFor more information about data providers, see the [Amazon Location Service data providers page](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the data provider of traffic and road network data\\. \nThis field is case\\-sensitive\\. Enter the valid values as shown\\. For example, entering `HERE` returns an error\\.\nValid values include: \n+ `Esri` \u2013 For additional information about [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s coverage in your region of interest, see [Esri details on street networks and traffic coverage](https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm)\\.", "title": "DataSource", "type": "string" }, @@ -121603,7 +124785,7 @@ "type": "string" }, "PricingPlanDataSource": { - "markdownDescription": "This parameter is no longer used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "This parameter is no longer used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PricingPlanDataSource", "type": "string" }, @@ -121675,7 +124857,7 @@ "additionalProperties": false, "properties": { "ConsumerArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the geofence collection that consumes the tracker resource updates\\. \n+ Format example: `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`\n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1600` \n*Pattern*: `^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the geofence collection to be associated to tracker resource\\. Used when you need to specify a resource across all AWS\\. \n+ Format example: `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`\n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1600` \n*Pattern*: `^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ConsumerArn", "type": "string" }, @@ -121753,7 +124935,7 @@ "type": "string" }, "DestinationPolicy": { - "markdownDescription": "An IAM policy document that governs which AWS accounts can create subscription filters against this destination\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An IAM policy document that governs which AWS accounts can create subscription filters against this destination\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DestinationPolicy", "type": "string" }, @@ -121832,6 +125014,8 @@ "additionalProperties": false, "properties": { "DataProtectionPolicy": { + "markdownDescription": "Creates a data protection policy and assigns it to the log group\\. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data\\. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks\\. \nFor more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataProtectionPolicy", "type": "object" }, "KmsKeyId": { @@ -121845,7 +125029,7 @@ "type": "string" }, "RetentionInDays": { - "markdownDescription": "The number of days to retain the log events in the specified log group\\. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653\\. \nTo set a log group to never have log events expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of days to retain the log events in the specified log group\\. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653\\. \nTo set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RetentionInDays", "type": "number" }, @@ -121988,6 +125172,8 @@ "additionalProperties": false, "properties": { "FilterName": { + "markdownDescription": "The name of the metric filter\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[^:*]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FilterName", "type": "string" }, "FilterPattern": { @@ -122041,9 +125227,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The name for the CloudWatch metric dimension that the metric filter creates\\. \nDimension names must contain only ASCII characters, must include at least one non\\-whitespace character, and cannot start with a colon \\(:\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "The log event field that will contain the value for this dimension\\. This dimension will only be published for a metric if the value is found in the log event\\. For example, `$.eventType` for JSON log events, or `$server` for space\\-delimited log events\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -122065,6 +125255,8 @@ "items": { "$ref": "#/definitions/AWS::Logs::MetricFilter.Dimension" }, + "markdownDescription": "The fields to use as dimensions for the metric\\. One metric filter can include as many as three dimensions\\. \nMetrics extracted from log events are charged as custom metrics\\. To prevent unexpected high charges, do not specify high\\-cardinality fields such as `IPAddress` or `requestID` as dimensions\\. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric\\. \nCloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time\\. This helps to prevent accidental high charges\\. \nYou can also set up a billing alarm to alert you if your charges are higher than expected\\. For more information, see [ Creating a Billing Alarm to Monitor Your Estimated AWS Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html)\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-dimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Dimensions", "type": "array" }, "MetricName": { @@ -122078,11 +125270,13 @@ "type": "string" }, "MetricValue": { - "markdownDescription": "The value that is published to the CloudWatch metric\\. For example, if you're counting the occurrences of a particular term like `Error`, specify 1 for the metric value\\. If you're counting the number of bytes transferred, reference the value that is in the log event by using $ followed by the name of the field that you specified in the filter pattern, such as `$.size`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value that is published to the CloudWatch metric\\. For example, if you're counting the occurrences of a particular term like `Error`, specify 1 for the metric value\\. If you're counting the number of bytes transferred, reference the value that is in the log event by using $\\. followed by the name of the field that you specified in the filter pattern, such as `$.size`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricValue", "type": "string" }, "Unit": { + "markdownDescription": "The unit to assign to the metric\\. If you omit this, the unit is set as `None`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Bits | Bits/Second | Bytes | Bytes/Second | Count | Count/Second | Gigabits | Gigabits/Second | Gigabytes | Gigabytes/Second | Kilobits | Kilobits/Second | Kilobytes | Kilobytes/Second | Megabits | Megabits/Second | Megabytes | Megabytes/Second | Microseconds | Milliseconds | None | Percent | Seconds | Terabits | Terabits/Second | Terabytes | Terabytes/Second` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Unit", "type": "string" } }, @@ -122288,9 +125482,13 @@ "type": "string" }, "Distribution": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Distribution", "type": "string" }, "FilterName": { + "markdownDescription": "The name of the subscription filter\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[^:*]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FilterName", "type": "string" }, "FilterPattern": { @@ -122379,12 +125577,12 @@ }, "DataInputConfiguration": { "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.DataInputConfiguration", - "markdownDescription": "Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location\\. \n*Required*: Yes \n*Type*: [DataInputConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-datainputconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataInputConfiguration" }, "DataOutputConfiguration": { "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.DataOutputConfiguration", - "markdownDescription": "Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output\\. \n*Required*: Yes \n*Type*: [DataOutputConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-dataoutputconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataOutputConfiguration" }, "DataUploadFrequency": { @@ -122455,13 +125653,19 @@ "additionalProperties": false, "properties": { "InferenceInputNameConfiguration": { - "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.InputNameConfiguration" + "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.InputNameConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [InputNameConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-inputnameconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InferenceInputNameConfiguration" }, "InputTimeZoneOffset": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputTimeZoneOffset", "type": "string" }, "S3InputConfiguration": { - "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.S3InputConfiguration" + "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.S3InputConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [S3InputConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-s3inputconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3InputConfiguration" } }, "required": [ @@ -122473,10 +125677,14 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "S3OutputConfiguration": { - "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.S3OutputConfiguration" + "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.S3OutputConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [S3OutputConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-s3outputconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3OutputConfiguration" } }, "required": [ @@ -122488,9 +125696,13 @@ "additionalProperties": false, "properties": { "ComponentTimestampDelimiter": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ComponentTimestampDelimiter", "type": "string" }, "TimestampFormat": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TimestampFormat", "type": "string" } }, @@ -122500,9 +125712,13 @@ "additionalProperties": false, "properties": { "Bucket": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Bucket", "type": "string" }, "Prefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Prefix", "type": "string" } }, @@ -122515,9 +125731,13 @@ "additionalProperties": false, "properties": { "Bucket": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Bucket", "type": "string" }, "Prefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Prefix", "type": "string" } }, @@ -122946,7 +126166,7 @@ "title": "MetricSource" }, "Offset": { - "markdownDescription": "After an interval ends, the amount of seconds that the detector waits before importing data\\. Offset is only supported for S3 and Redshift datasources\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "After an interval ends, the amount of seconds that the detector waits before importing data\\. Offset is only supported for S3, Redshift, Athena and datasources\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Offset", "type": "number" }, @@ -122973,22 +126193,22 @@ "properties": { "AppFlowConfig": { "$ref": "#/definitions/AWS::LookoutMetrics::AnomalyDetector.AppFlowConfig", - "markdownDescription": "An object containing information about the AppFlow configuration\\. \n*Required*: No \n*Type*: [AppFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-appflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Details about an AppFlow datasource\\. \n*Required*: No \n*Type*: [AppFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-appflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AppFlowConfig" }, "CloudwatchConfig": { "$ref": "#/definitions/AWS::LookoutMetrics::AnomalyDetector.CloudwatchConfig", - "markdownDescription": "An object containing information about the Amazon CloudWatch monitoring configuration\\. \n*Required*: No \n*Type*: [CloudwatchConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-cloudwatchconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Details about an Amazon CloudWatch monitoring datasource\\. \n*Required*: No \n*Type*: [CloudwatchConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-cloudwatchconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudwatchConfig" }, "RDSSourceConfig": { "$ref": "#/definitions/AWS::LookoutMetrics::AnomalyDetector.RDSSourceConfig", - "markdownDescription": "An object containing information about the Amazon Relational Database Service \\(RDS\\) configuration\\. \n*Required*: No \n*Type*: [RDSSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Details about an Amazon Relational Database Service \\(RDS\\) datasource\\. \n*Required*: No \n*Type*: [RDSSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RDSSourceConfig" }, "RedshiftSourceConfig": { "$ref": "#/definitions/AWS::LookoutMetrics::AnomalyDetector.RedshiftSourceConfig", - "markdownDescription": "An object containing information about the Amazon Redshift database configuration\\. \n*Required*: No \n*Type*: [RedshiftSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Details about an Amazon Redshift database datasource\\. \n*Required*: No \n*Type*: [RedshiftSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RedshiftSourceConfig" }, "S3SourceConfig": { @@ -123292,27 +126512,39 @@ "additionalProperties": false, "properties": { "Definition": { - "$ref": "#/definitions/AWS::M2::Application.Definition" + "$ref": "#/definitions/AWS::M2::Application.Definition", + "markdownDescription": "The application definition for a particular application\\. You can specify either inline JSON or an Amazon S3 bucket location\\. \nFor information about application definitions, see the [AWS Mainframe Modernization User Guide](https://docs.aws.amazon.com/m2/latest/userguide/applications-m2-definition.html)\\. \n*Required*: Yes \n*Type*: [Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-application-definition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Definition" }, "Description": { + "markdownDescription": "The description of the application\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "EngineType": { + "markdownDescription": "The type of the target platform for this application\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `bluage | microfocus` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EngineType", "type": "string" }, "KmsKeyId": { + "markdownDescription": "The identifier of a customer managed key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" }, "Name": { + "markdownDescription": "The name of the application\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -123348,9 +126580,13 @@ "additionalProperties": false, "properties": { "Content": { + "markdownDescription": "The content of the application definition\\. This is a JSON object that contains the resource configuration/definitions that identify an application\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `65000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Content", "type": "string" }, "S3Location": { + "markdownDescription": "The S3 bucket that contains the application definition\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\S{1,2000}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3Location", "type": "string" } }, @@ -123392,57 +126628,83 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the runtime environment\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Description", "type": "string" }, "EngineType": { + "markdownDescription": "The target platform for the runtime environment\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `bluage | microfocus` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EngineType", "type": "string" }, "EngineVersion": { + "markdownDescription": "The version of the runtime engine\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\S{1,10}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EngineVersion", "type": "string" }, "HighAvailabilityConfig": { - "$ref": "#/definitions/AWS::M2::Environment.HighAvailabilityConfig" + "$ref": "#/definitions/AWS::M2::Environment.HighAvailabilityConfig", + "markdownDescription": "Defines the details of a high availability configuration\\. \n*Required*: No \n*Type*: [HighAvailabilityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-highavailabilityconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HighAvailabilityConfig" }, "InstanceType": { + "markdownDescription": "The instance type of the runtime environment\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,20}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InstanceType", "type": "string" }, "KmsKeyId": { + "markdownDescription": "The identifier of a customer managed key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" }, "Name": { + "markdownDescription": "The name of the runtime environment\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "PreferredMaintenanceWindow": { + "markdownDescription": "Configures the maintenance window you want for the runtime environment\\. If you do not provide a value, a random system\\-generated value will be assigned\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\S{1,50}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PreferredMaintenanceWindow", "type": "string" }, "PubliclyAccessible": { + "markdownDescription": "Specifies whether the runtime environment is publicly accessible\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PubliclyAccessible", "type": "boolean" }, "SecurityGroupIds": { "items": { "type": "string" }, + "markdownDescription": "The list of security groups for the VPC associated with this runtime environment\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SecurityGroupIds", "type": "array" }, "StorageConfigurations": { "items": { "$ref": "#/definitions/AWS::M2::Environment.StorageConfiguration" }, + "markdownDescription": "Defines the storage configuration for a runtime environment\\. \n*Required*: No \n*Type*: List of [StorageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-storageconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StorageConfigurations", "type": "array" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "The list of subnets associated with the VPC for this runtime environment\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SubnetIds", "type": "array" }, "Tags": { "additionalProperties": true, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -123478,9 +126740,13 @@ "additionalProperties": false, "properties": { "FileSystemId": { + "markdownDescription": "The file system identifier\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,200}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemId", "type": "string" }, "MountPoint": { + "markdownDescription": "The mount point for the file system\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,200}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MountPoint", "type": "string" } }, @@ -123494,9 +126760,13 @@ "additionalProperties": false, "properties": { "FileSystemId": { + "markdownDescription": "The file system identifier\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,200}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemId", "type": "string" }, "MountPoint": { + "markdownDescription": "The mount point for the file system\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,200}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MountPoint", "type": "string" } }, @@ -123510,6 +126780,8 @@ "additionalProperties": false, "properties": { "DesiredCapacity": { + "markdownDescription": "The number of instances in a high availability configuration\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DesiredCapacity", "type": "number" } }, @@ -123522,10 +126794,14 @@ "additionalProperties": false, "properties": { "Efs": { - "$ref": "#/definitions/AWS::M2::Environment.EfsStorageConfiguration" + "$ref": "#/definitions/AWS::M2::Environment.EfsStorageConfiguration", + "markdownDescription": "Defines the storage configuration for an Amazon EFS file system\\. \n*Required*: No \n*Type*: [EfsStorageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-efsstorageconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Efs" }, "Fsx": { - "$ref": "#/definitions/AWS::M2::Environment.FsxStorageConfiguration" + "$ref": "#/definitions/AWS::M2::Environment.FsxStorageConfiguration", + "markdownDescription": "Defines the storage configuration for an Amazon FSx file system\\. \n*Required*: No \n*Type*: [FsxStorageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-fsxstorageconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Fsx" } }, "type": "object" @@ -123696,6 +126972,8 @@ "title": "OpenMonitoring" }, "StorageMode": { + "markdownDescription": "This controls storage mode for supported storage tiers\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageMode", "type": "string" }, "Tags": { @@ -123772,7 +127050,7 @@ "items": { "type": "string" }, - "markdownDescription": "The list of subnets to connect to in the client virtual private cloud \\(VPC\\)\\. Amazon creates elastic network interfaces inside these subnets\\. Client applications use elastic network interfaces to produce and consume data\\. \nSpecify exactly two subnets if you are using the US West \\(N\\. California\\) Region\\. For other Regions where Amazon MSK is available, you can specify either two or three subnets\\. The subnets that you specify must be in distinct Availability Zones\\. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify\\. \nClient subnets can't be in Availability Zone us\\-east\\-1e\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The list of subnets to connect to in the client virtual private cloud \\(VPC\\)\\. Amazon creates elastic network interfaces inside these subnets\\. Client applications use elastic network interfaces to produce and consume data\\. \nIf you use the US West \\(N\\. California\\) Region, specify exactly two subnets\\. For other Regions where Amazon MSK is available, you can specify either two or three subnets\\. The subnets that you specify must be in distinct Availability Zones\\. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify\\. \nClient subnets can't occupy the Availability Zone with ID `use1-az3`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ClientSubnets", "type": "array" }, @@ -123782,7 +127060,7 @@ "title": "ConnectivityInfo" }, "InstanceType": { - "markdownDescription": "The type of Amazon EC2 instances to use for brokers\\. The following instance types are allowed: kafka\\.m5\\.large, kafka\\.m5\\.xlarge, kafka\\.m5\\.2xlarge, kafka\\.m5\\.4xlarge, kafka\\.m5\\.8xlarge, kafka\\.m5\\.12xlarge, kafka\\.m5\\.16xlarge, and kafka\\.m5\\.24xlarge\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of Amazon EC2 instances to use for brokers\\. The following instance types are allowed: kafka\\.m5\\.large, kafka\\.m5\\.xlarge, kafka\\.m5\\.2xlarge, kafka\\.m5\\.4xlarge, kafka\\.m5\\.8xlarge, kafka\\.m5\\.12xlarge, kafka\\.m5\\.16xlarge, kafka\\.m5\\.24xlarge, and kafka\\.t3\\.small\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InstanceType", "type": "string" }, @@ -123796,7 +127074,7 @@ }, "StorageInfo": { "$ref": "#/definitions/AWS::MSK::Cluster.StorageInfo", - "markdownDescription": "Contains information about storage volumes attached to MSK broker nodes\\. \n*Required*: No \n*Type*: [StorageInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-storageinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains information about storage volumes attached to Amazon MSK broker nodes\\. \n*Required*: No \n*Type*: [StorageInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-storageinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StorageInfo" } }, @@ -123875,7 +127153,9 @@ "title": "PublicAccess" }, "VpcConnectivity": { - "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivity" + "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivity", + "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [VpcConnectivity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcConnectivity" } }, "type": "object" @@ -124176,7 +127456,9 @@ "additionalProperties": false, "properties": { "ClientAuthentication": { - "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityClientAuthentication" + "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityClientAuthentication", + "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [VpcConnectivityClientAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityclientauthentication.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientAuthentication" } }, "type": "object" @@ -124185,10 +127467,14 @@ "additionalProperties": false, "properties": { "Sasl": { - "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivitySasl" + "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivitySasl", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConnectivitySasl](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivitysasl.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sasl" }, "Tls": { - "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityTls" + "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityTls", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConnectivityTls](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivitytls.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tls" } }, "type": "object" @@ -124197,6 +127483,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" } }, @@ -124209,10 +127497,14 @@ "additionalProperties": false, "properties": { "Iam": { - "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityIam" + "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityIam", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConnectivityIam](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityiam.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Iam" }, "Scram": { - "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityScram" + "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityScram", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConnectivityScram](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityscram.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Scram" } }, "type": "object" @@ -124221,6 +127513,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" } }, @@ -124233,6 +127527,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" } }, @@ -124290,7 +127586,7 @@ "type": "array" }, "Name": { - "markdownDescription": "The name of the configuration\\. Configuration names are strings that match the regex \"^\\[0\\-9A\\-Za\\-z\\]\\[0\\-9A\\-Za\\-z\\-\\]\\{0,\\}$\"\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the configuration\\. Configuration names are strings that match the regex \"^\\[0\\-9A\\-Za\\-z\\]\\[0\\-9A\\-Za\\-z\\-\\]\\{0,\\}$\"\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -124363,24 +127659,32 @@ "additionalProperties": false, "properties": { "ClientAuthentication": { - "$ref": "#/definitions/AWS::MSK::ServerlessCluster.ClientAuthentication" + "$ref": "#/definitions/AWS::MSK::ServerlessCluster.ClientAuthentication", + "markdownDescription": "Specifies client authentication information for the serverless cluster\\. \n*Required*: Yes \n*Type*: [ClientAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-clientauthentication.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ClientAuthentication" }, "ClusterName": { + "markdownDescription": "The name of the serverless cluster\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ClusterName", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "A map of key:value pairs to apply to this serverless cluster\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "VpcConfigs": { "items": { "$ref": "#/definitions/AWS::MSK::ServerlessCluster.VpcConfig" }, + "markdownDescription": "VPC configuration information\\. \n*Required*: Yes \n*Type*: List of [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-vpcconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VpcConfigs", "type": "array" } }, @@ -124416,7 +127720,9 @@ "additionalProperties": false, "properties": { "Sasl": { - "$ref": "#/definitions/AWS::MSK::ServerlessCluster.Sasl" + "$ref": "#/definitions/AWS::MSK::ServerlessCluster.Sasl", + "markdownDescription": "Details for client authentication using SASL\\. To turn on SASL, you must also turn on `EncryptionInTransit` by setting `inCluster` to true\\. You must set `clientBroker` to either `TLS` or `TLS_PLAINTEXT`\\. If you choose `TLS_PLAINTEXT`, then you must also set `unauthenticated` to true\\. \n*Required*: Yes \n*Type*: [Sasl](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-sasl.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Sasl" } }, "required": [ @@ -124428,6 +127734,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "SASL/IAM authentication is enabled or not\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Enabled", "type": "boolean" } }, @@ -124440,7 +127748,9 @@ "additionalProperties": false, "properties": { "Iam": { - "$ref": "#/definitions/AWS::MSK::ServerlessCluster.Iam" + "$ref": "#/definitions/AWS::MSK::ServerlessCluster.Iam", + "markdownDescription": "Details for client authentication using IAM\\. \n*Required*: Yes \n*Type*: [Iam](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-iam.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Iam" } }, "required": [ @@ -124455,12 +127765,16 @@ "items": { "type": "string" }, + "markdownDescription": "Specifies up to five security groups that control inbound and outbound traffic for the serverless cluster\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SecurityGroups", "type": "array" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "A list of subnets in at least two different Availability Zones that host your client applications\\. We recommend that you specify a backup subnet in a different Availability Zone for failover in case of an outage\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SubnetIds", "type": "array" } }, @@ -124510,7 +127824,7 @@ "type": "object" }, "AirflowVersion": { - "markdownDescription": "The version of Apache Airflow to use for the environment\\. If no value is specified, defaults to the latest version\\. Valid values: `2.0.2`, `1.10.12`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of Apache Airflow to use for the environment\\. If no value is specified, defaults to the latest version\\. Valid values: `2.0.2`, `1.10.12`, `2.2.2`, and `2.4.3`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AirflowVersion", "type": "string" }, @@ -124580,7 +127894,7 @@ "type": "string" }, "Schedulers": { - "markdownDescription": "The number of schedulers that you want to run in your environment\\. Valid values: \n+ **v2\\.0\\.2** \\- Accepts between 2 to 5\\. Defaults to 2\\.\n+ **v1\\.10\\.12** \\- Accepts 1\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of schedulers that you want to run in your environment\\. Valid values: \n+ **v2** \\- Accepts between 2 to 5\\. Defaults to 2\\.\n+ **v1** \\- Accepts 1\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Schedulers", "type": "number" }, @@ -124741,18 +128055,26 @@ "additionalProperties": false, "properties": { "Criteria": { - "$ref": "#/definitions/AWS::Macie::AllowList.Criteria" + "$ref": "#/definitions/AWS::Macie::AllowList.Criteria", + "markdownDescription": "The criteria that specify the text or text pattern to ignore\\. The criteria can be the location and name of an Amazon S3 object that lists specific text to ignore \\(`S3WordsList`\\), or a regular expression \\(`Regex`\\) that defines a text pattern to ignore\\. \n*Required*: Yes \n*Type*: [Criteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-allowlist-criteria.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Criteria" }, "Description": { + "markdownDescription": "A custom description of the allow list\\. The description can contain 1\\-512 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A custom name for the allow list\\. The name can contain 1\\-128 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to the allow list\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -124787,10 +128109,14 @@ "additionalProperties": false, "properties": { "Regex": { + "markdownDescription": "The regular expression \\(*regex*\\) that defines the text pattern to ignore\\. The expression can contain 1\\-512 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Regex", "type": "string" }, "S3WordsList": { - "$ref": "#/definitions/AWS::Macie::AllowList.S3WordsList" + "$ref": "#/definitions/AWS::Macie::AllowList.S3WordsList", + "markdownDescription": "The location and name of an Amazon S3 object that lists specific text to ignore\\. \n*Required*: No \n*Type*: [S3WordsList](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-allowlist-s3wordslist.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3WordsList" } }, "type": "object" @@ -124799,9 +128125,13 @@ "additionalProperties": false, "properties": { "BucketName": { + "markdownDescription": "The full name of the S3 bucket that contains the object\\. This value correlates to the `Name` field of a bucket's properties in Amazon S3\\. \nThis value is case sensitive\\. In addition, don't use wildcard characters or specify partial values for the name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketName", "type": "string" }, "ObjectKey": { + "markdownDescription": "The full name of the S3 object\\. This value correlates to the `Key` field of an object's properties in Amazon S3\\. If the name includes a path, include the complete path\\. For example, `AllowLists/Macie/MyList.txt`\\. \nThis value is case sensitive\\. In addition, don't use wildcard characters or specify partial values for the name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObjectKey", "type": "string" } }, @@ -124847,7 +128177,7 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "The description of the custom data identifier\\. The description can contain as many as 512 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A custom description of the custom data identifier\\. The description can contain 1\\-512 characters\\. \nAvoid including sensitive data in the description\\. Users of the account might be able to see the description, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Description", "type": "string" }, @@ -124855,7 +128185,7 @@ "items": { "type": "string" }, - "markdownDescription": "An array that lists specific character sequences \\(ignore words\\) to exclude from the results\\. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it\\. The array can contain as many as 10 ignore words\\. Each ignore word can contain 4\\-90 characters\\. Ignore words are case sensitive\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An array of character sequences \\(*ignore words*\\) to exclude from the results\\. If text matches the regular expression \\(`Regex`\\) but it contains a string in this array, Amazon Macie ignores the text and doesn't include it in the results\\. \nThe array can contain 1\\-10 ignore words\\. Each ignore word can contain 4\\-90 UTF\\-8 characters\\. Ignore words are case sensitive\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IgnoreWords", "type": "array" }, @@ -124863,22 +128193,22 @@ "items": { "type": "string" }, - "markdownDescription": "An array that lists specific character sequences \\(keywords\\), one of which must be within proximity \\(`MaximumMatchDistance`\\) of the regular expression to match\\. The array can contain as many as 50 keywords\\. Each keyword can contain 3\\-90 characters\\. Keywords aren't case sensitive\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An array of character sequences \\(*keywords*\\), one of which must precede and be in proximity \\(`MaximumMatchDistance`\\) of the regular expression \\(`Regex`\\) to match\\. \nThe array can contain 1\\-50 keywords\\. Each keyword can contain 3\\-90 UTF\\-8 characters\\. Keywords aren't case sensitive\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Keywords", "type": "array" }, "MaximumMatchDistance": { - "markdownDescription": "The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the `Keywords` array\\. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern\\. The distance can be 1\\-300 characters\\. The default value is 50\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum number of characters that can exist between the end of at least one complete character sequence specified by the `Keywords` array and the end of text that matches the regular expression \\(`Regex`\\)\\. If a complete keyword precedes all the text that matches the regular expression and the keyword is within the specified distance, Amazon Macie includes the result\\. \nThe distance can be 1\\-300 characters\\. The default value is 50\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaximumMatchDistance", "type": "number" }, "Name": { - "markdownDescription": "A custom name for the custom data identifier\\. The name can contain as many as 128 characters\\. \nWe strongly recommend that you avoid including any sensitive data in the name of a custom data identifier\\. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A custom name for the custom data identifier\\. The name can contain 1\\-128 characters\\. \nAvoid including sensitive data in the name of a custom data identifier\\. Users of the account might be able to see the name, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, "Regex": { - "markdownDescription": "The regular expression \\(*regex*\\) that defines the pattern to match\\. The expression can contain as many as 512 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The regular expression \\(*regex*\\) that defines the text pattern to match\\. The expression can contain 1\\-512 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Regex", "type": "string" } @@ -124946,12 +128276,12 @@ "additionalProperties": false, "properties": { "Action": { - "markdownDescription": "The action to perform on findings that meet the filter criteria \\(`FindingCriteria`\\)\\. Valid values are: \n+ ARCHIVE \\- Suppress \\(automatically archive\\) the findings\\.\n+ NOOP \\- Don't perform any action on the findings\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action to perform on findings that match the filter criteria \\(`FindingCriteria`\\)\\. Valid values are: \n+ `ARCHIVE` \\- Suppress \\(automatically archive\\) the findings\\.\n+ `NOOP` \\- Don't perform any action on the findings\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Action", "type": "string" }, "Description": { - "markdownDescription": "A custom description of the filter\\. The description can contain as many as 512 characters\\. \nWe strongly recommend that you avoid including any sensitive data in the description of a filter\\. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A custom description of the findings filter\\. The description can contain 1\\-512 characters\\. \nAvoid including sensitive data in the description\\. Users of the account might be able to see the description, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -124961,12 +128291,12 @@ "title": "FindingCriteria" }, "Name": { - "markdownDescription": "A custom name for the filter\\. The name must contain at least 3 characters and can contain as many as 64 characters\\. \nWe strongly recommend that you avoid including any sensitive data in the name of a filter\\. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A custom name for the findings filter\\. The name can contain 3\\-64 characters\\. \nAvoid including sensitive data in the name\\. Users of the account might be able to see the name, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Position": { - "markdownDescription": "The position of the filter in the list of saved filters on the Amazon Macie console\\. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The position of the findings filter in the list of saved filters on the Amazon Macie console\\. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Position", "type": "number" } @@ -125005,24 +128335,36 @@ "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "eq", "type": "array" }, "gt": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "gt", "type": "number" }, "gte": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "gte", "type": "number" }, "lt": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "lt", "type": "number" }, "lte": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "lte", "type": "number" }, "neq": { "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "neq", "type": "array" } }, @@ -125033,7 +128375,7 @@ "properties": { "Criterion": { "additionalProperties": false, - "markdownDescription": "Specifies a condition that defines the property, operator, and value to use to filter the results\\. \n*Required*: No \n*Type*: [Criterion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-findingsfilter-criterion.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a condition that defines the property, operator, and one or more values to use to filter the results\\. \n*Required*: No \n*Type*: Map of [CriterionAdditionalProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-findingsfilter-criterionadditionalproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::Macie::FindingsFilter.CriterionAdditionalProperties" @@ -125049,12 +128391,12 @@ "additionalProperties": false, "properties": { "Id": { - "markdownDescription": "The unique identifier for the filter\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unique identifier for the findings filter\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Id", "type": "string" }, "Name": { - "markdownDescription": "The custom name of the filter\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The custom name of the findings filter\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" } @@ -125097,12 +128439,12 @@ "additionalProperties": false, "properties": { "FindingPublishingFrequency": { - "markdownDescription": "The frequency with which Amazon Macie publishes updates to policy findings for an account\\. This includes publishing updates to AWS Security Hub and Amazon EventBridge \\(formerly called Amazon CloudWatch Events\\)\\. Valid values are: \n+ FIFTEEN\\_MINUTES\n+ ONE\\_HOUR\n+ SIX\\_HOURS\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how often Amazon Macie publishes updates to policy findings for the account\\. This includes publishing updates to AWS Security Hub and Amazon EventBridge \\(formerly Amazon CloudWatch Events\\)\\. Valid values are: \n+ FIFTEEN\\_MINUTES\n+ ONE\\_HOUR\n+ SIX\\_HOURS\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FindingPublishingFrequency", "type": "string" }, "Status": { - "markdownDescription": "The `MacieStatus` of the `Session`\\. Valid values include `ENABLED` and `PAUSED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The status of Amazon Macie for the account\\. Valid values are: `ENABLED`, start or resume all Macie activities for the account; and, `PAUSED`, suspend all Macie activities for the account\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Status", "type": "string" } @@ -125215,7 +128557,7 @@ "additionalProperties": false, "properties": { "ProposalDurationInHours": { - "markdownDescription": "The duration from the time that a proposal is created until it expires\\. If members cast neither the required number of `YES` votes to approve the proposal nor the number of `NO` votes required to reject it before the duration expires, the proposal is `EXPIRED` and `ProposalActions` are not carried out\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `168` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The duration from the time that a proposal is created until it expires\\. If members cast neither the required number of `YES` votes to approve the proposal nor the number of `NO` votes required to reject it before the duration expires, the proposal is `EXPIRED` and `ProposalActions` aren't carried out\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `168` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProposalDurationInHours", "type": "number" }, @@ -125406,7 +128748,7 @@ "type": "string" }, "NetworkId": { - "markdownDescription": "The unique identifier of the network for the node\\. \nEthereum public networks have the following `NetworkId`s: \n+ `n-ethereum-mainnet` \n+ `n-ethereum-rinkeby` \n+ `n-ethereum-ropsten` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unique identifier of the network for the node\\. \nEthereum public networks have the following `NetworkId`s: \n+ `n-ethereum-mainnet` \n+ `n-ethereum-goerli` \n+ `n-ethereum-rinkeby` \n+ `n-ethereum-ropsten` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NetworkId", "type": "string" }, @@ -125604,15 +128946,19 @@ "additionalProperties": false, "properties": { "FailoverMode": { + "markdownDescription": "The type of failover you choose for this flow\\. MERGE combines the source streams into a single stream, allowing graceful recovery from any single\\-source loss\\. FAILOVER allows switching between different streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailoverMode", "type": "string" }, "RecoveryWindow": { - "markdownDescription": "The size of the buffer \\(delay\\) that the service maintains\\. A larger buffer means a longer delay in transmitting the stream, but more room for error correction\\. A smaller buffer means a shorter delay, but less room for error correction\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The size of the buffer \\(delay\\) that the service maintains\\. A larger buffer means a longer delay in transmitting the stream, but more room for error correction\\. A smaller buffer means a shorter delay, but less room for error correction\\. You can choose a value from 100\\-500 ms\\. If you keep this field blank, the service uses the default value of 200 ms\\. This setting only applies when Failover Mode is set to MERGE\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RecoveryWindow", "type": "number" }, "SourcePriority": { - "$ref": "#/definitions/AWS::MediaConnect::Flow.SourcePriority" + "$ref": "#/definitions/AWS::MediaConnect::Flow.SourcePriority", + "markdownDescription": "The priority you want to assign to a source\\. You can have a primary stream and a backup stream or two equally prioritized streams\\. This setting only applies when Failover Mode is set to FAILOVER\\. \n*Required*: No \n*Type*: [SourcePriority](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-sourcepriority.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourcePriority" }, "State": { "markdownDescription": "The state of source failover on the flow\\. If the state is disabled, the flow can have only one source\\. If the state is enabled, the flow can have one or two sources\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -125671,14 +129017,18 @@ "type": "string" }, "Protocol": { - "markdownDescription": "The protocol that is used by the source\\. For a full list of available protocols, see: [Source protocols](https://docs.aws.amazon.com/mediaconnect/latest/api/v1-flows-flowarn-source.html#v1-flows-flowarn-source-prop-setsourcerequest-protocol) in the *AWS Elemental MediaConnect API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The protocol that is used by the source\\. AWS CloudFormation does not currently support CDI or ST 2110 JPEG XS source protocols\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Protocol", "type": "string" }, "SenderControlPort": { + "markdownDescription": "The port that the flow uses to send outbound requests to initiate connection with the sender\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SenderControlPort", "type": "number" }, "SenderIpAddress": { + "markdownDescription": "The IP address that the flow communicates with to initiate connection with the sender\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SenderIpAddress", "type": "string" }, "SourceArn": { @@ -125692,9 +129042,13 @@ "type": "string" }, "SourceListenerAddress": { + "markdownDescription": "Source IP or domain name for SRT\\-caller protocol\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceListenerAddress", "type": "string" }, "SourceListenerPort": { + "markdownDescription": "Source port for SRT\\-caller protocol\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceListenerPort", "type": "number" }, "StreamId": { @@ -125719,6 +129073,8 @@ "additionalProperties": false, "properties": { "PrimarySource": { + "markdownDescription": "The name of the source you choose as the primary source for this flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PrimarySource", "type": "string" } }, @@ -125944,12 +129300,12 @@ "title": "Encryption" }, "FlowArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow this output is attached to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FlowArn", "type": "string" }, "MaxLatency": { - "markdownDescription": "The maximum latency in milliseconds for Zixi\\-based streams\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum latency in milliseconds\\. This parameter applies only to RIST\\-based, Zixi\\-based, and Fujitsu\\-based streams\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxLatency", "type": "number" }, @@ -125984,7 +129340,7 @@ "type": "number" }, "StreamId": { - "markdownDescription": "The stream ID that you want to use for the transport\\. This parameter applies only to Zixi\\-based streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The stream ID that you want to use for this transport\\. This parameter applies only to Zixi and SRT caller\\-based streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamId", "type": "string" }, @@ -126113,7 +129469,7 @@ "type": "string" }, "FlowArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow this source is connected to\\. The flow must have Failover enabled to add an additional source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FlowArn", "type": "string" }, @@ -126138,12 +129494,12 @@ "type": "string" }, "Protocol": { - "markdownDescription": "The protocol that the source uses to deliver the content to MediaConnect\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The protocol that the source uses to deliver the content to MediaConnect\\. Adding additional sources to an existing flow requires Failover to be enabled\\. When you enable Failover, the additional source must use the same protocol as the existing source\\. Only the following protocols support failover: Zixi\\-push, RTP\\-FEC, RTP, and RIST\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Protocol", "type": "string" }, "StreamId": { - "markdownDescription": "The stream ID that you want to use for the transport\\. This parameter applies only to Zixi\\-based streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The stream ID that you want to use for this transport\\. This parameter applies only to Zixi and SRT caller\\-based streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamId", "type": "string" }, @@ -129004,7 +132360,7 @@ "type": "string" }, "ProgramDateTimeClock": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the algorithm used to drive the HLS EXT\\-X\\-PROGRAM\\-DATE\\-TIME clock\\. Options include: INITIALIZE\\_FROM\\_OUTPUT\\_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment\\. SYSTEM\\_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment\\. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProgramDateTimeClock", "type": "string" }, @@ -129372,7 +132728,7 @@ "title": "NetworkInputSettings" }, "Scte35Pid": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Scte35Pid", "type": "number" }, @@ -131316,12 +134672,12 @@ "type": "string" }, "SourceArn": { - "markdownDescription": "The ARN for the source content in Amazon S3\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN for the source content in Amazon S3\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceArn", "type": "string" }, "SourceRoleArn": { - "markdownDescription": "The ARN for the IAM role that provides AWS Elemental MediaPackage access to the Amazon S3 bucket where the source content is stored\\. Valid format: arn:aws:iam::\\{accountID\\}:role/\\{name\\} \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN for the IAM role that provides AWS Elemental MediaPackage access to the Amazon S3 bucket where the source content is stored\\. Valid format: arn:aws:iam::\\{accountID\\}:role/\\{name\\} \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceRoleArn", "type": "string" }, @@ -131425,11 +134781,13 @@ }, "EgressAccessLogs": { "$ref": "#/definitions/AWS::MediaPackage::Channel.LogConfiguration", - "markdownDescription": "Configures egress access logs\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configures egress access logs\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EgressAccessLogs" }, "HlsIngest": { - "$ref": "#/definitions/AWS::MediaPackage::Channel.HlsIngest" + "$ref": "#/definitions/AWS::MediaPackage::Channel.HlsIngest", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [HlsIngest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-hlsingest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HlsIngest" }, "Id": { "markdownDescription": "Unique identifier that you assign to the channel\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -131438,7 +134796,7 @@ }, "IngressAccessLogs": { "$ref": "#/definitions/AWS::MediaPackage::Channel.LogConfiguration", - "markdownDescription": "Configures ingress access logs\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configures ingress access logs\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IngressAccessLogs" }, "Tags": { @@ -131483,6 +134841,8 @@ "items": { "$ref": "#/definitions/AWS::MediaPackage::Channel.IngestEndpoint" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [IngestEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-ingestendpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ingestEndpoints", "type": "array" } }, @@ -131492,15 +134852,23 @@ "additionalProperties": false, "properties": { "Id": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id", "type": "string" }, "Password": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Password", "type": "string" }, "Url": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Url", "type": "string" }, "Username": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Username", "type": "string" } }, @@ -131516,7 +134884,7 @@ "additionalProperties": false, "properties": { "LogGroupName": { - "markdownDescription": "Sets a custom Amazon CloudWatch log group name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Sets a custom Amazon CloudWatch log group name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogGroupName", "type": "string" } @@ -131564,7 +134932,7 @@ "title": "Authorization" }, "ChannelId": { - "markdownDescription": "The ID of the channel associated with this endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of the channel associated with this endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ChannelId", "type": "string" }, @@ -131604,12 +134972,12 @@ "title": "MssPackage" }, "Origination": { - "markdownDescription": "Controls video origination from this endpoint\\. \n+ **ALLOW** \\- enables this endpoint to serve content to requesting devices\\.\n+ **DENY** \\- prevents this endpoint from serving content\\. Denying origination is helpful for harvesting live\\-to\\-VOD assets\\. For more information about harvesting and origination, see [Live\\-to\\-VOD Requirements](https://docs.aws.amazon.com/mediapackage/latest/ug/ltov-reqmts.html)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Controls video origination from this endpoint\\. \nValid values: \n+ **ALLOW** \\- enables this endpoint to serve content to requesting devices\\.\n+ **DENY** \\- prevents this endpoint from serving content\\. Denying origination is helpful for harvesting live\\-to\\-VOD assets\\. For more information about harvesting and origination, see [Live\\-to\\-VOD Requirements](https://docs.aws.amazon.com/mediapackage/latest/ug/ltov-reqmts.html)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Origination", "type": "string" }, "StartoverWindowSeconds": { - "markdownDescription": "Maximum duration \\(seconds\\) of content to retain for startover playback\\. Omit this attribute or enter `0` to indicate that startover playback is disabled for this endpoint\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Maximum duration \\(seconds\\) of content to retain for startover playback\\. Omit this attribute or enter `0` to indicate that startover playback is disabled for this endpoint\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartoverWindowSeconds", "type": "number" }, @@ -131622,7 +134990,7 @@ "type": "array" }, "TimeDelaySeconds": { - "markdownDescription": "Minimum duration \\(seconds\\) of delay to enforce on the playback of live content\\. Omit this attribute or enter `0` to indicate that there is no time delay in effect for this endpoint \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Minimum duration \\(seconds\\) of delay to enforce on the playback of live content\\. Omit this attribute or enter `0` to indicate that there is no time delay in effect for this endpoint\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeDelaySeconds", "type": "number" }, @@ -131666,12 +135034,12 @@ "additionalProperties": false, "properties": { "CdnIdentifierSecret": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the secret in AWS Secrets Manager that your Content Distribution Network \\(CDN\\) uses for authorization to access your endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the secret in AWS Secrets Manager that your Content Delivery Network \\(CDN\\) uses for authorization to access your endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdnIdentifierSecret", "type": "string" }, "SecretsRoleArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the IAM role that allows AWS Elemental MediaPackage to communicate with AWS Secrets Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsRoleArn", "type": "string" } @@ -131686,15 +135054,17 @@ "additionalProperties": false, "properties": { "ConstantInitializationVector": { - "markdownDescription": "An optional 128\\-bit, 16\\-byte hex value represented by a 32\\-character string, used in conjunction with the key for encrypting blocks\\. If you don't specify a value, then MediaPackage creates the constant initialization vector \\(IV\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional 128\\-bit, 16\\-byte hex value represented by a 32\\-character string, used in conjunction with the key for encrypting blocks\\. If you don't specify a value, then AWS Elemental MediaPackage creates the constant initialization vector \\(IV\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConstantInitializationVector", "type": "string" }, "EncryptionMethod": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionMethod", "type": "string" }, "KeyRotationIntervalSeconds": { - "markdownDescription": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeyRotationIntervalSeconds", "type": "number" }, @@ -131737,7 +135107,7 @@ }, "StreamSelection": { "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.StreamSelection", - "markdownDescription": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamSelection" } }, @@ -131747,7 +135117,7 @@ "additionalProperties": false, "properties": { "KeyRotationIntervalSeconds": { - "markdownDescription": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeyRotationIntervalSeconds", "type": "number" }, @@ -131769,12 +135139,12 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies the SCTE\\-35 message types that MediaPackage treats as ad markers in the output manifest\\. \n Valid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **PROVIDER\\_ADVERTISEMENT**\\.\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **SPLICE\\_INSERT**\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the SCTE\\-35 message types that AWS Elemental MediaPackage treats as ad markers in the output manifest\\. \nValid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **PROVIDER\\_ADVERTISEMENT**\\.\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **SPLICE\\_INSERT**\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdTriggers", "type": "array" }, "AdsOnDeliveryRestrictions": { - "markdownDescription": "The flags on SCTE\\-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The flags on SCTE\\-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in AWS Elemental MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdsOnDeliveryRestrictions", "type": "string" }, @@ -131784,10 +135154,12 @@ "title": "Encryption" }, "IncludeIframeOnlyStream": { + "markdownDescription": "This applies only to stream sets with a single video track\\. When true, the stream set includes an additional I\\-frame trick\\-play only stream, along with the other tracks\\. If false, this extra stream is not included\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludeIframeOnlyStream", "type": "boolean" }, "ManifestLayout": { - "markdownDescription": "Determines the position of some tags in the manifest\\. \nOptions: \n+ **FULL** \\- elements like `SegmentTemplate` and `ContentProtection` are included in each `Representation`\\.\n+ **COMPACT** \\- duplicate elements are combined and presented at the `AdaptationSet` level\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the position of some tags in the manifest\\. \nValid values: \n+ **FULL** \\- Elements like `SegmentTemplate` and `ContentProtection` are included in each `Representation`\\.\n+ **COMPACT** \\- Duplicate elements are combined and presented at the `AdaptationSet` level\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ManifestLayout", "type": "string" }, @@ -131810,22 +135182,22 @@ "items": { "type": "string" }, - "markdownDescription": "Controls whether MediaPackage produces single\\-period or multi\\-period DASH manifests\\. For more information about periods, see [Multi\\-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html)\\. \nValid values: \n+ **ADS** \\- MediaPackage will produce multi\\-period DASH manifests\\. Periods are created based on the SCTE\\-35 ad markers present in the input manifest\\.\n+ *No value* \\- MediaPackage will produce single\\-period DASH manifests\\. This is the default setting\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Controls whether AWS Elemental MediaPackage produces single\\-period or multi\\-period DASH manifests\\. For more information about periods, see [Multi\\-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html)\\. \nValid values: \n+ **ADS** \\- AWS Elemental MediaPackage will produce multi\\-period DASH manifests\\. Periods are created based on the SCTE\\-35 ad markers present in the input manifest\\.\n+ *No value* \\- AWS Elemental MediaPackage will produce single\\-period DASH manifests\\. This is the default setting\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PeriodTriggers", "type": "array" }, "Profile": { - "markdownDescription": "DASH profile for the output, such as HbbTV\\. \nValid values: \n+ **NONE** \\- the output doesn't use a DASH profile\\.\n+ **HBBTV\\_1\\_5** \\- the output is HbbTV\\-compliant\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The DASH profile for the output\\. \nValid values: \n+ **NONE** \\- The output doesn't use a DASH profile\\.\n+ **HBBTV\\_1\\_5** \\- The output is compliant with HbbTV v1\\.5\\.\n+ **DVB\\_DASH\\_2014** \\- The output is compliant with DVB\\-DASH 2014\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Profile", "type": "string" }, "SegmentDurationSeconds": { - "markdownDescription": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SegmentDurationSeconds", "type": "number" }, "SegmentTemplateFormat": { - "markdownDescription": "Determines the type of variable used in the `media` URL of the `SegmentTemplate` tag in the manifest\\. Also specifies if segment timeline information is included in `SegmentTimeline` or `SegmentTemplate`\\. \n+ **NUMBER\\_WITH\\_TIMELINE** \\- The `$Number$` variable is used in the `media` URL\\. The value of this variable is the sequential number of the segment\\. A full `SegmentTimeline` object is presented in each `SegmentTemplate`\\.\n+ **NUMBER\\_WITH\\_DURATION** \\- The `$Number$` variable is used in the `media` URL and a `duration` attribute is added to the segment template\\. The `SegmentTimeline` object is removed from the representation\\.\n+ **TIME\\_WITH\\_TIMELINE** \\- The `$Time$` variable is used in the `media` URL\\. The value of this variable is the timestamp of when the segment starts\\. A full `SegmentTimeline` object is presented in each `SegmentTemplate`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the type of variable used in the `media` URL of the `SegmentTemplate` tag in the manifest\\. Also specifies if segment timeline information is included in `SegmentTimeline` or `SegmentTemplate`\\. \nValid values: \n+ **NUMBER\\_WITH\\_TIMELINE** \\- The `$Number$` variable is used in the `media` URL\\. The value of this variable is the sequential number of the segment\\. A full `SegmentTimeline` object is presented in each `SegmentTemplate`\\.\n+ **NUMBER\\_WITH\\_DURATION** \\- The `$Number$` variable is used in the `media` URL and a `duration` attribute is added to the segment template\\. The `SegmentTimeline` object is removed from the representation\\.\n+ **TIME\\_WITH\\_TIMELINE** \\- The `$Time$` variable is used in the `media` URL\\. The value of this variable is the timestamp of when the segment starts\\. A full `SegmentTimeline` object is presented in each `SegmentTemplate`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SegmentTemplateFormat", "type": "string" }, @@ -131840,12 +135212,12 @@ "type": "number" }, "UtcTiming": { - "markdownDescription": "Determines the type of UTC timing included in the DASH Media Presentation Description \\(MPD\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the type of UTC timing included in the DASH Media Presentation Description \\(MPD\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UtcTiming", "type": "string" }, "UtcTimingUri": { - "markdownDescription": "Specifies the value attribute of the UTC timing field when utcTiming is set to HTTP\\-ISO or HTTP\\-HEAD\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the value attribute of the UTC timing field when utcTiming is set to HTTP\\-ISO or HTTP\\-HEAD\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UtcTimingUri", "type": "string" } @@ -131856,9 +135228,13 @@ "additionalProperties": false, "properties": { "PresetSpeke20Audio": { + "markdownDescription": "A collection of audio encryption presets\\. \nValue description: \n+ `PRESET-AUDIO-1` \\- Use one content key to encrypt all of the audio tracks in your stream\\.\n+ `PRESET-AUDIO-2` \\- Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks\\.\n+ `PRESET-AUDIO-3` \\- Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels\\.\n+ `SHARED` \\- Use the same content key for all of the audio and video tracks in your stream\\.\n+ `UNENCRYPTED` \\- Don't encrypt any of the audio tracks in your stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PresetSpeke20Audio", "type": "string" }, "PresetSpeke20Video": { + "markdownDescription": "A collection of video encryption presets\\. \nValue description: \n+ `PRESET-VIDEO-1` \\- Use one content key to encrypt all of the video tracks in your stream\\.\n+ `PRESET-VIDEO-2` \\- Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks\\.\n+ `PRESET-VIDEO-3` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-4` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `PRESET-VIDEO-5` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `PRESET-VIDEO-6` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-7` \\- Use one content key to encrypt all of the SD\\+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-8` \\- Use one content key to encrypt all of the SD\\+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `SHARED` \\- Use the same content key for all of the video and audio tracks in your stream\\.\n+ `UNENCRYPTED` \\- Don't encrypt any of the video tracks in your stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PresetSpeke20Video", "type": "string" } }, @@ -131877,17 +135253,17 @@ "type": "string" }, "EncryptionMethod": { - "markdownDescription": "HLS encryption type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "HLS encryption type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EncryptionMethod", "type": "string" }, "KeyRotationIntervalSeconds": { - "markdownDescription": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeyRotationIntervalSeconds", "type": "number" }, "RepeatExtXKey": { - "markdownDescription": "Repeat the `EXT-X-KEY `directive for every media segment\\. This might result in an increase in client requests to the DRM server\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Repeat the `EXT-X-KEY `directive for every media segment\\. This might result in an increase in client requests to the DRM server\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RepeatExtXKey", "type": "boolean" }, @@ -131906,7 +135282,7 @@ "additionalProperties": false, "properties": { "AdMarkers": { - "markdownDescription": "Controls how ad markers are included in the packaged endpoint\\. Valid values are `none`, `passthrough`, or `scte35_enhanced`\\. \n+ **NONE** \\- omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Controls how ad markers are included in the packaged endpoint\\. \nValid values: \n+ **NONE** \\- Omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- Creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- Generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdMarkers", "type": "string" }, @@ -131914,12 +135290,12 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies the SCTE\\-35 message types that MediaPackage treats as ad markers in the output manifest\\. \nValid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_ADVERTISEMENT**\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\n+ **SPLICE\\_INSERT**\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the SCTE\\-35 message types that AWS Elemental MediaPackage treats as ad markers in the output manifest\\. \nValid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_ADVERTISEMENT**\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\n+ **SPLICE\\_INSERT**\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdTriggers", "type": "array" }, "AdsOnDeliveryRestrictions": { - "markdownDescription": "The flags on SCTE\\-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The flags on SCTE\\-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in AWS Elemental MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdsOnDeliveryRestrictions", "type": "string" }, @@ -131968,7 +135344,7 @@ "additionalProperties": false, "properties": { "AdMarkers": { - "markdownDescription": "Controls how ad markers are included in the packaged endpoint\\. Valid values are `none`, `passthrough`, or `scte35_enhanced`\\. \n+ **NONE** \\- omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Controls how ad markers are included in the packaged endpoint\\. \nValid values: \n+ **NONE** \\- Omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- Creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- Generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdMarkers", "type": "string" }, @@ -131976,12 +135352,12 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies the SCTE\\-35 message types that MediaPackage treats as ad markers in the output manifest\\. \n Valid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_ADVERTISEMENT**\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\n+ **SPLICE\\_INSERT**\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the SCTE\\-35 message types that AWS Elemental MediaPackage treats as ad markers in the output manifest\\. \nValid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_ADVERTISEMENT**\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\n+ **SPLICE\\_INSERT**\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdTriggers", "type": "array" }, "AdsOnDeliveryRestrictions": { - "markdownDescription": "The flags on SCTE\\-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The flags on SCTE\\-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in AWS Elemental MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdsOnDeliveryRestrictions", "type": "string" }, @@ -131991,10 +135367,12 @@ "title": "Encryption" }, "IncludeDvbSubtitles": { + "markdownDescription": "When enabled, MediaPackage passes through digital video broadcasting \\(DVB\\) subtitles into the output\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludeDvbSubtitles", "type": "boolean" }, "IncludeIframeOnlyStream": { - "markdownDescription": "Only applies to stream sets with a single video track\\. When true, the stream set includes an additional I\\-frame only stream, along with the other tracks\\. If false, this extra stream is not included\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Only applies to stream sets with a single video track\\. When true, the stream set includes an additional I\\-frame only stream, along with the other tracks\\. If false, this extra stream is not included\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeIframeOnlyStream", "type": "boolean" }, @@ -132014,7 +135392,7 @@ "type": "number" }, "SegmentDurationSeconds": { - "markdownDescription": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SegmentDurationSeconds", "type": "number" }, @@ -132065,7 +135443,7 @@ }, "StreamSelection": { "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.StreamSelection", - "markdownDescription": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamSelection" } }, @@ -132075,15 +135453,17 @@ "additionalProperties": false, "properties": { "CertificateArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the certificate that you imported to AWS Certificate Manager to add content key encryption to this endpoint\\. For this feature to work, your DRM key provider must support content key encryption\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the certificate that you imported to AWS Certificate Manager to add content key encryption to this endpoint\\. For this feature to work, your DRM key provider must support content key encryption\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CertificateArn", "type": "string" }, "EncryptionContractConfiguration": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.EncryptionContractConfiguration" + "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.EncryptionContractConfiguration", + "markdownDescription": "Use `encryptionContractConfiguration` to configure one or more content encryption keys for your endpoints that use SPEKE Version 2\\.0\\. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream\\. To configure the encryption contract, specify which audio and video encryption presets to use\\. \n*Required*: No \n*Type*: [EncryptionContractConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-encryptioncontractconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionContractConfiguration" }, "ResourceId": { - "markdownDescription": "Unique identifier for this endpoint, as it is configured in the key provider service\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Unique identifier for this endpoint, as it is configured in the key provider service\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceId", "type": "string" }, @@ -132096,7 +135476,7 @@ "items": { "type": "string" }, - "markdownDescription": "List of unique identifiers for the DRM systems to use, as defined in the CPIX specification\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "List of unique identifiers for the DRM systems to use, as defined in the CPIX specification\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SystemIds", "type": "array" }, @@ -132192,7 +135572,7 @@ }, "MssPackage": { "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.MssPackage", - "markdownDescription": "Parameters for Microsoft Smooth Streaming packaging\\. \n*Required*: No \n*Type*: [MssPackage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-msspackage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Parameters for Microsoft Smooth Streaming packaging\\. \n*Required*: No \n*Type*: [MssPackage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-msspackage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MssPackage" }, "PackagingGroupId": { @@ -132267,7 +135647,7 @@ "type": "array" }, "IncludeEncoderConfigurationInSegments": { - "markdownDescription": "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set \\(SPS\\), Picture Parameter Set \\(PPS\\), and Video Parameter Set \\(VPS\\) metadata in every video segment instead of in the init fragment\\. This lets you use different SPS/PPS/VPS settings for your assets during content playback\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When includeEncoderConfigurationInSegments is set to true, AWS Elemental MediaPackage places your encoder's Sequence Parameter Set \\(SPS\\), Picture Parameter Set \\(PPS\\), and Video Parameter Set \\(VPS\\) metadata in every video segment instead of in the init fragment\\. This lets you use different SPS/PPS/VPS settings for your assets during content playback\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeEncoderConfigurationInSegments", "type": "boolean" }, @@ -132320,11 +135700,13 @@ "type": "string" }, "ScteMarkersSource": { + "markdownDescription": "The source of scte markers used\\. \nValue description: \n+ `SEGMENTS` \\- The scte markers are sourced from the segments of the ingested content\\.\n+ `MANIFEST` \\- the scte markers are sourced from the manifest of the ingested content\\. The MANIFEST value is compatible with source HLS playlists using the SCTE\\-35 Enhanced syntax \\(`EXT-OATCLS-SCTE35` tags\\)\\. SCTE\\-35 Elemental and SCTE\\-35 Daterange syntaxes are not supported with this option\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ScteMarkersSource", "type": "string" }, "StreamSelection": { "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.StreamSelection", - "markdownDescription": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamSelection" } }, @@ -132347,18 +135729,20 @@ "title": "Encryption" }, "IncludeEncoderConfigurationInSegments": { - "markdownDescription": "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set \\(SPS\\), Picture Parameter Set \\(PPS\\), and Video Parameter Set \\(VPS\\) metadata in every video segment instead of in the init fragment\\. This lets you use different SPS/PPS/VPS settings for your assets during content playback\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When includeEncoderConfigurationInSegments is set to true, AWS Elemental MediaPackage places your encoder's Sequence Parameter Set \\(SPS\\), Picture Parameter Set \\(PPS\\), and Video Parameter Set \\(VPS\\) metadata in every video segment instead of in the init fragment\\. This lets you use different SPS/PPS/VPS settings for your assets during content playback\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeEncoderConfigurationInSegments", "type": "boolean" }, "IncludeIframeOnlyStream": { + "markdownDescription": "This applies only to stream sets with a single video track\\. When true, the stream set includes an additional I\\-frame trick\\-play only stream, along with the other tracks\\. If false, this extra stream is not included\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludeIframeOnlyStream", "type": "boolean" }, "PeriodTriggers": { "items": { "type": "string" }, - "markdownDescription": "Controls whether MediaPackage produces single\\-period or multi\\-period DASH manifests\\. For more information about periods, see [Multi\\-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html)\\. \nValid values: \n+ **ADS** \\- MediaPackage will produce multi\\-period DASH manifests\\. Periods are created based on the SCTE\\-35 ad markers present in the input manifest\\.\n+ *No value* \\- MediaPackage will produce single\\-period DASH manifests\\. This is the default setting\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Controls whether AWS Elemental MediaPackage produces single\\-period or multi\\-period DASH manifests\\. For more information about periods, see [Multi\\-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html)\\. \nValid values: \n+ **ADS** \\- AWS Elemental MediaPackage will produce multi\\-period DASH manifests\\. Periods are created based on the SCTE\\-35 ad markers present in the input manifest\\.\n+ *No value* \\- AWS Elemental MediaPackage will produce single\\-period DASH manifests\\. This is the default setting\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PeriodTriggers", "type": "array" }, @@ -132382,9 +135766,13 @@ "additionalProperties": false, "properties": { "PresetSpeke20Audio": { + "markdownDescription": "A collection of audio encryption presets\\. \nValue description: \n+ `PRESET-AUDIO-1` \\- Use one content key to encrypt all of the audio tracks in your stream\\.\n+ `PRESET-AUDIO-2` \\- Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks\\.\n+ `PRESET-AUDIO-3` \\- Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels\\.\n+ `SHARED` \\- Use the same content key for all of the audio and video tracks in your stream\\.\n+ `UNENCRYPTED` \\- Don't encrypt any of the audio tracks in your stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PresetSpeke20Audio", "type": "string" }, "PresetSpeke20Video": { + "markdownDescription": "A collection of video encryption presets\\. \nValue description: \n+ `PRESET-VIDEO-1` \\- Use one content key to encrypt all of the video tracks in your stream\\.\n+ `PRESET-VIDEO-2` \\- Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks\\.\n+ `PRESET-VIDEO-3` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-4` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `PRESET-VIDEO-5` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `PRESET-VIDEO-6` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-7` \\- Use one content key to encrypt all of the SD\\+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-8` \\- Use one content key to encrypt all of the SD\\+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `SHARED` \\- Use the same content key for all of the video and audio tracks in your stream\\.\n+ `UNENCRYPTED` \\- Don't encrypt any of the video tracks in your stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PresetSpeke20Video", "type": "string" } }, @@ -132398,12 +135786,12 @@ "additionalProperties": false, "properties": { "ConstantInitializationVector": { - "markdownDescription": "A 128\\-bit, 16\\-byte hex value represented by a 32\\-character string, used with the key for encrypting blocks\\. If you don't specify a constant initialization vector \\(IV\\), MediaPackage periodically rotates the IV\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A 128\\-bit, 16\\-byte hex value represented by a 32\\-character string, used with the key for encrypting blocks\\. If you don't specify a constant initialization vector \\(IV\\), AWS Elemental MediaPackage periodically rotates the IV\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConstantInitializationVector", "type": "string" }, "EncryptionMethod": { - "markdownDescription": "HLS encryption type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "HLS encryption type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EncryptionMethod", "type": "string" }, @@ -132422,7 +135810,7 @@ "additionalProperties": false, "properties": { "AdMarkers": { - "markdownDescription": "This setting controls ad markers in the packaged content\\. **NONE** omits SCTE\\-35 ad markers from the output\\. **PASSTHROUGH** copies SCTE\\-35 ad markers from the source content to the output\\. **SCTE35\\_ENHANCED** generates ad markers and blackout tags in the output, based on SCTE\\-35 messages in the source content\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This setting controls ad markers in the packaged content\\. \nValid values: \n+ **NONE** \\- Omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- Creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- Generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdMarkers", "type": "string" }, @@ -132471,6 +135859,8 @@ "type": "array" }, "IncludeDvbSubtitles": { + "markdownDescription": "When enabled, MediaPackage passes through digital video broadcasting \\(DVB\\) subtitles into the output\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludeDvbSubtitles", "type": "boolean" }, "SegmentDurationSeconds": { @@ -132536,7 +135926,7 @@ "type": "array" }, "SegmentDurationSeconds": { - "markdownDescription": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SegmentDurationSeconds", "type": "number" } @@ -132550,7 +135940,9 @@ "additionalProperties": false, "properties": { "EncryptionContractConfiguration": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.EncryptionContractConfiguration" + "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.EncryptionContractConfiguration", + "markdownDescription": "Use `encryptionContractConfiguration` to configure one or more content encryption keys for your endpoints that use SPEKE Version 2\\.0\\. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream\\. To configure the encryption contract, specify which audio and video encryption presets to use\\. \n*Required*: No \n*Type*: [EncryptionContractConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-encryptioncontractconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionContractConfiguration" }, "RoleArn": { "markdownDescription": "The ARN for the IAM role that's granted by the key provider to provide access to the key provider API\\. Valid format: arn:aws:iam::\\{accountID\\}:role/\\{name\\} \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -132561,7 +135953,7 @@ "items": { "type": "string" }, - "markdownDescription": "List of unique identifiers for the DRM systems to use, as defined in the CPIX specification\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "List of unique identifiers for the DRM systems to use, as defined in the CPIX specification\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SystemIds", "type": "array" }, @@ -132582,12 +135974,12 @@ "additionalProperties": false, "properties": { "MaxVideoBitsPerSecond": { - "markdownDescription": "The upper limit of the bitrates that this endpoint serves\\. If the video track exceeds this threshold, then AWS Elemental MediaPackage excludes it from output\\. If you don't specify a value, it defaults to 2147483647 bits per second\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The upper limit of the bitrates that this endpoint serves\\. If the video track exceeds this threshold, then AWS Elemental MediaPackage excludes it from output\\. If you don't specify a value, it defaults to 2147483647 bits per second\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxVideoBitsPerSecond", "type": "number" }, "MinVideoBitsPerSecond": { - "markdownDescription": "The lower limit of the bitrates that this endpoint serves\\. If the video track is below this threshold, then AWS Elemental MediaPackage excludes it from output\\. If you don't specify a value, it defaults to 0 bits per second\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The lower limit of the bitrates that this endpoint serves\\. If the video track is below this threshold, then AWS Elemental MediaPackage excludes it from output\\. If you don't specify a value, it defaults to 0 bits per second\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MinVideoBitsPerSecond", "type": "number" }, @@ -132693,7 +136085,7 @@ "type": "string" }, "SecretsRoleArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the IAM role that allows AWS Elemental MediaPackage to communicate with AWS Secrets Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsRoleArn", "type": "string" } @@ -132775,7 +136167,7 @@ }, "MetricPolicy": { "$ref": "#/definitions/AWS::MediaStore::Container.MetricPolicy", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [MetricPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-metricpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [MetricPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-metricpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricPolicy" }, "Policy": { @@ -132787,7 +136179,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -132939,57 +136331,87 @@ "additionalProperties": false, "properties": { "AdDecisionServerUrl": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdDecisionServerUrl", "type": "string" }, "AvailSuppression": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.AvailSuppression" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.AvailSuppression", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AvailSuppression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AvailSuppression" }, "Bumper": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.Bumper" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.Bumper", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Bumper](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-bumper.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Bumper" }, "CdnConfiguration": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.CdnConfiguration" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.CdnConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [CdnConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-cdnconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CdnConfiguration" }, "ConfigurationAliases": { "additionalProperties": true, + "markdownDescription": "The player parameters and aliases used as dynamic variables during session initialization\\. For more information, see [Domain Variables](https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html)\\. \n*Required*: No \n*Type*: Map of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "object" } }, + "title": "ConfigurationAliases", "type": "object" }, "DashConfiguration": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.DashConfiguration" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.DashConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DashConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DashConfiguration" }, "HlsConfiguration": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.HlsConfiguration" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.HlsConfiguration", + "markdownDescription": "The configuration for HLS content\\. \n*Required*: No \n*Type*: [HlsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-hlsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HlsConfiguration" }, "LivePreRollConfiguration": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.LivePreRollConfiguration" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.LivePreRollConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [LivePreRollConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LivePreRollConfiguration" }, "ManifestProcessingRules": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.ManifestProcessingRules" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.ManifestProcessingRules", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ManifestProcessingRules](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestprocessingrules.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManifestProcessingRules" }, "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "PersonalizationThresholdSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PersonalizationThresholdSeconds", "type": "number" }, "SlateAdUrl": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SlateAdUrl", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TranscodeProfileName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TranscodeProfileName", "type": "string" }, "VideoContentSourceUrl": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VideoContentSourceUrl", "type": "string" } }, @@ -133025,6 +136447,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" } }, @@ -133034,9 +136458,13 @@ "additionalProperties": false, "properties": { "Mode": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Mode", "type": "string" }, "Value": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -133046,9 +136474,13 @@ "additionalProperties": false, "properties": { "EndUrl": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndUrl", "type": "string" }, "StartUrl": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StartUrl", "type": "string" } }, @@ -133058,9 +136490,13 @@ "additionalProperties": false, "properties": { "AdSegmentUrlPrefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdSegmentUrlPrefix", "type": "string" }, "ContentSegmentUrlPrefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContentSegmentUrlPrefix", "type": "string" } }, @@ -133070,12 +136506,18 @@ "additionalProperties": false, "properties": { "ManifestEndpointPrefix": { + "markdownDescription": "The URL generated by MediaTailor to initiate a playback session\\. The session uses server\\-side reporting\\. This setting is ignored in PUT operations\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManifestEndpointPrefix", "type": "string" }, "MpdLocation": { + "markdownDescription": "The setting that controls whether MediaTailor includes the Location tag in DASH manifests\\. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects\\. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client\\-side reporting or your players support sticky HTTP redirects\\. Valid values are `DISABLED` and `EMT_DEFAULT`\\. The `EMT_DEFAULT` setting enables the inclusion of the tag and is the default value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MpdLocation", "type": "string" }, "OriginManifestType": { + "markdownDescription": "The setting that controls whether MediaTailor handles manifests from the origin server as multi\\-period manifests or single\\-period manifests\\. If your origin server produces single\\-period manifests, set this to `SINGLE_PERIOD`\\. The default setting is `MULTI_PERIOD`\\. For multi\\-period manifests, omit this setting or set it to `MULTI_PERIOD`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OriginManifestType", "type": "string" } }, @@ -133085,6 +136527,8 @@ "additionalProperties": false, "properties": { "ManifestEndpointPrefix": { + "markdownDescription": "The URL that is used to initiate a playback session for devices that support Apple HLS\\. The session uses server\\-side reporting\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManifestEndpointPrefix", "type": "string" } }, @@ -133094,9 +136538,13 @@ "additionalProperties": false, "properties": { "AdDecisionServerUrl": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdDecisionServerUrl", "type": "string" }, "MaxDurationSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxDurationSeconds", "type": "number" } }, @@ -133106,7 +136554,9 @@ "additionalProperties": false, "properties": { "AdMarkerPassthrough": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.AdMarkerPassthrough" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.AdMarkerPassthrough", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AdMarkerPassthrough](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-admarkerpassthrough.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdMarkerPassthrough" } }, "type": "object" @@ -133240,7 +136690,9 @@ "type": "boolean" }, "ClusterEndpoint": { - "$ref": "#/definitions/AWS::MemoryDB::Cluster.Endpoint" + "$ref": "#/definitions/AWS::MemoryDB::Cluster.Endpoint", + "markdownDescription": "The cluster's configuration endpoint\\. \n*Required*: No \n*Type*: [Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-cluster-endpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClusterEndpoint" }, "ClusterName": { "markdownDescription": "The name of the cluster\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -133248,6 +136700,8 @@ "type": "string" }, "DataTiering": { + "markdownDescription": "Enables data tiering\\. Data tiering is only supported for replication groups using the r6gd node type\\. This parameter must be set to true when using r6gd nodes\\. For more information, see [Data tiering](https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataTiering", "type": "string" }, "Description": { @@ -133276,7 +136730,7 @@ "type": "string" }, "NodeType": { - "markdownDescription": "The cluster's [node type](https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.supportedtypes.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The cluster's node type\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NodeType", "type": "string" }, @@ -133626,7 +137080,7 @@ }, "AuthenticationMode": { "$ref": "#/definitions/AWS::MemoryDB::User.AuthenticationMode", - "markdownDescription": "Denotes whether the user requires a password to authenticate\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Denotes whether the user requires a password to authenticate\\. \n**Example:**", "title": "AuthenticationMode" }, "Tags": { @@ -133678,9 +137132,13 @@ "items": { "type": "string" }, + "markdownDescription": "The password\\(s\\) used for authentication \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Passwords", "type": "array" }, "Type": { + "markdownDescription": "Indicates whether the user requires a password to authenticate\\. All newly\\-created users require a password\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `password` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -133929,7 +137387,7 @@ "type": "string" }, "Family": { - "markdownDescription": "Must be `neptune1`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Must be `neptune1` for engine versions prior to [1\\.2\\.0\\.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html), or `neptune1.2` for engine version `1.2.0.0` and higher\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Family", "type": "string" }, @@ -134036,7 +137494,7 @@ "type": "string" }, "DBInstanceClass": { - "markdownDescription": "Contains the name of the compute and memory capacity class of the DB instance\\. \nIf you update this property, some interruptions may occur\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains the name of the compute and memory capacity class of the DB instance\\. \nIf you update this property, some interruptions may occur\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "DBInstanceClass", "type": "string" }, @@ -134141,7 +137599,7 @@ "type": "string" }, "Family": { - "markdownDescription": "Must be `neptune1`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Must be `neptune1` for engine versions prior to [1\\.2\\.0\\.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html), or `neptune1.2` for engine version `1.2.0.0` and higher\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Family", "type": "string" }, @@ -134401,6 +137859,8 @@ "additionalProperties": false, "properties": { "IPAddressType": { + "markdownDescription": "The subnet's IP address type\\. You can't change the IP address type after you create the subnet\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DUALSTACK | IPV4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IPAddressType", "type": "string" }, "SubnetId": { @@ -134634,6 +138094,8 @@ "type": "string" }, "StreamExceptionPolicy": { + "markdownDescription": "Configures how Network Firewall processes traffic when a network connection breaks midstream\\. Network connections can break due to disruptions in external networks or within the firewall itself\\. \n+ `DROP` \\- Network Firewall fails closed and drops all subsequent traffic going to the firewall\\. This is the default behavior\\.\n+ `CONTINUE` \\- Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break\\. This impacts the behavior of rules that depend on this context\\. For example, if you have a stateful rule to `drop http` traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP\\. However, this behavior is rule dependent\u2014a TCP\\-layer rule using a `flow:stateless` rule would still match, as would the `aws:drop_strict` default action\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | DROP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StreamExceptionPolicy", "type": "string" } }, @@ -134643,6 +138105,8 @@ "additionalProperties": false, "properties": { "Action": { + "markdownDescription": "The action that changes the rule group from `DROP` to `ALERT`\\. This only applies to managed rule groups\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DROP_TO_ALERT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Action", "type": "string" } }, @@ -134652,7 +138116,9 @@ "additionalProperties": false, "properties": { "Override": { - "$ref": "#/definitions/AWS::NetworkFirewall::FirewallPolicy.StatefulRuleGroupOverride" + "$ref": "#/definitions/AWS::NetworkFirewall::FirewallPolicy.StatefulRuleGroupOverride", + "markdownDescription": "The action that allows the policy owner to override the behavior of the rule group within a policy\\. \n*Required*: No \n*Type*: [StatefulRuleGroupOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Override" }, "Priority": { "markdownDescription": "An integer setting that indicates the order in which to run the stateful rule groups in a single [AWS::NetworkFirewall::FirewallPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html)\\. This setting only applies to firewall policies that specify the `STRICT_ORDER` rule order in the stateful engine options settings\\. \nNetwork Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting\\. You must ensure that the priority settings are unique within each policy\\. \nYou can change the priority settings of your rule groups at any time\\. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -134929,7 +138395,7 @@ "additionalProperties": false, "properties": { "AddressDefinition": { - "markdownDescription": "Specify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^([a-fA-F\\d:\\.]+($|/\\d{1,3}))$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4 and IPv6\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^([a-fA-F\\d:\\.]+($|/\\d{1,3}))$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AddressDefinition", "type": "string" } @@ -134977,7 +138443,7 @@ "additionalProperties": false, "properties": { "Destination": { - "markdownDescription": "The destination IP address or address range to inspect for, in CIDR notation\\. To match with any address, specify `ANY`\\. \nSpecify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The destination IP address or address range to inspect for, in CIDR notation\\. To match with any address, specify `ANY`\\. \nSpecify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4 and IPv6\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Destination", "type": "string" }, @@ -134997,7 +138463,7 @@ "type": "string" }, "Source": { - "markdownDescription": "The source IP address or address range to inspect for, in CIDR notation\\. To match with any address, specify `ANY`\\. \nSpecify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The source IP address or address range to inspect for, in CIDR notation\\. To match with any address, specify `ANY`\\. \nSpecify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4 and IPv6\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Source", "type": "string" }, @@ -135035,6 +138501,8 @@ "additionalProperties": false, "properties": { "ReferenceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the resource to include in the [AWS::NetworkFirewall::RuleGroup IPSetReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-networkfirewall-rulegroup-ipsetreference.html#aws-properties-networkfirewall-rulegroup-ipsetreference)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^arn:aws.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReferenceArn", "type": "string" } }, @@ -135150,11 +138618,13 @@ "properties": { "IPSetReferences": { "additionalProperties": false, + "markdownDescription": "The IP set references to use in the stateful rule group\\. \n*Required*: No \n*Type*: Map of [IPSetReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ipsetreference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.IPSetReference" } }, + "title": "IPSetReferences", "type": "object" } }, @@ -135187,7 +138657,9 @@ "additionalProperties": false, "properties": { "ReferenceSets": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.ReferenceSets" + "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.ReferenceSets", + "markdownDescription": "The reference sets for the stateful rule group\\. \n*Required*: No \n*Type*: [ReferenceSets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-referencesets.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReferenceSets" }, "RuleVariables": { "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.RuleVariables", @@ -135277,7 +138749,7 @@ "items": { "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.StatefulRule" }, - "markdownDescription": "An array of individual stateful rules inspection criteria to be used together in a stateful rule group\\. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options\\. For information about the Suricata `Rules` format, see [Rules Format](https://suricata.readthedocs.io/en/suricata-5.0.0/rules/intro.html#)\\. \n*Required*: No \n*Type*: List of [StatefulRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of individual stateful rules inspection criteria to be used together in a stateful rule group\\. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options\\. For information about the Suricata `Rules` format, see [Rules Format](https://suricata.readthedocs.io/rules/intro.html#)\\. \n*Required*: No \n*Type*: List of [StatefulRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StatefulRules", "type": "array" }, @@ -135325,7 +138797,7 @@ "additionalProperties": false, "properties": { "Action": { - "markdownDescription": "Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria\\. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow\\. \nThe actions for a stateful rule are defined as follows: \n+ **PASS** \\- Permits the packets to go to the intended destination\\.\n+ **DROP** \\- Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the firewall's [AWS::NetworkFirewall::LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html)\\. \n+ **ALERT** \\- Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the firewall's [AWS::NetworkFirewall::LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html)\\.", + "markdownDescription": "Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria\\. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow\\. \nThe actions for a stateful rule are defined as follows: \n+ **PASS** \\- Permits the packets to go to the intended destination\\.\n+ **DROP** \\- Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the [AWS::NetworkFirewall::Firewall](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html) [AWS::NetworkFirewall::LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html)\\. \n+ **ALERT** \\- Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the [AWS::NetworkFirewall::Firewall](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html) [AWS::NetworkFirewall::LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html)\\.", "title": "Action", "type": "string" }, @@ -135467,21 +138939,31 @@ "additionalProperties": false, "properties": { "CoreNetworkId": { + "markdownDescription": "The ID of the core network where the Connect attachment is located\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CoreNetworkId", "type": "string" }, "EdgeLocation": { + "markdownDescription": "The Region where the edge is located\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EdgeLocation", "type": "string" }, "Options": { - "$ref": "#/definitions/AWS::NetworkManager::ConnectAttachment.ConnectAttachmentOptions" + "$ref": "#/definitions/AWS::NetworkManager::ConnectAttachment.ConnectAttachmentOptions", + "markdownDescription": "Options for connecting an attachment\\. \n*Required*: Yes \n*Type*: [ConnectAttachmentOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectattachment-connectattachmentoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Options" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TransportAttachmentId": { + "markdownDescription": "The ID of the transport attachment\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `50` \n*Pattern*: `^attachment-([0-9a-f]{8,17})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TransportAttachmentId", "type": "string" } }, @@ -135518,6 +139000,8 @@ "additionalProperties": false, "properties": { "Protocol": { + "markdownDescription": "The protocol used for the attachment connection\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GRE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Protocol", "type": "string" } }, @@ -135527,15 +139011,21 @@ "additionalProperties": false, "properties": { "AttachmentPolicyRuleNumber": { + "markdownDescription": "The rule number in the policy document that applies to this change\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AttachmentPolicyRuleNumber", "type": "number" }, "SegmentName": { + "markdownDescription": "The name of the segment to change\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SegmentName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value tags that changed for the segment\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -135577,27 +139067,39 @@ "additionalProperties": false, "properties": { "BgpOptions": { - "$ref": "#/definitions/AWS::NetworkManager::ConnectPeer.BgpOptions" + "$ref": "#/definitions/AWS::NetworkManager::ConnectPeer.BgpOptions", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [BgpOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-bgpoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BgpOptions" }, "ConnectAttachmentId": { + "markdownDescription": "The ID of the attachment to connect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `50` \n*Pattern*: `^attachment-([0-9a-f]{8,17})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConnectAttachmentId", "type": "string" }, "CoreNetworkAddress": { + "markdownDescription": "The IP address of a core network\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CoreNetworkAddress", "type": "string" }, "InsideCidrBlocks": { "items": { "type": "string" }, + "markdownDescription": "The inside IP addresses used for a Connect peer configuration\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InsideCidrBlocks", "type": "array" }, "PeerAddress": { + "markdownDescription": "The IP address of the Connect peer\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PeerAddress", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value tags associated with the Connect peer\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -135633,6 +139135,8 @@ "additionalProperties": false, "properties": { "PeerAsn": { + "markdownDescription": "The Peer ASN of the BGP\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PeerAsn", "type": "number" } }, @@ -135642,15 +139146,23 @@ "additionalProperties": false, "properties": { "CoreNetworkAddress": { + "markdownDescription": "The address of a core network\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CoreNetworkAddress", "type": "string" }, "CoreNetworkAsn": { + "markdownDescription": "The ASN of the Coret Network\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CoreNetworkAsn", "type": "number" }, "PeerAddress": { + "markdownDescription": "The address of a core network Connect peer\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PeerAddress", "type": "string" }, "PeerAsn": { + "markdownDescription": "The ASN of the Connect peer\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PeerAsn", "type": "number" } }, @@ -135663,21 +139175,31 @@ "items": { "$ref": "#/definitions/AWS::NetworkManager::ConnectPeer.ConnectPeerBgpConfiguration" }, + "markdownDescription": "The Connect peer BGP configurations\\. \n*Required*: No \n*Type*: List of [ConnectPeerBgpConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerbgpconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BgpConfigurations", "type": "array" }, "CoreNetworkAddress": { + "markdownDescription": "The IP address of a core network\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CoreNetworkAddress", "type": "string" }, "InsideCidrBlocks": { "items": { "type": "string" }, + "markdownDescription": "The inside IP addresses used for a Connect peer configuration\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InsideCidrBlocks", "type": "array" }, "PeerAddress": { + "markdownDescription": "The IP address of the Connect peer\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PeerAddress", "type": "string" }, "Protocol": { + "markdownDescription": "The protocol used for a Connect peer configuration\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GRE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Protocol", "type": "string" } }, @@ -135719,18 +139241,26 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of a core network\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "GlobalNetworkId": { + "markdownDescription": "The ID of the global network that your core network is a part of\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "GlobalNetworkId", "type": "string" }, "PolicyDocument": { + "markdownDescription": "Describes a core network policy\\. For more information, see [Core network policies](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-policy-changesets.html)\\. \nIf you update the policy document, CloudFormation will apply the core network change set generated from the updated policy document, and then set it as the LIVE policy\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyDocument", "type": "object" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value tags associated with a core network\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -135764,15 +139294,21 @@ "additionalProperties": false, "properties": { "Asn": { + "markdownDescription": "The ASN of a core network edge\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Asn", "type": "number" }, "EdgeLocation": { + "markdownDescription": "The Region where a core network edge is located\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EdgeLocation", "type": "string" }, "InsideCidrBlocks": { "items": { "type": "string" }, + "markdownDescription": "The inside IP addresses used for core network edges\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InsideCidrBlocks", "type": "array" } }, @@ -135785,15 +139321,21 @@ "items": { "type": "string" }, + "markdownDescription": "The Regions where the edges are located\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EdgeLocations", "type": "array" }, "Name": { + "markdownDescription": "The name of a core network segment\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "SharedSegments": { "items": { "type": "string" }, + "markdownDescription": "The shared segments of a core network\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SharedSegments", "type": "array" } }, @@ -136424,15 +139966,21 @@ "additionalProperties": false, "properties": { "CoreNetworkId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CoreNetworkId", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "VpnConnectionArn": { + "markdownDescription": "The ARN of the site\\-to\\-site VPN attachment\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:vpn-connection\\/vpn-[0-9a-f]{8,17}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VpnConnectionArn", "type": "string" } }, @@ -136467,15 +140015,21 @@ "additionalProperties": false, "properties": { "AttachmentPolicyRuleNumber": { + "markdownDescription": "The rule number in the policy document that applies to this change\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AttachmentPolicyRuleNumber", "type": "number" }, "SegmentName": { + "markdownDescription": "The name of the segment to change\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SegmentName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value tags that changed for the segment\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -136517,15 +140071,21 @@ "additionalProperties": false, "properties": { "CoreNetworkId": { + "markdownDescription": "The ID of the core network\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CoreNetworkId", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value tags associated with the peering\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TransitGatewayArn": { + "markdownDescription": "The ARN of the transit gateway\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TransitGatewayArn", "type": "string" } }, @@ -136665,24 +140225,34 @@ "additionalProperties": false, "properties": { "CoreNetworkId": { + "markdownDescription": "The core network ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CoreNetworkId", "type": "string" }, "Options": { - "$ref": "#/definitions/AWS::NetworkManager::VpcAttachment.VpcOptions" + "$ref": "#/definitions/AWS::NetworkManager::VpcAttachment.VpcOptions", + "markdownDescription": "Options for creating the VPC attachment\\. \n*Required*: No \n*Type*: [VpcOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-vpcoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Options" }, "SubnetArns": { "items": { "type": "string" }, + "markdownDescription": "The subnet ARNs\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetArns", "type": "array" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags associated with the VPC attachment\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "VpcArn": { + "markdownDescription": "The ARN of the VPC attachment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VpcArn", "type": "string" } }, @@ -136718,15 +140288,21 @@ "additionalProperties": false, "properties": { "AttachmentPolicyRuleNumber": { + "markdownDescription": "The rule number in the policy document that applies to this change\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AttachmentPolicyRuleNumber", "type": "number" }, "SegmentName": { + "markdownDescription": "The name of the segment to change\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SegmentName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value tags that changed for the segment\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -136736,9 +140312,13 @@ "additionalProperties": false, "properties": { "ApplianceModeSupport": { + "markdownDescription": "Indicates whether appliance mode is supported\\. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApplianceModeSupport", "type": "boolean" }, "Ipv6Support": { + "markdownDescription": "Indicates whether IPv6 is supported\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Ipv6Support", "type": "boolean" } }, @@ -136870,10 +140450,12 @@ "additionalProperties": false, "properties": { "AutomaticTerminationMode": { + "markdownDescription": "Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a `STOPPED` state\\. \n+ When `ACTIVATED`, the streaming session is scheduled for termination after being in the `STOPPED` state for the time specified in `maxStoppedSessionLengthInMinutes`\\.\n+ When `DEACTIVATED`, the streaming session can remain in the `STOPPED` state indefinitely\\.\nThis parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED`\\. When allowed, the default value for this parameter is `DEACTIVATED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutomaticTerminationMode", "type": "string" }, "ClipboardMode": { - "markdownDescription": "Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClipboardMode", "type": "string" }, @@ -136891,19 +140473,23 @@ "type": "number" }, "MaxStoppedSessionLengthInMinutes": { - "markdownDescription": "Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state\\. The default value is 0\\. The maximum value is 5760\\. \nIf the value is missing or set to 0, your sessions can\u2019t be stopped\\. If you then call `StopStreamingSession`, the session fails\\. If the time that a session stays in the READY state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be terminated \\(instead of stopped\\)\\. \nIf the value is set to a positive number, the session can be stopped\\. You can call `StopStreamingSession` to stop sessions in the READY state\\. If the time that a session stays in the READY state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be stopped \\(instead of terminated\\)\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Integer that determines if you can start and stop your sessions and how long a session can stay in the `STOPPED` state\\. The default value is 0\\. The maximum value is 5760\\. \nThis field is allowed only when `sessionPersistenceMode` is `ACTIVATED` and `automaticTerminationMode` is `ACTIVATED`\\. \nIf the value is set to 0, your sessions can\u2019t be `STOPPED`\\. If you then call `StopStreamingSession`, the session fails\\. If the time that a session stays in the `READY` state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be terminated \\(instead of `STOPPED`\\)\\. \nIf the value is set to a positive number, the session can be stopped\\. You can call `StopStreamingSession` to stop sessions in the `READY` state\\. If the time that a session stays in the `READY` state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be stopped \\(instead of terminated\\)\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxStoppedSessionLengthInMinutes", "type": "number" }, "SessionBackup": { - "$ref": "#/definitions/AWS::NimbleStudio::LaunchProfile.StreamConfigurationSessionBackup" + "$ref": "#/definitions/AWS::NimbleStudio::LaunchProfile.StreamConfigurationSessionBackup", + "markdownDescription": "Information about the streaming session backup\\. \n*Required*: No \n*Type*: [StreamConfigurationSessionBackup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionbackup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionBackup" }, "SessionPersistenceMode": { + "markdownDescription": "Determine if a streaming session created from this launch profile can configure persistent storage\\. This means that `volumeConfiguration` and `automaticTerminationMode` are configured\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionPersistenceMode", "type": "string" }, "SessionStorage": { "$ref": "#/definitions/AWS::NimbleStudio::LaunchProfile.StreamConfigurationSessionStorage", - "markdownDescription": "\\(Optional\\) The upload storage for a streaming session\\. \n*Required*: No \n*Type*: [StreamConfigurationSessionStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionstorage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The upload storage for a streaming session\\. \n*Required*: No \n*Type*: [StreamConfigurationSessionStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionstorage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SessionStorage" }, "StreamingImageIds": { @@ -136915,7 +140501,9 @@ "type": "array" }, "VolumeConfiguration": { - "$ref": "#/definitions/AWS::NimbleStudio::LaunchProfile.VolumeConfiguration" + "$ref": "#/definitions/AWS::NimbleStudio::LaunchProfile.VolumeConfiguration", + "markdownDescription": "Custom volume configuration for the root volumes that are attached to streaming sessions\\. \nThis parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED`\\. \n*Required*: No \n*Type*: [VolumeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VolumeConfiguration" } }, "required": [ @@ -136929,9 +140517,13 @@ "additionalProperties": false, "properties": { "MaxBackupsToRetain": { + "markdownDescription": "The maximum number of backups that each streaming session created from this launch profile can have\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxBackupsToRetain", "type": "number" }, "Mode": { + "markdownDescription": "Specifies how artists sessions are backed up\\. \nConfigures backups for streaming sessions launched with this launch profile\\. The default value is `DEACTIVATED`, which means that backups are deactivated\\. To allow backups, set this value to `AUTOMATIC`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Mode", "type": "string" } }, @@ -136944,7 +140536,7 @@ "items": { "type": "string" }, - "markdownDescription": "Allows artists to upload files to their workstations\\. The only valid option is `UPLOAD`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Allows artists to upload files to their workstations\\. The only valid option is `UPLOAD`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Mode", "type": "array" }, @@ -136979,12 +140571,18 @@ "additionalProperties": false, "properties": { "Iops": { + "markdownDescription": "The number of I/O operations per second for the root volume that is attached to streaming session\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Iops", "type": "number" }, "Size": { + "markdownDescription": "The size of the root volume that is attached to the streaming session\\. The root volume size is measured in GiBs\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Size", "type": "number" }, "Throughput": { + "markdownDescription": "The throughput to provision for the root volume that is attached to the streaming session\\. The throughput is measured in MiB/s\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Throughput", "type": "number" } }, @@ -137089,9 +140687,13 @@ "additionalProperties": false, "properties": { "KeyArn": { + "markdownDescription": "The ARN for a KMS key that is used to encrypt studio data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KeyArn", "type": "string" }, "KeyType": { + "markdownDescription": "The type of KMS key that is used to encrypt studio data\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KeyType", "type": "string" } }, @@ -137377,7 +140979,7 @@ "type": "array" }, "DirectoryId": { - "markdownDescription": "The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The directory ID of the AWS Directory Service for Microsoft Active Directory to access using this studio component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DirectoryId", "type": "string" }, @@ -137468,7 +141070,7 @@ "properties": { "ActiveDirectoryConfiguration": { "$ref": "#/definitions/AWS::NimbleStudio::StudioComponent.ActiveDirectoryConfiguration", - "markdownDescription": "The configuration for a Microsoft Active Directory \\(Microsoft AD\\) studio resource\\. \n*Required*: No \n*Type*: [ActiveDirectoryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectoryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The configuration for a AWS Directory Service for Microsoft Active Directory studio resource\\. \n*Required*: No \n*Type*: [ActiveDirectoryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectoryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ActiveDirectoryConfiguration" }, "ComputeFarmConfiguration": { @@ -137498,7 +141100,7 @@ "type": "string" }, "Platform": { - "markdownDescription": "The platform of the initialization script, either WINDOWS or LINUX\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The platform of the initialization script, either Windows or Linux\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Platform", "type": "string" }, @@ -137712,30 +141314,44 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description for the store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the Annotation Store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Reference": { - "$ref": "#/definitions/AWS::Omics::AnnotationStore.ReferenceItem" + "$ref": "#/definitions/AWS::Omics::AnnotationStore.ReferenceItem", + "markdownDescription": "The genome reference for the store's annotations\\. \n*Required*: No \n*Type*: [ReferenceItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-referenceitem.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Reference" }, "SseConfig": { - "$ref": "#/definitions/AWS::Omics::AnnotationStore.SseConfig" + "$ref": "#/definitions/AWS::Omics::AnnotationStore.SseConfig", + "markdownDescription": "The store's server\\-side encryption \\(SSE\\) settings\\. \n*Required*: No \n*Type*: [SseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-sseconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SseConfig" }, "StoreFormat": { + "markdownDescription": "The annotation file format of the store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StoreFormat", "type": "string" }, "StoreOptions": { - "$ref": "#/definitions/AWS::Omics::AnnotationStore.StoreOptions" + "$ref": "#/definitions/AWS::Omics::AnnotationStore.StoreOptions", + "markdownDescription": "File parsing options for the annotation store\\. \n*Required*: No \n*Type*: [StoreOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-storeoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StoreOptions" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tags for the store\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -137770,6 +141386,8 @@ "additionalProperties": false, "properties": { "ReferenceArn": { + "markdownDescription": "The reference's ARN\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ReferenceArn", "type": "string" } }, @@ -137782,9 +141400,13 @@ "additionalProperties": false, "properties": { "KeyArn": { + "markdownDescription": "An encryption key ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KeyArn", "type": "string" }, "Type": { + "markdownDescription": "The encryption type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -137797,7 +141419,9 @@ "additionalProperties": false, "properties": { "TsvStoreOptions": { - "$ref": "#/definitions/AWS::Omics::AnnotationStore.TsvStoreOptions" + "$ref": "#/definitions/AWS::Omics::AnnotationStore.TsvStoreOptions", + "markdownDescription": "Formatting options for a TSV file\\. \n*Required*: Yes \n*Type*: [TsvStoreOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-tsvstoreoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TsvStoreOptions" } }, "required": [ @@ -137809,18 +141433,24 @@ "additionalProperties": false, "properties": { "AnnotationType": { + "markdownDescription": "The store's annotation type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AnnotationType", "type": "string" }, "FormatToHeader": { "additionalProperties": true, + "markdownDescription": "The store's header key to column name mapping\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "FormatToHeader", "type": "object" }, "Schema": { + "markdownDescription": "The schema of an annotation store\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Schema", "type": "object" } }, @@ -137862,21 +141492,29 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description for the store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A name for the store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SseConfig": { - "$ref": "#/definitions/AWS::Omics::ReferenceStore.SseConfig" + "$ref": "#/definitions/AWS::Omics::ReferenceStore.SseConfig", + "markdownDescription": "Server\\-side encryption \\(SSE\\) settings for the store\\. \n*Required*: No \n*Type*: [SseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-referencestore-sseconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SseConfig" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tags for the store\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -137910,9 +141548,13 @@ "additionalProperties": false, "properties": { "KeyArn": { + "markdownDescription": "An encryption key ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KeyArn", "type": "string" }, "Type": { + "markdownDescription": "The encryption type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -137957,24 +141599,34 @@ "additionalProperties": false, "properties": { "MaxCpus": { + "markdownDescription": "The group's maximum CPU count setting\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `1` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxCpus", "type": "number" }, "MaxDuration": { + "markdownDescription": "The group's maximum duration setting in minutes\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `1` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxDuration", "type": "number" }, "MaxRuns": { + "markdownDescription": "The group's maximum concurrent run setting\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `1` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxRuns", "type": "number" }, "Name": { + "markdownDescription": "The group's name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tags for the group\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -138036,21 +141688,29 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description for the store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A name for the store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SseConfig": { - "$ref": "#/definitions/AWS::Omics::SequenceStore.SseConfig" + "$ref": "#/definitions/AWS::Omics::SequenceStore.SseConfig", + "markdownDescription": "Server\\-side encryption \\(SSE\\) settings for the store\\. \n*Required*: No \n*Type*: [SseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-sequencestore-sseconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SseConfig" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tags for the store\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -138084,9 +141744,13 @@ "additionalProperties": false, "properties": { "KeyArn": { + "markdownDescription": "An encryption key ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KeyArn", "type": "string" }, "Type": { + "markdownDescription": "The encryption type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -138131,24 +141795,34 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description for the store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A name for the store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Reference": { - "$ref": "#/definitions/AWS::Omics::VariantStore.ReferenceItem" + "$ref": "#/definitions/AWS::Omics::VariantStore.ReferenceItem", + "markdownDescription": "The genome reference for the store's variants\\. \n*Required*: Yes \n*Type*: [ReferenceItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-referenceitem.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Reference" }, "SseConfig": { - "$ref": "#/definitions/AWS::Omics::VariantStore.SseConfig" + "$ref": "#/definitions/AWS::Omics::VariantStore.SseConfig", + "markdownDescription": "Server\\-side encryption \\(SSE\\) settings for the store\\. \n*Required*: No \n*Type*: [SseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-sseconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SseConfig" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tags for the store\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -138183,6 +141857,8 @@ "additionalProperties": false, "properties": { "ReferenceArn": { + "markdownDescription": "The reference's ARN\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ReferenceArn", "type": "string" } }, @@ -138195,9 +141871,13 @@ "additionalProperties": false, "properties": { "KeyArn": { + "markdownDescription": "An encryption key ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KeyArn", "type": "string" }, "Type": { + "markdownDescription": "The encryption type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -138242,39 +141922,55 @@ "additionalProperties": false, "properties": { "DefinitionUri": { + "markdownDescription": "The URI of a definition for the workflow\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DefinitionUri", "type": "string" }, "Description": { + "markdownDescription": "The parameter's description\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Engine": { + "markdownDescription": "An engine for the workflow\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NEXTFLOW | WDL` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Engine", "type": "string" }, "Main": { + "markdownDescription": "The path of the main definition file for the workflow\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Main", "type": "string" }, "Name": { + "markdownDescription": "The workflow's name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ParameterTemplate": { "additionalProperties": false, + "markdownDescription": "The workflow's parameter template\\. \n*Required*: No \n*Type*: Map of [WorkflowParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::Omics::Workflow.WorkflowParameter" } }, + "title": "ParameterTemplate", "type": "object" }, "StorageCapacity": { + "markdownDescription": "A storage capacity for the workflow in gigabytes\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Maximum*: `100000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StorageCapacity", "type": "number" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tags for the workflow\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -138304,9 +142000,13 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The parameter's description\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Description", "type": "string" }, "Optional": { + "markdownDescription": "Whether the parameter is optional\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Optional", "type": "boolean" } }, @@ -138348,15 +142048,23 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Policy": { + "markdownDescription": "The JSON policy document without any whitespaces\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Policy", "type": "string" }, "Type": { + "markdownDescription": "The type of access policy\\. Currently the only option is `data`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -138418,18 +142126,26 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description of the collection\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the collection\\. \nCollection names must meet the following criteria: \n+ Starts with a lowercase letter\n+ Unique to your account and AWS Region\n+ Contains between 3 and 28 characters\n+ Contains only lowercase letters a\\-z, the numbers 0\\-9, and the hyphen \\(\\-\\)\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An arbitrary set of tags \\(key\u2013value pairs\\) to associate with the collection\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Tags", "type": "array" }, "Type": { + "markdownDescription": "The type of collection\\. Possible values are `SEARCH` and `TIMESERIES`\\. For more information, see [Choosing a collection type](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-usecase)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -138495,15 +142211,23 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the security configuration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the security configuration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SamlOptions": { - "$ref": "#/definitions/AWS::OpenSearchServerless::SecurityConfig.SamlConfigOptions" + "$ref": "#/definitions/AWS::OpenSearchServerless::SecurityConfig.SamlConfigOptions", + "markdownDescription": "SAML options for the security configuration in the form of a key\\-value map\\. \n*Required*: No \n*Type*: [SamlConfigOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SamlOptions" }, "Type": { + "markdownDescription": "The type of security configuration\\. Currently the only option is `saml`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -138533,15 +142257,23 @@ "additionalProperties": false, "properties": { "GroupAttribute": { + "markdownDescription": "The group attribute for this SAML integration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GroupAttribute", "type": "string" }, "Metadata": { + "markdownDescription": "The XML IdP metadata file generated from your identity provider\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Metadata", "type": "string" }, "SessionTimeout": { + "markdownDescription": "The session timeout, in minutes\\. Default is 60 minutes \\(12 hours\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionTimeout", "type": "number" }, "UserAttribute": { + "markdownDescription": "A user attribute for this SAML integration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserAttribute", "type": "string" } }, @@ -138586,15 +142318,23 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the security policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Policy": { + "markdownDescription": "The JSON policy document without any whitespaces\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Policy", "type": "string" }, "Type": { + "markdownDescription": "The type of security policy\\. Can be either `encryption` or `network`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -138660,21 +142400,29 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SecurityGroupIds": { "items": { "type": "string" }, + "markdownDescription": "The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroupIds", "type": "array" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "The ID of the subnets from which you access OpenSearch Serverless\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetIds", "type": "array" }, "VpcId": { + "markdownDescription": "The ID of the VPC from which you access OpenSearch Serverless\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VpcId", "type": "string" } }, @@ -138747,7 +142495,7 @@ }, "AdvancedOptions": { "additionalProperties": true, - "markdownDescription": "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\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Additional options to specify for the OpenSearch Service domain\\. For more information, see [AdvancedOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CreateDomain.html#API_CreateDomain_RequestBody) in the OpenSearch Service API reference\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -138758,12 +142506,12 @@ }, "AdvancedSecurityOptions": { "$ref": "#/definitions/AWS::OpenSearchService::Domain.AdvancedSecurityOptionsInput", - "markdownDescription": "Specifies options for fine\\-grained access control\\. \n*Required*: No \n*Type*: [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies options for fine\\-grained access control and SAML authentication\\. \nIf you specify advanced security options, you must also enable node\\-to\\-node encryption \\([NodeToNodeEncryptionOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodetonodeencryptionoptions.html)\\) and encryption at rest \\([EncryptionAtRestOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html)\\)\\. You must also enable `EnforceHTTPS` within [DomainEndpointOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html), which requires HTTPS for all traffic to the domain\\. \n*Required*: No \n*Type*: [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdvancedSecurityOptions" }, "ClusterConfig": { "$ref": "#/definitions/AWS::OpenSearchService::Domain.ClusterConfig", - "markdownDescription": "`ClusterConfig` is a property of the AWS::OpenSearchService::Domain resource that configures an Amazon OpenSearch Service cluster\\. \n*Required*: No \n*Type*: [ClusterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Container for the cluster configuration of a domain\\. \n*Required*: No \n*Type*: [ClusterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClusterConfig" }, "CognitoOptions": { @@ -138777,7 +142525,7 @@ "title": "DomainEndpointOptions" }, "DomainName": { - "markdownDescription": "A name for the OpenSearch Service domain\\. For valid values, see the [DomainName](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname) data type in the *Amazon OpenSearch Service Developer Guide*\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nRequired when creating a new domain\\. \nIf you specify a name, you can't perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A name for the OpenSearch Service domain\\. The name must have a minimum length of 3 and a maximum length of 28\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nRequired when creating a new domain\\. \nIf you specify a name, you can't perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DomainName", "type": "string" }, @@ -138792,7 +142540,7 @@ "title": "EncryptionAtRestOptions" }, "EngineVersion": { - "markdownDescription": "The version of OpenSearch to use\\. The value must be in the format `OpenSearch_X.Y` or `Elasticsearch_X.Y`\\. If not specified, the latest version of OpenSearch is used\\. For information about the versions that OpenSearch Service supports, see [Supported versions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide*\\. \nIf you set the [EnableVersionUpgrade](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain) update policy to `true`, you can update `EngineVersion` without interruption\\. When `EnableVersionUpgrade` is set to `false`, or is not specified, updating `EngineVersion` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of OpenSearch to use\\. The value must be in the format `OpenSearch_X.Y` or `Elasticsearch_X.Y`\\. If not specified, the latest version of OpenSearch is used\\. For information about the versions that OpenSearch Service supports, see [Supported versions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide*\\. \nIf you set the [EnableVersionUpgrade](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain) update policy to `true`, you can update `EngineVersion` without interruption\\. When `EnableVersionUpgrade` is set to `false`, or is not specified, updating `EngineVersion` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `14` \n*Maximum*: `18` \n*Pattern*: `^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EngineVersion", "type": "string" }, @@ -138814,7 +142562,7 @@ }, "SnapshotOptions": { "$ref": "#/definitions/AWS::OpenSearchService::Domain.SnapshotOptions", - "markdownDescription": "**DEPRECATED**\\. The automated snapshot configuration for the OpenSearch Service domain indices\\. \n*Required*: No \n*Type*: [SnapshotOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-snapshotoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**DEPRECATED**\\. The automated snapshot configuration for the OpenSearch Service domain indexes\\. \n*Required*: No \n*Type*: [SnapshotOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-snapshotoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SnapshotOptions" }, "Tags": { @@ -138827,7 +142575,7 @@ }, "VPCOptions": { "$ref": "#/definitions/AWS::OpenSearchService::Domain.VPCOptions", - "markdownDescription": "The virtual private cloud \\(VPC\\) configuration for the OpenSearch Service domain\\. For more information, see [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer Guide*\\. \n*Required*: No \n*Type*: [VPCOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-vpcoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The virtual private cloud \\(VPC\\) configuration for the OpenSearch Service domain\\. For more information, see [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer Guide*\\. \nIf you remove this entity altogether, along with its associated properties, it causes a replacement\\. You might encounter this scenario if you're updating your security configuration from a VPC to a public endpoint\\. \n*Required*: No \n*Type*: [VPCOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-vpcoptions.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "VPCOptions" } }, @@ -138857,28 +142605,34 @@ "additionalProperties": false, "properties": { "AnonymousAuthDisableDate": { + "markdownDescription": "Date and time when the migration period will be disabled\\. Only necessary when [enabling fine\\-grained access control on an existing domain](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AnonymousAuthDisableDate", "type": "string" }, "AnonymousAuthEnabled": { + "markdownDescription": "True to enable a 30\\-day migration period during which administrators can create role mappings\\. Only necessary when [enabling fine\\-grained access control on an existing domain](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AnonymousAuthEnabled", "type": "boolean" }, "Enabled": { - "markdownDescription": "True to enable fine\\-grained access control\\. You must also enable encryption of data at rest and node\\-to\\-node encryption\\. See [Fine\\-grained access control in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "True to enable fine\\-grained access control\\. You must also enable encryption of data at rest and node\\-to\\-node encryption\\. See [Fine\\-grained access control in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, "InternalUserDatabaseEnabled": { - "markdownDescription": "True to enable the internal user database\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "True to enable the internal user database\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InternalUserDatabaseEnabled", "type": "boolean" }, "MasterUserOptions": { "$ref": "#/definitions/AWS::OpenSearchService::Domain.MasterUserOptions", - "markdownDescription": "Specifies information about the master user\\. \n*Required*: No \n*Type*: [MasterUserOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies information about the master user\\. \n*Required*: No \n*Type*: [MasterUserOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserOptions" }, "SAMLOptions": { - "$ref": "#/definitions/AWS::OpenSearchService::Domain.SAMLOptions" + "$ref": "#/definitions/AWS::OpenSearchService::Domain.SAMLOptions", + "markdownDescription": "Container for information about the SAML configuration for OpenSearch Dashboards\\. \n*Required*: No \n*Type*: [SAMLOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SAMLOptions" } }, "type": "object" @@ -138897,7 +142651,7 @@ "type": "boolean" }, "DedicatedMasterType": { - "markdownDescription": "The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.search`\\. 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)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.search`\\. 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)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | c4.large.search | c4.xlarge.search | c5.18xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.large.search | c5.xlarge.search | c6g.12xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.large.search | c6g.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | d2.xlarge.search | i2.2xlarge.search | i2.xlarge.search | i3.16xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.large.search | i3.xlarge.search | m3.2xlarge.search | m3.large.search | m3.medium.search | m3.xlarge.search | m4.10xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.large.search | m4.xlarge.search | m5.12xlarge.search | m5.24xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.large.search | m5.xlarge.search | m6g.12xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.large.search | m6g.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | r3.large.search | r3.xlarge.search | r4.16xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.large.search | r4.xlarge.search | r5.12xlarge.search | r5.24xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.large.search | r5.xlarge.search | r6g.12xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.large.search | r6g.xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.large.search | r6gd.xlarge.search | t2.medium.search | t2.micro.search | t2.small.search | t3.2xlarge.search | t3.large.search | t3.medium.search | t3.micro.search | t3.nano.search | t3.small.search | t3.xlarge.search | t4g.medium.search | t4g.small.search | ultrawarm1.large.search | ultrawarm1.medium.search | ultrawarm1.xlarge.search` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DedicatedMasterType", "type": "string" }, @@ -138907,7 +142661,7 @@ "type": "number" }, "InstanceType": { - "markdownDescription": "The instance type for your data nodes, such as `m3.medium.search`\\. For valid values, see [Supported instance types in Amazon OpenSearch Service ](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The instance type for your data nodes, such as `m3.medium.search`\\. For valid values, see [Supported instance types in Amazon OpenSearch Service ](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | c4.large.search | c4.xlarge.search | c5.18xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.large.search | c5.xlarge.search | c6g.12xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.large.search | c6g.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | d2.xlarge.search | i2.2xlarge.search | i2.xlarge.search | i3.16xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.large.search | i3.xlarge.search | m3.2xlarge.search | m3.large.search | m3.medium.search | m3.xlarge.search | m4.10xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.large.search | m4.xlarge.search | m5.12xlarge.search | m5.24xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.large.search | m5.xlarge.search | m6g.12xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.large.search | m6g.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | r3.large.search | r3.xlarge.search | r4.16xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.large.search | r4.xlarge.search | r5.12xlarge.search | r5.24xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.large.search | r5.xlarge.search | r6g.12xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.large.search | r6g.xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.large.search | r6gd.xlarge.search | t2.medium.search | t2.micro.search | t2.small.search | t3.2xlarge.search | t3.large.search | t3.medium.search | t3.micro.search | t3.nano.search | t3.small.search | t3.xlarge.search | t4g.medium.search | t4g.small.search | ultrawarm1.large.search | ultrawarm1.medium.search | ultrawarm1.xlarge.search` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InstanceType", "type": "string" }, @@ -138922,7 +142676,7 @@ "type": "boolean" }, "WarmType": { - "markdownDescription": "The instance type for the cluster's warm nodes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The instance type for the cluster's warm nodes\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ultrawarm1.large.search | ultrawarm1.medium.search | ultrawarm1.xlarge.search` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WarmType", "type": "string" }, @@ -138948,17 +142702,17 @@ "type": "boolean" }, "IdentityPoolId": { - "markdownDescription": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `55` \n*Pattern*: `[\\w-]+:[0-9a-f-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdentityPoolId", "type": "string" }, "RoleArn": { - "markdownDescription": "The `AmazonOpenSearchServiceCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The `AmazonOpenSearchServiceCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):iam::[0-9]+:role\\/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RoleArn", "type": "string" }, "UserPoolId": { - "markdownDescription": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `55` \n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UserPoolId", "type": "string" } @@ -138969,7 +142723,7 @@ "additionalProperties": false, "properties": { "CustomEndpoint": { - "markdownDescription": "The fully qualified URL for your custom endpoint\\. Required if you enabled a custom endpoint for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The fully qualified URL for your custom endpoint\\. Required if you enabled a custom endpoint for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomEndpoint", "type": "string" }, @@ -138984,12 +142738,12 @@ "type": "boolean" }, "EnforceHTTPS": { - "markdownDescription": "True to require that all traffic to the domain arrive over HTTPS\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "True to require that all traffic to the domain arrive over HTTPS\\. Required if you enable fine\\-grained access control in [AdvancedSecurityOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \n*Required*: Conditional \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "EnforceHTTPS", "type": "boolean" }, "TLSSecurityPolicy": { - "markdownDescription": "The minimum TLS version required for traffic to the domain\\. Valid values are TLS 1\\.0 \\(default\\) or 1\\.2: \n+ `Policy-Min-TLS-1-0-2019-07`\n+ `Policy-Min-TLS-1-2-2019-07`\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The minimum TLS version required for traffic to the domain\\. Valid values are TLS 1\\.0 \\(default\\) or 1\\.2: \n+ `Policy-Min-TLS-1-0-2019-07`\n+ `Policy-Min-TLS-1-2-2019-07`\n*Required*: No \n*Type*: String \n*Allowed values*: `Policy-Min-TLS-1-0-2019-07 | Policy-Min-TLS-1-2-2019-07` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TLSSecurityPolicy", "type": "string" } @@ -139005,11 +142759,13 @@ "type": "boolean" }, "Iops": { - "markdownDescription": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. This property applies only to the Provisioned IOPS \\(SSD\\) EBS volume type\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. This property applies only to the `gp3` and provisioned IOPS EBS volume types\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Iops", "type": "number" }, "Throughput": { + "markdownDescription": "The throughput \\(in MiB/s\\) of the EBS volumes attached to data nodes\\. Applies only to the `gp3` volume type\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Throughput", "type": "number" }, "VolumeSize": { @@ -139018,7 +142774,7 @@ "type": "number" }, "VolumeType": { - "markdownDescription": "The EBS volume type to use with the OpenSearch Service domain, such as standard, gp2, or io1\\. For more information about each type, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide for Linux Instances*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The EBS volume type to use with the OpenSearch Service domain\\. If you choose `gp3`, you must also specify values for `Iops` and `Throughput`\\. For more information about each type, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide for Linux Instances*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `gp2 | gp3 | io1 | standard` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumeType", "type": "string" } @@ -139029,12 +142785,12 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "Specify `true` to enable encryption at rest\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify `true` to enable encryption at rest\\. Required if you enable fine\\-grained access control in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \n*Required*: Conditional \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, "KmsKeyId": { - "markdownDescription": "The KMS key ID\\. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`\\. Required if you enable encryption at rest\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The KMS key ID\\. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`\\. Required if you enable encryption at rest\\. \nYou can also use `keyAlias` as a value\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `500` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KmsKeyId", "type": "string" } @@ -139045,9 +142801,13 @@ "additionalProperties": false, "properties": { "EntityId": { + "markdownDescription": "The unique entity ID of the application in the SAML identity provider\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EntityId", "type": "string" }, "MetadataContent": { + "markdownDescription": "The metadata of the SAML application, in XML format\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1048576` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetadataContent", "type": "string" } }, @@ -139077,17 +142837,17 @@ "additionalProperties": false, "properties": { "MasterUserARN": { - "markdownDescription": "ARN for the master user\\. Only specify if `InternalUserDatabaseEnabled` is false in `AdvancedSecurityOptions`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Amazon Resource Name \\(ARN\\) for the master user\\. The ARN can point to an IAM user or role\\. This property is required for Amazon Cognito to work, and it must match the role configured for Cognito\\. Only specify if `InternalUserDatabaseEnabled` is false in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserARN", "type": "string" }, "MasterUserName": { - "markdownDescription": "Username for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. If you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Username for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \nIf you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserName", "type": "string" }, "MasterUserPassword": { - "markdownDescription": "Password for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. If you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Password for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \nIf you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `128` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserPassword", "type": "string" } @@ -139098,7 +142858,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "Specifies to enable or disable node\\-to\\-node encryption on the domain\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies to enable or disable node\\-to\\-node encryption on the domain\\. Required if you enable fine\\-grained access control in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \n*Required*: Conditional \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -139109,24 +142869,38 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "True to enable SAML authentication for a domain\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "Idp": { - "$ref": "#/definitions/AWS::OpenSearchService::Domain.Idp" + "$ref": "#/definitions/AWS::OpenSearchService::Domain.Idp", + "markdownDescription": "The SAML Identity Provider's information\\. \n*Required*: No \n*Type*: [Idp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-idp.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Idp" }, "MasterBackendRole": { + "markdownDescription": "The backend role that the SAML master user is mapped to\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MasterBackendRole", "type": "string" }, "MasterUserName": { + "markdownDescription": "The SAML master user name, which is stored in the domain's internal user database\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MasterUserName", "type": "string" }, "RolesKey": { + "markdownDescription": "Element of the SAML assertion to use for backend roles\\. Default is `roles`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RolesKey", "type": "string" }, "SessionTimeoutMinutes": { + "markdownDescription": "The duration, in minutes, after which a user session becomes inactive\\. Acceptable values are between 1 and 1440, and the default value is 60\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionTimeoutMinutes", "type": "number" }, "SubjectKey": { + "markdownDescription": "Element of the SAML assertion to use for the user name\\. Default is `NameID`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubjectKey", "type": "string" } }, @@ -139136,27 +142910,43 @@ "additionalProperties": false, "properties": { "AutomatedUpdateDate": { + "markdownDescription": "The timestamp, in Epoch time, until which you can manually request a service software update\\. After this date, we automatically update your service software\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutomatedUpdateDate", "type": "string" }, "Cancellable": { + "markdownDescription": "True if you're able to cancel your service software version update\\. False if you can't cancel your service software update\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cancellable", "type": "boolean" }, "CurrentVersion": { + "markdownDescription": "The current service software version present on the domain\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CurrentVersion", "type": "string" }, "Description": { + "markdownDescription": "A description of the service software update status\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "NewVersion": { + "markdownDescription": "The new service software version, if one is available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NewVersion", "type": "string" }, "OptionalDeployment": { + "markdownDescription": "True if a service software is never automatically updated\\. False if a service software is automatically updated after the automated update date\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OptionalDeployment", "type": "boolean" }, "UpdateAvailable": { + "markdownDescription": "True if you're able to update your service software version\\. False if you can't update your service software version\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UpdateAvailable", "type": "boolean" }, "UpdateStatus": { + "markdownDescription": "The status of your service software update\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `COMPLETED | ELIGIBLE | IN_PROGRESS | NOT_ELIGIBLE | PENDING_UPDATE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UpdateStatus", "type": "string" } }, @@ -139166,7 +142956,7 @@ "additionalProperties": false, "properties": { "AutomatedSnapshotStartHour": { - "markdownDescription": "The hour in UTC during which the service takes an automated daily snapshot of the indices in the OpenSearch Service domain\\. For example, if you specify 0, OpenSearch Service takes an automated snapshot everyday between midnight and 1 am\\. You can specify a value between 0 and 23\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The hour in UTC during which the service takes an automated daily snapshot of the indexes in the OpenSearch Service domain\\. For example, if you specify 0, OpenSearch Service takes an automated snapshot everyday between midnight and 1 am\\. You can specify a value between 0 and 23\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutomatedSnapshotStartHour", "type": "number" } @@ -139188,7 +142978,7 @@ "items": { "type": "string" }, - "markdownDescription": "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*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provide one subnet ID for each Availability Zone that your domain uses\\. For example, you must specify three subnet IDs for a three\\-AZ 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*\\. \nIf you specify more than one subnet, you must also configure `ZoneAwarenessEnabled` and `ZoneAwarenessConfig` within [ClusterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html), otherwise you'll see the error \"You must specify exactly one subnet\" during template creation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SubnetIds", "type": "array" } @@ -140907,24 +144697,34 @@ "additionalProperties": false, "properties": { "AccountName": { + "markdownDescription": "The account name given to the account when it was created\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\u0020-\\u007E]+` \n*Update requires*: Updates are not supported\\.", + "title": "AccountName", "type": "string" }, "Email": { + "markdownDescription": "The email address associated with the AWS account\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) for this parameter is a string of characters that represents a standard internet email address\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `64` \n*Pattern*: `[^\\s@]+@[^\\s@]+\\.[^\\s@]+` \n*Update requires*: Updates are not supported\\.", + "title": "Email", "type": "string" }, "ParentIds": { "items": { "type": "string" }, + "markdownDescription": "The unique identifier \\(ID\\) of the root or organizational unit \\(OU\\) that you want to create the new account in\\. If you don't specify this parameter, the `ParentId` defaults to the root ID\\. \nThis parameter only accepts a string array with one string value\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) for a parent ID string requires one of the following: \n+ **Root** \\- A string that begins with \"r\\-\" followed by from 4 to 32 lowercase letters or digits\\.\n+ **Organizational unit \\(OU\\)** \\- A string that begins with \"ou\\-\" followed by from 4 to 32 lowercase letters or digits \\(the ID of the root that the OU is in\\)\\. This string is followed by a second \"\\-\" dash and from 8 to 32 additional lowercase letters or digits\\.\n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Pattern*: `^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ParentIds", "type": "array" }, "RoleName": { + "markdownDescription": "The name of an IAM role that AWS Organizations automatically preconfigures in the new member account\\. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator\\. The role has administrator permissions in the new member account\\. \nIf you don't specify this parameter, the role name defaults to `OrganizationAccountAccessRole`\\. \nFor more information about how to use this role to access the member account, see the following links: \n+ [Accessing and Administering the Member Accounts in Your Organization](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role) in the * AWS Organizations User Guide* \n+ Steps 2 and 3 in [Tutorial: Delegate Access Across AWS accounts Using IAM Roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html) in the *IAM User Guide* \nThe [regex pattern](http://wikipedia.org/wiki/regex) that is used to validate this parameter\\. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,\\.@\\- \n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Pattern*: `[\\w+=,.@-]{1,64}` \n*Update requires*: Updates are not supported\\.", + "title": "RoleName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags that you want to attach to the newly created account\\. For each tag in the list, you must specify both a tag key and a value\\. You can set the value to an empty string, but you can't set it to `null`\\. For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide\\. \nIf any one of the tags is not valid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -140991,15 +144791,21 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The friendly name of this OU\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) that is used to validate this parameter is a string of any of the characters in the ASCII character range\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ParentId": { + "markdownDescription": "The unique identifier \\(ID\\) of the parent root or OU that you want to create the new OU in\\. \nTo update the `ParentId` parameter value, you must first remove all accounts attached to the organizational unit \\(OU\\)\\. OUs can't be moved within the organization with accounts still attached\\.\nThe [regex pattern](http://wikipedia.org/wiki/regex) for a parent ID string requires one of the following: \n+ **Root** \\- A string that begins with \"r\\-\" followed by from 4 to 32 lowercase letters or digits\\.\n+ **Organizational unit \\(OU\\)** \\- A string that begins with \"ou\\-\" followed by from 4 to 32 lowercase letters or digits \\(the ID of the root that the OU is in\\)\\. This string is followed by a second \"\\-\" dash and from 8 to 32 additional lowercase letters or digits\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `100` \n*Pattern*: `^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ParentId", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags that you want to attach to the newly created OU\\. For each tag in the list, you must specify both a tag key and a value\\. You can set the value to an empty string, but you can't set it to `null`\\. For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide\\. \nIf any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire request fails and the OU is not created\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -141066,27 +144872,39 @@ "additionalProperties": false, "properties": { "Content": { + "markdownDescription": "The policy text content\\. The text that you supply must adhere to the rules of the policy type you specify in the `Type` parameter\\. The following AWS Organizations quotas are enforced for the maximum size of a policy document: \n+ Service control policies: 5,120 bytes *\\(not characters\\)*\n+ AI services opt\\-out policies: 2,500 characters\n+ Backup policies: 10,000 characters\n+ Tag policies: 10,000 characters\nFor more information about Organizations service quotas, see [Quotas for AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html) in the *AWS Organizations User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000000` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Content", "type": "string" }, "Description": { + "markdownDescription": "Human readable description of the policy\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "Name of the policy\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) that is used to validate this parameter is a string of any of the characters in the ASCII character range\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags that you want to attach to the newly created policy\\. For each tag in the list, you must specify both a tag key and a value\\. You can set the value to an empty string, but you can't set it to `null`\\. For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide\\. \nIf any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TargetIds": { "items": { "type": "string" }, + "markdownDescription": "List of unique identifiers \\(IDs\\) of the root, OU, or account that you want to attach the policy to\\. You can get the ID by calling the [ListRoots](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html), [ListOrganizationalUnitsForParent](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListOrganizationalUnitsForParent.html), or [ListAccounts](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListAccounts.html) operations\\. If you don't specify this parameter, the policy is created but not attached to any organization resource\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) for a target ID string requires one of the following: \n+ **Root** \\- A string that begins with \"r\\-\" followed by from 4 to 32 lowercase letters or digits\\.\n+ **Account** \\- A string that consists of exactly 12 digits\\.\n+ **Organizational unit \\(OU\\)** \\- A string that begins with \"ou\\-\" followed by from 4 to 32 lowercase letters or digits \\(the ID of the root that the OU is in\\)\\. This string is followed by a second \"\\-\" dash and from 8 to 32 additional lowercase letters or digits\\.\n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Pattern*: `^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetIds", "type": "array" }, "Type": { + "markdownDescription": "The type of policy to create\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AISERVICES_OPT_OUT_POLICY | BACKUP_POLICY | SERVICE_CONTROL_POLICY | TAG_POLICY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -141118,6 +144936,81 @@ ], "type": "object" }, + "AWS::Organizations::ResourcePolicy": { + "additionalProperties": false, + "properties": { + "Condition": { + "type": "string" + }, + "DeletionPolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + }, + "DependsOn": { + "anyOf": [ + { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + { + "items": { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "type": "array" + } + ] + }, + "Metadata": { + "type": "object" + }, + "Properties": { + "additionalProperties": false, + "properties": { + "Content": { + "markdownDescription": "The policy text of the organization resource policy\\. You can specify the resource policy content as a JSON object or a JSON string\\. \nWhen you specify the resource policy content as a JSON string, you can't perform drift detection on the CloudFormation stack\\. For this reason, we recommend specifying the resource policy content as a JSON object instead\\.\n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `40000` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Content", + "type": "object" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "markdownDescription": "A list of tags that you want to attach to the newly created resource policy\\. For each tag in the list, you must specify both a tag key and a value\\. You can set the value to an empty string, but you can't set it to `null`\\. For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the *AWS Organizations User Guide*\\. \nIf any one of the tags is not valid or if you exceed the allowed number of tags for the resource policy, then the entire request fails and the resource policy is not created\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", + "type": "array" + } + }, + "required": [ + "Content" + ], + "type": "object" + }, + "Type": { + "enum": [ + "AWS::Organizations::ResourcePolicy" + ], + "type": "string" + }, + "UpdateReplacePolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Properties" + ], + "type": "object" + }, "AWS::Panorama::ApplicationInstance": { "additionalProperties": false, "properties": { @@ -141194,7 +145087,7 @@ "type": "string" }, "StatusFilter": { - "markdownDescription": "Only include instances with a specific status\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEPLOYMENT_ERROR | DEPLOYMENT_SUCCEEDED | PROCESSING_DEPLOYMENT | PROCESSING_REMOVAL | REMOVAL_FAILED | REMOVAL_SUCCEEDED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Only include instances with a specific status\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEPLOYMENT_ERROR | DEPLOYMENT_FAILED | DEPLOYMENT_SUCCEEDED | PROCESSING_DEPLOYMENT | PROCESSING_REMOVAL | REMOVAL_FAILED | REMOVAL_SUCCEEDED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StatusFilter", "type": "string" }, @@ -141297,7 +145190,9 @@ "type": "string" }, "StorageLocation": { - "$ref": "#/definitions/AWS::Panorama::Package.StorageLocation" + "$ref": "#/definitions/AWS::Panorama::Package.StorageLocation", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [StorageLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-panorama-package-storagelocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageLocation" }, "Tags": { "items": { @@ -141338,18 +145233,28 @@ "additionalProperties": false, "properties": { "BinaryPrefixLocation": { + "markdownDescription": "The location's binary prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BinaryPrefixLocation", "type": "string" }, "Bucket": { + "markdownDescription": "The location's bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Bucket", "type": "string" }, "GeneratedPrefixLocation": { + "markdownDescription": "The location's generated prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GeneratedPrefixLocation", "type": "string" }, "ManifestPrefixLocation": { + "markdownDescription": "The location's manifest prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManifestPrefixLocation", "type": "string" }, "RepoPrefixLocation": { + "markdownDescription": "The location's repo prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RepoPrefixLocation", "type": "string" } }, @@ -141543,6 +145448,8 @@ "additionalProperties": false, "properties": { "DataLocation": { + "markdownDescription": "The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored\\. For example: \n `s3://bucket-name/folder-name/` \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `(s3|http|https)://.+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataLocation", "type": "string" } }, @@ -141553,7 +145460,7 @@ "properties": { "DataSource": { "$ref": "#/definitions/AWS::Personalize::Dataset.DataSource", - "markdownDescription": "The Amazon S3 bucket that contains the training data to import\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon S3 bucket that contains the training data to import\\. \n*Required*: No \n*Type*: [DataSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataSource" }, "DatasetArn": { @@ -141790,7 +145697,7 @@ "type": "string" }, "PerformAutoML": { - "markdownDescription": "When true, Amazon Personalize performs a search for the best USER\\_PERSONALIZATION recipe from the list specified in the solution configuration \\(`recipeArn` must not be specified\\)\\. When false \\(the default\\), Amazon Personalize uses `recipeArn` for training\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "We don't recommend enabling automated machine learning\\. Instead, match your use case to the available Amazon Personalize recipes\\. For more information, see [Determining your use case\\.](https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html) \nWhen true, Amazon Personalize performs a search for the best USER\\_PERSONALIZATION recipe from the list specified in the solution configuration \\(`recipeArn` must not be specified\\)\\. When false \\(the default\\), Amazon Personalize uses `recipeArn` for training\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PerformAutoML", "type": "boolean" }, @@ -141844,18 +145751,24 @@ "items": { "$ref": "#/definitions/AWS::Personalize::Solution.CategoricalHyperParameterRange" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [CategoricalHyperParameterRange](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-categoricalhyperparameterrange.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CategoricalHyperParameterRanges", "type": "array" }, "ContinuousHyperParameterRanges": { "items": { "$ref": "#/definitions/AWS::Personalize::Solution.ContinuousHyperParameterRange" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ContinuousHyperParameterRange](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContinuousHyperParameterRanges", "type": "array" }, "IntegerHyperParameterRanges": { "items": { "$ref": "#/definitions/AWS::Personalize::Solution.IntegerHyperParameterRange" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [IntegerHyperParameterRange](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IntegerHyperParameterRanges", "type": "array" } }, @@ -141865,12 +145778,16 @@ "additionalProperties": false, "properties": { "MetricName": { + "markdownDescription": "The metric to optimize\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MetricName", "type": "string" }, "RecipeList": { "items": { "type": "string" }, + "markdownDescription": "The list of candidate recipes\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RecipeList", "type": "array" } }, @@ -141880,12 +145797,16 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the hyperparameter\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Values": { "items": { "type": "string" }, + "markdownDescription": "A list of the categories for the hyperparameter\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Values", "type": "array" } }, @@ -141895,12 +145816,18 @@ "additionalProperties": false, "properties": { "MaxValue": { + "markdownDescription": "The maximum allowable value for the hyperparameter\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaxValue", "type": "number" }, "MinValue": { + "markdownDescription": "The minimum allowable value for the hyperparameter\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MinValue", "type": "number" }, "Name": { + "markdownDescription": "The name of the hyperparameter\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -141910,13 +145837,19 @@ "additionalProperties": false, "properties": { "AlgorithmHyperParameterRanges": { - "$ref": "#/definitions/AWS::Personalize::Solution.AlgorithmHyperParameterRanges" + "$ref": "#/definitions/AWS::Personalize::Solution.AlgorithmHyperParameterRanges", + "markdownDescription": "The hyperparameters and their allowable ranges\\. \n*Required*: No \n*Type*: [AlgorithmHyperParameterRanges](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-algorithmhyperparameterranges.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AlgorithmHyperParameterRanges" }, "HpoObjective": { - "$ref": "#/definitions/AWS::Personalize::Solution.HpoObjective" + "$ref": "#/definitions/AWS::Personalize::Solution.HpoObjective", + "markdownDescription": "The metric to optimize during HPO\\. \nAmazon Personalize doesn't support configuring the `hpoObjective` at this time\\.\n*Required*: No \n*Type*: [HpoObjective](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "HpoObjective" }, "HpoResourceConfig": { - "$ref": "#/definitions/AWS::Personalize::Solution.HpoResourceConfig" + "$ref": "#/definitions/AWS::Personalize::Solution.HpoResourceConfig", + "markdownDescription": "Describes the resource configuration for HPO\\. \n*Required*: No \n*Type*: [HpoResourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hporesourceconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "HpoResourceConfig" } }, "type": "object" @@ -141925,12 +145858,18 @@ "additionalProperties": false, "properties": { "MetricName": { + "markdownDescription": "The name of the metric\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MetricName", "type": "string" }, "MetricRegex": { + "markdownDescription": "A regular expression for finding the metric in the training job logs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MetricRegex", "type": "string" }, "Type": { + "markdownDescription": "The type of the metric\\. Valid values are `Maximize` and `Minimize`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -141940,9 +145879,13 @@ "additionalProperties": false, "properties": { "MaxNumberOfTrainingJobs": { + "markdownDescription": "The maximum number of training jobs when you create a solution version\\. The maximum value for `maxNumberOfTrainingJobs` is `40`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaxNumberOfTrainingJobs", "type": "string" }, "MaxParallelTrainingJobs": { + "markdownDescription": "The maximum number of parallel training jobs when you create a solution version\\. The maximum value for `maxParallelTrainingJobs` is `10`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaxParallelTrainingJobs", "type": "string" } }, @@ -141952,12 +145895,18 @@ "additionalProperties": false, "properties": { "MaxValue": { + "markdownDescription": "The maximum allowable value for the hyperparameter\\. \n*Required*: No \n*Type*: Integer \n*Maximum*: `1000000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaxValue", "type": "number" }, "MinValue": { + "markdownDescription": "The minimum allowable value for the hyperparameter\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `-1000000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MinValue", "type": "number" }, "Name": { + "markdownDescription": "The name of the hyperparameter\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -141979,7 +145928,7 @@ }, "AutoMLConfig": { "$ref": "#/definitions/AWS::Personalize::Solution.AutoMLConfig", - "markdownDescription": "The [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) object containing a list of recipes to search when AutoML is performed\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) object containing a list of recipes to search when AutoML is performed\\. \n*Required*: No \n*Type*: [AutoMLConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-automlconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AutoMLConfig" }, "EventValueThreshold": { @@ -142000,7 +145949,7 @@ }, "HpoConfig": { "$ref": "#/definitions/AWS::Personalize::Solution.HpoConfig", - "markdownDescription": "Describes the properties for hyperparameter optimization \\(HPO\\)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Describes the properties for hyperparameter optimization \\(HPO\\)\\. \n*Required*: No \n*Type*: [HpoConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "HpoConfig" } }, @@ -142882,7 +146831,9 @@ "title": "CampaignHook" }, "CustomDeliveryConfiguration": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.CustomDeliveryConfiguration" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.CustomDeliveryConfiguration", + "markdownDescription": "The delivery configuration settings for sending the treatment through a custom channel\\. This object is required if the `MessageConfiguration` object for the treatment specifies a `CustomMessage` object\\. \n*Required*: No \n*Type*: [CustomDeliveryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomDeliveryConfiguration" }, "Description": { "markdownDescription": "A custom description of the campaign\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -142906,7 +146857,7 @@ }, "MessageConfiguration": { "$ref": "#/definitions/AWS::Pinpoint::Campaign.MessageConfiguration", - "markdownDescription": "The message configuration settings for the campaign\\. \n*Required*: Yes \n*Type*: [MessageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The message configuration settings for the campaign\\. \n*Required*: No \n*Type*: [MessageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageConfiguration" }, "Name": { @@ -142940,7 +146891,9 @@ "type": "object" }, "TemplateConfiguration": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.TemplateConfiguration" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.TemplateConfiguration", + "markdownDescription": "The message template to use for the treatment\\. \n*Required*: No \n*Type*: [TemplateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TemplateConfiguration" }, "TreatmentDescription": { "markdownDescription": "A custom description of the default treatment for the campaign\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -143005,6 +146958,8 @@ "additionalProperties": false, "properties": { "Data": { + "markdownDescription": "The raw, JSON\\-formatted string to use as the payload for the message\\. The maximum size is 5 KB\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Data", "type": "string" } }, @@ -143090,7 +147045,7 @@ "type": "object" }, "Layout": { - "markdownDescription": "A string that describes how the in\\-app message will appear\\. You can specify one of the following: \n+ `BOTTOM_BANNER` \u2013 a message that appears as a banner at the bottom of the page\\.\n+ `TOP_BANNER` \u2013 a message that appears as a banner at the top of the page\\.\n+ `OVERLAYS` \u2013 a message that covers entire screen\\.\n+ `MOBILE_FEED` \u2013 a message that appears in a window in front of the page\\.\n+ `MIDDLE_BANNER` \u2013 a message that appears as a banner in the middle of the page\\.\n+ `CAROUSEL` \u2013 a scrollable layout of up to five unique messages\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string that describes how the in\\-app message will appear\\. You can specify one of the following: \n+ `BOTTOM_BANNER` \u2013 a message that appears as a banner at the bottom of the page\\.\n+ `TOP_BANNER` \u2013 a message that appears as a banner at the top of the page\\.\n+ `OVERLAYS` \u2013 a message that covers entire screen\\.\n+ `MOBILE_FEED` \u2013 a message that appears in a window in front of the page\\.\n+ `MIDDLE_BANNER` \u2013 a message that appears as a banner in the middle of the page\\.\n+ `CAROUSEL` \u2013 a scrollable layout of up to five unique messages\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Layout", "type": "string" } @@ -143137,12 +147092,16 @@ "additionalProperties": false, "properties": { "DeliveryUri": { + "markdownDescription": "The destination to send the campaign or treatment to\\. This value can be one of the following: \n+ The name or Amazon Resource Name \\(ARN\\) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment\\.\n+ The URL for a web application or service that supports HTTPS and can receive the message\\. The URL has to be a full URL, including the HTTPS protocol\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeliveryUri", "type": "string" }, "EndpointTypes": { "items": { "type": "string" }, + "markdownDescription": "The types of endpoints to send the campaign or treatment to\\. Each valid value maps to a type of channel that you can associate with an endpoint by using the `ChannelType` property of an endpoint\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndpointTypes", "type": "array" } }, @@ -143162,7 +147121,7 @@ "type": "number" }, "ButtonAction": { - "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ButtonAction", "type": "string" }, @@ -143194,7 +147153,7 @@ }, "EventType": { "$ref": "#/definitions/AWS::Pinpoint::Campaign.SetDimension", - "markdownDescription": "The name of the event that causes the campaign to be sent or the journey activity to be performed\\. This can be a standard event that Amazon Pinpoint generates, such as `_email.delivered`\\. For campaigns, this can also be a custom event that's specific to your application\\. For information about standard events, see [Streaming Amazon Pinpoint Events](https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html) in the *Amazon Pinpoint Developer Guide*\\. \n*Required*: No \n*Type*: [SetDimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the event that causes the campaign to be sent or the journey activity to be performed\\. This can be a standard event that Amazon Pinpoint generates, such as `_email.delivered` or `_custom.delivered`\\. For campaigns, this can also be a custom event that's specific to your application\\. For information about standard events, see [Streaming Amazon Pinpoint Events](https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html) in the * Amazon Pinpoint Developer Guide*\\. \n*Required*: No \n*Type*: [SetDimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventType" }, "Metrics": { @@ -143328,7 +147287,7 @@ "type": "number" }, "Session": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Session", "type": "number" }, @@ -143425,7 +147384,9 @@ "title": "BaiduMessage" }, "CustomMessage": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.CampaignCustomMessage" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.CampaignCustomMessage", + "markdownDescription": "The message that the campaign sends through a custom channel, as specified by the delivery configuration \\(`CustomDeliveryConfiguration`\\) settings for the campaign\\. If specified, this message overrides the default message\\. \n*Required*: No \n*Type*: [CampaignCustomMessage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigncustommessage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomMessage" }, "DefaultMessage": { "$ref": "#/definitions/AWS::Pinpoint::Campaign.Message", @@ -143475,7 +147436,7 @@ "additionalProperties": false, "properties": { "ButtonAction": { - "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ButtonAction", "type": "string" }, @@ -143571,9 +147532,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the message template to use for the message\\. If specified, this value must match the name of an existing message template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Version": { + "markdownDescription": "The unique identifier for the version of the message template to use for the message\\. If specified, this value must match the identifier for an existing template version\\. To retrieve a list of versions and version identifiers for a template, use the [Template Versions](https://docs.aws.amazon.com/pinpoint/latest/apireference/templates-template-name-template-type-versions.html) resource\\. \nIf you don't specify a value for this property, Amazon Pinpoint uses the *active version* of the template\\. The *active version* is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow\\. It isn't necessarily the latest version of a template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Version", "type": "string" } }, @@ -143583,16 +147548,24 @@ "additionalProperties": false, "properties": { "EmailTemplate": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template", + "markdownDescription": "The email template to use for the message\\. \n*Required*: No \n*Type*: [Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EmailTemplate" }, "PushTemplate": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template", + "markdownDescription": "The push notification template to use for the message\\. \n*Required*: No \n*Type*: [Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PushTemplate" }, "SMSTemplate": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template", + "markdownDescription": "The SMS template to use for the message\\. \n*Required*: No \n*Type*: [Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SMSTemplate" }, "VoiceTemplate": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template", + "markdownDescription": "The voice template to use for the message\\. This object isn't supported for campaigns\\. \n*Required*: No \n*Type*: [Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VoiceTemplate" } }, "type": "object" @@ -143601,7 +147574,9 @@ "additionalProperties": false, "properties": { "CustomDeliveryConfiguration": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.CustomDeliveryConfiguration" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.CustomDeliveryConfiguration", + "markdownDescription": "The delivery configuration settings for sending the treatment through a custom channel\\. This object is required if the `MessageConfiguration` object for the treatment specifies a `CustomMessage` object\\. \n*Required*: No \n*Type*: [CustomDeliveryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomDeliveryConfiguration" }, "MessageConfiguration": { "$ref": "#/definitions/AWS::Pinpoint::Campaign.MessageConfiguration", @@ -143619,7 +147594,9 @@ "type": "number" }, "TemplateConfiguration": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.TemplateConfiguration" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.TemplateConfiguration", + "markdownDescription": "The message template to use for the treatment\\. \n*Required*: No \n*Type*: [TemplateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TemplateConfiguration" }, "TreatmentDescription": { "markdownDescription": "A custom description of the treatment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -144032,7 +148009,7 @@ "type": "object" }, "Layout": { - "markdownDescription": "A string that determines the appearance of the in\\-app message\\. You can specify one of the following: \n+ `BOTTOM_BANNER` \u2013 a message that appears as a banner at the bottom of the page\\.\n+ `TOP_BANNER` \u2013 a message that appears as a banner at the top of the page\\.\n+ `OVERLAYS` \u2013 a message that covers entire screen\\.\n+ `MOBILE_FEED` \u2013 a message that appears in a window in front of the page\\.\n+ `MIDDLE_BANNER` \u2013 a message that appears as a banner in the middle of the page\\.\n+ `CAROUSEL` \u2013 a scrollable layout of up to five unique messages\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string that determines the appearance of the in\\-app message\\. You can specify one of the following: \n+ `BOTTOM_BANNER` \u2013 a message that appears as a banner at the bottom of the page\\.\n+ `TOP_BANNER` \u2013 a message that appears as a banner at the top of the page\\.\n+ `OVERLAYS` \u2013 a message that covers entire screen\\.\n+ `MOBILE_FEED` \u2013 a message that appears in a window in front of the page\\.\n+ `MIDDLE_BANNER` \u2013 a message that appears as a banner in the middle of the page\\.\n+ `CAROUSEL` \u2013 a scrollable layout of up to five unique messages\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Layout", "type": "string" }, @@ -144139,7 +148116,7 @@ "type": "number" }, "ButtonAction": { - "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ButtonAction", "type": "string" }, @@ -144222,7 +148199,7 @@ "additionalProperties": false, "properties": { "ButtonAction": { - "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ButtonAction", "type": "string" }, @@ -144582,7 +148559,7 @@ "title": "Dimensions" }, "Name": { - "markdownDescription": "The name of the segment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the segment\\. \nA segment must have a name otherwise it will not appear in the Amazon Pinpoint console\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -145656,43 +149633,65 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description of the pipe\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "DesiredState": { + "markdownDescription": "The state the pipe should be in\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DesiredState", "type": "string" }, "Enrichment": { + "markdownDescription": "The ARN of the enrichment resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enrichment", "type": "string" }, "EnrichmentParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeEnrichmentParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeEnrichmentParameters", + "markdownDescription": "The parameters required to set up enrichment on your pipe\\. \n*Required*: No \n*Type*: [PipeEnrichmentParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmentparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnrichmentParameters" }, "Name": { + "markdownDescription": "The name of the pipe\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "RoleArn": { + "markdownDescription": "The ARN of the role that allows the pipe to send data to the target\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "Source": { + "markdownDescription": "The ARN of the source resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Source", "type": "string" }, "SourceParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceParameters", + "markdownDescription": "The parameters required to set up a source for your pipe\\. \n*Required*: No \n*Type*: [PipeSourceParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceParameters" }, "Tags": { "additionalProperties": true, + "markdownDescription": "The list of key\\-value pairs to associate with the pipe\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "Target": { + "markdownDescription": "The ARN of the target resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Target", "type": "string" }, "TargetParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetParameters", + "markdownDescription": "The parameters required to set up a target for your pipe\\. \nFor more information about pipe target parameters, including how to use dynamic path parameters, see [Target parameters](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) in the *Amazon EventBridge User Guide*\\. \n*Required*: No \n*Type*: [PipeTargetParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetParameters" } }, "required": [ @@ -145727,18 +149726,24 @@ "additionalProperties": false, "properties": { "AssignPublicIp": { + "markdownDescription": "Specifies whether the task's elastic network interface receives a public IP address\\. You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssignPublicIp", "type": "string" }, "SecurityGroups": { "items": { "type": "string" }, + "markdownDescription": "Specifies the security groups associated with the task\\. These security groups must all be in the same VPC\\. You can specify as many as five security groups\\. If you do not specify a security group, the default security group for the VPC is used\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroups", "type": "array" }, "Subnets": { "items": { "type": "string" }, + "markdownDescription": "Specifies the subnets associated with the task\\. These subnets must all be in the same VPC\\. You can specify as many as 16 subnets\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Subnets", "type": "array" } }, @@ -145751,6 +149756,8 @@ "additionalProperties": false, "properties": { "Size": { + "markdownDescription": "The size of the array, if this is an array batch job\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Size", "type": "number" } }, @@ -145763,21 +149770,29 @@ "items": { "type": "string" }, + "markdownDescription": "The command to send to the container that overrides the default command from the Docker image or the task definition\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Command", "type": "array" }, "Environment": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.BatchEnvironmentVariable" }, + "markdownDescription": "The environment variables to send to the container\\. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition\\. \nEnvironment variables cannot start with \"`AWS Batch`\"\\. This naming convention is reserved for variables that AWS Batch sets\\.\n*Required*: No \n*Type*: List of [BatchEnvironmentVariable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchenvironmentvariable.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Environment", "type": "array" }, "InstanceType": { + "markdownDescription": "The instance type to use for a multi\\-node parallel job\\. \nThis parameter isn't applicable to single\\-node container jobs or jobs that run on Fargate resources, and shouldn't be provided\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InstanceType", "type": "string" }, "ResourceRequirements": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.BatchResourceRequirement" }, + "markdownDescription": "The type and amount of resources to assign to a container\\. This overrides the settings in the job definition\\. The supported resources include `GPU`, `MEMORY`, and `VCPU`\\. \n*Required*: No \n*Type*: List of [BatchResourceRequirement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchresourcerequirement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceRequirements", "type": "array" } }, @@ -145787,9 +149802,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the key\\-value pair\\. For environment variables, this is the name of the environment variable\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Value": { + "markdownDescription": "The value of the key\\-value pair\\. For environment variables, this is the value of the environment variable\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -145799,9 +149818,13 @@ "additionalProperties": false, "properties": { "JobId": { + "markdownDescription": "The job ID of the AWS Batch job that's associated with this dependency\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "JobId", "type": "string" }, "Type": { + "markdownDescription": "The type of the job dependency\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -145811,9 +149834,13 @@ "additionalProperties": false, "properties": { "Type": { + "markdownDescription": "The type of resource to assign to a container\\. The supported resources include `GPU`, `MEMORY`, and `VCPU`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "Value": { + "markdownDescription": "The quantity of the specified resource to reserve for the container\\. The values vary based on the `type` specified\\. \ntype=\"GPU\" \nThe number of physical GPUs to reserve for the container\\. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on\\. \nGPUs aren't available for jobs that are running on Fargate resources\\. \ntype=\"MEMORY\" \nThe memory hard limit \\(in MiB\\) present to the container\\. This parameter is supported for jobs that are running on EC2 resources\\. If your container attempts to exceed the memory specified, the container is terminated\\. This parameter maps to `Memory` in the [ Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. You must specify at least 4 MiB of memory for a job\\. This is required but can be specified in several places for multi\\-node parallel \\(MNP\\) jobs\\. It must be specified for each node at least once\\. This parameter maps to `Memory` in the [ Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. \nIf you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see [Memory management](https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in the *AWS Batch User Guide*\\.\nFor jobs that are running on Fargate resources, then `value` is the hard limit \\(in MiB\\), and must match one of the supported values and the `VCPU` values must be one of the values supported for that memory value\\. \nvalue = 512 \n`VCPU` = 0\\.25 \nvalue = 1024 \n`VCPU` = 0\\.25 or 0\\.5 \nvalue = 2048 \n`VCPU` = 0\\.25, 0\\.5, or 1 \nvalue = 3072 \n`VCPU` = 0\\.5, or 1 \nvalue = 4096 \n`VCPU` = 0\\.5, 1, or 2 \nvalue = 5120, 6144, or 7168 \n`VCPU` = 1 or 2 \nvalue = 8192 \n`VCPU` = 1, 2, 4, or 8 \nvalue = 9216, 10240, 11264, 12288, 13312, 14336, or 15360 \n`VCPU` = 2 or 4 \nvalue = 16384 \n`VCPU` = 2, 4, or 8 \nvalue = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720 \n`VCPU` = 4 \nvalue = 20480, 24576, or 28672 \n`VCPU` = 4 or 8 \nvalue = 36864, 45056, 53248, or 61440 \n`VCPU` = 8 \nvalue = 32768, 40960, 49152, or 57344 \n`VCPU` = 8 or 16 \nvalue = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880 \n`VCPU` = 16 \ntype=\"VCPU\" \nThe number of vCPUs reserved for the container\\. This parameter maps to `CpuShares` in the [ Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--cpu-shares` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. Each vCPU is equivalent to 1,024 CPU shares\\. For EC2 resources, you must specify at least one vCPU\\. This is required but can be specified in several places; it must be specified for each node at least once\\. \nThe default for the Fargate On\\-Demand vCPU resource count quota is 6 vCPUs\\. For more information about Fargate quotas, see [AWS Fargate quotas](https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate) in the *AWS General Reference*\\. \nFor jobs that are running on Fargate resources, then `value` must match one of the supported values and the `MEMORY` values must be one of the values supported for that `VCPU` value\\. The supported values are 0\\.25, 0\\.5, 1, 2, 4, 8, and 16 \nvalue = 0\\.25 \n`MEMORY` = 512, 1024, or 2048 \nvalue = 0\\.5 \n`MEMORY` = 1024, 2048, 3072, or 4096 \nvalue = 1 \n`MEMORY` = 2048, 3072, 4096, 5120, 6144, 7168, or 8192 \nvalue = 2 \n`MEMORY` = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384 \nvalue = 4 \n`MEMORY` = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720 \nvalue = 8 \n`MEMORY` = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440 \nvalue = 16 \n`MEMORY` = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880 \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -145827,6 +149854,8 @@ "additionalProperties": false, "properties": { "Attempts": { + "markdownDescription": "The number of times to move a job to the `RUNNABLE` status\\. If the value of `attempts` is greater than one, the job is retried on failure the same number of attempts as the value\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Attempts", "type": "number" } }, @@ -145836,12 +149865,18 @@ "additionalProperties": false, "properties": { "Base": { + "markdownDescription": "The base value designates how many tasks, at a minimum, to run on the specified capacity provider\\. Only one capacity provider in a capacity provider strategy can have a base defined\\. If no value is specified, the default value of 0 is used\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Base", "type": "number" }, "CapacityProvider": { + "markdownDescription": "The short name of the capacity provider\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CapacityProvider", "type": "string" }, "Weight": { + "markdownDescription": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider\\. The weight value is taken into consideration after the base value, if defined, is satisfied\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Weight", "type": "number" } }, @@ -145854,6 +149889,8 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "The ARN of the Amazon SQS queue specified as the target for the dead\\-letter queue\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Arn", "type": "string" } }, @@ -145866,36 +149903,52 @@ "items": { "type": "string" }, + "markdownDescription": "The command to send to the container that overrides the default command from the Docker image or the task definition\\. You must also specify a container name\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Command", "type": "array" }, "Cpu": { + "markdownDescription": "The number of `cpu` units reserved for the container, instead of the default value from the task definition\\. You must also specify a container name\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cpu", "type": "number" }, "Environment": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.EcsEnvironmentVariable" }, + "markdownDescription": "The environment variables to send to the container\\. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition\\. You must also specify a container name\\. \n*Required*: No \n*Type*: List of [EcsEnvironmentVariable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentvariable.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Environment", "type": "array" }, "EnvironmentFiles": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.EcsEnvironmentFile" }, + "markdownDescription": "A list of files containing the environment variables to pass to a container, instead of the value from the container definition\\. \n*Required*: No \n*Type*: List of [EcsEnvironmentFile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentfile.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnvironmentFiles", "type": "array" }, "Memory": { + "markdownDescription": "The hard limit \\(in MiB\\) of memory to present to the container, instead of the default value from the task definition\\. If your container attempts to exceed the memory specified here, the container is killed\\. You must also specify a container name\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Memory", "type": "number" }, "MemoryReservation": { + "markdownDescription": "The soft limit \\(in MiB\\) of memory to reserve for the container, instead of the default value from the task definition\\. You must also specify a container name\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MemoryReservation", "type": "number" }, "Name": { + "markdownDescription": "The name of the container that receives the override\\. This parameter is required if any override is specified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ResourceRequirements": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.EcsResourceRequirement" }, + "markdownDescription": "The type and amount of a resource to assign to a container, instead of the default value from the task definition\\. The only supported resource is a GPU\\. \n*Required*: No \n*Type*: List of [EcsResourceRequirement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsresourcerequirement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceRequirements", "type": "array" } }, @@ -145905,9 +149958,13 @@ "additionalProperties": false, "properties": { "Type": { + "markdownDescription": "The file type to use\\. The only supported value is `s3`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "Value": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon S3 object containing the environment variable file\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -145921,9 +149978,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the key\\-value pair\\. For environment variables, this is the name of the environment variable\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Value": { + "markdownDescription": "The value of the key\\-value pair\\. For environment variables, this is the value of the environment variable\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -145933,6 +149994,8 @@ "additionalProperties": false, "properties": { "SizeInGiB": { + "markdownDescription": "The total amount, in GiB, of ephemeral storage to set for the task\\. The minimum supported value is `21` GiB and the maximum supported value is `200` GiB\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SizeInGiB", "type": "number" } }, @@ -145945,9 +150008,13 @@ "additionalProperties": false, "properties": { "DeviceName": { + "markdownDescription": "The Elastic Inference accelerator device name to override for the task\\. This parameter must match a `deviceName` specified in the task definition\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeviceName", "type": "string" }, "DeviceType": { + "markdownDescription": "The Elastic Inference accelerator type to use\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeviceType", "type": "string" } }, @@ -145957,9 +150024,13 @@ "additionalProperties": false, "properties": { "Type": { + "markdownDescription": "The type of resource to assign to a container\\. The supported values are `GPU` or `InferenceAccelerator`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "Value": { + "markdownDescription": "The value for the specified resource type\\. \nIf the `GPU` type is used, the value is the number of physical `GPUs` the Amazon ECS container agent reserves for the container\\. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on\\. \nIf the `InferenceAccelerator` type is used, the `value` matches the `deviceName` for an InferenceAccelerator specified in a task definition\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -145976,27 +150047,41 @@ "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.EcsContainerOverride" }, + "markdownDescription": "One or more container overrides that are sent to a task\\. \n*Required*: No \n*Type*: List of [EcsContainerOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContainerOverrides", "type": "array" }, "Cpu": { + "markdownDescription": "The cpu override for the task\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cpu", "type": "string" }, "EphemeralStorage": { - "$ref": "#/definitions/AWS::Pipes::Pipe.EcsEphemeralStorage" + "$ref": "#/definitions/AWS::Pipes::Pipe.EcsEphemeralStorage", + "markdownDescription": "The ephemeral storage setting override for the task\\. \nThis parameter is only supported for tasks hosted on Fargate that use the following platform versions: \n+ Linux platform version `1.4.0` or later\\.\n+ Windows platform version `1.0.0` or later\\.\n*Required*: No \n*Type*: [EcsEphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsephemeralstorage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EphemeralStorage" }, "ExecutionRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the task execution IAM role override for the task\\. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExecutionRoleArn", "type": "string" }, "InferenceAcceleratorOverrides": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.EcsInferenceAcceleratorOverride" }, + "markdownDescription": "The Elastic Inference accelerator override for the task\\. \n*Required*: No \n*Type*: List of [EcsInferenceAcceleratorOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsinferenceacceleratoroverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InferenceAcceleratorOverrides", "type": "array" }, "Memory": { + "markdownDescription": "The memory override for the task\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Memory", "type": "string" }, "TaskRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IAM role that containers in this task can assume\\. All containers in this task are granted the permissions that are specified in this role\\. For more information, see [IAM Role for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TaskRoleArn", "type": "string" } }, @@ -146006,6 +150091,8 @@ "additionalProperties": false, "properties": { "Pattern": { + "markdownDescription": "The event pattern\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pattern", "type": "string" } }, @@ -146018,6 +150105,8 @@ "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.Filter" }, + "markdownDescription": "The event patterns\\. \n*Required*: No \n*Type*: List of [Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Filters", "type": "array" } }, @@ -146027,6 +150116,8 @@ "additionalProperties": false, "properties": { "BasicAuth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BasicAuth", "type": "string" } }, @@ -146039,9 +150130,13 @@ "additionalProperties": false, "properties": { "ClientCertificateTlsAuth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientCertificateTlsAuth", "type": "string" }, "SaslScram512Auth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SaslScram512Auth", "type": "string" } }, @@ -146051,7 +150146,9 @@ "additionalProperties": false, "properties": { "AwsvpcConfiguration": { - "$ref": "#/definitions/AWS::Pipes::Pipe.AwsVpcConfiguration" + "$ref": "#/definitions/AWS::Pipes::Pipe.AwsVpcConfiguration", + "markdownDescription": "Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used\\. This structure is relevant only for ECS tasks that use the `awsvpc` network mode\\. \n*Required*: No \n*Type*: [AwsVpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-awsvpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AwsvpcConfiguration" } }, "type": "object" @@ -146061,26 +150158,32 @@ "properties": { "HeaderParameters": { "additionalProperties": true, + "markdownDescription": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "HeaderParameters", "type": "object" }, "PathParameterValues": { "items": { "type": "string" }, + "markdownDescription": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards \\(\"\\*\"\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PathParameterValues", "type": "array" }, "QueryStringParameters": { "additionalProperties": true, + "markdownDescription": "The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "QueryStringParameters", "type": "object" } }, @@ -146090,9 +150193,13 @@ "additionalProperties": false, "properties": { "HttpParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeEnrichmentHttpParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeEnrichmentHttpParameters", + "markdownDescription": "Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination\\. \nIf you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request\\. If you're using ApiDestinations, the corresponding Connection can also have these values configured\\. In case of any conflicting keys, values from the Connection take precedence\\. \n*Required*: No \n*Type*: [PipeEnrichmentHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmenthttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HttpParameters" }, "InputTemplate": { + "markdownDescription": "Valid JSON text passed to the enrichment\\. In this case, nothing from the event itself is passed to the enrichment\\. For more information, see [The JavaScript Object Notation \\(JSON\\) Data Interchange Format](http://www.rfc-editor.org/rfc/rfc7159.txt)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputTemplate", "type": "string" } }, @@ -146102,15 +150209,23 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "Credentials": { - "$ref": "#/definitions/AWS::Pipes::Pipe.MQBrokerAccessCredentials" + "$ref": "#/definitions/AWS::Pipes::Pipe.MQBrokerAccessCredentials", + "markdownDescription": "The credentials needed to access the resource\\. \n*Required*: Yes \n*Type*: [MQBrokerAccessCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mqbrokeraccesscredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Credentials" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" }, "QueueName": { + "markdownDescription": "The name of the destination queue to consume\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "QueueName", "type": "string" } }, @@ -146124,27 +150239,43 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "DeadLetterConfig": { - "$ref": "#/definitions/AWS::Pipes::Pipe.DeadLetterConfig" + "$ref": "#/definitions/AWS::Pipes::Pipe.DeadLetterConfig", + "markdownDescription": "Define the target queue to send dead\\-letter queue events to\\. \n*Required*: No \n*Type*: [DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-deadletterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeadLetterConfig" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" }, "MaximumRecordAgeInSeconds": { + "markdownDescription": "\\(Streams only\\) Discard records older than the specified age\\. The default value is \\-1, which sets the maximum age to infinite\\. When the value is set to infinite, EventBridge never discards old records\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumRecordAgeInSeconds", "type": "number" }, "MaximumRetryAttempts": { + "markdownDescription": "\\(Streams only\\) Discard records after the specified number of retries\\. The default value is \\-1, which sets the maximum number of retries to infinite\\. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumRetryAttempts", "type": "number" }, "OnPartialBatchItemFailure": { + "markdownDescription": "\\(Streams only\\) Define how to handle item process failures\\. `AUTOMATIC_BISECT` halves each batch and retry each half until all the records are processed or there is one failed message left in the batch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OnPartialBatchItemFailure", "type": "string" }, "ParallelizationFactor": { + "markdownDescription": "\\(Streams only\\) The number of batches to process concurrently from each shard\\. The default value is 1\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ParallelizationFactor", "type": "number" }, "StartingPosition": { + "markdownDescription": "\\(Streams only\\) The position in a stream from which to start reading\\. \n*Valid values*: `TRIM_HORIZON | LATEST` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StartingPosition", "type": "string" } }, @@ -146157,30 +150288,48 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "DeadLetterConfig": { - "$ref": "#/definitions/AWS::Pipes::Pipe.DeadLetterConfig" + "$ref": "#/definitions/AWS::Pipes::Pipe.DeadLetterConfig", + "markdownDescription": "Define the target queue to send dead\\-letter queue events to\\. \n*Required*: No \n*Type*: [DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-deadletterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeadLetterConfig" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" }, "MaximumRecordAgeInSeconds": { + "markdownDescription": "\\(Streams only\\) Discard records older than the specified age\\. The default value is \\-1, which sets the maximum age to infinite\\. When the value is set to infinite, EventBridge never discards old records\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumRecordAgeInSeconds", "type": "number" }, "MaximumRetryAttempts": { + "markdownDescription": "\\(Streams only\\) Discard records after the specified number of retries\\. The default value is \\-1, which sets the maximum number of retries to infinite\\. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumRetryAttempts", "type": "number" }, "OnPartialBatchItemFailure": { + "markdownDescription": "\\(Streams only\\) Define how to handle item process failures\\. `AUTOMATIC_BISECT` halves each batch and retry each half until all the records are processed or there is one failed message left in the batch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OnPartialBatchItemFailure", "type": "string" }, "ParallelizationFactor": { + "markdownDescription": "\\(Streams only\\) The number of batches to process concurrently from each shard\\. The default value is 1\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ParallelizationFactor", "type": "number" }, "StartingPosition": { + "markdownDescription": "\\(Streams only\\) The position in a stream from which to start reading\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StartingPosition", "type": "string" }, "StartingPositionTimestamp": { + "markdownDescription": "With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading, in Unix time seconds\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StartingPositionTimestamp", "type": "string" } }, @@ -146193,21 +150342,33 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "ConsumerGroupID": { + "markdownDescription": "The name of the destination queue to consume\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConsumerGroupID", "type": "string" }, "Credentials": { - "$ref": "#/definitions/AWS::Pipes::Pipe.MSKAccessCredentials" + "$ref": "#/definitions/AWS::Pipes::Pipe.MSKAccessCredentials", + "markdownDescription": "The credentials needed to access the resource\\. \n*Required*: No \n*Type*: [MSKAccessCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mskaccesscredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Credentials" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" }, "StartingPosition": { + "markdownDescription": "\\(Streams only\\) The position in a stream from which to start reading\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StartingPosition", "type": "string" }, "TopicName": { + "markdownDescription": "The name of the topic that the pipe will read from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TopicName", "type": "string" } }, @@ -146220,28 +150381,44 @@ "additionalProperties": false, "properties": { "ActiveMQBrokerParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceActiveMQBrokerParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceActiveMQBrokerParameters", + "markdownDescription": "The parameters for using an Active MQ broker as a source\\. \n*Required*: No \n*Type*: [PipeSourceActiveMQBrokerParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActiveMQBrokerParameters" }, "DynamoDBStreamParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceDynamoDBStreamParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceDynamoDBStreamParameters", + "markdownDescription": "The parameters for using a DynamoDB stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceDynamoDBStreamParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DynamoDBStreamParameters" }, "FilterCriteria": { - "$ref": "#/definitions/AWS::Pipes::Pipe.FilterCriteria" + "$ref": "#/definitions/AWS::Pipes::Pipe.FilterCriteria", + "markdownDescription": "The collection of event patterns used to filter events\\. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*\\. \n*Required*: No \n*Type*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-filtercriteria.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FilterCriteria" }, "KinesisStreamParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceKinesisStreamParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceKinesisStreamParameters", + "markdownDescription": "The parameters for using a Kinesis stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceKinesisStreamParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KinesisStreamParameters" }, "ManagedStreamingKafkaParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceManagedStreamingKafkaParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceManagedStreamingKafkaParameters", + "markdownDescription": "The parameters for using an MSK stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceManagedStreamingKafkaParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManagedStreamingKafkaParameters" }, "RabbitMQBrokerParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceRabbitMQBrokerParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceRabbitMQBrokerParameters", + "markdownDescription": "The parameters for using a Rabbit MQ broker as a source\\. \n*Required*: No \n*Type*: [PipeSourceRabbitMQBrokerParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RabbitMQBrokerParameters" }, "SelfManagedKafkaParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceSelfManagedKafkaParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceSelfManagedKafkaParameters", + "markdownDescription": "The parameters for using a self\\-managed Apache Kafka stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceSelfManagedKafkaParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SelfManagedKafkaParameters" }, "SqsQueueParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceSqsQueueParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceSqsQueueParameters", + "markdownDescription": "The parameters for using a Amazon SQS stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceSqsQueueParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcesqsqueueparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SqsQueueParameters" } }, "type": "object" @@ -146250,18 +150427,28 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "Credentials": { - "$ref": "#/definitions/AWS::Pipes::Pipe.MQBrokerAccessCredentials" + "$ref": "#/definitions/AWS::Pipes::Pipe.MQBrokerAccessCredentials", + "markdownDescription": "The credentials needed to access the resource\\. \n*Required*: Yes \n*Type*: [MQBrokerAccessCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mqbrokeraccesscredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Credentials" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" }, "QueueName": { + "markdownDescription": "The name of the destination queue to consume\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "QueueName", "type": "string" }, "VirtualHost": { + "markdownDescription": "The name of the virtual host associated with the source broker\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VirtualHost", "type": "string" } }, @@ -146278,31 +150465,49 @@ "items": { "type": "string" }, + "markdownDescription": "An array of server URLs\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalBootstrapServers", "type": "array" }, "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "ConsumerGroupID": { + "markdownDescription": "The name of the destination queue to consume\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConsumerGroupID", "type": "string" }, "Credentials": { - "$ref": "#/definitions/AWS::Pipes::Pipe.SelfManagedKafkaAccessConfigurationCredentials" + "$ref": "#/definitions/AWS::Pipes::Pipe.SelfManagedKafkaAccessConfigurationCredentials", + "markdownDescription": "The credentials needed to access the resource\\. \n*Required*: No \n*Type*: [SelfManagedKafkaAccessConfigurationCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Credentials" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" }, "ServerRootCaCertificate": { + "markdownDescription": "The ARN of the Secrets Manager secret used for certification\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerRootCaCertificate", "type": "string" }, "StartingPosition": { + "markdownDescription": "\\(Streams only\\) The position in a stream from which to start reading\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StartingPosition", "type": "string" }, "TopicName": { + "markdownDescription": "The name of the topic that the pipe will read from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TopicName", "type": "string" }, "Vpc": { - "$ref": "#/definitions/AWS::Pipes::Pipe.SelfManagedKafkaAccessConfigurationVpc" + "$ref": "#/definitions/AWS::Pipes::Pipe.SelfManagedKafkaAccessConfigurationVpc", + "markdownDescription": "This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used\\. \n*Required*: No \n*Type*: [SelfManagedKafkaAccessConfigurationVpc](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Vpc" } }, "required": [ @@ -146314,9 +150519,13 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" } }, @@ -146326,34 +150535,48 @@ "additionalProperties": false, "properties": { "ArrayProperties": { - "$ref": "#/definitions/AWS::Pipes::Pipe.BatchArrayProperties" + "$ref": "#/definitions/AWS::Pipes::Pipe.BatchArrayProperties", + "markdownDescription": "The array properties for the submitted job, such as the size of the array\\. The array size can be between 2 and 10,000\\. If you specify array properties for a job, it becomes an array job\\. This parameter is used only if the target is an AWS Batch job\\. \n*Required*: No \n*Type*: [BatchArrayProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batcharrayproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ArrayProperties" }, "ContainerOverrides": { - "$ref": "#/definitions/AWS::Pipes::Pipe.BatchContainerOverrides" + "$ref": "#/definitions/AWS::Pipes::Pipe.BatchContainerOverrides", + "markdownDescription": "The overrides that are sent to a container\\. \n*Required*: No \n*Type*: [BatchContainerOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContainerOverrides" }, "DependsOn": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.BatchJobDependency" }, + "markdownDescription": "A list of dependencies for the job\\. A job can depend upon a maximum of 20 jobs\\. You can specify a `SEQUENTIAL` type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0\\. You can also specify an `N_TO_N` type dependency with a job ID for array jobs\\. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin\\. \n*Required*: No \n*Type*: List of [BatchJobDependency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchjobdependency.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DependsOn", "type": "array" }, "JobDefinition": { + "markdownDescription": "The job definition used by this job\\. This value can be one of `name`, `name:revision`, or the Amazon Resource Name \\(ARN\\) for the job definition\\. If name is specified without a revision then the latest active revision is used\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "JobDefinition", "type": "string" }, "JobName": { + "markdownDescription": "The name of the job\\. It can be up to 128 letters long\\. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens \\(\\-\\), and underscores \\(\\_\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "JobName", "type": "string" }, "Parameters": { "additionalProperties": true, + "markdownDescription": "Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition\\. Parameters are specified as a key and value pair mapping\\. Parameters included here override any corresponding parameter defaults from the job definition\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Parameters", "type": "object" }, "RetryStrategy": { - "$ref": "#/definitions/AWS::Pipes::Pipe.BatchRetryStrategy" + "$ref": "#/definitions/AWS::Pipes::Pipe.BatchRetryStrategy", + "markdownDescription": "The retry strategy to use for failed jobs\\. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition\\. \n*Required*: No \n*Type*: [BatchRetryStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchretrystrategy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetryStrategy" } }, "required": [ @@ -146366,9 +150589,13 @@ "additionalProperties": false, "properties": { "LogStreamName": { + "markdownDescription": "The name of the log stream\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogStreamName", "type": "string" }, "Timestamp": { + "markdownDescription": "The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Timestamp", "type": "string" } }, @@ -146381,57 +150608,87 @@ "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.CapacityProviderStrategyItem" }, + "markdownDescription": "The capacity provider strategy to use for the task\\. \nIf a `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted\\. If no `capacityProviderStrategy` or launchType is specified, the `defaultCapacityProviderStrategy` for the cluster is used\\. \n*Required*: No \n*Type*: List of [CapacityProviderStrategyItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-capacityproviderstrategyitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CapacityProviderStrategy", "type": "array" }, "EnableECSManagedTags": { + "markdownDescription": "Specifies whether to enable Amazon ECS managed tags for the task\\. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon Elastic Container Service Developer Guide\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableECSManagedTags", "type": "boolean" }, "EnableExecuteCommand": { + "markdownDescription": "Whether or not to enable the execute command functionality for the containers in this task\\. If true, this enables execute command functionality on all containers in the task\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableExecuteCommand", "type": "boolean" }, "Group": { + "markdownDescription": "Specifies an Amazon ECS task group for the task\\. The maximum length is 255 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Group", "type": "string" }, "LaunchType": { + "markdownDescription": "Specifies the launch type on which your task is running\\. The launch type that you specify here must match one of the launch type \\(compatibilities\\) of the target task\\. The `FARGATE` value is supported only in the Regions where AWS Fargate with Amazon ECS is supported\\. For more information, see [AWS Fargate on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LaunchType", "type": "string" }, "NetworkConfiguration": { - "$ref": "#/definitions/AWS::Pipes::Pipe.NetworkConfiguration" + "$ref": "#/definitions/AWS::Pipes::Pipe.NetworkConfiguration", + "markdownDescription": "Use this structure if the Amazon ECS task uses the `awsvpc` network mode\\. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used\\. This structure is required if `LaunchType` is `FARGATE` because the `awsvpc` mode is required for Fargate tasks\\. \nIf you specify `NetworkConfiguration` when the target ECS task does not use the `awsvpc` network mode, the task fails\\. \n*Required*: No \n*Type*: [NetworkConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-networkconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkConfiguration" }, "Overrides": { - "$ref": "#/definitions/AWS::Pipes::Pipe.EcsTaskOverride" + "$ref": "#/definitions/AWS::Pipes::Pipe.EcsTaskOverride", + "markdownDescription": "The overrides that are associated with a task\\. \n*Required*: No \n*Type*: [EcsTaskOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecstaskoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Overrides" }, "PlacementConstraints": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.PlacementConstraint" }, + "markdownDescription": "An array of placement constraint objects to use for the task\\. You can specify up to 10 constraints per task \\(including constraints in the task definition and those specified at runtime\\)\\. \n*Required*: No \n*Type*: List of [PlacementConstraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementconstraint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PlacementConstraints", "type": "array" }, "PlacementStrategy": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.PlacementStrategy" }, + "markdownDescription": "The placement strategy objects to use for the task\\. You can specify a maximum of five strategy rules per task\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementstrategy.html) of [PlacementStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementstrategy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PlacementStrategy", "type": "array" }, "PlatformVersion": { + "markdownDescription": "Specifies the platform version for the task\\. Specify only the numeric portion of the platform version, such as `1.1.0`\\. \nThis structure is used only if `LaunchType` is `FARGATE`\\. For more information about valid platform versions, see [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PlatformVersion", "type": "string" }, "PropagateTags": { + "markdownDescription": "Specifies whether to propagate the tags from the task definition to the task\\. If no value is specified, the tags are not propagated\\. Tags can only be propagated to the task during task creation\\. To add tags to a task after task creation, use the `TagResource` API action\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PropagateTags", "type": "string" }, "ReferenceId": { + "markdownDescription": "The reference ID to use for the task\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReferenceId", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The metadata that you apply to the task to help you categorize and organize them\\. Each tag consists of a key and an optional value, both of which you define\\. To learn more, see [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) in the Amazon ECS API Reference\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TaskCount": { + "markdownDescription": "The number of tasks to create based on `TaskDefinition`\\. The default is 1\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TaskCount", "type": "number" }, "TaskDefinitionArn": { + "markdownDescription": "The ARN of the task definition to use if the event target is an Amazon ECS task\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TaskDefinitionArn", "type": "string" } }, @@ -146444,21 +150701,31 @@ "additionalProperties": false, "properties": { "DetailType": { + "markdownDescription": "A free\\-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DetailType", "type": "string" }, "EndpointId": { + "markdownDescription": "The URL subdomain of the endpoint\\. For example, if the URL for Endpoint is https://abcde\\.veo\\.endpoints\\.event\\.amazonaws\\.com, then the EndpointId is `abcde.veo`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndpointId", "type": "string" }, "Resources": { "items": { "type": "string" }, + "markdownDescription": "AWS resources, identified by Amazon Resource Name \\(ARN\\), which the event primarily concerns\\. Any number, including zero, may be present\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Resources", "type": "array" }, "Source": { + "markdownDescription": "The source of the event\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Source", "type": "string" }, "Time": { + "markdownDescription": "The time stamp of the event, per [RFC3339](https://www.rfc-editor.org/rfc/rfc3339.txt)\\. If no time stamp is provided, the time stamp of the [PutEvents](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) call is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Time", "type": "string" } }, @@ -146469,26 +150736,32 @@ "properties": { "HeaderParameters": { "additionalProperties": true, + "markdownDescription": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "HeaderParameters", "type": "object" }, "PathParameterValues": { "items": { "type": "string" }, + "markdownDescription": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards \\(\"\\*\"\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PathParameterValues", "type": "array" }, "QueryStringParameters": { "additionalProperties": true, + "markdownDescription": "The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "QueryStringParameters", "type": "object" } }, @@ -146498,6 +150771,8 @@ "additionalProperties": false, "properties": { "PartitionKey": { + "markdownDescription": "Determines which shard in the stream the data record is assigned to\\. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key\\. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard\\. Specifically, an MD5 hash function is used to map partition keys to 128\\-bit integer values and to map associated data records to shards\\. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PartitionKey", "type": "string" } }, @@ -146510,6 +150785,8 @@ "additionalProperties": false, "properties": { "InvocationType": { + "markdownDescription": "Specify whether to invoke the function synchronously or asynchronously\\. \n+ `REQUEST_RESPONSE` \\(default\\) \\- Invoke synchronously\\. This corresponds to the `RequestResponse` option in the `InvocationType` parameter for the Lambda [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) API\\.\n+ `FIRE_AND_FORGET` \\- Invoke asynchronously\\. This corresponds to the `Event` option in the `InvocationType` parameter for the Lambda [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) API\\.\nFor more information, see [Invocation types](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) in the *Amazon EventBridge User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InvocationType", "type": "string" } }, @@ -146519,40 +150796,64 @@ "additionalProperties": false, "properties": { "BatchJobParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetBatchJobParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetBatchJobParameters", + "markdownDescription": "The parameters for using an AWS Batch job as a target\\. \n*Required*: No \n*Type*: [PipeTargetBatchJobParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchJobParameters" }, "CloudWatchLogsParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetCloudWatchLogsParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetCloudWatchLogsParameters", + "markdownDescription": "The parameters for using an CloudWatch Logs log stream as a target\\. \n*Required*: No \n*Type*: [PipeTargetCloudWatchLogsParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetcloudwatchlogsparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CloudWatchLogsParameters" }, "EcsTaskParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetEcsTaskParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetEcsTaskParameters", + "markdownDescription": "The parameters for using an Amazon ECS task as a target\\. \n*Required*: No \n*Type*: [PipeTargetEcsTaskParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EcsTaskParameters" }, "EventBridgeEventBusParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetEventBridgeEventBusParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetEventBridgeEventBusParameters", + "markdownDescription": "The parameters for using an EventBridge event bus as a target\\. \n*Required*: No \n*Type*: [PipeTargetEventBridgeEventBusParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventBridgeEventBusParameters" }, "HttpParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetHttpParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetHttpParameters", + "markdownDescription": "These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations\\. \n*Required*: No \n*Type*: [PipeTargetHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargethttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HttpParameters" }, "InputTemplate": { + "markdownDescription": "Valid JSON text passed to the target\\. In this case, nothing from the event itself is passed to the target\\. For more information, see [The JavaScript Object Notation \\(JSON\\) Data Interchange Format](http://www.rfc-editor.org/rfc/rfc7159.txt)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputTemplate", "type": "string" }, "KinesisStreamParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetKinesisStreamParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetKinesisStreamParameters", + "markdownDescription": "The parameters for using a Kinesis stream as a source\\. \n*Required*: No \n*Type*: [PipeTargetKinesisStreamParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetkinesisstreamparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KinesisStreamParameters" }, "LambdaFunctionParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetLambdaFunctionParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetLambdaFunctionParameters", + "markdownDescription": "The parameters for using a Lambda function as a target\\. \n*Required*: No \n*Type*: [PipeTargetLambdaFunctionParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetlambdafunctionparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LambdaFunctionParameters" }, "RedshiftDataParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetRedshiftDataParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetRedshiftDataParameters", + "markdownDescription": "These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement\\. \n*Required*: No \n*Type*: [PipeTargetRedshiftDataParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RedshiftDataParameters" }, "SageMakerPipelineParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetSageMakerPipelineParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetSageMakerPipelineParameters", + "markdownDescription": "The parameters for using a SageMaker pipeline as a target\\. \n*Required*: No \n*Type*: [PipeTargetSageMakerPipelineParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsagemakerpipelineparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SageMakerPipelineParameters" }, "SqsQueueParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetSqsQueueParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetSqsQueueParameters", + "markdownDescription": "The parameters for using a Amazon SQS stream as a source\\. \n*Required*: No \n*Type*: [PipeTargetSqsQueueParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SqsQueueParameters" }, "StepFunctionStateMachineParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetStateMachineParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetStateMachineParameters", + "markdownDescription": "The parameters for using a Step Functions state machine as a target\\. \n*Required*: No \n*Type*: [PipeTargetStateMachineParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetstatemachineparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StepFunctionStateMachineParameters" } }, "type": "object" @@ -146561,24 +150862,36 @@ "additionalProperties": false, "properties": { "Database": { + "markdownDescription": "The name of the database\\. Required when authenticating using temporary credentials\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Database", "type": "string" }, "DbUser": { + "markdownDescription": "The database user name\\. Required when authenticating using temporary credentials\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DbUser", "type": "string" }, "SecretManagerArn": { + "markdownDescription": "The name or ARN of the secret that enables access to the database\\. Required when authenticating using Secrets Manager\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecretManagerArn", "type": "string" }, "Sqls": { "items": { "type": "string" }, + "markdownDescription": "The SQL statement text to run\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sqls", "type": "array" }, "StatementName": { + "markdownDescription": "The name of the SQL statement\\. You can name the SQL statement when you create it to identify the query\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StatementName", "type": "string" }, "WithEvent": { + "markdownDescription": "Indicates whether to send an event back to EventBridge after the SQL statement runs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WithEvent", "type": "boolean" } }, @@ -146595,6 +150908,8 @@ "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.SageMakerPipelineParameter" }, + "markdownDescription": "List of Parameter names and values for SageMaker Model Building Pipeline execution\\. \n*Required*: No \n*Type*: List of [SageMakerPipelineParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-sagemakerpipelineparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PipelineParameterList", "type": "array" } }, @@ -146604,9 +150919,13 @@ "additionalProperties": false, "properties": { "MessageDeduplicationId": { + "markdownDescription": "This parameter applies only to FIFO \\(first\\-in\\-first\\-out\\) queues\\. \nThe token used for deduplication of sent messages\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageDeduplicationId", "type": "string" }, "MessageGroupId": { + "markdownDescription": "The FIFO message group ID to use as the target\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageGroupId", "type": "string" } }, @@ -146616,6 +150935,8 @@ "additionalProperties": false, "properties": { "InvocationType": { + "markdownDescription": "Specify whether to invoke the Step Functions state machine synchronously or asynchronously\\. \n+ `REQUEST_RESPONSE` \\(default\\) \\- Invoke synchronously\\. For more information, see [StartSyncExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html) in the *AWS Step Functions API Reference*\\.\n**Note** \n`REQUEST_RESPONSE` is not supported for `STANDARD` state machine workflows\\.\n+ `FIRE_AND_FORGET` \\- Invoke asynchronously\\. For more information, see [StartExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html) in the *AWS Step Functions API Reference*\\.\nFor more information, see [Invocation types](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) in the *Amazon EventBridge User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InvocationType", "type": "string" } }, @@ -146625,9 +150946,13 @@ "additionalProperties": false, "properties": { "Expression": { + "markdownDescription": "A cluster query language expression to apply to the constraint\\. You cannot specify an expression if the constraint type is `distinctInstance`\\. To learn more, see [Cluster Query Language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the Amazon Elastic Container Service Developer Guide\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Expression", "type": "string" }, "Type": { + "markdownDescription": "The type of constraint\\. Use distinctInstance to ensure that each task in a particular group is running on a different container instance\\. Use memberOf to restrict the selection to a group of valid candidates\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -146637,9 +150962,13 @@ "additionalProperties": false, "properties": { "Field": { + "markdownDescription": "The field to apply the placement strategy against\\. For the spread placement strategy, valid values are instanceId \\(or host, which has the same effect\\), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs\\.availability\\-zone\\. For the binpack placement strategy, valid values are cpu and memory\\. For the random placement strategy, this field is not used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Field", "type": "string" }, "Type": { + "markdownDescription": "The type of placement strategy\\. The random placement strategy randomly places tasks on available candidates\\. The spread placement strategy spreads placement across available candidates evenly based on the field parameter\\. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter\\. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory \\(but still enough to run the task\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -146649,9 +150978,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "Name of parameter to start execution of a SageMaker Model Building Pipeline\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Value": { + "markdownDescription": "Value of parameter to start execution of a SageMaker Model Building Pipeline\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -146665,15 +150998,23 @@ "additionalProperties": false, "properties": { "BasicAuth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BasicAuth", "type": "string" }, "ClientCertificateTlsAuth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientCertificateTlsAuth", "type": "string" }, "SaslScram256Auth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SaslScram256Auth", "type": "string" }, "SaslScram512Auth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SaslScram512Auth", "type": "string" } }, @@ -146686,12 +151027,16 @@ "items": { "type": "string" }, + "markdownDescription": "Specifies the security groups associated with the stream\\. These security groups must all be in the same VPC\\. You can specify as many as five security groups\\. If you do not specify a security group, the default security group for the VPC is used\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroup", "type": "array" }, "Subnets": { "items": { "type": "string" }, + "markdownDescription": "Specifies the subnets associated with the stream\\. These subnets must all be in the same VPC\\. You can specify as many as 16 subnets\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Subnets", "type": "array" } }, @@ -146733,12 +151078,12 @@ "additionalProperties": false, "properties": { "DeletionProtection": { - "markdownDescription": "The flag that prevents a ledger from being deleted by any user\\. If not provided on ledger creation, this feature is enabled \\(`true`\\) by default\\. \nIf deletion protection is enabled, you must first disable it before you can delete the ledger\\. You can disable it by calling the `UpdateLedger` operation to set the flag to `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the ledger is protected from being deleted by any user\\. If not defined during ledger creation, this feature is enabled \\(`true`\\) by default\\. \nIf deletion protection is enabled, you must first disable it before you can delete the ledger\\. You can disable it by calling the `UpdateLedger` operation to set this parameter to `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeletionProtection", "type": "boolean" }, "KmsKey": { - "markdownDescription": "The key in AWS Key Management Service \\(AWS KMS\\) to use for encryption of data at rest in the ledger\\. For more information, see [Encryption at rest](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) in the *Amazon QLDB Developer Guide*\\. \nUse one of the following options to specify this parameter: \n+ `AWS_OWNED_KMS_KEY`: Use an AWS KMS key that is owned and managed by AWS on your behalf\\.\n+ **Undefined**: By default, use an AWS owned KMS key\\.\n+ **A valid symmetric customer managed KMS key**: Use the specified KMS key in your account that you create, own, and manage\\.", + "markdownDescription": "The key in AWS Key Management Service \\(AWS KMS\\) to use for encryption of data at rest in the ledger\\. For more information, see [Encryption at rest](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) in the *Amazon QLDB Developer Guide*\\. \nUse one of the following options to specify this parameter: \n+ `AWS_OWNED_KMS_KEY`: Use an AWS KMS key that is owned and managed by AWS on your behalf\\.\n+ **Undefined**: By default, use an AWS owned KMS key\\.\n+ **A valid symmetric customer managed KMS key**: Use the specified symmetric encryption KMS key in your account that you create, own, and manage\\.", "title": "KmsKey", "type": "string" }, @@ -146943,7 +151288,7 @@ "additionalProperties": false, "properties": { "AnalysisId": { - "markdownDescription": "The ID for the analysis that you're creating\\. This ID displays in the URL of the analysis\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID for the analysis that you're creating\\. This ID displays in the URL of the analysis\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AnalysisId", "type": "string" }, @@ -146956,7 +151301,7 @@ "items": { "$ref": "#/definitions/AWS::QuickSight::Analysis.AnalysisError" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [AnalysisError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysiserror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [AnalysisError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysiserror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Errors", "type": "array" }, @@ -146980,7 +151325,7 @@ }, "SourceEntity": { "$ref": "#/definitions/AWS::QuickSight::Analysis.AnalysisSourceEntity", - "markdownDescription": "A source entity to use for the analysis that you're creating\\. This metadata structure contains details that describe a source template and one or more datasets\\. \n*Required*: Yes \n*Type*: [AnalysisSourceEntity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourceentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A source entity to use for the analysis that you're creating\\. This metadata structure contains details that describe a source template and one or more datasets\\. \nEither a `SourceEntity` or a `Definition` must be provided in order for the request to be valid\\. \n*Required*: Yes \n*Type*: [AnalysisSourceEntity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourceentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceEntity" }, "Tags": { @@ -147229,12 +151574,12 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of a sheet\\. This name is displayed on the sheet's tab in the Amazon QuickSight console\\. \n*Required*: No \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of a sheet\\. This name is displayed on the sheet's tab in the Amazon QuickSight console\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "SheetId": { - "markdownDescription": "The unique identifier associated with a sheet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unique identifier associated with a sheet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SheetId", "type": "string" } @@ -147305,7 +151650,7 @@ "type": "string" }, "DashboardId": { - "markdownDescription": "The ID for the dashboard, also added to the IAM policy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID for the dashboard, also added to the IAM policy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DashboardId", "type": "string" }, @@ -147399,9 +151744,13 @@ "additionalProperties": false, "properties": { "Message": { + "markdownDescription": "Message\\. \n*Required*: No \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Message", "type": "string" }, "Type": { + "markdownDescription": "Type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACCESS_DENIED | COLUMN_GEOGRAPHIC_ROLE_MISMATCH | COLUMN_REPLACEMENT_MISSING | COLUMN_TYPE_MISMATCH | DATA_SET_NOT_FOUND | INTERNAL_FAILURE | PARAMETER_NOT_FOUND | PARAMETER_TYPE_INVALID | PARAMETER_VALUE_INCOMPATIBLE | SOURCE_NOT_FOUND` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -147466,42 +151815,62 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Arn", "type": "string" }, "CreatedTime": { + "markdownDescription": "The time that this dashboard version was created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreatedTime", "type": "string" }, "DataSetArns": { "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Numbers \\(ARNs\\) for the datasets that are associated with this version of the dashboard\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSetArns", "type": "array" }, "Description": { + "markdownDescription": "Description\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Errors": { "items": { "$ref": "#/definitions/AWS::QuickSight::Dashboard.DashboardError" }, + "markdownDescription": "Errors associated with this dashboard version\\. \n*Required*: No \n*Type*: List of [DashboardError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboarderror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Errors", "type": "array" }, "Sheets": { "items": { "$ref": "#/definitions/AWS::QuickSight::Dashboard.Sheet" }, + "markdownDescription": "A list of the associated sheets with the unique identifier and name of each sheet\\. \n*Required*: No \n*Type*: List of [Sheet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheet.html) \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sheets", "type": "array" }, "SourceEntityArn": { + "markdownDescription": "Source entity ARN\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceEntityArn", "type": "string" }, "Status": { + "markdownDescription": "The HTTP status of the request\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CREATION_FAILED | CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | DELETED | UPDATE_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "ThemeArn": { + "markdownDescription": "The ARN of the theme associated with a version of the dashboard\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ThemeArn", "type": "string" }, "VersionNumber": { + "markdownDescription": "Version number for this version of the dashboard\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VersionNumber", "type": "number" } }, @@ -147672,9 +152041,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of a sheet\\. This name is displayed on the sheet's tab in the Amazon QuickSight console\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "SheetId": { + "markdownDescription": "The unique identifier associated with a sheet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SheetId", "type": "string" } }, @@ -147776,7 +152149,9 @@ "type": "string" }, "DataSetUsageConfiguration": { - "$ref": "#/definitions/AWS::QuickSight::DataSet.DataSetUsageConfiguration" + "$ref": "#/definitions/AWS::QuickSight::DataSet.DataSetUsageConfiguration", + "markdownDescription": "The usage configuration to apply to child datasets that reference this dataset as a source\\. \n*Required*: No \n*Type*: [DataSetUsageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetusageconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSetUsageConfiguration" }, "FieldFolders": { "additionalProperties": false, @@ -148037,9 +152412,13 @@ "additionalProperties": false, "properties": { "DisableUseAsDirectQuerySource": { + "markdownDescription": "An option that controls whether a child dataset of a direct query can use this dataset as a source\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DisableUseAsDirectQuerySource", "type": "boolean" }, "DisableUseAsImportedSource": { + "markdownDescription": "An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DisableUseAsImportedSource", "type": "boolean" } }, @@ -148207,7 +152586,7 @@ "items": { "$ref": "#/definitions/AWS::QuickSight::DataSet.TransformOperation" }, - "markdownDescription": "Transform operations that act on this logical table\\. \n*Required*: No \n*Type*: List of [TransformOperation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html) \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Transform operations that act on this logical table\\. For this structure to be valid, only one of the attributes can be non\\-null\\. \n*Required*: No \n*Type*: List of [TransformOperation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html) \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataTransforms", "type": "array" }, @@ -148227,6 +152606,8 @@ "additionalProperties": false, "properties": { "DataSetArn": { + "markdownDescription": "The Amazon Resource Number \\(ARN\\) of the parent dataset\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSetArn", "type": "string" }, "JoinInstruction": { @@ -148305,7 +152686,7 @@ "additionalProperties": false, "properties": { "Catalog": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Catalog", "type": "string" }, @@ -148626,7 +153007,7 @@ "type": "array" }, "Type": { - "markdownDescription": "The type of the data source\\. To return a list of all data sources, use `ListDataSources`\\. \nUse `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | AMAZON_OPENSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | EXASOL | GITHUB | JIRA | MARIADB | MYSQL | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TIMESTREAM | TWITTER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of the data source\\. To return a list of all data sources, use `ListDataSources`\\. \nUse `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | AMAZON_OPENSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | DATABRICKS | EXASOL | GITHUB | JIRA | MARIADB | MYSQL | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TIMESTREAM | TWITTER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" }, @@ -148791,6 +153172,8 @@ "title": "CredentialPair" }, "SecretArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the secret associated with the data source in Amazon Secrets Manager\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecretArn", "type": "string" } }, @@ -148841,7 +153224,9 @@ "title": "AuroraPostgreSqlParameters" }, "DatabricksParameters": { - "$ref": "#/definitions/AWS::QuickSight::DataSource.DatabricksParameters" + "$ref": "#/definitions/AWS::QuickSight::DataSource.DatabricksParameters", + "markdownDescription": "The required parameters that are needed to connect to a Databricks data source\\. \n*Required*: No \n*Type*: [DatabricksParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-databricksparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DatabricksParameters" }, "MariaDbParameters": { "$ref": "#/definitions/AWS::QuickSight::DataSource.MariaDbParameters", @@ -148910,12 +153295,18 @@ "additionalProperties": false, "properties": { "Host": { + "markdownDescription": "The host name of the Databricks data source\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Host", "type": "string" }, "Port": { + "markdownDescription": "The port for the Databricks data source\\. \n*Required*: Yes \n*Type*: Double \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "SqlEndpointPath": { + "markdownDescription": "The HTTP path of the Databricks data source\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SqlEndpointPath", "type": "string" } }, @@ -149340,7 +153731,7 @@ }, "SourceEntity": { "$ref": "#/definitions/AWS::QuickSight::Template.TemplateSourceEntity", - "markdownDescription": "The entity that you are using as a source when you create the template\\. In `SourceEntity`, you specify the type of object you're using as source: `SourceTemplate` for a template or `SourceAnalysis` for an analysis\\. Both of these require an Amazon Resource Name \\(ARN\\)\\. For `SourceTemplate`, specify the ARN of the source template\\. For `SourceAnalysis`, specify the ARN of the source analysis\\. The `SourceTemplate` ARN can contain any AWS account and any Amazon QuickSight\\-supported AWS Region\\. \nUse the `DataSetReferences` entity within `SourceTemplate` or `SourceAnalysis` to list the replacement datasets for the placeholders listed in the original\\. The schema in each dataset must match its placeholder\\. \n*Required*: Yes \n*Type*: [TemplateSourceEntity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The entity that you are using as a source when you create the template\\. In `SourceEntity`, you specify the type of object you're using as source: `SourceTemplate` for a template or `SourceAnalysis` for an analysis\\. Both of these require an Amazon Resource Name \\(ARN\\)\\. For `SourceTemplate`, specify the ARN of the source template\\. For `SourceAnalysis`, specify the ARN of the source analysis\\. The `SourceTemplate` ARN can contain any AWS account and any Amazon QuickSight\\-supported AWS Region\\. \nUse the `DataSetReferences` entity within `SourceTemplate` or `SourceAnalysis` to list the replacement datasets for the placeholders listed in the original\\. The schema in each dataset must match its placeholder\\. \nEither a `SourceEntity` or a `Definition` must be provided in order for the request to be valid\\. \n*Required*: Yes \n*Type*: [TemplateSourceEntity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceEntity" }, "Tags": { @@ -149352,7 +153743,7 @@ "type": "array" }, "TemplateId": { - "markdownDescription": "An ID for the template that you want to create\\. This template is unique per AWS Region; in each AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An ID for the template that you want to create\\. This template is unique per AWS Region; in each AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TemplateId", "type": "string" }, @@ -149394,6 +153785,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the column group's column schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -149406,9 +153799,13 @@ "items": { "$ref": "#/definitions/AWS::QuickSight::Template.ColumnGroupColumnSchema" }, + "markdownDescription": "A structure containing the list of schemas for column group columns\\. \n*Required*: No \n*Type*: List of [ColumnGroupColumnSchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupcolumnschema.html) \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ColumnGroupColumnSchemaList", "type": "array" }, "Name": { + "markdownDescription": "The name of the column group schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -149418,12 +153815,18 @@ "additionalProperties": false, "properties": { "DataType": { + "markdownDescription": "The data type of the column schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType", "type": "string" }, "GeographicRole": { + "markdownDescription": "The geographic role of the column schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GeographicRole", "type": "string" }, "Name": { + "markdownDescription": "The name of the column schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -149436,12 +153839,18 @@ "items": { "$ref": "#/definitions/AWS::QuickSight::Template.ColumnGroupSchema" }, + "markdownDescription": "A structure containing the list of column group schemas\\. \n*Required*: No \n*Type*: List of [ColumnGroupSchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupschema.html) \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ColumnGroupSchemaList", "type": "array" }, "DataSetSchema": { - "$ref": "#/definitions/AWS::QuickSight::Template.DataSetSchema" + "$ref": "#/definitions/AWS::QuickSight::Template.DataSetSchema", + "markdownDescription": "Dataset schema\\. \n*Required*: No \n*Type*: [DataSetSchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetschema.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSetSchema" }, "Placeholder": { + "markdownDescription": "Placeholder\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Placeholder", "type": "string" } }, @@ -149474,6 +153883,8 @@ "items": { "$ref": "#/definitions/AWS::QuickSight::Template.ColumnSchema" }, + "markdownDescription": "A structure containing the list of column schemas\\. \n*Required*: No \n*Type*: List of [ColumnSchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html) \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ColumnSchemaList", "type": "array" } }, @@ -149506,9 +153917,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of a sheet\\. This name is displayed on the sheet's tab in the Amazon QuickSight console\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "SheetId": { + "markdownDescription": "The unique identifier associated with a sheet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SheetId", "type": "string" } }, @@ -149518,9 +153933,13 @@ "additionalProperties": false, "properties": { "Message": { + "markdownDescription": "Description of the error type\\. \n*Required*: No \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Message", "type": "string" }, "Type": { + "markdownDescription": "Type of error\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACCESS_DENIED | DATA_SET_NOT_FOUND | INTERNAL_FAILURE | SOURCE_NOT_FOUND` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -149583,39 +154002,57 @@ "additionalProperties": false, "properties": { "CreatedTime": { + "markdownDescription": "The time that this template version was created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreatedTime", "type": "string" }, "DataSetConfigurations": { "items": { "$ref": "#/definitions/AWS::QuickSight::Template.DataSetConfiguration" }, + "markdownDescription": "Schema of the dataset identified by the placeholder\\. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation\\. \n*Required*: No \n*Type*: List of [DataSetConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html) \n*Maximum*: `30` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSetConfigurations", "type": "array" }, "Description": { + "markdownDescription": "The description of the template\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Errors": { "items": { "$ref": "#/definitions/AWS::QuickSight::Template.TemplateError" }, + "markdownDescription": "Errors associated with this template version\\. \n*Required*: No \n*Type*: List of [TemplateError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateerror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Errors", "type": "array" }, "Sheets": { "items": { "$ref": "#/definitions/AWS::QuickSight::Template.Sheet" }, + "markdownDescription": "A list of the associated sheets with the unique identifier and name of each sheet\\. \n*Required*: No \n*Type*: List of [Sheet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheet.html) \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sheets", "type": "array" }, "SourceEntityArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an analysis or template that was used to create this template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceEntityArn", "type": "string" }, "Status": { + "markdownDescription": "The status that is associated with the template\\. \n+ `CREATION_IN_PROGRESS` \n+ `CREATION_SUCCESSFUL` \n+ `CREATION_FAILED` \n+ `UPDATE_IN_PROGRESS` \n+ `UPDATE_SUCCESSFUL` \n+ `UPDATE_FAILED` \n+ `DELETED` \n*Required*: No \n*Type*: String \n*Allowed values*: `CREATION_FAILED | CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | DELETED | UPDATE_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "ThemeArn": { + "markdownDescription": "The ARN of the theme associated with this version of the template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ThemeArn", "type": "string" }, "VersionNumber": { + "markdownDescription": "The version number of the template version\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VersionNumber", "type": "number" } }, @@ -149662,7 +154099,7 @@ "type": "string" }, "BaseThemeId": { - "markdownDescription": "The ID of the theme that a custom theme will inherit from\\. All themes inherit from one of the starting themes defined by Amazon QuickSight\\. For a list of the starting themes, use `ListThemes` or choose **Themes** from within an analysis\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of the theme that a custom theme will inherit from\\. All themes inherit from one of the starting themes defined by Amazon QuickSight\\. For a list of the starting themes, use `ListThemes` or choose **Themes** from within an analysis\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BaseThemeId", "type": "string" }, @@ -149693,7 +154130,7 @@ "type": "array" }, "ThemeId": { - "markdownDescription": "An ID for the theme that you want to create\\. The theme ID is unique per AWS Region in each AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An ID for the theme that you want to create\\. The theme ID is unique per AWS Region in each AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ThemeId", "type": "string" }, @@ -149772,7 +154209,7 @@ "additionalProperties": false, "properties": { "FontFamily": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FontFamily", "type": "string" } @@ -149855,7 +154292,7 @@ }, "Typography": { "$ref": "#/definitions/AWS::QuickSight::Theme.Typography", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [Typography](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-typography.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Typography](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-typography.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Typography" }, "UIColorPalette": { @@ -149870,9 +154307,13 @@ "additionalProperties": false, "properties": { "Message": { + "markdownDescription": "The error message\\. \n*Required*: No \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Message", "type": "string" }, "Type": { + "markdownDescription": "The type of error\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `INTERNAL_FAILURE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -149882,30 +154323,46 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Arn", "type": "string" }, "BaseThemeId": { + "markdownDescription": "The Amazon QuickSight\\-defined ID of the theme that a custom theme inherits from\\. All themes initially inherit from a default Amazon QuickSight theme\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BaseThemeId", "type": "string" }, "Configuration": { - "$ref": "#/definitions/AWS::QuickSight::Theme.ThemeConfiguration" + "$ref": "#/definitions/AWS::QuickSight::Theme.ThemeConfiguration", + "markdownDescription": "The theme configuration, which contains all the theme display properties\\. \n*Required*: No \n*Type*: [ThemeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Configuration" }, "CreatedTime": { + "markdownDescription": "The date and time that this theme version was created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreatedTime", "type": "string" }, "Description": { + "markdownDescription": "The description of the theme\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Errors": { "items": { "$ref": "#/definitions/AWS::QuickSight::Theme.ThemeError" }, + "markdownDescription": "Errors associated with the theme\\. \n*Required*: No \n*Type*: List of [ThemeError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeerror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Errors", "type": "array" }, "Status": { + "markdownDescription": "The status of the theme version\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CREATION_FAILED | CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | DELETED | UPDATE_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "VersionNumber": { + "markdownDescription": "The version number of the theme\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VersionNumber", "type": "number" } }, @@ -149945,7 +154402,7 @@ "items": { "$ref": "#/definitions/AWS::QuickSight::Theme.Font" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [Font](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-font.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Font](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-font.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FontFamilies", "type": "array" } @@ -150178,231 +154635,269 @@ "additionalProperties": false, "properties": { "AllocatedStorage": { + "markdownDescription": "The amount of storage in gibibytes \\(GiB\\) to allocate to each DB instance in the Multi\\-AZ DB cluster\\. \nThis setting is required to create a Multi\\-AZ DB cluster\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllocatedStorage", "type": "number" }, "AssociatedRoles": { "items": { "$ref": "#/definitions/AWS::RDS::DBCluster.DBClusterRole" }, - "markdownDescription": "Provides a list of the AWS Identity and Access Management \\(IAM\\) roles that are associated with the DB cluster\\. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf\\. \n*Required*: No \n*Type*: List of [DBClusterRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides a list of the AWS Identity and Access Management \\(IAM\\) roles that are associated with the DB cluster\\. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: List of [DBClusterRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AssociatedRoles", "type": "array" }, "AutoMinorVersionUpgrade": { + "markdownDescription": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window\\. By default, minor engine upgrades are applied automatically\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoMinorVersionUpgrade", "type": "boolean" }, "AvailabilityZones": { "items": { "type": "string" }, - "markdownDescription": "A list of Availability Zones \\(AZs\\) where instances in the DB cluster can be created\\. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of Availability Zones \\(AZs\\) where instances in the DB cluster can be created\\. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AvailabilityZones", "type": "array" }, "BacktrackWindow": { - "markdownDescription": "The target backtrack window, in seconds\\. To disable backtracking, set this value to 0\\. \nCurrently, Backtrack is only supported for Aurora MySQL DB clusters\\.\nDefault: 0 \nConstraints: \n+ If specified, this value must be set to a number from 0 to 259,200 \\(72 hours\\)\\.\n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The target backtrack window, in seconds\\. To disable backtracking, set this value to 0\\. \nCurrently, Backtrack is only supported for Aurora MySQL DB clusters\\.\nDefault: 0 \nConstraints: \n+ If specified, this value must be set to a number from 0 to 259,200 \\(72 hours\\)\\.\nValid for: Aurora MySQL DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BacktrackWindow", "type": "number" }, "BackupRetentionPeriod": { - "markdownDescription": "The number of days for which automated backups are retained\\. \nDefault: 1 \nConstraints: \n+ Must be a value from 1 to 35\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of days for which automated backups are retained\\. \nDefault: 1 \nConstraints: \n+ Must be a value from 1 to 35\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BackupRetentionPeriod", "type": "number" }, "CopyTagsToSnapshot": { - "markdownDescription": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster\\. The default is not to copy them\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster\\. The default is not to copy them\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CopyTagsToSnapshot", "type": "boolean" }, "DBClusterIdentifier": { - "markdownDescription": "The DB cluster identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain from 1 to 63 letters, numbers, or hyphens\\.\n+ First character must be a letter\\.\n+ Can't end with a hyphen or contain two consecutive hyphens\\.\nExample: `my-cluster1` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The DB cluster identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain from 1 to 63 letters, numbers, or hyphens\\.\n+ First character must be a letter\\.\n+ Can't end with a hyphen or contain two consecutive hyphens\\.\nExample: `my-cluster1` \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DBClusterIdentifier", "type": "string" }, "DBClusterInstanceClass": { + "markdownDescription": "The compute and memory capacity of each DB instance in the Multi\\-AZ DB cluster, for example db\\.m6gd\\.xlarge\\. Not all DB instance classes are available in all AWS Regions, or for all database engines\\. \nFor the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*\\. \nThis setting is required to create a Multi\\-AZ DB cluster\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DBClusterInstanceClass", "type": "string" }, "DBClusterParameterGroupName": { - "markdownDescription": "The name of the DB cluster parameter group to associate with this DB cluster\\. \nIf you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot\\. This can result in an outage while the DB instances are rebooting\\. \nIf you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started\\.\nTo list all of the available DB cluster parameter group names, use the following command: \n`aws rds describe-db-cluster-parameter-groups --query \"DBClusterParameterGroups[].DBClusterParameterGroupName\" --output text` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the DB cluster parameter group to associate with this DB cluster\\. \nIf you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot\\. This can result in an outage while the DB instances are rebooting\\. \nIf you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started\\.\nTo list all of the available DB cluster parameter group names, use the following command: \n`aws rds describe-db-cluster-parameter-groups --query \"DBClusterParameterGroups[].DBClusterParameterGroupName\" --output text` \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DBClusterParameterGroupName", "type": "string" }, "DBInstanceParameterGroupName": { + "markdownDescription": "The name of the DB parameter group to apply to all instances of the DB cluster\\. \nWhen you apply a parameter group using the `DBInstanceParameterGroupName` parameter, the DB cluster isn't rebooted automatically\\. Also, parameter changes are applied immediately rather than during the next maintenance window\\.\nDefault: The existing name setting \nConstraints: \n+ The DB parameter group must be in the same DB parameter group family as this DB cluster\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DBInstanceParameterGroupName", "type": "string" }, "DBSubnetGroupName": { - "markdownDescription": "A DB subnet group that you want to associate with this DB cluster\\. \nIf you are restoring a DB cluster to a point in time with `RestoreType` set to `copy-on-write`, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A DB subnet group that you want to associate with this DB cluster\\. \nIf you are restoring a DB cluster to a point in time with `RestoreType` set to `copy-on-write`, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DBSubnetGroupName", "type": "string" }, "DBSystemId": { + "markdownDescription": "Reserved for future use\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DBSystemId", "type": "string" }, "DatabaseName": { - "markdownDescription": "The name of your database\\. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster\\. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of your database\\. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster\\. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DatabaseName", "type": "string" }, "DeletionProtection": { - "markdownDescription": "A value that indicates whether the DB cluster has deletion protection enabled\\. The database can't be deleted when deletion protection is enabled\\. By default, deletion protection is disabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether the DB cluster has deletion protection enabled\\. The database can't be deleted when deletion protection is enabled\\. By default, deletion protection is disabled\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeletionProtection", "type": "boolean" }, "Domain": { + "markdownDescription": "Indicates the directory ID of the Active Directory to create the DB cluster\\. \nFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster\\. \nFor more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Domain", "type": "string" }, "DomainIAMRoleName": { + "markdownDescription": "Specifies the name of the IAM role to use when making API calls to the Directory Service\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DomainIAMRoleName", "type": "string" }, "EnableCloudwatchLogsExports": { "items": { "type": "string" }, - "markdownDescription": "The list of log types that need to be enabled for exporting to CloudWatch Logs\\. The values in the list depend on the DB engine being used\\. For more information, see [ Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*\\. \n **Aurora MySQL** \nValid values: `audit`, `error`, `general`, `slowquery` \n **Aurora PostgreSQL** \nValid values: `postgresql` \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The list of log types that need to be enabled for exporting to CloudWatch Logs\\. The values in the list depend on the DB engine being used\\. For more information, see [ Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*\\. \n **Aurora MySQL** \nValid values: `audit`, `error`, `general`, `slowquery` \n **Aurora PostgreSQL** \nValid values: `postgresql` \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableCloudwatchLogsExports", "type": "array" }, "EnableHttpEndpoint": { - "markdownDescription": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster\\. By default, the HTTP endpoint is disabled\\. \nWhen enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster\\. You can also query your database from inside the RDS console with the query editor\\. \nFor more information, see [Using the Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster\\. By default, the HTTP endpoint is disabled\\. \nWhen enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster\\. You can also query your database from inside the RDS console with the query editor\\. \nFor more information, see [Using the Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableHttpEndpoint", "type": "boolean" }, "EnableIAMDatabaseAuthentication": { - "markdownDescription": "A value that indicates whether to enable mapping of AWS Identity and Access Management \\(IAM\\) accounts to database accounts\\. By default, mapping is disabled\\. \nFor more information, see [ IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide\\.* \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether to enable mapping of AWS Identity and Access Management \\(IAM\\) accounts to database accounts\\. By default, mapping is disabled\\. \nFor more information, see [ IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide\\.* \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableIAMDatabaseAuthentication", "type": "boolean" }, "Engine": { - "markdownDescription": "The name of the database engine to be used for this DB cluster\\. \nValid Values: `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\), `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\), and `aurora-postgresql` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The name of the database engine to be used for this DB cluster\\. \nValid Values: \n+ `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\)\n+ `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\)\n+ `aurora-postgresql`\n+ `mysql`\n+ `postgres`\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "Engine", "type": "string" }, "EngineMode": { - "markdownDescription": "The DB engine mode of the DB cluster, either `provisioned`, `serverless`, `parallelquery`, `global`, or `multimaster`\\. \nThe `parallelquery` engine mode isn't required for Aurora MySQL version 1\\.23 and higher 1\\.x versions, and version 2\\.09 and higher 2\\.x versions\\. \nThe `global` engine mode isn't required for Aurora MySQL version 1\\.22 and higher 1\\.x versions, and `global` engine mode isn't required for any 2\\.x versions\\. \nThe `multimaster` engine mode only applies for DB clusters created with Aurora MySQL version 5\\.6\\.10a\\. \nFor Aurora PostgreSQL, the `global` engine mode isn't required, and both the `parallelquery` and the `multimaster` engine modes currently aren't supported\\. \nLimitations and requirements apply to some DB engine modes\\. For more information, see the following sections in the *Amazon Aurora User Guide*: \n+ [ Limitations of Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) \n+ [ Limitations of Parallel Query](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations) \n+ [ Limitations of Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations) \n+ [ Limitations of Multi\\-Master Clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations) \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The DB engine mode of the DB cluster, either `provisioned`, `serverless`, `parallelquery`, `global`, or `multimaster`\\. \nThe `parallelquery` engine mode isn't required for Aurora MySQL version 1\\.23 and higher 1\\.x versions, and version 2\\.09 and higher 2\\.x versions\\. \nThe `global` engine mode isn't required for Aurora MySQL version 1\\.22 and higher 1\\.x versions, and `global` engine mode isn't required for any 2\\.x versions\\. \nThe `multimaster` engine mode only applies for DB clusters created with Aurora MySQL version 5\\.6\\.10a\\. \nFor Aurora PostgreSQL, the `global` engine mode isn't required, and both the `parallelquery` and the `multimaster` engine modes currently aren't supported\\. \nLimitations and requirements apply to some DB engine modes\\. For more information, see the following sections in the *Amazon Aurora User Guide*: \n+ [ Limitations of Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) \n+ [ Limitations of Parallel Query](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations) \n+ [ Limitations of Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations) \n+ [ Limitations of Multi\\-Master Clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations) \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EngineMode", "type": "string" }, "EngineVersion": { - "markdownDescription": "The version number of the database engine to use\\. \nTo list all of the available engine versions for `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\), use the following command: \n`aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"` \nTo list all of the available engine versions for `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\), use the following command: \n`aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"` \nTo list all of the available engine versions for `aurora-postgresql`, use the following command: \n`aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"` \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The version number of the database engine to use\\. \nTo list all of the available engine versions for `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\), use the following command: \n`aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"` \nTo list all of the available engine versions for `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\), use the following command: \n`aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"` \nTo list all of the available engine versions for `aurora-postgresql`, use the following command: \n`aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"` \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "EngineVersion", "type": "string" }, "GlobalClusterIdentifier": { - "markdownDescription": "If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster\\. To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource\\. \n If you aren't configuring a global database cluster, don't specify this property\\. \nTo remove the DB cluster from a global database cluster, specify an empty value for the `GlobalClusterIdentifier` property\\.\nFor information about Aurora global databases, see [ Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster\\. To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource\\. \n If you aren't configuring a global database cluster, don't specify this property\\. \nTo remove the DB cluster from a global database cluster, specify an empty value for the `GlobalClusterIdentifier` property\\.\nFor information about Aurora global databases, see [ Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "GlobalClusterIdentifier", "type": "string" }, "Iops": { + "markdownDescription": "The amount of Provisioned IOPS \\(input/output operations per second\\) to be initially allocated for each DB instance in the Multi\\-AZ DB cluster\\. \nFor information about valid IOPS values, see [Amazon RDS Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*\\. \nThis setting is required to create a Multi\\-AZ DB cluster\\. \nConstraints: Must be a multiple between \\.5 and 50 of the storage amount for the DB cluster\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Iops", "type": "number" }, "KmsKeyId": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`\\. If you enable the `StorageEncrypted` property but don't specify this property, the default KMS key is used\\. If you specify this property, you must set the `StorageEncrypted` property to `true`\\. \nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`\\. If you enable the `StorageEncrypted` property but don't specify this property, the default KMS key is used\\. If you specify this property, you must set the `StorageEncrypted` property to `true`\\. \nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" }, "ManageMasterUserPassword": { + "markdownDescription": "A value that indicates whether to manage the master user password with AWS Secrets Manager\\. \nFor more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide\\.* \nConstraints: \n+ Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManageMasterUserPassword", "type": "boolean" }, "MasterUserPassword": { - "markdownDescription": "The master password for the DB instance\\. \nIf you specify the `SourceDBClusterIdentifier` or `SnapshotIdentifier` property, don't specify this property\\. The value is inherited from the source DB instance or snapshot\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The master password for the DB instance\\. \nIf you specify the `SourceDBClusterIdentifier`, `SnapshotIdentifier`, or `GlobalClusterIdentifier` property, don't specify this property\\. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserPassword", "type": "string" }, "MasterUserSecret": { - "$ref": "#/definitions/AWS::RDS::DBCluster.MasterUserSecret" + "$ref": "#/definitions/AWS::RDS::DBCluster.MasterUserSecret", + "markdownDescription": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password\\. \nFor more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide\\.* \n*Required*: No \n*Type*: [MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MasterUserSecret" }, "MasterUsername": { - "markdownDescription": "The name of the master user for the DB cluster\\. \nIf you specify the `SourceDBClusterIdentifier` or `SnapshotIdentifier` property, don't specify this property\\. The value is inherited from the source DB instance or snapshot\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the master user for the DB cluster\\. \nIf you specify the `SourceDBClusterIdentifier`, `SnapshotIdentifier`, or `GlobalClusterIdentifier` property, don't specify this property\\. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "MasterUsername", "type": "string" }, "MonitoringInterval": { + "markdownDescription": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster\\. To turn off collecting Enhanced Monitoring metrics, specify 0\\. The default is 0\\. \nIf `MonitoringRoleArn` is specified, also set `MonitoringInterval` to a value other than 0\\. \nValid Values: `0, 1, 5, 10, 15, 30, 60` \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MonitoringInterval", "type": "number" }, "MonitoringRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs\\. An example is `arn:aws:iam:123456789012:role/emaccess`\\. For information on creating a monitoring role, see [Setting up and enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*\\. \nIf `MonitoringInterval` is set to a value other than 0, supply a `MonitoringRoleArn` value\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MonitoringRoleArn", "type": "string" }, "NetworkType": { + "markdownDescription": "The network type of the DB cluster\\. \nValid values: \n+ `IPV4` \n+ `DUAL` \nThe network type is determined by the `DBSubnetGroup` specified for the DB cluster\\. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and IPv6 protocols \\(`DUAL`\\)\\. \nFor more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide\\.* \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkType", "type": "string" }, "PerformanceInsightsEnabled": { + "markdownDescription": "A value that indicates whether to turn on Performance Insights for the DB cluster\\. \nFor more information, see [ Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PerformanceInsightsEnabled", "type": "boolean" }, "PerformanceInsightsKmsKeyId": { + "markdownDescription": "The AWS KMS key identifier for encryption of Performance Insights data\\. \nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key\\. \nIf you don't specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key\\. There is a default KMS key for your AWS account\\. Your AWS account has a different default KMS key for each AWS Region\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PerformanceInsightsKmsKeyId", "type": "string" }, "PerformanceInsightsRetentionPeriod": { + "markdownDescription": "The number of days to retain Performance Insights data\\. The default is 7 days\\. The following values are valid: \n+ 7\n+ *month* \\* 31, where *month* is a number of months from 1\\-23\n+ 731\nFor example, the following values are valid: \n+ 93 \\(3 months \\* 31\\)\n+ 341 \\(11 months \\* 31\\)\n+ 589 \\(19 months \\* 31\\)\n+ 731\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PerformanceInsightsRetentionPeriod", "type": "number" }, "Port": { - "markdownDescription": "The port number on which the DB instances in the DB cluster accept connections\\. \nDefault: \n+ When `EngineMode` is `provisioned`, `3306` \\(for both Aurora MySQL and Aurora PostgreSQL\\)\n+ When `EngineMode` is `serverless`:\n + `3306` when `Engine` is `aurora` or `aurora-mysql`\n + `5432` when `Engine` is `aurora-postgresql`\nThe `No interruption` on update behavior only applies to DB clusters\\. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The port number on which the DB instances in the DB cluster accept connections\\. \nDefault: \n+ When `EngineMode` is `provisioned`, `3306` \\(for both Aurora MySQL and Aurora PostgreSQL\\)\n+ When `EngineMode` is `serverless`:\n + `3306` when `Engine` is `aurora` or `aurora-mysql`\n + `5432` when `Engine` is `aurora-postgresql`\nThe `No interruption` on update behavior only applies to DB clusters\\. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Port", "type": "number" }, "PreferredBackupWindow": { - "markdownDescription": "The daily time range during which automated backups are created\\. For more information, see [ Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide\\.* \nConstraints: \n+ Must be in the format `hh24:mi-hh24:mi`\\.\n+ Must be in Universal Coordinated Time \\(UTC\\)\\.\n+ Must not conflict with the preferred maintenance window\\.\n+ Must be at least 30 minutes\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The daily time range during which automated backups are created\\. For more information, see [ Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide\\.* \nConstraints: \n+ Must be in the format `hh24:mi-hh24:mi`\\.\n+ Must be in Universal Coordinated Time \\(UTC\\)\\.\n+ Must not conflict with the preferred maintenance window\\.\n+ Must be at least 30 minutes\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PreferredBackupWindow", "type": "string" }, "PreferredMaintenanceWindow": { - "markdownDescription": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \nFormat: `ddd:hh24:mi-ddd:hh24:mi` \nThe default is a 30\\-minute window selected at random from an 8\\-hour block of time for each AWS Region, occurring on a random day of the week\\. To see the time blocks available, see [ Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide\\.* \nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun\\. \nConstraints: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \nFormat: `ddd:hh24:mi-ddd:hh24:mi` \nThe default is a 30\\-minute window selected at random from an 8\\-hour block of time for each AWS Region, occurring on a random day of the week\\. To see the time blocks available, see [ Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide\\.* \nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun\\. \nConstraints: Minimum 30\\-minute window\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PreferredMaintenanceWindow", "type": "string" }, "PubliclyAccessible": { + "markdownDescription": "A value that indicates whether the DB cluster is publicly accessible\\. \nWhen the DB cluster is publicly accessible, its Domain Name System \\(DNS\\) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud \\(VPC\\)\\. It resolves to the public IP address from outside of the DB cluster's VPC\\. Access to the DB cluster is ultimately controlled by the security group it uses\\. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it\\. \nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address\\. \nDefault: The default behavior varies depending on whether `DBSubnetGroupName` is specified\\. \nIf `DBSubnetGroupName` isn't specified, and `PubliclyAccessible` isn't specified, the following applies: \n+ If the default VPC in the target Region doesn\u2019t have an internet gateway attached to it, the DB cluster is private\\.\n+ If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public\\.\nIf `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't specified, the following applies: \n+ If the subnets are part of a VPC that doesn\u2019t have an internet gateway attached to it, the DB cluster is private\\.\n+ If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public\\.\nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PubliclyAccessible", "type": "boolean" }, "ReplicationSourceIdentifier": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the source DB instance or DB cluster if this DB cluster is created as a read replica\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the source DB instance or DB cluster if this DB cluster is created as a read replica\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReplicationSourceIdentifier", "type": "string" }, "RestoreType": { - "markdownDescription": "The type of restore to be performed\\. You can specify one of the following values: \n+ `full-copy` \\- The new DB cluster is restored as a full copy of the source DB cluster\\.\n+ `copy-on-write` \\- The new DB cluster is restored as a clone of the source DB cluster\\.\nConstraints: You can't specify `copy-on-write` if the engine version of the source DB cluster is earlier than 1\\.11\\. \nIf you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of restore to be performed\\. You can specify one of the following values: \n+ `full-copy` \\- The new DB cluster is restored as a full copy of the source DB cluster\\.\n+ `copy-on-write` \\- The new DB cluster is restored as a clone of the source DB cluster\\.\nConstraints: You can't specify `copy-on-write` if the engine version of the source DB cluster is earlier than 1\\.11\\. \nIf you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestoreType", "type": "string" }, "ScalingConfiguration": { "$ref": "#/definitions/AWS::RDS::DBCluster.ScalingConfiguration", - "markdownDescription": "The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster\\. \n*Required*: No \n*Type*: [ScalingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster\\. \nThis property is only supported for Aurora Serverless v1\\. For Aurora Serverless v2, use `ServerlessV2ScalingConfiguration` property\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: [ScalingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScalingConfiguration" }, "ServerlessV2ScalingConfiguration": { - "$ref": "#/definitions/AWS::RDS::DBCluster.ServerlessV2ScalingConfiguration" + "$ref": "#/definitions/AWS::RDS::DBCluster.ServerlessV2ScalingConfiguration", + "markdownDescription": "The `ServerlessV2ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster\\. \nThis property is only supported for Aurora Serverless v2\\. For Aurora Serverless v1, use `ScalingConfiguration` property\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: [ServerlessV2ScalingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerlessV2ScalingConfiguration" }, "SnapshotIdentifier": { - "markdownDescription": "The identifier for the DB snapshot or DB cluster snapshot to restore from\\. \nYou can use either the name or the Amazon Resource Name \\(ARN\\) to specify a DB cluster snapshot\\. However, you can use only the ARN to specify a DB snapshot\\. \nAfter you restore a DB cluster with a `SnapshotIdentifier` property, you must specify the same `SnapshotIdentifier` property for any future updates to the DB cluster\\. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed\\. However, if you don't specify the `SnapshotIdentifier` property, an empty DB cluster is created, and the original DB cluster is deleted\\. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified `SnapshotIdentifier` property, and the original DB cluster is deleted\\. \nIf you specify the `SnapshotIdentifier` property to restore a DB cluster \\(as opposed to specifying it for DB cluster updates\\), then don't specify the following properties: \n+ `GlobalClusterIdentifier`\n+ `MasterUsername`\n+ `ReplicationSourceIdentifier`\n+ `RestoreType`\n+ `SourceDBClusterIdentifier`\n+ `SourceRegion`\n+ `StorageEncrypted`\n+ `UseLatestRestorableTime`\nConstraints: \n+ Must match the identifier of an existing Snapshot\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The identifier for the DB snapshot or DB cluster snapshot to restore from\\. \nYou can use either the name or the Amazon Resource Name \\(ARN\\) to specify a DB cluster snapshot\\. However, you can use only the ARN to specify a DB snapshot\\. \nAfter you restore a DB cluster with a `SnapshotIdentifier` property, you must specify the same `SnapshotIdentifier` property for any future updates to the DB cluster\\. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed\\. However, if you don't specify the `SnapshotIdentifier` property, an empty DB cluster is created, and the original DB cluster is deleted\\. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified `SnapshotIdentifier` property, and the original DB cluster is deleted\\. \nIf you specify the `SnapshotIdentifier` property to restore a DB cluster \\(as opposed to specifying it for DB cluster updates\\), then don't specify the following properties: \n+ `GlobalClusterIdentifier`\n+ `MasterUsername`\n+ `MasterUserPassword`\n+ `ReplicationSourceIdentifier`\n+ `RestoreType`\n+ `SourceDBClusterIdentifier`\n+ `SourceRegion`\n+ `StorageEncrypted` \\(for an encrypted snapshot\\)\n+ `UseLatestRestorableTime`\nConstraints: \n+ Must match the identifier of an existing Snapshot\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SnapshotIdentifier", "type": "string" }, "SourceDBClusterIdentifier": { - "markdownDescription": "When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore\\. \nConstraints: \n+ Must match the identifier of an existing DBCluster\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore\\. \nConstraints: \n+ Must match the identifier of an existing DBCluster\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SourceDBClusterIdentifier", "type": "string" }, "SourceRegion": { - "markdownDescription": "The AWS Region which contains the source DB cluster when replicating a DB cluster\\. For example, `us-east-1`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The AWS Region which contains the source DB cluster when replicating a DB cluster\\. For example, `us-east-1`\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SourceRegion", "type": "string" }, "StorageEncrypted": { - "markdownDescription": "Indicates whether the DB cluster is encrypted\\. \nIf you specify the `KmsKeyId` property, then you must enable encryption\\. \nIf you specify the `SnapshotIdentifier` or `SourceDBClusterIdentifier` property, don't specify this property\\. The value is inherited from the snapshot or source DB cluster, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Indicates whether the DB cluster is encrypted\\. \nIf you specify the `KmsKeyId` property, then you must enable encryption\\. \nIf you specify the `SourceDBClusterIdentifier` property, don't specify this property\\. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used\\. \nIf you specify the `SnapshotIdentifier` and the specified snapshot is encrypted, don't specify this property\\. The value is inherited from the snapshot, and the specified `KmsKeyId` property is used\\. \nIf you specify the `SnapshotIdentifier` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted\\. Specify the `KmsKeyId` property for the KMS key to use for encryption\\. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to `false`\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StorageEncrypted", "type": "boolean" }, "StorageType": { + "markdownDescription": "Specifies the storage type to be associated with the DB cluster\\. \nThis setting is required to create a Multi\\-AZ DB cluster\\. \nValid values: `io1` \nWhen specified, a value for the `Iops` parameter is required\\. \nDefault: `io1` \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageType", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the DB cluster\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this DB cluster\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, "UseLatestRestorableTime": { - "markdownDescription": "A value that indicates whether to restore the DB cluster to the latest restorable backup time\\. By default, the DB cluster is not restored to the latest restorable backup time\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A value that indicates whether to restore the DB cluster to the latest restorable backup time\\. By default, the DB cluster is not restored to the latest restorable backup time\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "UseLatestRestorableTime", "type": "boolean" }, @@ -150410,7 +154905,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of EC2 VPC security groups to associate with this DB cluster\\. \nIf you plan to update the resource, don't specify VPC security groups in a shared VPC\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of EC2 VPC security groups to associate with this DB cluster\\. \nIf you plan to update the resource, don't specify VPC security groups in a shared VPC\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VpcSecurityGroupIds", "type": "array" } @@ -150460,9 +154955,13 @@ "additionalProperties": false, "properties": { "Address": { + "markdownDescription": "Specifies the connection endpoint for the primary instance of the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Address", "type": "string" }, "Port": { + "markdownDescription": "Specifies the port that the database engine is listening on\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "string" } }, @@ -150472,9 +154971,13 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "The AWS KMS key identifier that is used to encrypt the secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "SecretArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecretArn", "type": "string" } }, @@ -150484,6 +154987,8 @@ "additionalProperties": false, "properties": { "Address": { + "markdownDescription": "The host address of the reader endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Address", "type": "string" } }, @@ -150508,6 +155013,8 @@ "type": "number" }, "SecondsBeforeTimeout": { + "markdownDescription": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action\\. The default is 300\\. \nSpecify a value between 60 and 600 seconds\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecondsBeforeTimeout", "type": "number" }, "SecondsUntilAutoPause": { @@ -150516,6 +155023,8 @@ "type": "number" }, "TimeoutAction": { + "markdownDescription": "The action to take when the timeout is reached, either `ForceApplyCapacityChange` or `RollbackCapacityChange`\\. \n `ForceApplyCapacityChange` sets the capacity to the specified value as soon as possible\\. \n `RollbackCapacityChange`, the default, ignores the capacity change if a scaling point isn't found in the timeout period\\. \nIf you specify `ForceApplyCapacityChange`, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped\\.\nFor more information, see [ Autoscaling for Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TimeoutAction", "type": "string" } }, @@ -150525,9 +155034,13 @@ "additionalProperties": false, "properties": { "MaxCapacity": { + "markdownDescription": "The maximum number of Aurora capacity units \\(ACUs\\) for a DB instance in an Aurora Serverless v2 cluster\\. You can specify ACU values in half\\-step increments, such as 40, 40\\.5, 41, and so on\\. The largest value that you can use is 128\\. \nThe maximum capacity must be higher than 0\\.5 ACUs\\. For more information, see [ Choosing the maximum Aurora Serverless v2 capacity setting for a cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.setting-capacity.html#aurora-serverless-v2.max_capacity_considerations) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxCapacity", "type": "number" }, "MinCapacity": { + "markdownDescription": "The minimum number of Aurora capacity units \\(ACUs\\) for a DB instance in an Aurora Serverless v2 cluster\\. You can specify ACU values in half\\-step increments, such as 8, 8\\.5, 9, and so on\\. The smallest value that you can use is 0\\.5\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MinCapacity", "type": "number" } }, @@ -150569,6 +155082,8 @@ "additionalProperties": false, "properties": { "DBClusterParameterGroupName": { + "markdownDescription": "The name of the DB cluster parameter group\\. \nConstraints: \n+ Must not match the name of an existing DB cluster parameter group\\.\nIf you don't specify a value for `DBClusterParameterGroupName` property, a name is automatically created for the DB cluster paramter group\\. \nThis value is stored as a lowercase string\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DBClusterParameterGroupName", "type": "string" }, "Description": { @@ -150590,7 +155105,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the DB cluster parameter group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this DB cluster parameter group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -150659,7 +155174,7 @@ "additionalProperties": false, "properties": { "AllocatedStorage": { - "markdownDescription": "The amount of storage \\(in gigabytes\\) to be initially allocated for the database instance\\. \nIf any value is set in the `Iops` parameter, `AllocatedStorage` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000\\. If you increase the `Iops` value \\(in 1,000 IOPS increments\\), then you must also increase the `AllocatedStorage` value \\(in 100\\-GiB increments\\)\\. \n **Amazon Aurora** \nNot applicable\\. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume\\. \n **MySQL** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **MariaDB** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **PostgreSQL** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **Oracle** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 10 to 3072\\.\n **SQL Server** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384\\.\n + Web and Express editions: Must be an integer from 20 to 16384\\.\n+ Provisioned IOPS storage \\(io1\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384\\.\n + Web and Express editions: Must be an integer from 20 to 16384\\.\n+ Magnetic storage \\(standard\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 1024\\.\n + Web and Express editions: Must be an integer from 20 to 1024\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of storage in gibibytes \\(GiB\\) to be initially allocated for the database instance\\. \nIf any value is set in the `Iops` parameter, `AllocatedStorage` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000\\. If you increase the `Iops` value \\(in 1,000 IOPS increments\\), then you must also increase the `AllocatedStorage` value \\(in 100\\-GiB increments\\)\\. \n **Amazon Aurora** \nNot applicable\\. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume\\. \n **MySQL** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **MariaDB** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **PostgreSQL** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **Oracle** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 10 to 3072\\.\n **SQL Server** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384\\.\n + Web and Express editions: Must be an integer from 20 to 16384\\.\n+ Provisioned IOPS storage \\(io1\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384\\.\n + Web and Express editions: Must be an integer from 20 to 16384\\.\n+ Magnetic storage \\(standard\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 1024\\.\n + Web and Express editions: Must be an integer from 20 to 1024\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllocatedStorage", "type": "string" }, @@ -150672,17 +155187,17 @@ "items": { "$ref": "#/definitions/AWS::RDS::DBInstance.DBInstanceRole" }, - "markdownDescription": "The AWS Identity and Access Management \\(IAM\\) roles associated with the DB instance\\. \n*Required*: No \n*Type*: List of [DBInstanceRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS Identity and Access Management \\(IAM\\) roles associated with the DB instance\\. \n **Amazon Aurora** \nNot applicable\\. The associated roles are managed by the DB cluster\\. \n*Required*: No \n*Type*: List of [DBInstanceRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AssociatedRoles", "type": "array" }, "AutoMinorVersionUpgrade": { - "markdownDescription": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window\\. By default, minor engine upgrades are applied automatically\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window\\. By default, minor engine upgrades are applied automatically\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "AutoMinorVersionUpgrade", "type": "boolean" }, "AvailabilityZone": { - "markdownDescription": "The Availability Zone that the database instance will be created in\\. \nDefault: A random, system\\-chosen Availability Zone in the endpoint's region\\. \n Example: `us-east-1d` \n Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to `true`\\. The specified Availability Zone must be in the same region as the current endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Availability Zone \\(AZ\\) where the database will be created\\. For information on AWS Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)\\. \n **Amazon Aurora** \nEach Aurora DB cluster hosts copies of its storage in three separate Availability Zones\\. Specify one of these Availability Zones\\. Aurora automatically chooses an appropriate Availability Zone if you don't specify one\\. \nDefault: A random, system\\-chosen Availability Zone in the endpoint's AWS Region\\. \nExample: `us-east-1d` \nConstraint: The `AvailabilityZone` parameter can't be specified if the DB instance is a Multi\\-AZ deployment\\. The specified Availability Zone must be in the same AWS Region as the current endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "AvailabilityZone", "type": "string" }, @@ -150697,9 +155212,13 @@ "type": "string" }, "CertificateDetails": { - "$ref": "#/definitions/AWS::RDS::DBInstance.CertificateDetails" + "$ref": "#/definitions/AWS::RDS::DBInstance.CertificateDetails", + "markdownDescription": "The details of the DB instance's server certificate\\. \n*Required*: No \n*Type*: [CertificateDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-certificatedetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertificateDetails" }, "CertificateRotationRestart": { + "markdownDescription": "A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate\\. \nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate\\. The certificate is not updated until the DB instance is restarted\\. \nSet this parameter only if you are *not* using SSL/TLS to connect to the DB instance\\.\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: \n+ For more information about rotating your SSL/TLS certificate for RDS DB engines, see [ Rotating Your SSL/TLS Certificate\\.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide\\.* \n+ For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [ Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*\\.\nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertificateRotationRestart", "type": "boolean" }, "CharacterSetName": { @@ -150713,6 +155232,8 @@ "type": "boolean" }, "CustomIAMInstanceProfile": { + "markdownDescription": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance\\. The instance profile must meet the following requirements: \n+ The profile must exist in your account\\.\n+ The profile must have an IAM role that Amazon EC2 has permissions to assume\\.\n+ The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom`\\.\nFor the list of permissions required for the IAM role, see [ Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*\\. \nThis setting is required for RDS Custom\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CustomIAMInstanceProfile", "type": "string" }, "DBClusterIdentifier": { @@ -150721,10 +155242,12 @@ "type": "string" }, "DBClusterSnapshotIdentifier": { + "markdownDescription": "The identifier for the RDS for MySQL Multi\\-AZ DB cluster snapshot to restore from\\. \nFor more information on Multi\\-AZ DB clusters, see [ Multi\\-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*\\. \nConstraints: \n+ Must match the identifier of an existing Multi\\-AZ DB cluster snapshot\\.\n+ Can't be specified when `DBSnapshotIdentifier` is specified\\.\n+ Must be specified when `DBSnapshotIdentifier` isn't specified\\.\n+ If you are restoring from a shared manual Multi\\-AZ DB cluster snapshot, the `DBClusterSnapshotIdentifier` must be the ARN of the shared snapshot\\.\n+ Can't be the identifier of an Aurora DB cluster snapshot\\.\n+ Can't be the identifier of an RDS for PostgreSQL Multi\\-AZ DB cluster snapshot\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "DBClusterSnapshotIdentifier", "type": "string" }, "DBInstanceClass": { - "markdownDescription": "The compute and memory capacity of the DB instance, for example, `db.m4.large`\\. Not all DB instance classes are available in all AWS Regions, or for all database engines\\. \nFor the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide\\.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](http://aws.amazon.com/rds/pricing/)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The compute and memory capacity of the DB instance, for example, `db.m4.large`\\. Not all DB instance classes are available in all AWS Regions, or for all database engines\\. \nFor the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide\\.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](http://aws.amazon.com/rds/pricing/)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "DBInstanceClass", "type": "string" }, @@ -150734,12 +155257,12 @@ "type": "string" }, "DBName": { - "markdownDescription": "The meaning of this parameter differs according to the database engine you use\\. \n If you specify the ` [ DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)` property, AWS CloudFormation ignores this property\\. \nIf you restore DB instances from snapshots, this property doesn't apply to the MySQL, PostgreSQL, or MariaDB engines\\.\n **MySQL** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, no database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 64 letters or numbers\\.\n+ Can't be a word reserved by the specified database engine\n **MariaDB** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, no database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 64 letters or numbers\\.\n+ Can't be a word reserved by the specified database engine\n **PostgreSQL** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, the default `postgres` database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 63 letters, numbers, or underscores\\.\n+ Must begin with a letter or an underscore\\. Subsequent characters can be letters, underscores, or digits \\(0\\-9\\)\\.\n+ Can't be a word reserved by the specified database engine\n **Oracle** \nThe Oracle System ID \\(SID\\) of the created DB instance\\. If you specify `null`, the default value `ORCL` is used\\. You can't specify the string NULL, or any other reserved word, for `DBName`\\. \nDefault: `ORCL` \nConstraints: \n+ Can't be longer than 8 characters\n **SQL Server** \nNot applicable\\. Must be null\\. \n **Amazon Aurora MySQL** \nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created\\. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster\\. \nConstraints: \n+ It must contain 1 to 64 alphanumeric characters\\.\n+ It can't be a word reserved by the database engine\\.\n **Amazon Aurora PostgreSQL** \nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created\\. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named `postgres` is created in the DB cluster\\. \nConstraints: \n+ It must contain 1 to 63 alphanumeric characters\\.\n+ It must begin with a letter or an underscore\\. Subsequent characters can be letters, underscores, or digits \\(0 to 9\\)\\.\n+ It can't be a word reserved by the database engine\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The meaning of this parameter differs according to the database engine you use\\. \nIf you specify the `[ DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)` property, this property only applies to RDS for Oracle\\.\n **Amazon Aurora** \nNot applicable\\. The database name is managed by the DB cluster\\. \n **MySQL** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, no database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 64 letters or numbers\\.\n+ Can't be a word reserved by the specified database engine\n **MariaDB** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, no database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 64 letters or numbers\\.\n+ Can't be a word reserved by the specified database engine\n **PostgreSQL** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, the default `postgres` database is created in the DB instance\\. \nConstraints: \n+ Must begin with a letter\\. Subsequent characters can be letters, underscores, or digits \\(0\\-9\\)\\.\n+ Must contain 1 to 63 characters\\.\n+ Can't be a word reserved by the specified database engine\n **Oracle** \nThe Oracle System ID \\(SID\\) of the created DB instance\\. If you specify `null`, the default value `ORCL` is used\\. You can't specify the string NULL, or any other reserved word, for `DBName`\\. \nDefault: `ORCL` \nConstraints: \n+ Can't be longer than 8 characters\n **SQL Server** \nNot applicable\\. Must be null\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DBName", "type": "string" }, "DBParameterGroupName": { - "markdownDescription": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template\\. \nTo list all of the available DB parameter group names, use the following command: \n`aws rds describe-db-parameter-groups --query \"DBParameterGroups[].DBParameterGroupName\" --output text` \nIf any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption\\. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot\\.\nIf you don't specify a value for the `DBParameterGroupName` property, the default DB parameter group for the specified engine and engine version is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template\\. \nTo list all of the available DB parameter group names, use the following command: \n`aws rds describe-db-parameter-groups --query \"DBParameterGroups[].DBParameterGroupName\" --output text` \nIf any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption\\. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot\\.\nIf you don't specify a value for `DBParameterGroupName` property, the default DB parameter group for the specified engine and engine version is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "DBParameterGroupName", "type": "string" }, @@ -150752,7 +155275,7 @@ "type": "array" }, "DBSnapshotIdentifier": { - "markdownDescription": "The name or Amazon Resource Name \\(ARN\\) of the DB snapshot that's used to restore the DB instance\\. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot\\. \nBy specifying this property, you can create a DB instance from the specified DB snapshot\\. If the `DBSnapshotIdentifier` property is an empty string or the `AWS::RDS::DBInstance` declaration has no `DBSnapshotIdentifier` property, AWS CloudFormation creates a new database\\. If the property contains a value \\(other than an empty string\\), AWS CloudFormation creates a database from the specified snapshot\\. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack\\. \nSome DB instance properties aren't valid when you restore from a snapshot, such as the `MasterUsername` and `MasterUserPassword` properties\\. For information about the properties that you can specify, see the `RestoreDBInstanceFromDBSnapshot` action in the *Amazon RDS API Reference*\\. \nAfter you restore a DB instance with a `DBSnapshotIdentifier` property, you must specify the same `DBSnapshotIdentifier` property for any future updates to the DB instance\\. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed\\. However, if you don't specify the `DBSnapshotIdentifier` property, an empty DB instance is created, and the original DB instance is deleted\\. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified `DBSnapshotIdentifier` property, and the original DB instance is deleted\\. \nIf you specify the `DBSnapshotIdentifier` property to restore a DB instance \\(as opposed to specifying it for DB instance updates\\), then don't specify the following properties: \n+ `CharacterSetName`\n+ `DBClusterIdentifier`\n+ `DBName`\n+ `DeleteAutomatedBackups`\n+ `EnablePerformanceInsights`\n+ `KmsKeyId`\n+ `MasterUsername`\n+ `MonitoringInterval`\n+ `MonitoringRoleArn`\n+ `PerformanceInsightsKMSKeyId`\n+ `PerformanceInsightsRetentionPeriod`\n+ `PromotionTier`\n+ `SourceDBInstanceIdentifier`\n+ `SourceRegion`\n+ `StorageEncrypted`\n+ `Timezone`\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name or Amazon Resource Name \\(ARN\\) of the DB snapshot that's used to restore the DB instance\\. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot\\. \nBy specifying this property, you can create a DB instance from the specified DB snapshot\\. If the `DBSnapshotIdentifier` property is an empty string or the `AWS::RDS::DBInstance` declaration has no `DBSnapshotIdentifier` property, AWS CloudFormation creates a new database\\. If the property contains a value \\(other than an empty string\\), AWS CloudFormation creates a database from the specified snapshot\\. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack\\. \nSome DB instance properties aren't valid when you restore from a snapshot, such as the `MasterUsername` and `MasterUserPassword` properties\\. For information about the properties that you can specify, see the `RestoreDBInstanceFromDBSnapshot` action in the *Amazon RDS API Reference*\\. \nAfter you restore a DB instance with a `DBSnapshotIdentifier` property, you must specify the same `DBSnapshotIdentifier` property for any future updates to the DB instance\\. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed\\. However, if you don't specify the `DBSnapshotIdentifier` property, an empty DB instance is created, and the original DB instance is deleted\\. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified `DBSnapshotIdentifier` property, and the original DB instance is deleted\\. \nIf you specify the `DBSnapshotIdentifier` property to restore a DB instance \\(as opposed to specifying it for DB instance updates\\), then don't specify the following properties: \n+ `CharacterSetName`\n+ `DBClusterIdentifier`\n+ `DBName`\n+ `DeleteAutomatedBackups`\n+ `EnablePerformanceInsights`\n+ `KmsKeyId`\n+ `MasterUsername`\n+ `MasterUserPassword`\n+ `PerformanceInsightsKMSKeyId`\n+ `PerformanceInsightsRetentionPeriod`\n+ `PromotionTier`\n+ `SourceDBInstanceIdentifier`\n+ `SourceRegion`\n+ `StorageEncrypted` \\(for an encrypted snapshot\\)\n+ `Timezone`\n **Amazon Aurora** \nNot applicable\\. Snapshot restore is managed by the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "DBSnapshotIdentifier", "type": "string" }, @@ -150762,7 +155285,7 @@ "type": "string" }, "DeleteAutomatedBackups": { - "markdownDescription": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted\\. This parameter isn't case\\-sensitive\\. The default is to remove automated backups immediately after the DB instance is deleted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted\\. This parameter isn't case\\-sensitive\\. The default is to remove automated backups immediately after the DB instance is deleted\\. \n**Amazon Aurora** \nNot applicable\\. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered\\. Manual DB cluster snapshots of the DB cluster are not deleted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeleteAutomatedBackups", "type": "boolean" }, @@ -150777,7 +155300,7 @@ "type": "string" }, "DomainIAMRoleName": { - "markdownDescription": "Specify the name of the IAM role to be used when making API calls to the Directory Service\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify the name of the IAM role to be used when making API calls to the Directory Service\\. \nThis setting doesn't apply to RDS Custom\\. \n **Amazon Aurora** \nNot applicable\\. The domain is managed by the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DomainIAMRoleName", "type": "string" }, @@ -150790,7 +155313,7 @@ "type": "array" }, "EnableIAMDatabaseAuthentication": { - "markdownDescription": "A value that indicates whether to enable mapping of AWS Identity and Access Management \\(IAM\\) accounts to database accounts\\. By default, mapping is disabled\\. \nFor more information, see [ IAM Database Authentication for MySQL and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide\\.* \n **Amazon Aurora** \nNot applicable\\. Mapping AWS IAM accounts to database accounts is managed by the DB cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether to enable mapping of AWS Identity and Access Management \\(IAM\\) accounts to database accounts\\. By default, mapping is disabled\\. \nThis property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL\\. For more information, see [ IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide\\.* \n **Amazon Aurora** \nNot applicable\\. Mapping AWS IAM accounts to database accounts is managed by the DB cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableIAMDatabaseAuthentication", "type": "boolean" }, @@ -150800,15 +155323,17 @@ "type": "boolean" }, "Endpoint": { - "$ref": "#/definitions/AWS::RDS::DBInstance.Endpoint" + "$ref": "#/definitions/AWS::RDS::DBInstance.Endpoint", + "markdownDescription": "Specifies the connection endpoint\\. \nThe endpoint might not be shown for instances whose status is `creating`\\.\n*Required*: No \n*Type*: [Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Endpoint" }, "Engine": { - "markdownDescription": "The name of the database engine that you want to use for this DB instance\\. \nWhen you are creating a DB instance, the `Engine` property is required\\.\nValid Values: \n+ `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\)\n+ `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\)\n+ `aurora-postgresql`\n+ `mariadb`\n+ `mysql`\n+ `oracle-ee`\n+ `oracle-se2`\n+ `oracle-se1`\n+ `oracle-se`\n+ `postgres`\n+ `sqlserver-ee`\n+ `sqlserver-se`\n+ `sqlserver-ex`\n+ `sqlserver-web`\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The name of the database engine that you want to use for this DB instance\\. \nWhen you are creating a DB instance, the `Engine` property is required\\.\nValid Values: \n+ `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\)\n+ `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\)\n+ `aurora-postgresql`\n+ `custom-oracle-ee`\n+ `custom-oracle-ee-cdb`\n+ `custom-sqlserver-ee`\n+ `custom-sqlserver-se`\n+ `custom-sqlserver-web`\n+ `mariadb`\n+ `mysql`\n+ `oracle-ee`\n+ `oracle-ee-cdb`\n+ `oracle-se2`\n+ `oracle-se2-cdb`\n+ `postgres`\n+ `sqlserver-ee`\n+ `sqlserver-se`\n+ `sqlserver-ex`\n+ `sqlserver-web`\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "Engine", "type": "string" }, "EngineVersion": { - "markdownDescription": "The version number of the database engine to use\\. \nFor a list of valid engine versions, use the `DescribeDBEngineVersions` action\\. \nThe following are the database engines and links to information about the major and minor versions that are available with Amazon RDS\\. Not every database engine is available for every AWS Region\\. \n **Amazon Aurora** \nNot applicable\\. The version number of the database engine to be used by the DB instance is managed by the DB cluster\\. \n**MariaDB** \nSee [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide\\.* \n**Microsoft SQL Server** \nSee [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide\\.* \n**MySQL** \nSee [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide\\.* \n**Oracle** \nSee [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide\\.* \n**PostgreSQL** \nSee [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The version number of the database engine to use\\. \nFor a list of valid engine versions, use the `DescribeDBEngineVersions` action\\. \nThe following are the database engines and links to information about the major and minor versions that are available with Amazon RDS\\. Not every database engine is available for every AWS Region\\. \n **Amazon Aurora** \nNot applicable\\. The version number of the database engine to be used by the DB instance is managed by the DB cluster\\. \n**MariaDB** \nSee [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide\\.* \n**Microsoft SQL Server** \nSee [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide\\.* \n**MySQL** \nSee [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide\\.* \n**Oracle** \nSee [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide\\.* \n**PostgreSQL** \nSee [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EngineVersion", "type": "string" }, @@ -150828,6 +155353,8 @@ "type": "string" }, "ManageMasterUserPassword": { + "markdownDescription": "A value that indicates whether to manage the master user password with AWS Secrets Manager\\. \nFor more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide\\.* \nConstraints: \n+ Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManageMasterUserPassword", "type": "boolean" }, "MasterUserPassword": { @@ -150836,7 +155363,9 @@ "type": "string" }, "MasterUserSecret": { - "$ref": "#/definitions/AWS::RDS::DBInstance.MasterUserSecret" + "$ref": "#/definitions/AWS::RDS::DBInstance.MasterUserSecret", + "markdownDescription": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password\\. \nFor more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide\\.* \n*Required*: No \n*Type*: [MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-masterusersecret.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MasterUserSecret" }, "MasterUsername": { "markdownDescription": "The master user name for the DB instance\\. \nIf you specify the `SourceDBInstanceIdentifier` or `DBSnapshotIdentifier` property, don't specify this property\\. The value is inherited from the source DB instance or snapshot\\.\n **Amazon Aurora** \nNot applicable\\. The name for the master user is managed by the DB cluster\\. \n **MariaDB** \nConstraints: \n+ Required for MariaDB\\.\n+ Must be 1 to 16 letters or numbers\\.\n+ Can't be a reserved word for the chosen database engine\\.\n **Microsoft SQL Server** \nConstraints: \n+ Required for SQL Server\\.\n+ Must be 1 to 128 letters or numbers\\.\n+ The first character must be a letter\\.\n+ Can't be a reserved word for the chosen database engine\\.\n **MySQL** \nConstraints: \n+ Required for MySQL\\.\n+ Must be 1 to 16 letters or numbers\\.\n+ First character must be a letter\\.\n+ Can't be a reserved word for the chosen database engine\\.\n **Oracle** \nConstraints: \n+ Required for Oracle\\.\n+ Must be 1 to 30 letters or numbers\\.\n+ First character must be a letter\\.\n+ Can't be a reserved word for the chosen database engine\\.\n **PostgreSQL** \nConstraints: \n+ Required for PostgreSQL\\.\n+ Must be 1 to 63 letters or numbers\\.\n+ First character must be a letter\\.\n+ Can't be a reserved word for the chosen database engine\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -150844,12 +155373,12 @@ "type": "string" }, "MaxAllocatedStorage": { - "markdownDescription": "The upper limit in gibibytes \\(GiB\\) to which Amazon RDS can automatically scale the storage of the DB instance\\. \nFor more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The upper limit in gibibytes \\(GiB\\) to which Amazon RDS can automatically scale the storage of the DB instance\\. \nFor more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*\\. \nThis setting doesn't apply to RDS Custom\\. \n **Amazon Aurora** \nNot applicable\\. Storage is managed by the DB cluster\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxAllocatedStorage", "type": "number" }, "MonitoringInterval": { - "markdownDescription": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance\\. To disable collection of Enhanced Monitoring metrics, specify 0\\. The default is 0\\. \nIf `MonitoringRoleArn` is specified, then you must set `MonitoringInterval` to a value other than 0\\. \nThis setting doesn't apply to RDS Custom\\. \nValid Values: `0, 1, 5, 10, 15, 30, 60` \n*Required*: No \n*Type*: Integer \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance\\. To disable collection of Enhanced Monitoring metrics, specify 0\\. The default is 0\\. \nIf `MonitoringRoleArn` is specified, then you must set `MonitoringInterval` to a value other than 0\\. \nThis setting doesn't apply to RDS Custom\\. \nValid Values: `0, 1, 5, 10, 15, 30, 60` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MonitoringInterval", "type": "number" }, @@ -150859,14 +155388,18 @@ "type": "string" }, "MultiAZ": { - "markdownDescription": "Specifies whether the database instance is a multiple Availability Zone deployment\\. You can't set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to true\\. \n **Amazon Aurora** \nNot applicable\\. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the `MultiAZ` option to be set\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "Specifies whether the database instance is a Multi\\-AZ DB instance deployment\\. You can't set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to true\\. \nFor more information, see [ Multi\\-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*\\. \n **Amazon Aurora** \nNot applicable\\. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the `MultiAZ` option to be set\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "MultiAZ", "type": "boolean" }, "NcharCharacterSetName": { + "markdownDescription": "The name of the NCHAR character set for the Oracle DB instance\\. \nThis parameter doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NcharCharacterSetName", "type": "string" }, "NetworkType": { + "markdownDescription": "The network type of the DB instance\\. \nValid values: \n+ `IPV4` \n+ `DUAL` \nThe network type is determined by the `DBSubnetGroup` specified for the DB instance\\. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and IPv6 protocols \\(`DUAL`\\)\\. \nFor more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkType", "type": "string" }, "OptionGroupName": { @@ -150875,7 +155408,7 @@ "type": "string" }, "PerformanceInsightsKMSKeyId": { - "markdownDescription": "The AWS KMS key identifier for encryption of Performance Insights data\\. \nThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key\\. \nIf you do not specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key\\. There is a default KMS key for your AWS account\\. Your AWS account has a different default KMS key for each AWS Region\\. \nFor information about enabling Performance Insights, see [ EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The AWS KMS key identifier for encryption of Performance Insights data\\. \nThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key\\. \nIf you do not specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key\\. There is a default KMS key for your AWS account\\. Your AWS account has a different default KMS key for each AWS Region\\. \nFor information about enabling Performance Insights, see [ EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "PerformanceInsightsKMSKeyId", "type": "string" }, @@ -150885,7 +155418,7 @@ "type": "number" }, "Port": { - "markdownDescription": "The port number on which the database accepts connections\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The port number on which the database accepts connections\\. \n **Amazon Aurora** \nNot applicable\\. The port number is managed by the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Port", "type": "string" }, @@ -150903,7 +155436,7 @@ "items": { "$ref": "#/definitions/AWS::RDS::DBInstance.ProcessorFeature" }, - "markdownDescription": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: List of [ProcessorFeature](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance\\. \nThis setting doesn't apply to RDS Custom\\. \n **Amazon Aurora** \nNot applicable\\. \n*Required*: No \n*Type*: List of [ProcessorFeature](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProcessorFeatures", "type": "array" }, @@ -150913,25 +155446,33 @@ "type": "number" }, "PubliclyAccessible": { - "markdownDescription": "Indicates whether the DB instance is an internet\\-facing instance\\. If you specify `true`, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address\\. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address\\. \n The default behavior value depends on your VPC setup and the database subnet group\\. For more information, see the `PubliclyAccessible` parameter in [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*\\. \n If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the *DependsOn* attribute to declare a dependency on the VPC\\-gateway attachment\\. For more information, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html)\\. \nIf you specify DBSecurityGroups, AWS CloudFormation ignores this property\\. To specify a security group and this property, you must use a VPC security group\\. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Indicates whether the DB instance is an internet\\-facing instance\\. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address\\. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address\\. \nThe default behavior value depends on your VPC setup and the database subnet group\\. For more information, see the `PubliclyAccessible` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PubliclyAccessible", "type": "boolean" }, "ReplicaMode": { + "markdownDescription": "The open mode of an Oracle read replica\\. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*\\. \nThis setting is only supported in RDS for Oracle\\. \nDefault: `open-read-only` \nValid Values: `open-read-only` or `mounted` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReplicaMode", "type": "string" }, "RestoreTime": { + "markdownDescription": "The date and time to restore from\\. \nValid Values: Value must be a time in Universal Coordinated Time \\(UTC\\) format \nConstraints: \n+ Must be before the latest restorable time for the DB instance\n+ Can't be specified if the `UseLatestRestorableTime` parameter is enabled\nExample: `2009-09-07T23:45:00Z` \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "RestoreTime", "type": "string" }, "SourceDBInstanceAutomatedBackupsArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the replicated automated backups from which to restore, for example, `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "SourceDBInstanceAutomatedBackupsArn", "type": "string" }, "SourceDBInstanceIdentifier": { - "markdownDescription": "If you want to create a read replica DB instance, specify the ID of the source DB instance\\. Each DB instance can have a limited number of read replicas\\. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*\\. \nFor information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*\\. \nThe `SourceDBInstanceIdentifier` property determines whether a DB instance is a read replica\\. If you remove the `SourceDBInstanceIdentifier` property from your template and then update your stack, AWS CloudFormation deletes the Read Replica and creates a new DB instance \\(not a read replica\\)\\. \n+ If you specify a source DB instance that uses VPC security groups, we recommend that you specify the `VPCSecurityGroups` property\\. If you don't specify the property, the read replica inherits the value of the `VPCSecurityGroups` property from the source DB when you create the replica\\. However, if you update the stack, AWS CloudFormation reverts the replica's `VPCSecurityGroups` property to the default value because it's not defined in the stack's template\\. This change might cause unexpected issues\\.\n+ Read replicas don't support deletion policies\\. AWS CloudFormation ignores any deletion policy that's associated with a read replica\\.\n+ If you specify `SourceDBInstanceIdentifier`, don't specify the `DBSnapshotIdentifier` property\\. You can't create a read replica from a snapshot\\.\n+ Don't set the `BackupRetentionPeriod`, `DBName`, `MasterUsername`, `MasterUserPassword`, and `PreferredBackupWindow` properties\\. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas\\.\n+ If the source DB instance is in a different region than the read replica, specify the source region in `SourceRegion`, and specify an ARN for a valid DB instance in `SourceDBInstanceIdentifier`\\. For more information, see [ Constructing a Amazon RDS Amazon Resource Name \\(ARN\\)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*\\.\n+ For DB instances in Amazon Aurora clusters, don't specify this property\\. Amazon RDS automatically assigns writer and reader DB instances\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "If you want to create a read replica DB instance, specify the ID of the source DB instance\\. Each DB instance can have a limited number of read replicas\\. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*\\. \nFor information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*\\. \nThe `SourceDBInstanceIdentifier` property determines whether a DB instance is a read replica\\. If you remove the `SourceDBInstanceIdentifier` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance\\. \n+ If you specify a source DB instance that uses VPC security groups, we recommend that you specify the `VPCSecurityGroups` property\\. If you don't specify the property, the read replica inherits the value of the `VPCSecurityGroups` property from the source DB when you create the replica\\. However, if you update the stack, AWS CloudFormation reverts the replica's `VPCSecurityGroups` property to the default value because it's not defined in the stack's template\\. This change might cause unexpected issues\\.\n+ Read replicas don't support deletion policies\\. AWS CloudFormation ignores any deletion policy that's associated with a read replica\\.\n+ If you specify `SourceDBInstanceIdentifier`, don't specify the `DBSnapshotIdentifier` property\\. You can't create a read replica from a snapshot\\.\n+ Don't set the `BackupRetentionPeriod`, `DBName`, `MasterUsername`, `MasterUserPassword`, and `PreferredBackupWindow` properties\\. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas\\.\n+ If the source DB instance is in a different region than the read replica, specify the source region in `SourceRegion`, and specify an ARN for a valid DB instance in `SourceDBInstanceIdentifier`\\. For more information, see [ Constructing a Amazon RDS Amazon Resource Name \\(ARN\\)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*\\.\n+ For DB instances in Amazon Aurora clusters, don't specify this property\\. Amazon RDS automatically assigns writer and reader DB instances\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "SourceDBInstanceIdentifier", "type": "string" }, "SourceDbiResourceId": { + "markdownDescription": "The resource ID of the source DB instance from which to restore\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "SourceDbiResourceId", "type": "string" }, "SourceRegion": { @@ -150940,15 +155481,17 @@ "type": "string" }, "StorageEncrypted": { - "markdownDescription": "A value that indicates whether the DB instance is encrypted\\. By default, it isn't encrypted\\. \nIf you specify the `KmsKeyId` property, then you must enable encryption\\. \nIf you specify the `SnapshotIdentifier` or `SourceDBInstanceIdentifier` property, don't specify this property\\. The value is inherited from the snapshot or source DB instance, and if the DB instance is encrypted, the specified `KmsKeyId` property is used\\. \n **Amazon Aurora** \nNot applicable\\. The encryption for DB instances is managed by the DB cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A value that indicates whether the DB instance is encrypted\\. By default, it isn't encrypted\\. \nIf you specify the `KmsKeyId` property, then you must enable encryption\\. \nIf you specify the `SourceDBInstanceIdentifier` property, don't specify this property\\. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified `KmsKeyId` property is used\\. \nIf you specify the `SnapshotIdentifier` and the specified snapshot is encrypted, don't specify this property\\. The value is inherited from the snapshot, and the specified `KmsKeyId` property is used\\. \nIf you specify the `SnapshotIdentifier` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted\\. Specify the `KmsKeyId` property for the KMS key to use for encryption\\. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to `false`\\. \n**Amazon Aurora** \nNot applicable\\. The encryption for DB instances is managed by the DB cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StorageEncrypted", "type": "boolean" }, "StorageThroughput": { + "markdownDescription": "Specifies the storage throughput value for the DB instance\\. This setting applies only to the `gp3` storage type\\. \nThis setting doesn't apply to RDS Custom or Amazon Aurora\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageThroughput", "type": "number" }, "StorageType": { - "markdownDescription": "Specifies the storage type to be associated with the DB instance\\. \n Valid values: `standard | gp2 | io1` \nThe `standard` value is also known as magnetic\\. \n If you specify `io1`, you must also include a value for the `Iops` parameter\\. \n Default: `io1` if the `Iops` parameter is specified, otherwise `standard` \nFor more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*\\. \n **Amazon Aurora** \nNot applicable\\. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives \\(SSDs\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "Specifies the storage type to be associated with the DB instance\\. \n Valid values: ` gp2 | gp3 | io1 | standard` \nThe `standard` value is also known as magnetic\\. \n If you specify `io1` or `gp3`, you must also include a value for the `Iops` parameter\\. \n Default: `io1` if the `Iops` parameter is specified, otherwise `gp2` \nFor more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*\\. \n **Amazon Aurora** \nNot applicable\\. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives \\(SSDs\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "StorageType", "type": "string" }, @@ -150956,7 +155499,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the DB instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this DB instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -150971,6 +155514,8 @@ "type": "boolean" }, "UseLatestRestorableTime": { + "markdownDescription": "A value that indicates whether the DB instance is restored from the latest backup time\\. By default, the DB instance isn't restored from the latest backup time\\. \nConstraints: Can't be specified if the `RestoreTime` parameter is provided\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "UseLatestRestorableTime", "type": "boolean" }, "VPCSecurityGroups": { @@ -151008,9 +155553,13 @@ "additionalProperties": false, "properties": { "CAIdentifier": { + "markdownDescription": "The CA identifier of the CA certificate used for the DB instance's server certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CAIdentifier", "type": "string" }, "ValidTill": { + "markdownDescription": "The expiration date of the DB instance\u2019s server certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ValidTill", "type": "string" } }, @@ -151040,12 +155589,18 @@ "additionalProperties": false, "properties": { "Address": { + "markdownDescription": "Specifies the DNS address of the DB instance\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Address", "type": "string" }, "HostedZoneId": { + "markdownDescription": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HostedZoneId", "type": "string" }, "Port": { + "markdownDescription": "Specifies the port that the database engine is listening on\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "string" } }, @@ -151055,9 +155610,13 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "The AWS KMS key identifier that is used to encrypt the secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "SecretArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecretArn", "type": "string" } }, @@ -151115,20 +155674,22 @@ "additionalProperties": false, "properties": { "DBParameterGroupName": { + "markdownDescription": "The name of the DB parameter group\\. \nConstraints: \n+ Must be 1 to 255 letters, numbers, or hyphens\\.\n+ First character must be a letter\n+ Can't end with a hyphen or contain two consecutive hyphens\nIf you don't specify a value for `DBParameterGroupName` property, a name is automatically created for the DB parameter group\\. \nThis value is stored as a lowercase string\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DBParameterGroupName", "type": "string" }, "Description": { - "markdownDescription": "Provides the customer\\-specified description for this DB parameter group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides the customer\\-specified description for this DB parameter group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Description", "type": "string" }, "Family": { - "markdownDescription": "The DB parameter group family name\\. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family\\. \nThe DB parameter group family can't be changed when updating a DB parameter group\\.\nTo list all of the available parameter group families, use the following command: \n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"` \nThe output contains duplicates\\. \nFor more information, see [`CreateDBParameterGroup`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The DB parameter group family name\\. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family\\. \nThe DB parameter group family can't be changed when updating a DB parameter group\\.\nTo list all of the available parameter group families, use the following command: \n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"` \nThe output contains duplicates\\. \nFor more information, see [`CreateDBParameterGroup`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Family", "type": "string" }, "Parameters": { - "markdownDescription": "An array of parameter names and values for the parameter update\\. At least one parameter name and value must be supplied\\. Subsequent arguments are optional\\. \nFor more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*\\. \nFor more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [ Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*\\. \nAWS CloudFormation doesn't support specifying an apply method for each individual parameter\\. The default apply method for each parameter is used\\.\n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of parameter names and values for the parameter update\\. At least one parameter name and value must be supplied\\. Subsequent arguments are optional\\. \nFor more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*\\. \nFor more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [ Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*\\. \nAWS CloudFormation doesn't support specifying an apply method for each individual parameter\\. The default apply method for each parameter is used\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Parameters", "type": "object" }, @@ -151136,7 +155697,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the DB parameter group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this DB parameter group\\. \nCurrently, this is the only property that supports drift detection\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -151222,7 +155783,7 @@ "type": "boolean" }, "EngineFamily": { - "markdownDescription": "The kinds of databases that the proxy can connect to\\. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database\\. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora\\. \n*Valid values*: `MYSQL` \\| `POSTGRESQL` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The kinds of databases that the proxy can connect to\\. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database\\. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify `MYSQL`\\. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify `POSTGRESQL`\\. For RDS for Microsoft SQL Server, specify `SQLSERVER`\\. \n*Valid values*: `MYSQL` \\| `POSTGRESQL` \\| `SQLSERVER` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EngineFamily", "type": "string" }, @@ -151305,6 +155866,8 @@ "type": "string" }, "ClientPasswordAuthType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientPasswordAuthType", "type": "string" }, "Description": { @@ -151313,7 +155876,7 @@ "type": "string" }, "IAMAuth": { - "markdownDescription": "Whether to require or disallow AWS Identity and Access Management \\(IAM\\) authentication for connections to the proxy\\. \nValid Values: `DISABLED | REQUIRED` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Whether to require or disallow AWS Identity and Access Management \\(IAM\\) authentication for connections to the proxy\\. The `ENABLED` value is valid only for proxies with RDS for Microsoft SQL Server\\. \nValid Values: `ENABLED | DISABLED | REQUIRED` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IAMAuth", "type": "string" }, @@ -151512,7 +156075,7 @@ "type": "array" }, "DBProxyName": { - "markdownDescription": "The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DBProxyName", "type": "string" }, @@ -151563,12 +156126,12 @@ "type": "string" }, "MaxConnectionsPercent": { - "markdownDescription": "The maximum size of the connection pool for each target in a target group\\. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group\\. \nDefault: 100 \nConstraints: between 1 and 100 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum size of the connection pool for each target in a target group\\. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group\\. \nIf you specify `MaxIdleConnectionsPercent`, then you must also include a value for this parameter\\. \nDefault: 10 for RDS for Microsoft SQL Server, and 100 for all other engines \nConstraints: Must be between 1 and 100\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxConnectionsPercent", "type": "number" }, "MaxIdleConnectionsPercent": { - "markdownDescription": "Controls how actively the proxy closes idle database connections in the connection pool\\. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group\\. With a high value, the proxy leaves a high percentage of idle database connections open\\. A low value causes the proxy to close more idle connections and return them to the database\\. \nDefault: 50 \nConstraints: between 0 and `MaxConnectionsPercent` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Controls how actively the proxy closes idle database connections in the connection pool\\. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group\\. With a high value, the proxy leaves a high percentage of idle database connections open\\. A low value causes the proxy to close more idle connections and return them to the database\\. \nIf you specify this parameter, then you must also include a value for `MaxConnectionsPercent`\\. \nDefault: The default value is half of the value of `MaxConnectionsPercent`\\. For example, if `MaxConnectionsPercent` is 80, then the default value of `MaxIdleConnectionsPercent` is 40\\. If the value of `MaxConnectionsPercent` isn't specified, then for SQL Server, `MaxIdleConnectionsPercent` is 5, and for all other engines, the default is 50\\. \nConstraints: Must be between 0 and the value of `MaxConnectionsPercent`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxIdleConnectionsPercent", "type": "number" }, @@ -151640,7 +156203,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the DB security group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this DB security group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -151681,17 +156244,17 @@ "type": "string" }, "EC2SecurityGroupId": { - "markdownDescription": "Id of the EC2 Security Group to authorize\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Id of the EC2 security group to authorize\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EC2SecurityGroupId", "type": "string" }, "EC2SecurityGroupName": { - "markdownDescription": "Name of the EC2 Security Group to authorize\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Name of the EC2 security group to authorize\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EC2SecurityGroupName", "type": "string" }, "EC2SecurityGroupOwnerId": { - "markdownDescription": "AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter\\. The AWS Access Key ID is not an acceptable value\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter\\. The AWS access key ID isn't an acceptable value\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EC2SecurityGroupOwnerId", "type": "string" } @@ -151739,22 +156302,22 @@ "type": "string" }, "DBSecurityGroupName": { - "markdownDescription": "The name of the DB Security Group to add authorization to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the DB security group to add authorization to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DBSecurityGroupName", "type": "string" }, "EC2SecurityGroupId": { - "markdownDescription": "Id of the EC2 Security Group to authorize\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Id of the EC2 security group to authorize\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EC2SecurityGroupId", "type": "string" }, "EC2SecurityGroupName": { - "markdownDescription": "Name of the EC2 Security Group to authorize\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Name of the EC2 security group to authorize\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EC2SecurityGroupName", "type": "string" }, "EC2SecurityGroupOwnerId": { - "markdownDescription": "AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter\\. The AWS Access Key ID is not an acceptable value\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter\\. The AWS access key ID isn't an acceptable value\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EC2SecurityGroupOwnerId", "type": "string" } @@ -151821,7 +156384,7 @@ "additionalProperties": false, "properties": { "DBSubnetGroupDescription": { - "markdownDescription": "The description for the DB Subnet Group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description for the DB subnet group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DBSubnetGroupDescription", "type": "string" }, @@ -151834,7 +156397,7 @@ "items": { "type": "string" }, - "markdownDescription": "The EC2 Subnet IDs for the DB Subnet Group\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The EC2 Subnet IDs for the DB subnet group\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SubnetIds", "type": "array" }, @@ -151842,7 +156405,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the DB subnet group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this DB subnet group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -151910,7 +156473,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "A Boolean value; set to **true** to activate the subscription, set to **false** to create the subscription but not active it\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether to activate the subscription\\. If the event notification subscription isn't activated, the subscription is created but not active\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, @@ -151918,7 +156481,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of event categories for a SourceType that you want to subscribe to\\. You can see a list of the categories for a given SourceType in the [Events](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) topic in the Amazon RDS User Guide or by using the **DescribeEventCategories** action\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of event categories for a particular source type \\(`SourceType`\\) that you want to subscribe to\\. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the [https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html)\\. You can also see this list by using the `DescribeEventCategories` operation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventCategories", "type": "array" }, @@ -151936,17 +156499,21 @@ "type": "array" }, "SourceType": { - "markdownDescription": "The type of source that is generating the events\\. For example, if you want to be notified of events generated by a DB instance, set this parameter to `db-instance`\\. If this value isn't specified, all events are returned\\. \nValid values: `db-instance` \\| `db-cluster` \\| `db-parameter-group` \\| `db-security-group` \\| `db-snapshot` \\| `db-cluster-snapshot` \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The type of source that is generating the events\\. For example, if you want to be notified of events generated by a DB instance, set this parameter to `db-instance`\\. If this value isn't specified, all events are returned\\. \nValid values: `db-instance` \\| `db-cluster` \\| `db-parameter-group` \\| `db-security-group` \\| `db-snapshot` \\| `db-cluster-snapshot` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceType", "type": "string" }, "SubscriptionName": { + "markdownDescription": "The name of the subscription\\. \nConstraints: The name must be less than 255 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SubscriptionName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An optional array of key\\-value pairs to apply to this subscription\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -152100,7 +156667,7 @@ "additionalProperties": false, "properties": { "EngineName": { - "markdownDescription": "Specifies the name of the engine that this option group should be associated with\\. \nValid Values: \n+ `mariadb`\n+ `mysql`\n+ `oracle-ee`\n+ `oracle-se2`\n+ `oracle-se1`\n+ `oracle-se`\n+ `postgres`\n+ `sqlserver-ee`\n+ `sqlserver-se`\n+ `sqlserver-ex`\n+ `sqlserver-web`\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the name of the engine that this option group should be associated with\\. \nValid Values: \n+ `mariadb`\n+ `mysql`\n+ `oracle-ee`\n+ `oracle-ee-cdb`\n+ `oracle-se2`\n+ `oracle-se2-cdb`\n+ `postgres`\n+ `sqlserver-ee`\n+ `sqlserver-se`\n+ `sqlserver-ex`\n+ `sqlserver-web`\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EngineName", "type": "string" }, @@ -152113,7 +156680,7 @@ "items": { "$ref": "#/definitions/AWS::RDS::OptionGroup.OptionConfiguration" }, - "markdownDescription": "A list of options and the settings for each option\\. \n*Required*: Conditional \n*Type*: List of [OptionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of options and the settings for each option\\. \n*Required*: Conditional \n*Type*: List of [OptionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OptionConfigurations", "type": "array" }, @@ -152123,13 +156690,15 @@ "type": "string" }, "OptionGroupName": { + "markdownDescription": "The name of the option group to be created\\. \nConstraints: \n+ Must be 1 to 255 letters, numbers, or hyphens\n+ First character must be a letter\n+ Can't end with a hyphen or contain two consecutive hyphens\nExample: `myoptiongroup` \nIf you don't specify a value for `OptionGroupName` property, a name is automatically created for the option group\\. \nThis value is stored as a lowercase string\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OptionGroupName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the option group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this option group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -152182,7 +156751,7 @@ "items": { "$ref": "#/definitions/AWS::RDS::OptionGroup.OptionSetting" }, - "markdownDescription": "The option settings to include in an option group\\. \n*Required*: No \n*Type*: List of [OptionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations-optionsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The option settings to include in an option group\\. \n*Required*: No \n*Type*: List of [OptionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OptionSettings", "type": "array" }, @@ -152267,7 +156836,9 @@ "title": "AppMonitorConfiguration" }, "CustomEvents": { - "$ref": "#/definitions/AWS::RUM::AppMonitor.CustomEvents" + "$ref": "#/definitions/AWS::RUM::AppMonitor.CustomEvents", + "markdownDescription": "Specifies whether this app monitor allows the web client to define and send custom events\\. If you omit this parameter, custom events are `DISABLED`\\. \n*Required*: No \n*Type*: [CustomEvents](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-customevents.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomEvents" }, "CwLogEnabled": { "markdownDescription": "Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted\\. This parameter specifies whether CloudWatch RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account\\. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges\\. \nIf you omit this parameter, the default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -152371,6 +156942,8 @@ "items": { "$ref": "#/definitions/AWS::RUM::AppMonitor.MetricDestination" }, + "markdownDescription": "An array of structures that each define a destination that this app monitor will send extended metrics to\\. \n*Required*: No \n*Type*: List of [MetricDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetricDestinations", "type": "array" }, "SessionSampleRate": { @@ -152393,6 +156966,8 @@ "additionalProperties": false, "properties": { "Status": { + "markdownDescription": "Set this to `ENABLED` to allow the web client to send custom events for this app monitor\\. \nValid values are `ENABLED` and `DISABLED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" } }, @@ -152403,23 +156978,33 @@ "properties": { "DimensionKeys": { "additionalProperties": true, + "markdownDescription": "This field is a map of field paths to dimension names\\. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is `CloudWatch`\\. If the metric destination is `Evidently`, the value of `DimensionKeys` is ignored\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "DimensionKeys", "type": "object" }, "EventPattern": { + "markdownDescription": "The pattern that defines the metric\\. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination\\. \nIf the metrics destination is `CloudWatch` and the event also matches a value in `DimensionKeys`, then the metric is published with the specified dimensions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventPattern", "type": "string" }, "Name": { + "markdownDescription": "The name of the metric that is defined in this structure\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "UnitLabel": { + "markdownDescription": "Use this field only if you are sending this metric to CloudWatch\\. It defines the CloudWatch metric unit that this metric is measured in\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UnitLabel", "type": "string" }, "ValueKey": { + "markdownDescription": "The field within the event object that the metric value is sourced from\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ValueKey", "type": "string" } }, @@ -152432,18 +157017,26 @@ "additionalProperties": false, "properties": { "Destination": { + "markdownDescription": "Defines the destination to send the metrics to\\. Valid values are `CloudWatch` and `Evidently`\\. If you specify `Evidently`, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Destination", "type": "string" }, "DestinationArn": { + "markdownDescription": "Use this parameter only if `Destination` is `Evidently`\\. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DestinationArn", "type": "string" }, "IamRoleArn": { + "markdownDescription": "This parameter is required if `Destination` is `Evidently`\\. If `Destination` is `CloudWatch`, do not use this parameter\\. \nThis parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to\\. This role must have permission to write to that experiment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IamRoleArn", "type": "string" }, "MetricDefinitions": { "items": { "$ref": "#/definitions/AWS::RUM::AppMonitor.MetricDefinition" }, + "markdownDescription": "An array of structures which define the metrics that you want to send\\. \n*Required*: No \n*Type*: List of [MetricDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetricDefinitions", "type": "array" } }, @@ -152493,7 +157086,7 @@ "type": "boolean" }, "AquaConfigurationStatus": { - "markdownDescription": "The value represents how the cluster is configured to use AQUA \\(Advanced Query Accelerator\\) when it is created\\. Possible values include the following\\. \n+ enabled \\- Use AQUA if it is available for the current AWS Region and Amazon Redshift node type\\.\n+ disabled \\- Don't use AQUA\\. \n+ auto \\- Amazon Redshift determines whether to use AQUA\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `auto | disabled | enabled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This parameter is retired\\. It does not set the AQUA configuration status\\. Amazon Redshift automatically determines whether to use AQUA \\(Advanced Query Accelerator\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `auto | disabled | enabled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AquaConfigurationStatus", "type": "string" }, @@ -152561,22 +157154,22 @@ "type": "string" }, "DeferMaintenance": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeferMaintenance", "type": "boolean" }, "DeferMaintenanceDuration": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeferMaintenanceDuration", "type": "number" }, "DeferMaintenanceEndTime": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeferMaintenanceEndTime", "type": "string" }, "DeferMaintenanceStartTime": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeferMaintenanceStartTime", "type": "string" }, @@ -152586,7 +157179,7 @@ "type": "string" }, "ElasticIp": { - "markdownDescription": "The Elastic IP \\(EIP\\) address for the cluster\\. \nConstraints: The cluster must be provisioned in EC2\\-VPC and publicly\\-accessible through an Internet gateway\\. For more information about provisioning clusters in EC2\\-VPC, go to [Supported Platforms to Launch Your Cluster](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms) in the Amazon Redshift Cluster Management Guide\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Elastic IP \\(EIP\\) address for the cluster\\. \nConstraints: The cluster must be provisioned in EC2\\-VPC and publicly\\-accessible through an Internet gateway\\. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on\\. For more information about provisioning clusters in EC2\\-VPC, go to [Supported Platforms to Launch Your Cluster](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms) in the Amazon Redshift Cluster Management Guide\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ElasticIp", "type": "string" }, @@ -152596,7 +157189,9 @@ "type": "boolean" }, "Endpoint": { - "$ref": "#/definitions/AWS::Redshift::Cluster.Endpoint" + "$ref": "#/definitions/AWS::Redshift::Cluster.Endpoint", + "markdownDescription": "The connection endpoint\\. \n*Required*: No \n*Type*: [Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Endpoint" }, "EnhancedVpcRouting": { "markdownDescription": "An option that specifies whether to create the cluster with enhanced VPC routing enabled\\. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC\\. For more information, see [Enhanced VPC Routing](https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in the Amazon Redshift Cluster Management Guide\\. \nIf this option is `true`, enhanced VPC routing is enabled\\. \nDefault: false \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -152642,12 +157237,12 @@ "type": "number" }, "MasterUserPassword": { - "markdownDescription": "The password associated with the admin user account for the cluster that is being created\\. \nConstraints: \n+ Must be between 8 and 64 characters in length\\.\n+ Must contain at least one uppercase letter\\.\n+ Must contain at least one lowercase letter\\.\n+ Must contain one number\\.\n+ Can be any printable ASCII character \\(ASCII code 33\\-126\\) except ' \\(single quote\\), \" \\(double quote\\), \\\\, /, or @\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The password associated with the admin user account for the cluster that is being created\\. \nConstraints: \n+ Must be between 8 and 64 characters in length\\.\n+ Must contain at least one uppercase letter\\.\n+ Must contain at least one lowercase letter\\.\n+ Must contain one number\\.\n+ Can be any printable ASCII character \\(ASCII code 33\\-126\\) except `'` \\(single quote\\), `\"` \\(double quote\\), `\\`, `/`, or `@`\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserPassword", "type": "string" }, "MasterUsername": { - "markdownDescription": "The user name associated with the admin user account for the cluster that is being created\\. \nConstraints: \n+ Must be 1 \\- 128 alphanumeric characters\\. The user name can't be `PUBLIC`\\.\n+ First character must be a letter\\.\n+ Cannot be a reserved word\\. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The user name associated with the admin user account for the cluster that is being created\\. \nConstraints: \n+ Must be 1 \\- 128 alphanumeric characters or hyphens\\. The user name can't be `PUBLIC`\\.\n+ Must contain only lowercase letters, numbers, underscore, plus sign, period \\(dot\\), at symbol \\(@\\), or hyphen\\.\n+ The first character must be a letter\\.\n+ Must not contain a colon \\(:\\) or a slash \\(/\\)\\.\n+ Cannot be a reserved word\\. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MasterUsername", "type": "string" }, @@ -152682,17 +157277,17 @@ "type": "boolean" }, "ResourceAction": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceAction", "type": "string" }, "RevisionTarget": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RevisionTarget", "type": "string" }, "RotateEncryptionKey": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RotateEncryptionKey", "type": "boolean" }, @@ -152707,17 +157302,17 @@ "type": "string" }, "SnapshotCopyManual": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SnapshotCopyManual", "type": "boolean" }, "SnapshotCopyRetentionPeriod": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region\\. \nBy default, this only changes the retention period of copied automated snapshots\\. \nIf you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period\\. \nConstraints: Must be at least 1 and no more than 35 for automated snapshots\\. \nIf you specify the `manual` option, only newly copied manual snapshots will have the new retention period\\. \nIf you specify the value of \\-1 newly copied manual snapshots are retained indefinitely\\. \nConstraints: The number of days must be either \\-1 or an integer between 1 and 3,653 for manual snapshots\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SnapshotCopyRetentionPeriod", "type": "number" }, "SnapshotIdentifier": { - "markdownDescription": "The name of the snapshot from which to create the new cluster\\. This parameter isn't case sensitive\\. \nExample: `my-snapshot-id` \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the snapshot from which to create the new cluster\\. This parameter isn't case sensitive\\. You must specify this parameter or `snapshotArn`, but not both\\. \nExample: `my-snapshot-id` \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SnapshotIdentifier", "type": "string" }, @@ -152852,7 +157447,7 @@ "items": { "$ref": "#/definitions/AWS::Redshift::ClusterParameterGroup.Parameter" }, - "markdownDescription": "An array of parameters to be modified\\. A maximum of 20 parameters can be modified in a single request\\. \nFor each parameter to be modified, you must supply at least the parameter name and parameter value; other name\\-value pairs of the parameter are optional\\. \nFor the workload management \\(WLM\\) configuration, you must supply all the name\\-value pairs in the wlm\\_json\\_configuration parameter\\. \n*Required*: No \n*Type*: List of [Parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-property-redshift-clusterparametergroup-parameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of parameters to be modified\\. A maximum of 20 parameters can be modified in a single request\\. \nFor each parameter to be modified, you must supply at least the parameter name and parameter value; other name\\-value pairs of the parameter are optional\\. \nFor the workload management \\(WLM\\) configuration, you must supply all the name\\-value pairs in the wlm\\_json\\_configuration parameter\\. \n*Required*: No \n*Type*: List of [Parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-clusterparametergroup-parameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Parameters", "type": "array" }, @@ -153189,7 +157784,7 @@ "additionalProperties": false, "properties": { "ClusterIdentifier": { - "markdownDescription": "The cluster identifier of the cluster associated with the endpoint\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The cluster identifier of the cluster associated with the endpoint\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ClusterIdentifier", "type": "string" }, @@ -153204,7 +157799,7 @@ "type": "string" }, "SubnetGroupName": { - "markdownDescription": "The subnet group name where Amazon Redshift chooses to deploy the endpoint\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The subnet group name where Amazon Redshift chooses to deploy the endpoint\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SubnetGroupName", "type": "string" }, @@ -153250,15 +157845,23 @@ "additionalProperties": false, "properties": { "AvailabilityZone": { + "markdownDescription": "The Availability Zone\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AvailabilityZone", "type": "string" }, "NetworkInterfaceId": { + "markdownDescription": "The network interface identifier\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkInterfaceId", "type": "string" }, "PrivateIpAddress": { + "markdownDescription": "The IPv4 address of the network interface within the subnet\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PrivateIpAddress", "type": "string" }, "SubnetId": { + "markdownDescription": "The subnet identifier\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetId", "type": "string" } }, @@ -153271,12 +157874,18 @@ "items": { "$ref": "#/definitions/AWS::Redshift::EndpointAccess.NetworkInterface" }, + "markdownDescription": "One or more network interfaces of the endpoint\\. Also known as an interface endpoint\\. \n*Required*: No \n*Type*: List of [NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-networkinterface.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkInterfaces", "type": "array" }, "VpcEndpointId": { + "markdownDescription": "The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcEndpointId", "type": "string" }, "VpcId": { + "markdownDescription": "The VPC identifier that the endpoint is associated\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcId", "type": "string" } }, @@ -153334,7 +157943,7 @@ "additionalProperties": false, "properties": { "Account": { - "markdownDescription": "The AAWS account ID of either the cluster owner \\(grantor\\) or grantee\\. If `Grantee` parameter is true, then the `Account` value is of the grantor\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The AWS account ID of either the cluster owner \\(grantor\\) or grantee\\. If `Grantee` parameter is true, then the `Account` value is of the grantor\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Account", "type": "string" }, @@ -153810,42 +158419,64 @@ "additionalProperties": false, "properties": { "AdminUsername": { + "markdownDescription": "The username of the administrator for the first database created in the namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdminUsername", "type": "string" }, "CreationDate": { + "markdownDescription": "The date of when the namespace was created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreationDate", "type": "string" }, "DbName": { + "markdownDescription": "The name of the first database created in the namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DbName", "type": "string" }, "DefaultIamRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IAM role to set as a default in the namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultIamRoleArn", "type": "string" }, "IamRoles": { "items": { "type": "string" }, + "markdownDescription": "A list of IAM roles to associate with the namespace\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IamRoles", "type": "array" }, "KmsKeyId": { + "markdownDescription": "The ID of the AWS Key Management Service key used to encrypt your data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "LogExports": { "items": { "type": "string" }, + "markdownDescription": "The types of logs the namespace can export\\. Available export types are User log, Connection log, and User activity log\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogExports", "type": "array" }, "NamespaceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) associated with a namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NamespaceArn", "type": "string" }, "NamespaceId": { + "markdownDescription": "The unique identifier of a namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NamespaceId", "type": "string" }, "NamespaceName": { + "markdownDescription": "The name of the namespace\\. Must be between 3\\-64 alphanumeric characters in lowercase, and it cannot be a reserved word\\. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NamespaceName", "type": "string" }, "Status": { + "markdownDescription": "The status of the namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" } }, @@ -153910,6 +158541,8 @@ "type": "string" }, "Port": { + "markdownDescription": "The custom port to use when connecting to a workgroup\\. Valid port ranges are 5431\\-5455 and 8191\\-8215\\. The default is 5439\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "PubliclyAccessible": { @@ -153993,15 +158626,21 @@ "additionalProperties": false, "properties": { "Address": { + "markdownDescription": "The DNS address of the VPC endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Address", "type": "string" }, "Port": { + "markdownDescription": "The port that Amazon Redshift Serverless listens on\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "VpcEndpoints": { "items": { "$ref": "#/definitions/AWS::RedshiftServerless::Workgroup.VpcEndpoint" }, + "markdownDescription": "An array of `VpcEndpoint` objects\\. \n*Required*: No \n*Type*: List of [VpcEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-vpcendpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcEndpoints", "type": "array" } }, @@ -154011,15 +158650,23 @@ "additionalProperties": false, "properties": { "AvailabilityZone": { + "markdownDescription": "The availability Zone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AvailabilityZone", "type": "string" }, "NetworkInterfaceId": { + "markdownDescription": "The unique identifier of the network interface\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkInterfaceId", "type": "string" }, "PrivateIpAddress": { + "markdownDescription": "The IPv4 address of the network interface within the subnet\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PrivateIpAddress", "type": "string" }, "SubnetId": { + "markdownDescription": "The unique identifier of the subnet\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetId", "type": "string" } }, @@ -154032,12 +158679,18 @@ "items": { "$ref": "#/definitions/AWS::RedshiftServerless::Workgroup.NetworkInterface" }, + "markdownDescription": "One or more network interfaces of the endpoint\\. Also known as an interface endpoint\\. \n*Required*: No \n*Type*: List of [NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-networkinterface.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkInterfaces", "type": "array" }, "VpcEndpointId": { + "markdownDescription": "The connection endpoint ID for connecting to Amazon Redshift Serverless\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcEndpointId", "type": "string" }, "VpcId": { + "markdownDescription": "The VPC identifier that the endpoint is associated with\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcId", "type": "string" } }, @@ -154047,51 +158700,77 @@ "additionalProperties": false, "properties": { "BaseCapacity": { + "markdownDescription": "The base data warehouse capacity of the workgroup in Redshift Processing Units \\(RPUs\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BaseCapacity", "type": "number" }, "ConfigParameters": { "items": { "$ref": "#/definitions/AWS::RedshiftServerless::Workgroup.ConfigParameter" }, + "markdownDescription": "An array of parameters to set for advanced control over a database\\. The options are `auto_mv`, `datestyle`, `enable_case_sensitivity_identifier`, `enable_user_activity_logging`, `query_group`, , `search_path`, and query monitoring metrics that let you define performance boundaries\\. For more information about query monitoring rules and available metrics, see [ Query monitoring metrics for Amazon Redshift Serverless](https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless)\\. \n*Required*: No \n*Type*: List of [ConfigParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-configparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConfigParameters", "type": "array" }, "CreationDate": { + "markdownDescription": "The creation date of the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreationDate", "type": "string" }, "Endpoint": { - "$ref": "#/definitions/AWS::RedshiftServerless::Workgroup.Endpoint" + "$ref": "#/definitions/AWS::RedshiftServerless::Workgroup.Endpoint", + "markdownDescription": "The endpoint that is created from the workgroup\\. \n*Required*: No \n*Type*: [Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-endpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Endpoint" }, "EnhancedVpcRouting": { + "markdownDescription": "The value that specifies whether to enable enhanced virtual private cloud \\(VPC\\) routing, which forces Amazon Redshift Serverless to route traffic through your VPC\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnhancedVpcRouting", "type": "boolean" }, "NamespaceName": { + "markdownDescription": "The namespace the workgroup is associated with\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NamespaceName", "type": "string" }, "PubliclyAccessible": { + "markdownDescription": "A value that specifies whether the workgroup can be accessible from a public network \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PubliclyAccessible", "type": "boolean" }, "SecurityGroupIds": { "items": { "type": "string" }, + "markdownDescription": "An array of security group IDs to associate with the workgroup\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroupIds", "type": "array" }, "Status": { + "markdownDescription": "The status of the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "An array of subnet IDs the workgroup is associated with\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetIds", "type": "array" }, "WorkgroupArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) that links to the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WorkgroupArn", "type": "string" }, "WorkgroupId": { + "markdownDescription": "The unique identifier of the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WorkgroupId", "type": "string" }, "WorkgroupName": { + "markdownDescription": "The name of the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WorkgroupName", "type": "string" } }, @@ -154326,7 +159005,9 @@ "type": "string" }, "DefaultRoute": { - "$ref": "#/definitions/AWS::RefactorSpaces::Route.DefaultRouteInput" + "$ref": "#/definitions/AWS::RefactorSpaces::Route.DefaultRouteInput", + "markdownDescription": "Configuration for the default route type\\. \n*Required*: No \n*Type*: [DefaultRouteInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-defaultrouteinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultRoute" }, "EnvironmentIdentifier": { "markdownDescription": "The unique identifier of the environment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -154353,7 +159034,7 @@ }, "UriPathRoute": { "$ref": "#/definitions/AWS::RefactorSpaces::Route.UriPathRouteInput", - "markdownDescription": "The configuration for the URI path route type\\. \n*Required*: No \n*Type*: [UriPathRouteInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The configuration for the URI path route type\\. \n*Required*: No \n*Type*: [UriPathRouteInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UriPathRoute" } }, @@ -154389,6 +159070,8 @@ "additionalProperties": false, "properties": { "ActivationState": { + "markdownDescription": "If set to `ACTIVE`, traffic is forwarded to this route\u2019s service after the route is created\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActivationState", "type": "string" } }, @@ -154401,7 +159084,7 @@ "additionalProperties": false, "properties": { "ActivationState": { - "markdownDescription": "Indicates whether traffic is forwarded to this route\u2019s service after the route is created\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "If set to `ACTIVE`, traffic is forwarded to this route\u2019s service after the route is created\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ActivationState", "type": "string" }, @@ -154544,7 +159227,7 @@ "additionalProperties": false, "properties": { "Arn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Lambda endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Lambda function or alias\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Arn", "type": "string" } @@ -154754,45 +159437,71 @@ "items": { "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.BoundingBox" }, + "markdownDescription": "List of BoundingBox objects, each of which denotes a region of interest on screen\\. For more information, see the BoundingBox field of [RegionOfInterest](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RegionOfInterest)\\. \n*Required*: No \n*Type*: List of [BoundingBox](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-boundingbox.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BoundingBoxRegionsOfInterest", "type": "array" }, "ConnectedHomeSettings": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.ConnectedHomeSettings" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.ConnectedHomeSettings", + "markdownDescription": "Connected home settings to use on a streaming video\\. You can use a stream processor for connected home features and select what you want the stream processor to detect, such as people or pets\\. When the stream processor has started, one notification is sent for each object class specified\\. For more information, see the ConnectedHome section of [StreamProcessorSettings](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorSettings)\\. \n*Required*: No \n*Type*: [ConnectedHomeSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-connectedhomesettings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConnectedHomeSettings" }, "DataSharingPreference": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.DataSharingPreference" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.DataSharingPreference", + "markdownDescription": "Allows you to opt in or opt out to share data with Rekognition to improve model performance\\. You can choose this option at the account level or on a per\\-stream basis\\. Note that if you opt out at the account level this setting is ignored on individual streams\\. For more information, see [StreamProcessorDataSharingPreference](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorDataSharingPreference)\\. \n*Required*: No \n*Type*: [DataSharingPreference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-datasharingpreference.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataSharingPreference" }, "FaceSearchSettings": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.FaceSearchSettings" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.FaceSearchSettings", + "markdownDescription": "The input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor\\. For more information regarding the contents of the parameters, see [FaceSearchSettings](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_FaceSearchSettings)\\. \n*Required*: No \n*Type*: [FaceSearchSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-facesearchsettings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FaceSearchSettings" }, "KinesisDataStream": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.KinesisDataStream" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.KinesisDataStream", + "markdownDescription": "Amazon Rekognition's Video Stream Processor takes a Kinesis video stream as input\\. This is the Amazon Kinesis Data Streams instance to which the Amazon Rekognition stream processor streams the analysis results\\. This must be created within the constraints specified at [KinesisDataStream](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_KinesisDataStream)\\. \n*Required*: No \n*Type*: [KinesisDataStream](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-kinesisdatastream.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KinesisDataStream" }, "KinesisVideoStream": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.KinesisVideoStream" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.KinesisVideoStream", + "markdownDescription": "The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor\\. For more information, see [KinesisVideoStream](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_KinesisVideoStream)\\. \n*Required*: Yes \n*Type*: [KinesisVideoStream](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-kinesisvideostream.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KinesisVideoStream" }, "KmsKeyId": { + "markdownDescription": "The identifier for your Amazon Key Management Service key \\(Amazon KMS key\\)\\. Optional parameter for connected home stream processors used to encrypt results and data published to your Amazon S3 bucket\\. For more information, see the KMSKeyId section of [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" }, "Name": { + "markdownDescription": "The Name attribute specifies the name of the stream processor and it must be within the constraints described in the Name section of [StreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessor)\\. If you don't specify a name, Amazon CloudFormation generates a unique ID and uses that ID for the stream processor name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[a-zA-Z0-9_.\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "NotificationChannel": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.NotificationChannel" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.NotificationChannel", + "markdownDescription": "The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation\\. Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream\\. Amazon Rekognition also publishes an end\\-of\\-session notification with a summary when the stream processing session is complete\\. For more information, see [StreamProcessorNotificationChannel](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorNotificationChannel)\\. \n*Required*: No \n*Type*: [NotificationChannel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-notificationchannel.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NotificationChannel" }, "PolygonRegionsOfInterest": { + "markdownDescription": "A set of ordered lists of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects\\. Each entry of the set contains a polygon denoting a region of interest on the screen\\. Each polygon is an ordered list of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects\\. For more information, see the Polygon field of [RegionOfInterest](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RegionOfInterest)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PolygonRegionsOfInterest", "type": "object" }, "RoleArn": { + "markdownDescription": "The ARN of the IAM role that allows access to the stream processor\\. The IAM role provides Rekognition read permissions to the Kinesis stream\\. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a connected home stream processor\\. This is required for both face search and connected home stream processors\\. For information about constraints, see the RoleArn section of [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RoleArn", "type": "string" }, "S3Destination": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.S3Destination" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.S3Destination", + "markdownDescription": "The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation\\. For more information, see the S3Destination section of [StreamProcessorOutput](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorOutput)\\. \n*Required*: No \n*Type*: [S3Destination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-s3destination.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3Destination" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A set of tags \\(key\\-value pairs\\) that you want to attach to the stream processor\\. For more information, see the Tags section of [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -154827,15 +159536,23 @@ "additionalProperties": false, "properties": { "Height": { + "markdownDescription": "Height of the bounding box as a ratio of the overall image height\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Height", "type": "number" }, "Left": { + "markdownDescription": "Left coordinate of the bounding box as a ratio of overall image width\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Left", "type": "number" }, "Top": { + "markdownDescription": "Top coordinate of the bounding box as a ratio of overall image height\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Top", "type": "number" }, "Width": { + "markdownDescription": "Width of the bounding box as a ratio of the overall image width\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Width", "type": "number" } }, @@ -154854,9 +159571,13 @@ "items": { "type": "string" }, + "markdownDescription": "Specifies what you want to detect in the video, such as people, packages, or pets\\. The current valid labels you can include in this list are: \"PERSON\", \"PET\", \"PACKAGE\", and \"ALL\"\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Labels", "type": "array" }, "MinConfidence": { + "markdownDescription": "The minimum confidence required to label an object in the video\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MinConfidence", "type": "number" } }, @@ -154869,6 +159590,8 @@ "additionalProperties": false, "properties": { "OptIn": { + "markdownDescription": "Describes the opt\\-in status applied to a stream processor's data sharing policy\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OptIn", "type": "boolean" } }, @@ -154881,9 +159604,13 @@ "additionalProperties": false, "properties": { "CollectionId": { + "markdownDescription": "The ID of a collection that contains faces that you want to search for\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CollectionId", "type": "string" }, "FaceMatchThreshold": { + "markdownDescription": "Minimum face match confidence score that must be met to return a result for a recognized face\\. The default is 80\\. 0 is the lowest confidence\\. 100 is the highest confidence\\. Values between 0 and 100 are accepted, and values lower than 80 are set to 80\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FaceMatchThreshold", "type": "number" } }, @@ -154896,6 +159623,8 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "ARN of the output Amazon Kinesis Data Streams stream\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `(^arn:([a-z\\d-]+):kinesis:([a-z\\d-]+):\\d{12}:.+$)` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Arn", "type": "string" } }, @@ -154908,6 +159637,8 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "ARN of the Kinesis video stream stream that streams the source video\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `(^arn:([a-z\\d-]+):kinesisvideo:([a-z\\d-]+):\\d{12}:.+$)` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Arn", "type": "string" } }, @@ -154920,6 +159651,8 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "The ARN of the SNS topic that receives notifications\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Arn", "type": "string" } }, @@ -154932,9 +159665,13 @@ "additionalProperties": false, "properties": { "BucketName": { + "markdownDescription": "Describes the destination Amazon Simple Storage Service \\(Amazon S3\\) bucket name of a stream processor's exports\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BucketName", "type": "string" }, "ObjectKeyPrefix": { + "markdownDescription": "Describes the destination Amazon Simple Storage Service \\(Amazon S3\\) object keys of a stream processor's exports\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ObjectKeyPrefix", "type": "string" } }, @@ -154979,6 +159716,8 @@ "additionalProperties": false, "properties": { "AppAssessmentSchedule": { + "markdownDescription": "Assessment execution schedule with 'Daily' or 'Disabled' values\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppAssessmentSchedule", "type": "string" }, "AppTemplateBody": { @@ -155088,7 +159827,7 @@ "type": "string" }, "MappingType": { - "markdownDescription": "Specifies the type of resource mapping\\. \nAppRegistryApp \nThe resource is mapped to another application\\. The name of the application is contained in the `appRegistryAppName` property\\. \nCfnStack \nThe resource is mapped to a CloudFormation stack\\. The name of the CloudFormation stack is contained in the `logicalStackName` property\\. \nResource \nThe resource is mapped to another resource\\. The name of the resource is contained in the `resourceName` property\\. \nResourceGroup \nThe resource is mapped to a resource group\\. The name of the resource group is contained in the `resourceGroupName` property\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the type of resource mapping\\. \nValid Values: CfnStack \\| Resource \\| AppRegistryApp \\| ResourceGroup \\| Terraform \nAppRegistryApp \nThe resource is mapped to another application\\. The name of the application is contained in the `appRegistryAppName` property\\. \nCfnStack \nThe resource is mapped to a CloudFormation stack\\. The name of the CloudFormation stack is contained in the `logicalStackName` property\\. \nResource \nThe resource is mapped to another resource\\. The name of the resource is contained in the `resourceName` property\\. \nResourceGroup \nThe resource is mapped to a resource group\\. The name of the resource group is contained in the `resourceGroupName` property\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MappingType", "type": "string" }, @@ -155103,6 +159842,8 @@ "type": "string" }, "TerraformSourceName": { + "markdownDescription": "The short name of the Terraform source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TerraformSourceName", "type": "string" } }, @@ -155274,6 +160015,8 @@ "additionalProperties": false, "properties": { "ViewArn": { + "markdownDescription": "The ARN of the view to set as the default for the AWS Region and AWS account in which you call this operation\\. The specified view must already exist in the specified Region\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ViewArn", "type": "string" } }, @@ -155340,14 +160083,18 @@ "properties": { "Tags": { "additionalProperties": true, + "markdownDescription": "The specified tags are attached to only the index created in this AWS Region\\. The tags don't attach to any of the resources listed in the index\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "Type": { + "markdownDescription": "Specifies the type of the index in this Region\\. For information about the aggregator index and how it differs from a local index, see [Turning on cross\\-Region search by creating an aggregator index](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) in the *AWS Resource Explorer User Guide\\.*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AGGREGATOR | LOCAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -155413,24 +160160,32 @@ "additionalProperties": false, "properties": { "Filters": { - "$ref": "#/definitions/AWS::ResourceExplorer2::View.Filters" + "$ref": "#/definitions/AWS::ResourceExplorer2::View.Filters", + "markdownDescription": "An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view\\. When you use this view in a [Search](https://docs.aws.amazon.com/resource-explorer/latest/APIReference/API_Search.html) operation, the filter string is combined with the search's `QueryString` parameter using a logical `AND` operator\\. \nFor information about the supported syntax, see [Search query reference for Resource Explorer](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) in the *AWS Resource Explorer User Guide*\\. \nThis query string in the context of this operation supports only [filter prefixes](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) with optional [operators](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators)\\. It doesn't support free\\-form text\\. For example, the string `region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any AWS Region that begin with the letters `us` and are *not* tagged with a key `Stage` that has the value `prod`\\.\n*Required*: No \n*Type*: [Filters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-filters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Filters" }, "IncludedProperties": { "items": { "$ref": "#/definitions/AWS::ResourceExplorer2::View.IncludedProperty" }, + "markdownDescription": "A list of fields that provide additional information about the view\\. \n*Required*: No \n*Type*: List of [IncludedProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-includedproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludedProperties", "type": "array" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tag key and value pairs that are attached to the view\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "ViewName": { + "markdownDescription": "The name of the new view\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9\\-]{1,64}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ViewName", "type": "string" } }, @@ -155464,6 +160219,8 @@ "additionalProperties": false, "properties": { "FilterString": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FilterString", "type": "string" } }, @@ -155476,6 +160233,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the property that is included in this view\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -155905,7 +160664,7 @@ }, "RobotSoftwareSuite": { "$ref": "#/definitions/AWS::RoboMaker::RobotApplication.RobotSoftwareSuite", - "markdownDescription": "The robot software suite \\(ROS distribuition\\) used by the robot application\\. \n*Required*: Yes \n*Type*: [RobotSoftwareSuite](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The robot software suite used by the robot application\\. \n*Required*: Yes \n*Type*: [RobotSoftwareSuite](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RobotSoftwareSuite" }, "Sources": { @@ -155958,12 +160717,12 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of the robot software suite \\(ROS distribution\\)\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `General | ROS | ROS2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the robot software suite\\. `General` is the only supported value\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `General | ROS | ROS2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Version": { - "markdownDescription": "The version of the robot software suite \\(ROS distribution\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Dashing | Foxy | Kinetic | Melodic` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the robot software suite\\. Not applicable for General software suite\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Dashing | Foxy | Kinetic | Melodic` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -156128,7 +160887,7 @@ }, "RobotSoftwareSuite": { "$ref": "#/definitions/AWS::RoboMaker::SimulationApplication.RobotSoftwareSuite", - "markdownDescription": "The robot software suite \\(ROS distribution\\) used by the simulation application\\. \n*Required*: Yes \n*Type*: [RobotSoftwareSuite](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The robot software suite used by the simulation application\\. \n*Required*: Yes \n*Type*: [RobotSoftwareSuite](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RobotSoftwareSuite" }, "SimulationSoftwareSuite": { @@ -156207,12 +160966,12 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of the robot software suite \\(ROS distribution\\)\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `General | ROS | ROS2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the robot software suite\\. `General` is the only supported value\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `General | ROS | ROS2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Version": { - "markdownDescription": "The version of the robot software suite \\(ROS distribution\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Dashing | Foxy | Kinetic | Melodic` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the robot software suite\\. Not applicable for General software suite\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Dashing | Foxy | Kinetic | Melodic` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -156226,12 +160985,12 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of the simulation software suite\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Gazebo | RosbagPlay | SimulationRuntime` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the simulation software suite\\. `SimulationRuntime` is the only supported value\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Gazebo | RosbagPlay | SimulationRuntime` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Version": { - "markdownDescription": "The version of the simulation software suite\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Pattern*: `7|9|11|Kinetic|Melodic|Dashing|Foxy` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the simulation software suite\\. Not applicable for `SimulationRuntime`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Pattern*: `7|9|11|Kinetic|Melodic|Dashing|Foxy` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -156375,21 +161134,31 @@ "additionalProperties": false, "properties": { "CrlData": { + "markdownDescription": "The revocation record for a certificate, following the x509 v3 standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CrlData", "type": "string" }, "Enabled": { + "markdownDescription": "Indicates whether the certificate revocation list \\(CRL\\) is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "Name": { + "markdownDescription": "The name of the certificate revocation list \\(CRL\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags to attach to the CRL\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TrustAnchorArn": { + "markdownDescription": "The ARN of the TrustAnchor the certificate revocation list \\(CRL\\) will provide revocation for\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrustAnchorArn", "type": "string" } }, @@ -156456,36 +161225,52 @@ "additionalProperties": false, "properties": { "DurationSeconds": { + "markdownDescription": "Sets the maximum number of seconds that vended temporary credentials through [CreateSession](https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html) will be valid for, between 900 and 3600\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DurationSeconds", "type": "number" }, "Enabled": { + "markdownDescription": "Indicates whether the profile is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "ManagedPolicyArns": { "items": { "type": "string" }, + "markdownDescription": "A list of managed policy ARNs that apply to the vended session credentials\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManagedPolicyArns", "type": "array" }, "Name": { + "markdownDescription": "The name of the profile\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[ a-zA-Z0-9-_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "RequireInstanceProperties": { + "markdownDescription": "Specifies whether instance properties are required in temporary credential requests with this profile\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RequireInstanceProperties", "type": "boolean" }, "RoleArns": { "items": { "type": "string" }, + "markdownDescription": "A list of IAM role ARNs\\. During `CreateSession`, if a matching role ARN is provided, the properties in this profile will be applied to the intersection session policy\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArns", "type": "array" }, "SessionPolicy": { + "markdownDescription": "A session policy that applies to the trust boundary of the vended session credentials\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionPolicy", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags to attach to the profile\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -156552,18 +161337,26 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Indicates whether the trust anchor is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "Name": { + "markdownDescription": "The name of the trust anchor\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[ a-zA-Z0-9-_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Source": { - "$ref": "#/definitions/AWS::RolesAnywhere::TrustAnchor.Source" + "$ref": "#/definitions/AWS::RolesAnywhere::TrustAnchor.Source", + "markdownDescription": "The trust anchor type and its related certificate data\\. \n*Required*: Yes \n*Type*: [Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-source.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Source" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags to attach to the trust anchor\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -156598,9 +161391,13 @@ "additionalProperties": false, "properties": { "SourceData": { - "$ref": "#/definitions/AWS::RolesAnywhere::TrustAnchor.SourceData" + "$ref": "#/definitions/AWS::RolesAnywhere::TrustAnchor.SourceData", + "markdownDescription": "The data field of the trust anchor depending on its type\\. \n*Required*: No \n*Type*: [SourceData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-sourcedata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceData" }, "SourceType": { + "markdownDescription": "The type of the trust anchor\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AWS_ACM_PCA | CERTIFICATE_BUNDLE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceType", "type": "string" } }, @@ -156610,9 +161407,13 @@ "additionalProperties": false, "properties": { "AcmPcaArn": { + "markdownDescription": "The root certificate of the AWS Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests\\. Included for trust anchors of type `AWS_ACM_PCA`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AcmPcaArn", "type": "string" }, "X509CertificateData": { + "markdownDescription": "The PEM\\-encoded data for the certificate anchor\\. Included for trust anchors of type `CERTIFICATE_BUNDLE`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "X509CertificateData", "type": "string" } }, @@ -156657,9 +161458,13 @@ "items": { "$ref": "#/definitions/AWS::Route53::CidrCollection.Location" }, + "markdownDescription": "A complex type that contains information about the list of CIDR locations\\. \n*Required*: No \n*Type*: List of [Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrcollection-location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Locations", "type": "array" }, "Name": { + "markdownDescription": "The name of a CIDR collection\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[0-9A-Za-z_\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -156696,9 +161501,13 @@ "items": { "type": "string" }, + "markdownDescription": "List of CIDR blocks\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CidrList", "type": "array" }, "LocationName": { + "markdownDescription": "The CIDR collection location name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16` \n*Pattern*: `[0-9A-Za-z_\\-\\*]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LocationName", "type": "string" } }, @@ -156812,7 +161621,7 @@ "properties": { "HealthCheckConfig": { "$ref": "#/definitions/AWS::Route53::HealthCheck.HealthCheckConfig", - "markdownDescription": "A complex type that contains detailed information about one health check\\. \nFor the values to enter for `HealthCheckConfig`, see [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html) \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains detailed information about one health check\\. \nFor the values to enter for `HealthCheckConfig`, see [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html) \n*Required*: Yes \n*Type*: [HealthCheckConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HealthCheckConfig" }, "HealthCheckTags": { @@ -156854,9 +161663,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy\\. \nRoute 53 supports CloudWatch alarms with the following features: \n+ Standard\\-resolution metrics\\. High\\-resolution metrics aren't supported\\. For more information, see [High\\-Resolution Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics) in the *Amazon CloudWatch User Guide*\\.\n+ Statistics: Average, Minimum, Maximum, Sum, and SampleCount\\. Extended statistics aren't supported\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Region": { + "markdownDescription": "For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in\\. \nFor the current list of CloudWatch regions, see [Amazon CloudWatch endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/cw_region.html) in the *Amazon Web Services General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-gov-east-1 | us-gov-west-1 | us-iso-east-1 | us-iso-west-1 | us-isob-east-1 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Region", "type": "string" } }, @@ -156870,60 +161683,94 @@ "additionalProperties": false, "properties": { "AlarmIdentifier": { - "$ref": "#/definitions/AWS::Route53::HealthCheck.AlarmIdentifier" + "$ref": "#/definitions/AWS::Route53::HealthCheck.AlarmIdentifier", + "markdownDescription": "A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy\\. \n*Required*: No \n*Type*: [AlarmIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmIdentifier" }, "ChildHealthChecks": { "items": { "type": "string" }, + "markdownDescription": "\\(CALCULATED Health Checks Only\\) A complex type that contains one `ChildHealthCheck` element for each health check that you want to associate with a `CALCULATED` health check\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ChildHealthChecks", "type": "array" }, "EnableSNI": { + "markdownDescription": "Specify whether you want Amazon Route 53 to send the value of `FullyQualifiedDomainName` to the endpoint in the `client_hello` message during TLS negotiation\\. This allows the endpoint to respond to `HTTPS` health check requests with the applicable SSL/TLS certificate\\. \nSome endpoints require that `HTTPS` requests include the host name in the `client_hello` message\\. If you don't enable SNI, the status of the health check will be `SSL alert handshake_failure`\\. A health check can also have that status for other reasons\\. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid\\. \nThe SSL/TLS certificate on your endpoint includes a domain name in the `Common Name` field and possibly several more in the `Subject Alternative Names` field\\. One of the domain names in the certificate should match the value that you specify for `FullyQualifiedDomainName`\\. If the endpoint responds to the `client_hello` message with a certificate that does not include the domain name that you specified in `FullyQualifiedDomainName`, a health checker will retry the handshake\\. In the second attempt, the health checker will omit `FullyQualifiedDomainName` from the `client_hello` message\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableSNI", "type": "boolean" }, "FailureThreshold": { + "markdownDescription": "The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa\\. For more information, see [How Amazon Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) in the *Amazon Route 53 Developer Guide*\\. \nIf you don't specify a value for `FailureThreshold`, the default value is three health checks\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailureThreshold", "type": "number" }, "FullyQualifiedDomainName": { + "markdownDescription": "Amazon Route 53 behavior depends on whether you specify a value for `IPAddress`\\. \n **If you specify a value for** `IPAddress`: \nAmazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of `FullyQualifiedDomainName` in the `Host` header for all health checks except TCP health checks\\. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks\\. \nWhen Route 53 checks the health of an endpoint, here is how it constructs the `Host` header: \n+ If you specify a value of `80` for `Port` and `HTTP` or `HTTP_STR_MATCH` for `Type`, Route 53 passes the value of `FullyQualifiedDomainName` to the endpoint in the Host header\\. \n+ If you specify a value of `443` for `Port` and `HTTPS` or `HTTPS_STR_MATCH` for `Type`, Route 53 passes the value of `FullyQualifiedDomainName` to the endpoint in the `Host` header\\.\n+ If you specify another value for `Port` and any value except `TCP` for `Type`, Route 53 passes `FullyQualifiedDomainName:Port` to the endpoint in the `Host` header\\.\nIf you don't specify a value for `FullyQualifiedDomainName`, Route 53 substitutes the value of `IPAddress` in the `Host` header in each of the preceding cases\\. \n **If you don't specify a value for `IPAddress` **: \nRoute 53 sends a DNS request to the domain that you specify for `FullyQualifiedDomainName` at the interval that you specify for `RequestInterval`\\. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint\\. \nIf you don't specify a value for `IPAddress`, Route 53 uses only IPv4 to send health checks to the endpoint\\. If there's no record with a type of A for the name that you specify for `FullyQualifiedDomainName`, the health check fails with a \"DNS resolution failed\" error\\.\nIf you want to check the health of multiple records that have the same name and type, such as multiple weighted records, and if you choose to specify the endpoint only by `FullyQualifiedDomainName`, we recommend that you create a separate health check for each endpoint\\. For example, create a health check for each HTTP server that is serving content for www\\.example\\.com\\. For the value of `FullyQualifiedDomainName`, specify the domain name of the server \\(such as us\\-east\\-2\\-www\\.example\\.com\\), not the name of the records \\(www\\.example\\.com\\)\\. \nIn this configuration, if you create a health check for which the value of `FullyQualifiedDomainName` matches the name of the records and you then associate the health check with those records, health check results will be unpredictable\\.\nIn addition, if the value that you specify for `Type` is `HTTP`, `HTTPS`, `HTTP_STR_MATCH`, or `HTTPS_STR_MATCH`, Route 53 passes the value of `FullyQualifiedDomainName` in the `Host` header, as it does when you specify a value for `IPAddress`\\. If the value of `Type` is `TCP`, Route 53 doesn't pass a `Host` header\\. \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FullyQualifiedDomainName", "type": "string" }, "HealthThreshold": { + "markdownDescription": "The number of child health checks that are associated with a `CALCULATED` health check that Amazon Route 53 must consider healthy for the `CALCULATED` health check to be considered healthy\\. To specify the child health checks that you want to associate with a `CALCULATED` health check, use the [ChildHealthChecks](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks) element\\. \nNote the following: \n+ If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy\\.\n+ If you specify `0`, Route 53 always considers this health check to be healthy\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HealthThreshold", "type": "number" }, "IPAddress": { + "markdownDescription": "The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on\\. If you don't specify a value for `IPAddress`, Route 53 sends a DNS request to resolve the domain name that you specify in `FullyQualifiedDomainName` at the interval that you specify in `RequestInterval`\\. Using an IP address returned by DNS, Route 53 then checks the health of the endpoint\\. \nUse one of the following formats for the value of `IPAddress`: \n+ **IPv4 address**: four values between 0 and 255, separated by periods \\(\\.\\), for example, `192.0.2.44`\\.\n+ **IPv6 address**: eight groups of four hexadecimal values, separated by colons \\(:\\), for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`\\. You can also shorten IPv6 addresses as described in RFC 5952, for example, `2001:db8:85a3::abcd:1:2345`\\.\nIf the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for `IPAddress`\\. This ensures that the IP address of your instance will never change\\. \nFor more information, see [FullyQualifiedDomainName](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName)\\. \nConstraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non\\-routable, or multicast ranges\\. For more information about IP addresses for which you can't create health checks, see the following documents: \n+ [RFC 5735, Special Use IPv4 Addresses](https://tools.ietf.org/html/rfc5735) \n+ [RFC 6598, IANA\\-Reserved IPv4 Prefix for Shared Address Space](https://tools.ietf.org/html/rfc6598) \n+ [RFC 5156, Special\\-Use IPv6 Addresses](https://tools.ietf.org/html/rfc5156) \nWhen the value of `Type` is `CALCULATED` or `CLOUDWATCH_METRIC`, omit `IPAddress`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `45` \n*Pattern*: `(^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IPAddress", "type": "string" }, "InsufficientDataHealthStatus": { + "markdownDescription": "When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check: \n+ `Healthy`: Route 53 considers the health check to be healthy\\.\n+ `Unhealthy`: Route 53 considers the health check to be unhealthy\\.\n+ `LastKnownStatus`: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state\\. For new health checks that have no last known status, the default status for the health check is healthy\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `Healthy | LastKnownStatus | Unhealthy` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InsufficientDataHealthStatus", "type": "string" }, "Inverted": { + "markdownDescription": "Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Inverted", "type": "boolean" }, "MeasureLatency": { + "markdownDescription": "Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the **Health Checks** page in the Route 53 console\\. \nYou can't change the value of `MeasureLatency` after you create a health check\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MeasureLatency", "type": "boolean" }, "Port": { + "markdownDescription": "The port on the endpoint that you want Amazon Route 53 to perform health checks on\\. \nDon't specify a value for `Port` when you specify a value for [Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type) of `CLOUDWATCH_METRIC` or `CALCULATED`\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "Regions": { "items": { "type": "string" }, + "markdownDescription": "A complex type that contains one `Region` element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint\\. \nIf you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under **Valid Values**\\. \nIf you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint \\(for example, if you replace three regions with four different regions\\)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Regions", "type": "array" }, "RequestInterval": { + "markdownDescription": "The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request\\. Each Route 53 health checker makes requests at this interval\\. \nYou can't change the value of `RequestInterval` after you create a health check\\.\nIf you don't specify a value for `RequestInterval`, the default value is `30` seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `10` \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RequestInterval", "type": "number" }, "ResourcePath": { + "markdownDescription": "The path, if any, that you want Amazon Route 53 to request when performing health checks\\. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53\\-health\\-check\\.html\\. You can also include query string parameters, for example, `/welcome.html?language=jp&login=y`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourcePath", "type": "string" }, "RoutingControlArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the Route 53 Application Recovery Controller routing control\\. \nFor more information about Route 53 Application Recovery Controller, see [Route 53 Application Recovery Controller Developer Guide\\.](https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route-53-recovery.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoutingControlArn", "type": "string" }, "SearchString": { + "markdownDescription": "If the value of Type is `HTTP_STR_MATCH` or `HTTPS_STR_MATCH`, the string that you want Amazon Route 53 to search for in the response body from the specified resource\\. If the string appears in the response body, Route 53 considers the resource healthy\\. \nRoute 53 considers case when searching for `SearchString` in the response body\\. \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SearchString", "type": "string" }, "Type": { + "markdownDescription": "The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy\\. \nYou can't change the value of `Type` after you create a health check\\.\nYou can create the following types of health checks: \n+ **HTTP**: Route 53 tries to establish a TCP connection\\. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400\\.\n+ **HTTPS**: Route 53 tries to establish a TCP connection\\. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400\\.\n**Important** \nIf you specify `HTTPS` for the value of `Type`, the endpoint must support TLS v1\\.0 or later\\.\n+ **HTTP\\_STR\\_MATCH**: Route 53 tries to establish a TCP connection\\. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in `SearchString`\\.\n+ **HTTPS\\_STR\\_MATCH**: Route 53 tries to establish a TCP connection\\. If successful, Route 53 submits an `HTTPS` request and searches the first 5,120 bytes of the response body for the string that you specify in `SearchString`\\.\n+ **TCP**: Route 53 tries to establish a TCP connection\\.\n+ **CLOUDWATCH\\_METRIC**: The health check is associated with a CloudWatch alarm\\. If the state of the alarm is `OK`, the health check is considered healthy\\. If the state is `ALARM`, the health check is considered unhealthy\\. If CloudWatch doesn't have sufficient data to determine whether the state is `OK` or `ALARM`, the health check status depends on the setting for `InsufficientDataHealthStatus`: `Healthy`, `Unhealthy`, or `LastKnownStatus`\\. \n+ **CALCULATED**: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of `HealthThreshold`\\. \n+ **RECOVERY\\_CONTROL**: The health check is assocated with a Route53 Application Recovery Controller routing control\\. If the routing control state is `ON`, the health check is considered healthy\\. If the state is `OFF`, the health check is considered unhealthy\\. \nFor more information, see [How Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) in the *Amazon Route 53 Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CALCULATED | CLOUDWATCH_METRIC | HTTP | HTTP_STR_MATCH | HTTPS | HTTPS_STR_MATCH | RECOVERY_CONTROL | TCP` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -157228,11 +162075,13 @@ "properties": { "AliasTarget": { "$ref": "#/definitions/AWS::Route53::RecordSet.AliasTarget", - "markdownDescription": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to\\. \nIf you're creating resource records sets for a private hosted zone, note the following: \n+ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution\\.\n+ Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported\\.\n+ For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide*\\.\n*Required*: No \n*Type*: [AliasTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to\\. \nIf you're creating resource records sets for a private hosted zone, note the following: \n+ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution\\.\n+ For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide*\\.\n*Required*: No \n*Type*: [AliasTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AliasTarget" }, "CidrRoutingConfig": { - "$ref": "#/definitions/AWS::Route53::RecordSet.CidrRoutingConfig" + "$ref": "#/definitions/AWS::Route53::RecordSet.CidrRoutingConfig", + "markdownDescription": "The object that is specified in resource record set object when you are linking a resource record set to a CIDR location\\. \nA `LocationName` with an asterisk \u201c\\*\u201d can be used to create a default CIDR record\\. `CollectionId` is still required for default record\\. \n*Required*: No \n*Type*: [CidrRoutingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CidrRoutingConfig" }, "Comment": { "markdownDescription": "*Optional:* Any comments you want to include about a change batch request\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -157275,7 +162124,7 @@ "type": "string" }, "Region": { - "markdownDescription": "*Latency\\-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to\\. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type\\. \nAlthough creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported\\.\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region\\. Route 53 then returns the value that is associated with the selected resource record set\\. \nNote the following: \n+ You can only specify one `ResourceRecord` per latency resource record set\\.\n+ You can only create one latency resource record set for each Amazon EC2 Region\\.\n+ You aren't required to create latency resource record sets for all Amazon EC2 Regions\\. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for\\.\n+ You can't create non\\-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "*Latency\\-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to\\. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type\\. \nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region\\. Route 53 then returns the value that is associated with the selected resource record set\\. \nNote the following: \n+ You can only specify one `ResourceRecord` per latency resource record set\\.\n+ You can only create one latency resource record set for each Amazon EC2 Region\\.\n+ You aren't required to create latency resource record sets for all Amazon EC2 Regions\\. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for\\.\n+ You can't create non\\-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Region", "type": "string" }, @@ -157364,9 +162213,13 @@ "additionalProperties": false, "properties": { "CollectionId": { + "markdownDescription": "The CIDR collection ID\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CollectionId", "type": "string" }, "LocationName": { + "markdownDescription": "The CIDR collection location name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16` \n*Pattern*: `[0-9A-Za-z_\\-\\*]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LocationName", "type": "string" } }, @@ -157438,12 +162291,12 @@ "type": "string" }, "HostedZoneId": { - "markdownDescription": "The ID of the hosted zone that contains the resource record sets that you want to change\\. \n*Required*: Conditional \n*Type*: String \n*Maximum*: `32` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the hosted zone that you want to create records in\\. \nSpecify either `HostedZoneName` or `HostedZoneId`, but not both\\. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `32` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "HostedZoneId", "type": "string" }, "HostedZoneName": { - "markdownDescription": "The name of the hosted zone that you want to create, update, or delete resource record sets in\\. \n*Required*: Conditional \n*Type*: String \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the hosted zone that you want to create records in\\. You must include a trailing dot \\(for example, `www.example.com.`\\) as part of the `HostedZoneName`\\. \nWhen you create a stack using an `AWS::Route53::RecordSet` that specifies `HostedZoneName`, AWS CloudFormation attempts to find a hosted zone whose name matches the `HostedZoneName`\\. If AWS CloudFormation can't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack\\. \nSpecify either `HostedZoneName` or `HostedZoneId`, but not both\\. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "HostedZoneName", "type": "string" }, @@ -157507,9 +162360,13 @@ "additionalProperties": false, "properties": { "CollectionId": { + "markdownDescription": "The CIDR collection ID\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CollectionId", "type": "string" }, "LocationName": { + "markdownDescription": "The CIDR collection location name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16` \n*Pattern*: `[0-9A-Za-z_\\-\\*]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LocationName", "type": "string" } }, @@ -157545,11 +162402,13 @@ "properties": { "AliasTarget": { "$ref": "#/definitions/AWS::Route53::RecordSetGroup.AliasTarget", - "markdownDescription": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to\\. \nIf you're creating resource records sets for a private hosted zone, note the following: \n+ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution\\.\n+ Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported\\.\n+ For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide*\\.\n*Required*: No \n*Type*: [AliasTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to\\. \nIf you're creating resource records sets for a private hosted zone, note the following: \n+ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution\\.\n+ For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide*\\.\n*Required*: No \n*Type*: [AliasTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AliasTarget" }, "CidrRoutingConfig": { - "$ref": "#/definitions/AWS::Route53::RecordSetGroup.CidrRoutingConfig" + "$ref": "#/definitions/AWS::Route53::RecordSetGroup.CidrRoutingConfig", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [CidrRoutingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CidrRoutingConfig" }, "Failover": { "markdownDescription": "*Failover resource record sets only:* To configure failover, you add the `Failover` element to two resource record sets\\. For one resource record set, you specify `PRIMARY` as the value for `Failover`; for the other resource record set, you specify `SECONDARY`\\. In addition, you include the `HealthCheckId` element and specify the health check that you want Amazon Route 53 to perform for each resource record set\\. \nExcept where noted, the following failover behaviors assume that you have included the `HealthCheckId` element in both resource record sets: \n+ When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set\\.\n+ When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set\\.\n+ When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set\\.\n+ If you omit the `HealthCheckId` element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set\\. This is true regardless of the health of the associated endpoint\\.\nYou can't create non\\-failover resource record sets that have the same values for the `Name` and `Type` elements as failover resource record sets\\. \nFor failover alias resource record sets, you must also include the `EvaluateTargetHealth` element and set the value to true\\. \nFor more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide*: \n+ [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) \n+ [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) \n*Required*: No \n*Type*: String \n*Allowed values*: `PRIMARY | SECONDARY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -157587,7 +162446,7 @@ "type": "string" }, "Region": { - "markdownDescription": "*Latency\\-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to\\. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type\\. \nAlthough creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported\\.\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region\\. Route 53 then returns the value that is associated with the selected resource record set\\. \nNote the following: \n+ You can only specify one `ResourceRecord` per latency resource record set\\.\n+ You can only create one latency resource record set for each Amazon EC2 Region\\.\n+ You aren't required to create latency resource record sets for all Amazon EC2 Regions\\. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for\\.\n+ You can't create non\\-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "*Latency\\-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to\\. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type\\. \nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region\\. Route 53 then returns the value that is associated with the selected resource record set\\. \nNote the following: \n+ You can only specify one `ResourceRecord` per latency resource record set\\.\n+ You can only create one latency resource record set for each Amazon EC2 Region\\.\n+ You aren't required to create latency resource record sets for all Amazon EC2 Regions\\. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for\\.\n+ You can't create non\\-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Region", "type": "string" }, @@ -157665,6 +162524,8 @@ "items": { "$ref": "#/definitions/AWS::Route53RecoveryControl::Cluster.ClusterEndpoint" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ClusterEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoverycontrol-cluster-clusterendpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClusterEndpoints", "type": "array" }, "Name": { @@ -157927,7 +162788,7 @@ "title": "GatingRule" }, "Name": { - "markdownDescription": "The name of the assertion rule\\. You can use any non\\-white space character in the name\\. The name must be unique within a control panel\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the assertion rule\\. The name must be unique within a control panel\\. You can use any non\\-white space character in the name except the following: & > < ' \\(single quote\\) \" \\(double quote\\) ; \\(semicolon\\) \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -158090,7 +162951,7 @@ "additionalProperties": false, "properties": { "CellName": { - "markdownDescription": "The name of the cell to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the cell to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CellName", "type": "string" }, @@ -158169,7 +163030,7 @@ "additionalProperties": false, "properties": { "ReadinessCheckName": { - "markdownDescription": "The name of the readiness check to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the readiness check to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ReadinessCheckName", "type": "string" }, @@ -158253,7 +163114,7 @@ "type": "array" }, "RecoveryGroupName": { - "markdownDescription": "The name of the recovery group to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the recovery group to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RecoveryGroupName", "type": "string" }, @@ -158324,7 +163185,7 @@ "additionalProperties": false, "properties": { "ResourceSetName": { - "markdownDescription": "The name of the resource set to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the resource set to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceSetName", "type": "string" }, @@ -158976,12 +163837,18 @@ "type": "string" }, "OutpostArn": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OutpostArn", "type": "string" }, "PreferredInstanceType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PreferredInstanceType", "type": "string" }, "ResolverEndpointType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResolverEndpointType", "type": "string" }, "SecurityGroupIds": { @@ -159038,6 +163905,8 @@ "type": "string" }, "Ipv6": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Ipv6", "type": "string" }, "SubnetId": { @@ -159223,7 +164092,7 @@ "additionalProperties": false, "properties": { "DomainName": { - "markdownDescription": "DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps`\\. If a query matches multiple Resolver rules \\(example\\.com and www\\.example\\.com\\), the query is routed using the Resolver rule that contains the most specific domain name \\(www\\.example\\.com\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps`\\. If a query matches multiple Resolver rules \\(example\\.com and www\\.example\\.com\\), the query is routed using the Resolver rule that contains the most specific domain name \\(www\\.example\\.com\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "DomainName", "type": "string" }, @@ -159290,11 +164159,13 @@ "additionalProperties": false, "properties": { "Ip": { - "markdownDescription": "One IP address that you want to forward DNS queries to\\. You can specify only IPv4 addresses\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `7` \n*Maximum*: `36` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "One IP address that you want to forward DNS queries to\\. You can specify only IPv4 addresses\\. \n*Required*: No \n*Type*: String \n*Minimum*: `7` \n*Maximum*: `36` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Ip", "type": "string" }, "Ipv6": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Ipv6", "type": "string" }, "Port": { @@ -159424,6 +164295,8 @@ "type": "string" }, "BucketAccountId": { + "markdownDescription": "The AWS account ID associated with the S3 bucket associated with this access point\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BucketAccountId", "type": "string" }, "Name": { @@ -159438,7 +164311,7 @@ }, "PolicyStatus": { "$ref": "#/definitions/AWS::S3::AccessPoint.PolicyStatus", - "markdownDescription": "The container element for a bucket's policy status\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The container element for a bucket's policy status\\. \n*Required*: No \n*Type*: [PolicyStatus](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-policystatus.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PolicyStatus" }, "PublicAccessBlockConfiguration": { @@ -159482,6 +164355,8 @@ "additionalProperties": false, "properties": { "IsPublic": { + "markdownDescription": "The policy status for this bucket\\. `TRUE` indicates that this bucket is public\\. `FALSE` indicates that the bucket is not public\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsPublic", "type": "string" } }, @@ -159951,7 +164826,7 @@ "additionalProperties": false, "properties": { "ReplicaKmsKeyID": { - "markdownDescription": "Specifies the ID \\(Key ARN or Alias ARN\\) of the customer managed AWS KMS key stored in AWS Key Management Service \\(KMS\\) for the destination bucket\\. Amazon S3 uses this key to encrypt replica objects\\. Amazon S3 only supports symmetric, customer managed KMS keys\\. For more information, see [Using symmetric and asymmetric keys](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the * AWS Key Management Service Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the ID \\(Key ARN or Alias ARN\\) of the customer managed AWS KMS key stored in AWS Key Management Service \\(KMS\\) for the destination bucket\\. Amazon S3 uses this key to encrypt replica objects\\. Amazon S3 only supports symmetric encryption KMS keys\\. For more information, see [Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the * AWS Key Management Service Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReplicaKmsKeyID", "type": "string" } @@ -160297,7 +165172,7 @@ }, "Rule": { "$ref": "#/definitions/AWS::S3::Bucket.ObjectLockRule", - "markdownDescription": "Specifies the Object Lock rule for the specified object\\. Enable the this rule when you apply `ObjectLockConfiguration` to a bucket\\. If Object Lock is turned on, bucket settings require both `Mode` and a period of either `Days` or `Years`\\. You cannot specify `Days` and `Years` at the same time\\. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)\\. \n*Required*: Conditional \n*Type*: [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the Object Lock rule for the specified object\\. Enable this rule when you apply `ObjectLockConfiguration` to a bucket\\. If Object Lock is turned on, bucket settings require both `Mode` and a period of either `Days` or `Years`\\. You cannot specify `Days` and `Years` at the same time\\. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)\\. \n*Required*: Conditional \n*Type*: [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Rule" } }, @@ -160378,7 +165253,7 @@ }, "Filter": { "$ref": "#/definitions/AWS::S3::Bucket.NotificationFilter", - "markdownDescription": "The filtering rules that determine which objects trigger notifications\\. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a `.jpg` extension are added to the bucket\\. \n*Required*: No \n*Type*: [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The filtering rules that determine which objects trigger notifications\\. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a `.jpg` extension are added to the bucket\\. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Filter" }, "Queue": { @@ -160539,7 +165414,7 @@ }, "Filter": { "$ref": "#/definitions/AWS::S3::Bucket.ReplicationRuleFilter", - "markdownDescription": "A filter that identifies the subset of objects to which the replication rule applies\\. A `Filter` must specify exactly one `Prefix`, `TagFilter`, or an `And` child element\\. The use of the filter field indicates this is a V2 replication configuration\\. V1 does not have this field\\. \n*Required*: No \n*Type*: [ReplicationRuleFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A filter that identifies the subset of objects to which the replication rule applies\\. A `Filter` must specify exactly one `Prefix`, `TagFilter`, or an `And` child element\\. The use of the filter field indicates that this is a V2 replication configuration\\. This field isn't supported in a V1 replication configuration\\. \nV1 replication configuration only supports filtering by key prefix\\. To filter using a V1 replication configuration, add the `Prefix` directly as a child element of the `Rule` element\\.\n*Required*: No \n*Type*: [ReplicationRuleFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Filter" }, "Id": { @@ -160548,7 +165423,7 @@ "type": "string" }, "Prefix": { - "markdownDescription": "An object key name prefix that identifies the object or objects to which the rule applies\\. The maximum prefix length is 1,024 characters\\. To include all objects in a bucket, specify an empty string\\. \nReplacement must be made for object keys containing special characters \\(such as carriage returns\\) when using XML requests\\. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An object key name prefix that identifies the object or objects to which the rule applies\\. The maximum prefix length is 1,024 characters\\. To include all objects in a bucket, specify an empty string\\. To filter using a V1 replication configuration, add the `Prefix` directly as a child element of the `Rule` element\\. \nReplacement must be made for object keys containing special characters \\(such as carriage returns\\) when using XML requests\\. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Prefix", "type": "string" }, @@ -160735,12 +165610,12 @@ "type": "array" }, "ObjectSizeGreaterThan": { - "markdownDescription": "Specifies the minimum object size in bytes for this rule to apply to\\. For more information about size based rules, see [Lifecycle configuration using size\\-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the minimum object size in bytes for this rule to apply to\\. Objects must be larger than this value in bytes\\. For more information about size based rules, see [Lifecycle configuration using size\\-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ObjectSizeGreaterThan", "type": "number" }, "ObjectSizeLessThan": { - "markdownDescription": "Specifies the maximum object size in bytes for this rule to apply to\\. For more information about sized based rules, see [Lifecycle configuration using size\\-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the maximum object size in bytes for this rule to apply to\\. Objects must be smaller than this value in bytes\\. For more information about sized based rules, see [Lifecycle configuration using size\\-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ObjectSizeLessThan", "type": "number" }, @@ -161276,6 +166151,8 @@ "additionalProperties": false, "properties": { "IsPublic": { + "markdownDescription": "The policy status for this bucket\\. `TRUE` indicates that this bucket is public\\. `FALSE` indicates that the bucket is not public\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsPublic", "type": "string" } }, @@ -161364,14 +166241,18 @@ "properties": { "ActivityMetrics": { "$ref": "#/definitions/AWS::S3::StorageLens.ActivityMetrics", - "markdownDescription": "This property contains the details of the account\\-level activity metrics for Amazon S3 Storage Lens\\. \n*Required*: No \n*Type*: [ActivityMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This property contains the details of account\\-level activity metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [ActivityMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ActivityMetrics" }, "AdvancedCostOptimizationMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedCostOptimizationMetrics" + "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedCostOptimizationMetrics", + "markdownDescription": "This property contains the details of account\\-level advanced cost optimization metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [AdvancedCostOptimizationMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedcostoptimizationmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdvancedCostOptimizationMetrics" }, "AdvancedDataProtectionMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedDataProtectionMetrics" + "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedDataProtectionMetrics", + "markdownDescription": "This property contains the details of account\\-level advanced data protection metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [AdvancedDataProtectionMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advanceddataprotectionmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdvancedDataProtectionMetrics" }, "BucketLevel": { "$ref": "#/definitions/AWS::S3::StorageLens.BucketLevel", @@ -161379,7 +166260,9 @@ "title": "BucketLevel" }, "DetailedStatusCodesMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.DetailedStatusCodesMetrics" + "$ref": "#/definitions/AWS::S3::StorageLens.DetailedStatusCodesMetrics", + "markdownDescription": "This property contains the details of account\\-level detailed status code metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [DetailedStatusCodesMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-detailedstatuscodesmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DetailedStatusCodesMetrics" } }, "required": [ @@ -161402,6 +166285,8 @@ "additionalProperties": false, "properties": { "IsEnabled": { + "markdownDescription": "Indicates whether advanced cost optimization metrics are enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsEnabled", "type": "boolean" } }, @@ -161411,6 +166296,8 @@ "additionalProperties": false, "properties": { "IsEnabled": { + "markdownDescription": "Indicates whether advanced data protection metrics are enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsEnabled", "type": "boolean" } }, @@ -161435,21 +166322,27 @@ "properties": { "ActivityMetrics": { "$ref": "#/definitions/AWS::S3::StorageLens.ActivityMetrics", - "markdownDescription": "A property for the bucket\\-level activity metrics for Amazon S3 Storage Lens\\. \n*Required*: No \n*Type*: [ActivityMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A property for bucket\\-level activity metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [ActivityMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ActivityMetrics" }, "AdvancedCostOptimizationMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedCostOptimizationMetrics" + "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedCostOptimizationMetrics", + "markdownDescription": "A property for bucket\\-level advanced cost optimization metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [AdvancedCostOptimizationMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedcostoptimizationmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdvancedCostOptimizationMetrics" }, "AdvancedDataProtectionMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedDataProtectionMetrics" + "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedDataProtectionMetrics", + "markdownDescription": "A property for bucket\\-level advanced data protection metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [AdvancedDataProtectionMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advanceddataprotectionmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdvancedDataProtectionMetrics" }, "DetailedStatusCodesMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.DetailedStatusCodesMetrics" + "$ref": "#/definitions/AWS::S3::StorageLens.DetailedStatusCodesMetrics", + "markdownDescription": "A property for bucket\\-level detailed status code metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [DetailedStatusCodesMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-detailedstatuscodesmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DetailedStatusCodesMetrics" }, "PrefixLevel": { "$ref": "#/definitions/AWS::S3::StorageLens.PrefixLevel", - "markdownDescription": "A property for the bucket\\-level prefix\\-level storage metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [PrefixLevel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A property for bucket\\-level prefix\\-level storage metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [PrefixLevel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PrefixLevel" } }, @@ -161511,6 +166404,8 @@ "additionalProperties": false, "properties": { "IsEnabled": { + "markdownDescription": "Indicates whether detailed status code metrics are enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsEnabled", "type": "boolean" } }, @@ -161520,9 +166415,13 @@ "additionalProperties": false, "properties": { "SSEKMS": { - "$ref": "#/definitions/AWS::S3::StorageLens.SSEKMS" + "$ref": "#/definitions/AWS::S3::StorageLens.SSEKMS", + "markdownDescription": "Specifies the use of AWS Key Management Service keys \\(SSE\\-KMS\\) to encrypt the S3 Storage Lens metrics export file\\. \n*Required*: No \n*Type*: [SSEKMS](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-ssekms.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SSEKMS" }, "SSES3": { + "markdownDescription": "Specifies the use of an Amazon S3\\-managed key \\(SSE\\-S3\\) to encrypt the S3 Storage Lens metrics export file\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SSES3", "type": "object" } }, @@ -161604,6 +166503,8 @@ "additionalProperties": false, "properties": { "KeyId": { + "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of the customer managed AWS KMS key to use for encrypting the S3 Storage Lens metrics export file\\. Amazon S3 only supports symmetric encryption keys\\. For more information, see [Special\\-purpose keys](https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html) in the *AWS Key Management Service Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KeyId", "type": "string" } }, @@ -161760,9 +166661,13 @@ "additionalProperties": false, "properties": { "FunctionArn": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FunctionArn", "type": "string" }, "FunctionPayload": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FunctionPayload", "type": "string" } }, @@ -161775,7 +166680,9 @@ "additionalProperties": false, "properties": { "AwsLambda": { - "$ref": "#/definitions/AWS::S3ObjectLambda::AccessPoint.AwsLambda" + "$ref": "#/definitions/AWS::S3ObjectLambda::AccessPoint.AwsLambda", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [AwsLambda](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-awslambda.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AwsLambda" } }, "required": [ @@ -161790,7 +166697,7 @@ "items": { "type": "string" }, - "markdownDescription": "A container for allowed features\\. Valid inputs are `GetObject-Range` and `GetObject-PartNumber`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A container for allowed features\\. Valid inputs are `GetObject-Range`, `GetObject-PartNumber`, `HeadObject-Range`, and `HeadObject-PartNumber`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowedFeatures", "type": "array" }, @@ -161823,6 +166730,8 @@ "additionalProperties": false, "properties": { "IsPublic": { + "markdownDescription": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsPublic", "type": "boolean" } }, @@ -161832,15 +166741,23 @@ "additionalProperties": false, "properties": { "BlockPublicAcls": { + "markdownDescription": "Specifies whether Amazon S3 should block public access control lists \\(ACLs\\) for buckets in this account\\. Setting this element to `TRUE` causes the following behavior: \n+ `PutBucketAcl` and `PutObjectAcl` calls fail if the specified ACL is public\\.\n+ PUT Object calls fail if the request includes a public ACL\\.\n+ PUT Bucket calls fail if the request includes a public ACL\\.\nEnabling this setting doesn't affect existing policies or ACLs\\. \nThis property is not supported for Amazon S3 on Outposts\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BlockPublicAcls", "type": "boolean" }, "BlockPublicPolicy": { + "markdownDescription": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account\\. Setting this element to `TRUE` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access\\. \nEnabling this setting doesn't affect existing bucket policies\\. \nThis property is not supported for Amazon S3 on Outposts\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BlockPublicPolicy", "type": "boolean" }, "IgnorePublicAcls": { + "markdownDescription": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account\\. Setting this element to `TRUE` causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain\\. \nEnabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set\\. \nThis property is not supported for Amazon S3 on Outposts\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IgnorePublicAcls", "type": "boolean" }, "RestrictPublicBuckets": { + "markdownDescription": "Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account\\. Setting this element to `TRUE` restricts access to buckets with public policies to only AWS service principals and authorized users within this account\\. \nEnabling this setting doesn't affect previously stored bucket policies, except that public and cross\\-account access within any public bucket policy, including non\\-public delegation to specific accounts, is blocked\\. \nThis property is not supported for Amazon S3 on Outposts\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RestrictPublicBuckets", "type": "boolean" } }, @@ -161853,13 +166770,13 @@ "items": { "type": "string" }, - "markdownDescription": "A container for the action of an Object Lambda Access Point configuration\\. Valid input is `GetObject`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A container for the action of an Object Lambda Access Point configuration\\. Valid inputs are `GetObject`, `HeadObject`, `ListObject`, and `ListObjectV2`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Actions", "type": "array" }, "ContentTransformation": { "$ref": "#/definitions/AWS::S3ObjectLambda::AccessPoint.ContentTransformation", - "markdownDescription": "A container for the content transformation of an Object Lambda Access Point configuration\\. Can include the FunctionArn and FunctionPayload\\. For more information, see [AwsLambdaTransformation](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_AwsLambdaTransformation.html) in the *Amazon S3 API Reference*\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A container for the content transformation of an Object Lambda Access Point configuration\\. Can include the FunctionArn and FunctionPayload\\. For more information, see [AwsLambdaTransformation](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_AwsLambdaTransformation.html) in the *Amazon S3 API Reference*\\. \n*Required*: Yes \n*Type*: [ContentTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-contenttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContentTransformation" } }, @@ -162141,13 +167058,19 @@ "additionalProperties": false, "properties": { "AndOperator": { - "$ref": "#/definitions/AWS::S3Outposts::Bucket.FilterAndOperator" + "$ref": "#/definitions/AWS::S3Outposts::Bucket.FilterAndOperator", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [FilterAndOperator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filterandoperator.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AndOperator" }, "Prefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Prefix", "type": "string" }, "Tag": { - "$ref": "#/definitions/AWS::S3Outposts::Bucket.FilterTag" + "$ref": "#/definitions/AWS::S3Outposts::Bucket.FilterTag", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [FilterTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filtertag.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tag" } }, "type": "object" @@ -162156,12 +167079,16 @@ "additionalProperties": false, "properties": { "Prefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Prefix", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/AWS::S3Outposts::Bucket.FilterTag" }, + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: List of [FilterTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filtertag.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -162174,9 +167101,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -162223,7 +167154,7 @@ }, "Filter": { "$ref": "#/definitions/AWS::S3Outposts::Bucket.Filter", - "markdownDescription": "The container for the filter of the lifecycle rule\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The container for the filter of the lifecycle rule\\. \n*Required*: No \n*Type*: [Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Filter" }, "Id": { @@ -162232,7 +167163,7 @@ "type": "string" }, "Status": { - "markdownDescription": "If `Enabled`, the rule is currently being applied\\. If `Disabled`, the rule is not currently being applied\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If `Enabled`, the rule is currently being applied\\. If `Disabled`, the rule is not currently being applied\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Status", "type": "string" } @@ -162517,7 +167448,9 @@ "additionalProperties": false, "properties": { "DeliveryOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.DeliveryOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.DeliveryOptions", + "markdownDescription": "Specifies whether messages that use the configuration set are required to use Transport Layer Security \\(TLS\\)\\. \n*Required*: No \n*Type*: [DeliveryOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-deliveryoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeliveryOptions" }, "Name": { "markdownDescription": "The name of the configuration set\\. The name must meet the following requirements: \n+ Contain only letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), or dashes \\(\\-\\)\\.\n+ Contain 64 characters or fewer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -162525,19 +167458,29 @@ "type": "string" }, "ReputationOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.ReputationOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.ReputationOptions", + "markdownDescription": "An object that represents the reputation settings for the configuration set\\. \n*Required*: No \n*Type*: [ReputationOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-reputationoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReputationOptions" }, "SendingOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.SendingOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.SendingOptions", + "markdownDescription": "An object that defines whether or not Amazon SES can send email that you send using the configuration set\\. \n*Required*: No \n*Type*: [SendingOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-sendingoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SendingOptions" }, "SuppressionOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.SuppressionOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.SuppressionOptions", + "markdownDescription": "An object that contains information about the suppression list preferences for your account\\. \n*Required*: No \n*Type*: [SuppressionOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-suppressionoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SuppressionOptions" }, "TrackingOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.TrackingOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.TrackingOptions", + "markdownDescription": "The name of the custom open and click tracking domain associated with the configuration set\\. \n*Required*: No \n*Type*: [TrackingOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-trackingoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrackingOptions" }, "VdmOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.VdmOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.VdmOptions", + "markdownDescription": "The Virtual Deliverability Manager \\(VDM\\) options that apply to the configuration set\\. \n*Required*: No \n*Type*: [VdmOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-vdmoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VdmOptions" } }, "type": "object" @@ -162566,6 +167509,8 @@ "additionalProperties": false, "properties": { "EngagementMetrics": { + "markdownDescription": "Specifies the status of your VDM engagement metrics collection\\. Can be one of the following: \n+ `ENABLED` \u2013 Amazon SES enables engagement metrics for the configuration set\\.\n+ `DISABLED` \u2013 Amazon SES disables engagement metrics for the configuration set\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EngagementMetrics", "type": "string" } }, @@ -162578,9 +167523,13 @@ "additionalProperties": false, "properties": { "SendingPoolName": { + "markdownDescription": "The name of the dedicated IP pool to associate with the configuration set\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SendingPoolName", "type": "string" }, "TlsPolicy": { + "markdownDescription": "Specifies whether messages that use the configuration set are required to use Transport Layer Security \\(TLS\\)\\. If the value is `REQUIRE`, messages are only delivered if a TLS connection can be established\\. If the value is `OPTIONAL`, messages can be delivered in plain text if a TLS connection can't be established\\. \nValid Values: `REQUIRE | OPTIONAL` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TlsPolicy", "type": "string" } }, @@ -162590,6 +167539,8 @@ "additionalProperties": false, "properties": { "OptimizedSharedDelivery": { + "markdownDescription": "Specifies the status of your VDM optimized shared delivery\\. Can be one of the following: \n+ `ENABLED` \u2013 Amazon SES enables optimized shared delivery for the configuration set\\.\n+ `DISABLED` \u2013 Amazon SES disables optimized shared delivery for the configuration set\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OptimizedSharedDelivery", "type": "string" } }, @@ -162602,6 +167553,8 @@ "additionalProperties": false, "properties": { "ReputationMetricsEnabled": { + "markdownDescription": "Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch\\. \nIf the value is `true`, reputation metrics are published\\. If the value is `false`, reputation metrics are not published\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReputationMetricsEnabled", "type": "boolean" } }, @@ -162611,6 +167564,8 @@ "additionalProperties": false, "properties": { "SendingEnabled": { + "markdownDescription": "If `true`, email sending is enabled for the configuration set\\. If `false`, email sending is disabled for the configuration set\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SendingEnabled", "type": "boolean" } }, @@ -162623,6 +167578,8 @@ "items": { "type": "string" }, + "markdownDescription": "A list that contains the reasons that email addresses are automatically added to the suppression list for your account\\. This list can contain any or all of the following: \n+ `COMPLAINT` \u2013 Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint\\.\n+ `BOUNCE` \u2013 Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SuppressedReasons", "type": "array" } }, @@ -162632,6 +167589,8 @@ "additionalProperties": false, "properties": { "CustomRedirectDomain": { + "markdownDescription": "The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomRedirectDomain", "type": "string" } }, @@ -162641,10 +167600,14 @@ "additionalProperties": false, "properties": { "DashboardOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.DashboardOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.DashboardOptions", + "markdownDescription": "Settings for your VDM configuration as applicable to the Dashboard\\. \n*Required*: No \n*Type*: [DashboardOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-dashboardoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DashboardOptions" }, "GuardianOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.GuardianOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.GuardianOptions", + "markdownDescription": "Settings for your VDM configuration as applicable to the Guardian\\. \n*Required*: No \n*Type*: [GuardianOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-guardianoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GuardianOptions" } }, "type": "object" @@ -162745,7 +167708,7 @@ "type": "string" }, "DimensionName": { - "markdownDescription": "The name of an Amazon CloudWatch dimension associated with an email sending metric\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), or dashes \\(\\-\\)\\.\n+ Contain 256 characters or fewer\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of an Amazon CloudWatch dimension associated with an email sending metric\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), dashes \\(\\-\\), or colons \\(:\\)\\.\n+ Contain 256 characters or fewer\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DimensionName", "type": "string" }, @@ -162784,7 +167747,7 @@ "items": { "type": "string" }, - "markdownDescription": "The type of email sending events to publish to the event destination\\. \n+ `send` \\- The call was successful and Amazon SES is attempting to deliver the email\\.\n+ `reject` \\- Amazon SES determined that the email contained a virus and rejected it\\.\n+ `bounce` \\- The recipient's mail server permanently rejected the email\\. This corresponds to a hard bounce\\.\n+ `complaint` \\- The recipient marked the email as spam\\.\n+ `delivery` \\- Amazon SES successfully delivered the email to the recipient's mail server\\.\n+ `open` \\- The recipient received the email and opened it in their email client\\.\n+ `click` \\- The recipient clicked one or more links in the email\\.\n+ `renderingFailure` \\- Amazon SES did not send the email because of a template rendering issue\\.\n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of email sending events to publish to the event destination\\. \n+ `send` \\- The send request was successful and SES will attempt to deliver the message to the recipient\u2019s mail server\\. \\(If account\\-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed\\.\\)\n+ `reject` \\- SES accepted the email, but determined that it contained a virus and didn\u2019t attempt to deliver it to the recipient\u2019s mail server\\.\n+ `bounce` \\- \\(*Hard bounce*\\) The recipient's mail server permanently rejected the email\\. \\(*Soft bounces* are only included when SES fails to deliver the email after retrying for a period of time\\.\\)\n+ `complaint` \\- The email was successfully delivered to the recipient\u2019s mail server, but the recipient marked it as spam\\.\n+ `delivery` \\- SES successfully delivered the email to the recipient's mail server\\.\n+ `open` \\- The recipient received the message and opened it in their email client\\.\n+ `click` \\- The recipient clicked one or more links in the email\\.\n+ `renderingFailure` \\- The email wasn't sent because of a template rendering issue\\. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data\\. \\(This event type only occurs when you send email using the [https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html](https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html) or [https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html](https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html) API operations\\.\\) \n+ `deliveryDelay` \\- The email couldn't be delivered to the recipient\u2019s mail server because a temporary issue occurred\\. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue\\.\n+ `subscription` \\- The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an *unsubscribe* link as part of your [subscription management](https://docs.aws.amazon.com/ses/latest/dg/sending-email-subscription-management.html)\\.\n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MatchingEventTypes", "type": "array" }, @@ -162794,7 +167757,9 @@ "type": "string" }, "SnsDestination": { - "$ref": "#/definitions/AWS::SES::ConfigurationSetEventDestination.SnsDestination" + "$ref": "#/definitions/AWS::SES::ConfigurationSetEventDestination.SnsDestination", + "markdownDescription": "An object that contains the topic ARN associated with an Amazon Simple Notification Service \\(Amazon SNS\\) event destination\\. \n*Required*: No \n*Type*: [SnsDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-snsdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SnsDestination" } }, "required": [ @@ -162826,6 +167791,8 @@ "additionalProperties": false, "properties": { "TopicARN": { + "markdownDescription": "The ARN of the Amazon SNS topic for email sending events\\. You can find the ARN of a topic by using the [ListTopics](https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) Amazon SNS operation\\. \nFor more information about Amazon SNS topics, see the [Amazon SNS Developer Guide](https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TopicARN", "type": "string" } }, @@ -162985,9 +167952,13 @@ "additionalProperties": false, "properties": { "PoolName": { + "markdownDescription": "The name of the dedicated IP pool that the IP address is associated with\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PoolName", "type": "string" }, "ScalingMode": { + "markdownDescription": "The type of scaling mode\\. \nThe following options are available: \n+ `STANDARD` \\- The customer controls which IPs are part of the dedicated IP pool\\.\n+ `MANAGED` \\- The reputation and number of IPs is automatically managed by Amazon SES\\.\nThe `STANDARD` option is selected by default if no value is specified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ScalingMode", "type": "string" } }, @@ -163049,22 +168020,34 @@ "additionalProperties": false, "properties": { "ConfigurationSetAttributes": { - "$ref": "#/definitions/AWS::SES::EmailIdentity.ConfigurationSetAttributes" + "$ref": "#/definitions/AWS::SES::EmailIdentity.ConfigurationSetAttributes", + "markdownDescription": "Used to associate a configuration set with an email identity\\. \n*Required*: No \n*Type*: [ConfigurationSetAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-configurationsetattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConfigurationSetAttributes" }, "DkimAttributes": { - "$ref": "#/definitions/AWS::SES::EmailIdentity.DkimAttributes" + "$ref": "#/definitions/AWS::SES::EmailIdentity.DkimAttributes", + "markdownDescription": "An object that contains information about the DKIM attributes for the identity\\. \n*Required*: No \n*Type*: [DkimAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DkimAttributes" }, "DkimSigningAttributes": { - "$ref": "#/definitions/AWS::SES::EmailIdentity.DkimSigningAttributes" + "$ref": "#/definitions/AWS::SES::EmailIdentity.DkimSigningAttributes", + "markdownDescription": "If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM \\(BYODKIM\\) for DKIM authentication purposes, or, configures the key length to be used for [Easy DKIM](https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html)\\. \n*Required*: No \n*Type*: [DkimSigningAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimsigningattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DkimSigningAttributes" }, "EmailIdentity": { + "markdownDescription": "The email address or domain to verify\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EmailIdentity", "type": "string" }, "FeedbackAttributes": { - "$ref": "#/definitions/AWS::SES::EmailIdentity.FeedbackAttributes" + "$ref": "#/definitions/AWS::SES::EmailIdentity.FeedbackAttributes", + "markdownDescription": "Used to enable or disable feedback forwarding for an identity\\. \n*Required*: No \n*Type*: [FeedbackAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-feedbackattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FeedbackAttributes" }, "MailFromAttributes": { - "$ref": "#/definitions/AWS::SES::EmailIdentity.MailFromAttributes" + "$ref": "#/definitions/AWS::SES::EmailIdentity.MailFromAttributes", + "markdownDescription": "Used to enable or disable the custom Mail\\-From domain configuration for an email identity\\. \n*Required*: No \n*Type*: [MailFromAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-mailfromattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MailFromAttributes" } }, "required": [ @@ -163097,6 +168080,8 @@ "additionalProperties": false, "properties": { "ConfigurationSetName": { + "markdownDescription": "The configuration set to associate with an email identity\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConfigurationSetName", "type": "string" } }, @@ -163106,6 +168091,8 @@ "additionalProperties": false, "properties": { "SigningEnabled": { + "markdownDescription": "Sets the DKIM signing configuration for the identity\\. \n When you set this value `true`, then the messages that are sent from the identity are signed using DKIM\\. If you set this value to `false`, your messages are sent without DKIM signing\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SigningEnabled", "type": "boolean" } }, @@ -163115,12 +168102,18 @@ "additionalProperties": false, "properties": { "DomainSigningPrivateKey": { + "markdownDescription": "\\[Bring Your Own DKIM\\] A private key that's used to generate a DKIM signature\\. \nThe private key must use 1024 or 2048\\-bit RSA encryption, and must be encoded using base64 encoding\\. \nRather than embedding sensitive information directly in your CFN templates, we recommend you use dynamic parameters in the stack template to reference sensitive information that is stored and managed outside of CFN, such as in the AWS Systems Manager Parameter Store or AWS Secrets Manager\\. \nFor more information, see the [Do not embed credentials in your templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html#creds) best practice\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DomainSigningPrivateKey", "type": "string" }, "DomainSigningSelector": { + "markdownDescription": "\\[Bring Your Own DKIM\\] A string that's used to identify a public key in the DNS configuration for a domain\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DomainSigningSelector", "type": "string" }, "NextSigningKeyLength": { + "markdownDescription": "\\[Easy DKIM\\] The key length of the future DKIM key pair to be generated\\. This can be changed at most once per day\\. \nValid Values: `RSA_1024_BIT | RSA_2048_BIT` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NextSigningKeyLength", "type": "string" } }, @@ -163130,6 +168123,8 @@ "additionalProperties": false, "properties": { "EmailForwardingEnabled": { + "markdownDescription": "Sets the feedback forwarding configuration for the identity\\. \n If the value is `true`, you receive email notifications when bounce or complaint events occur\\. These notifications are sent to the address that you specified in the `Return-Path` header of the original email\\. \n You're required to have a method of tracking bounces and complaints\\. If you haven't set up another mechanism for receiving bounce or complaint notifications \\(for example, by setting up an event destination\\), you receive an email notification when these events occur \\(even if this setting is disabled\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EmailForwardingEnabled", "type": "boolean" } }, @@ -163139,9 +168134,13 @@ "additionalProperties": false, "properties": { "BehaviorOnMxFailure": { + "markdownDescription": "The action to take if the required MX record isn't found when you send an email\\. When you set this value to `USE_DEFAULT_VALUE`, the mail is sent using *amazonses\\.com* as the MAIL FROM domain\\. When you set this value to `REJECT_MESSAGE`, the Amazon SES API v2 returns a `MailFromDomainNotVerified` error, and doesn't attempt to deliver the email\\. \nThese behaviors are taken when the custom MAIL FROM domain configuration is in the `Pending`, `Failed`, and `TemporaryFailure` states\\. \nValid Values: `USE_DEFAULT_VALUE | REJECT_MESSAGE` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BehaviorOnMxFailure", "type": "string" }, "MailFromDomain": { + "markdownDescription": "The custom MAIL FROM domain that you want the verified identity to use\\. The MAIL FROM domain must meet the following criteria: \n+ It has to be a subdomain of the verified identity\\.\n+ It can't be used to receive email\\.\n+ It can't be used in a \"From\" address if the MAIL FROM domain is a destination for feedback forwarding emails\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MailFromDomain", "type": "string" } }, @@ -163469,7 +168468,7 @@ "type": "boolean" }, "Name": { - "markdownDescription": "The name of the receipt rule\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), or dashes \\(\\-\\)\\.\n+ Start and end with a letter or number\\.\n+ Contain 64 characters or fewer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the receipt rule\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), dashes \\(\\-\\), or periods \\(\\.\\)\\. \n+ Start and end with a letter or number\\.\n+ Contain 64 characters or fewer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -163487,7 +168486,7 @@ "type": "boolean" }, "TlsPolicy": { - "markdownDescription": "Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security \\(TLS\\)\\. If this parameter is set to `Require`, Amazon SES bounces emails that are not received over TLS\\. The default is `Optional`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Optional | Require` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security \\(TLS\\)\\. If this parameter is set to `Require`, Amazon SES bounces emails that are not received over TLS\\. The default is `Optional`\\. \nValid Values: `Require | Optional` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TlsPolicy", "type": "string" } @@ -163768,10 +168767,14 @@ "additionalProperties": false, "properties": { "DashboardAttributes": { - "$ref": "#/definitions/AWS::SES::VdmAttributes.DashboardAttributes" + "$ref": "#/definitions/AWS::SES::VdmAttributes.DashboardAttributes", + "markdownDescription": "Specifies additional settings for your VDM configuration as applicable to the Dashboard\\. \n*Required*: No \n*Type*: [DashboardAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-vdmattributes-dashboardattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DashboardAttributes" }, "GuardianAttributes": { - "$ref": "#/definitions/AWS::SES::VdmAttributes.GuardianAttributes" + "$ref": "#/definitions/AWS::SES::VdmAttributes.GuardianAttributes", + "markdownDescription": "Specifies additional settings for your VDM configuration as applicable to the Guardian\\. \n*Required*: No \n*Type*: [GuardianAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-vdmattributes-guardianattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GuardianAttributes" } }, "type": "object" @@ -163800,6 +168803,8 @@ "additionalProperties": false, "properties": { "EngagementMetrics": { + "markdownDescription": "Specifies the status of your VDM engagement metrics collection\\. Can be one of the following: \n+ `ENABLED` \u2013 Amazon SES enables engagement metrics for your account\\.\n+ `DISABLED` \u2013 Amazon SES disables engagement metrics for your account\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EngagementMetrics", "type": "string" } }, @@ -163809,6 +168814,8 @@ "additionalProperties": false, "properties": { "OptimizedSharedDelivery": { + "markdownDescription": "Specifies the status of your VDM optimized shared delivery\\. Can be one of the following: \n+ `ENABLED` \u2013 Amazon SES enables optimized shared delivery for your account\\.\n+ `DISABLED` \u2013 Amazon SES disables optimized shared delivery for your account\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OptimizedSharedDelivery", "type": "string" } }, @@ -163865,6 +168872,8 @@ "type": "object" }, "FilterPolicyScope": { + "markdownDescription": "This attribute lets you choose the filtering scope by using one of the following string value types: \n+ `MessageAttributes` \\(default\\) \\- The filter is applied on the message attributes\\.\n+ `MessageBody` \\- The filter is applied on the message body\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FilterPolicyScope", "type": "string" }, "Protocol": { @@ -163973,10 +168982,12 @@ "type": "boolean" }, "DataProtectionPolicy": { + "markdownDescription": "The body of the policy document you want to use for this topic\\. \nYou can only add one policy per topic\\. \nThe policy must be in JSON string format\\. \nLength Constraints: Maximum length of 30,720\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataProtectionPolicy", "type": "object" }, "DisplayName": { - "markdownDescription": "The display name to use for an Amazon SNS topic with SMS subscriptions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The display name to use for an Amazon SNS topic with SMS subscriptions\\. The display name must be maximum 100 characters long, including hyphens \\(\\-\\), underscores \\(\\_\\), spaces, and tabs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DisplayName", "type": "string" }, @@ -163991,13 +169002,15 @@ "type": "string" }, "SignatureVersion": { + "markdownDescription": "The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS\\. By default, `SignatureVersion` is set to `1`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SignatureVersion", "type": "string" }, "Subscription": { "items": { "$ref": "#/definitions/AWS::SNS::Topic.Subscription" }, - "markdownDescription": "The Amazon SNS subscriptions \\(endpoints\\) for this topic\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html) of [Subscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon SNS subscriptions \\(endpoints\\) for this topic\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html) of [Subscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Subscription", "type": "array" }, @@ -164015,6 +169028,8 @@ "type": "string" }, "TracingConfig": { + "markdownDescription": "Tracing mode of an Amazon SNS topic\\. By default `TracingConfig` is set to `PassThrough`, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions\\. If set to Active, SNS will vend X\\-Ray segment data to topic owner account if the sampled flag in the tracing header is true\\. Only supported on standard topics\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TracingConfig", "type": "string" } }, @@ -164044,12 +169059,12 @@ "additionalProperties": false, "properties": { "Endpoint": { - "markdownDescription": "The endpoint that receives notifications from the Amazon SNS topic\\. The endpoint value depends on the protocol that you specify\\. For more information, see the `Endpoint` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The endpoint that receives notifications from the Amazon SNS topic\\. The endpoint value depends on the protocol that you specify\\. For more information, see the `Endpoint` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Endpoint", "type": "string" }, "Protocol": { - "markdownDescription": "The subscription's protocol\\. For more information, see the `Protocol` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The subscription's protocol\\. For more information, see the `Protocol` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Protocol", "type": "string" } @@ -164209,7 +169224,7 @@ "type": "number" }, "KmsMasterKeyId": { - "markdownDescription": "The ID of an AWS managed customer master key \\(CMK\\) for Amazon SQS or a custom CMK\\. To use the AWS managed CMK for Amazon SQS, specify the \\(default\\) alias `alias/aws/sqs`\\. For more information, see the following: \n+ [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Amazon SQS Developer Guide* \n+ [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *Amazon SQS API Reference* \n+ The Customer Master Keys section of the [AWS Key Management Service Best Practices](https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of an AWS Key Management Service \\(KMS\\) for Amazon SQS, or a custom KMS\\. To use the AWS managed KMS for Amazon SQS, specify a \\(default\\) alias ARN, alias name \\(e\\.g\\. `alias/aws/sqs`\\), key ARN, or key ID\\. For more information, see the following: \n+ [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Amazon SQS Developer Guide* \n+ [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *Amazon SQS API Reference* \n+ [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *AWS Key Management Service API Reference* \n+ The Key Management Service \\(KMS\\) section of the [AWS Key Management Service Best Practices](https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KmsMasterKeyId", "type": "string" }, @@ -164244,6 +169259,8 @@ "type": "object" }, "SqsManagedSseEnabled": { + "markdownDescription": "Enables server\\-side queue encryption using SQS owned encryption keys\\. Only one server\\-side encryption option is supported per queue \\(for example, [SSE\\-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE\\-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SqsManagedSseEnabled", "type": "boolean" }, "Tags": { @@ -164442,7 +169459,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The name of the SSM document that contains the configuration information for the instance\\. You can specify `Command` or `Automation` documents\\. The documents can be AWS\\-predefined documents, documents you created, or a document that is shared with you from another account\\. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: \n`arn:partition:ssm:region:account-id:document/document-name` \nFor example: `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document` \nFor AWS\\-predefined documents and SSM documents you created in your account, you only need to specify the document name\\. For example, AWS\\-ApplyPatchBaseline or My\\-Document\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the SSM document that contains the configuration information for the instance\\. You can specify `Command` or `Automation` documents\\. The documents can be AWS\\-predefined documents, documents you created, or a document that is shared with you from another account\\. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: \n`arn:partition:ssm:region:account-id:document/document-name` \nFor example: `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document` \nFor AWS\\-predefined documents and SSM documents you created in your account, you only need to specify the document name\\. For example, `AWS-ApplyPatchBaseline` or `My-Document`\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -164452,7 +169469,7 @@ "title": "OutputLocation" }, "Parameters": { - "markdownDescription": "The parameters for the runtime configuration of the document\\. \n*Required*: No \n*Type*: Map of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The parameters for the runtime configuration of the document\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Parameters", "type": "object" }, @@ -164462,6 +169479,8 @@ "type": "string" }, "ScheduleOffset": { + "markdownDescription": "Number of days to wait after the scheduled day to run an association\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ScheduleOffset", "type": "number" }, "SyncCompliance": { @@ -164553,7 +169572,7 @@ "items": { "type": "string" }, - "markdownDescription": "User\\-defined criteria that maps to `Key`\\. For example, if you specified `tag:ServerRole`, you could specify Value `WebServer` to run a command on instances that include EC2 tags of `ServerRole,WebServer`\\. \nDepending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "User\\-defined criteria that maps to `Key`\\. For example, if you specified `tag:ServerRole`, you could specify `value:WebServer` to run a command on instances that include EC2 tags of `ServerRole,WebServer`\\. \nDepending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -164603,17 +169622,17 @@ "items": { "$ref": "#/definitions/AWS::SSM::Document.AttachmentsSource" }, - "markdownDescription": "A list of key\\-value pairs that describe attachments to a version of a document\\. \n*Required*: No \n*Type*: List of [AttachmentsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of key\\-value pairs that describe attachments to a version of a document\\. \n*Required*: No \n*Type*: List of [AttachmentsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html) \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Attachments", "type": "array" }, "Content": { - "markdownDescription": "The content for the new SSM document in JSON or YAML\\. \nThis parameter also supports `String` data types\\.\n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The content for the new SSM document in JSON or YAML\\. For more information about the schemas for SSM document content, see [SSM document schema features and examples](https://docs.aws.amazon.com/systems-manager/latest/userguide/document-schemas-features.html) in the *AWS Systems Manager User Guide*\\. \nThis parameter also supports `String` data types\\.\n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Content", "type": "object" }, "DocumentFormat": { - "markdownDescription": "Specify the document format for the request\\. JSON is the default format\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `JSON | TEXT | YAML` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specify the document format for the request\\. JSON is the default format\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `JSON | TEXT | YAML` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DocumentFormat", "type": "string" }, @@ -164623,7 +169642,7 @@ "type": "string" }, "Name": { - "markdownDescription": "A name for the SSM document\\. \nYou can't use the following strings as document name prefixes\\. These are reserved by AWS for use as document name prefixes: \n+ `aws-` \n+ `amazon` \n+ `amzn` \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A name for the SSM document\\. \nYou can't use the following strings as document name prefixes\\. These are reserved by AWS for use as document name prefixes: \n+ `aws` \n+ `amazon` \n+ `amzn` \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -164631,7 +169650,7 @@ "items": { "$ref": "#/definitions/AWS::SSM::Document.DocumentRequires" }, - "markdownDescription": "A list of SSM documents required by a document\\. This parameter is used exclusively by AWS AppConfig\\. When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes\\. In this case, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document for validation purposes\\. For more information, see [What is AWS AppConfig?](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the * AWS AppConfig User Guide*\\. \n*Required*: No \n*Type*: List of [DocumentRequires](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of SSM documents required by a document\\. This parameter is used exclusively by AWS AppConfig\\. When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes\\. In this case, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document for validation purposes\\. For more information, see [What is AWS AppConfig?](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the * AWS AppConfig User Guide*\\. \n*Required*: No \n*Type*: List of [DocumentRequires](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Requires", "type": "array" }, @@ -164644,15 +169663,17 @@ "type": "array" }, "TargetType": { - "markdownDescription": "Specify a target type to define the kinds of resources the document can run on\\. For example, to run a document on EC2 instances, specify the following value: `/AWS::EC2::Instance`\\. If you specify a value of '/' the document can run on all types of resources\\. If you don't specify a value, the document can't run on any resources\\. For a list of valid resource types, see [AWS resource and property types reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the *AWS CloudFormation User Guide*\\. \n*Required*: No \n*Type*: String \n*Maximum*: `200` \n*Pattern*: `^\\/[\\w\\.\\-\\:\\/]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specify a target type to define the kinds of resources the document can run on\\. For example, to run a document on EC2 instances, specify the following value: `/AWS::EC2::Instance`\\. If you specify a value of '/' the document can run on all types of resources\\. If you don't specify a value, the document can't run on any resources\\. For a list of valid resource types, see [AWS resource and property types reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the *AWS CloudFormation User Guide*\\. \n*Required*: No \n*Type*: String \n*Maximum*: `200` \n*Pattern*: `^\\/[\\w\\.\\-\\:\\/]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TargetType", "type": "string" }, "UpdateMethod": { + "markdownDescription": "If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced\\. `Replace` is the default method\\. If you specify `NewVersion` for the `UpdateMethod` parameter, and the `Name` of the document does not match an existing resource, a new document is created\\. When you specify `NewVersion`, the default version of the document is changed to the newly created version\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UpdateMethod", "type": "string" }, "VersionName": { - "markdownDescription": "An optional field specifying the version of the artifact you are creating with the document\\. For example, \"Release 12, Update 6\"\\. This value is unique across all versions of a document, and can't be changed\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{1,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An optional field specifying the version of the artifact you are creating with the document\\. For example, `Release12.1`\\. This value is unique across all versions of a document, and can't be changed\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{1,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VersionName", "type": "string" } @@ -164687,12 +169708,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The key of a key\\-value pair that identifies the location of an attachment to a document\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AttachmentReference | S3FileUrl | SourceUrl` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The key of a key\\-value pair that identifies the location of an attachment to a document\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AttachmentReference | S3FileUrl | SourceUrl` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Name": { - "markdownDescription": "The name of the document attachment file\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the document attachment file\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -164711,12 +169732,12 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of the required SSM document\\. The name can be an Amazon Resource Name \\(ARN\\)\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the required SSM document\\. The name can be an Amazon Resource Name \\(ARN\\)\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Version": { - "markdownDescription": "The document version required by the current document\\. \n*Required*: No \n*Type*: String \n*Pattern*: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The document version required by the current document\\. \n*Required*: No \n*Type*: String \n*Pattern*: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -165014,7 +170035,7 @@ }, "LoggingInfo": { "$ref": "#/definitions/AWS::SSM::MaintenanceWindowTask.LoggingInfo", - "markdownDescription": "Information about an Amazon S3 bucket to write task\\-level logs to\\. \n `LoggingInfo` has been deprecated\\. To specify an Amazon S3 bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure\\. For information about how Systems Manager handles these options for the supported maintenance window task types, see [AWS Systems Manager MaintenanceWindowTask TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html)\\.\n*Required*: No \n*Type*: [LoggingInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Information about an Amazon S3 bucket to write Run Command task\\-level logs to\\. \n `LoggingInfo` has been deprecated\\. To specify an Amazon S3 bucket to contain logs for Run Command tasks, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure\\. For information about how Systems Manager handles these options for the supported maintenance window task types, see [AWS::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html)\\.\n*Required*: No \n*Type*: [LoggingInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoggingInfo" }, "MaxConcurrency": { @@ -165130,7 +170151,7 @@ "type": "string" }, "S3Bucket": { - "markdownDescription": "The name of an S3 bucket where execution logs are stored \\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of an S3 bucket where execution logs are stored\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3Bucket", "type": "string" }, @@ -165518,7 +170539,7 @@ "type": "string" }, "OperatingSystem": { - "markdownDescription": "Defines the operating system the patch baseline applies to\\. The default value is `WINDOWS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AMAZON_LINUX | AMAZON_LINUX_2 | CENTOS | DEBIAN | MACOS | ORACLE_LINUX | RASPBIAN | REDHAT_ENTERPRISE_LINUX | SUSE | UBUNTU | WINDOWS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Defines the operating system the patch baseline applies to\\. The default value is `WINDOWS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | CENTOS | DEBIAN | MACOS | ORACLE_LINUX | RASPBIAN | REDHAT_ENTERPRISE_LINUX | ROCKY_LINUX | SUSE | UBUNTU | WINDOWS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "OperatingSystem", "type": "string" }, @@ -165927,9 +170948,13 @@ "additionalProperties": false, "properties": { "Policy": { + "markdownDescription": "A policy you want to associate with a resource\\. \n*Required*: Yes \n*Type*: Json \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Policy", "type": "object" }, "ResourceArn": { + "markdownDescription": "Amazon Resource Name \\(ARN\\) of the resource to which you want to attach a policy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceArn", "type": "string" } }, @@ -166268,6 +171293,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags to add to the replication set\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -166384,7 +171411,7 @@ "items": { "type": "string" }, - "markdownDescription": "The contacts and escalation plans that the response plan engages during an incident\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the contacts and escalation plans that the response plan engages during an incident\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Engagements", "type": "array" }, @@ -166397,6 +171424,8 @@ "items": { "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.Integration" }, + "markdownDescription": "Information about third\\-party services integrated into the response plan\\. \n*Required*: No \n*Type*: List of [Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-integration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Integrations", "type": "array" }, "Name": { @@ -166469,10 +171498,14 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The key parameter to use when running the Systems Manager Automation runbook\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { - "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.DynamicSsmParameterValue" + "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.DynamicSsmParameterValue", + "markdownDescription": "The dynamic parameter value\\. \n*Required*: Yes \n*Type*: [DynamicSsmParameterValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparametervalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value" } }, "required": [ @@ -166485,6 +171518,8 @@ "additionalProperties": false, "properties": { "Variable": { + "markdownDescription": "Variable dynamic parameters\\. A parameter value is determined when an incident is created\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `INCIDENT_RECORD_ARN | INVOLVED_RESOURCES` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Variable", "type": "string" } }, @@ -166507,6 +171542,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Tags to assign to the template\\. When the `StartIncident` API action is called, Incident Manager assigns the tags specified in the template to the incident\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncidentTags", "type": "array" }, "NotificationTargets": { @@ -166538,7 +171575,9 @@ "additionalProperties": false, "properties": { "PagerDutyConfiguration": { - "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.PagerDutyConfiguration" + "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.PagerDutyConfiguration", + "markdownDescription": "Information about the PagerDuty service where the response plan creates an incident\\. \n*Required*: Yes \n*Type*: [PagerDutyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PagerDutyConfiguration" } }, "required": [ @@ -166561,12 +171600,18 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the PagerDuty configuration\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "PagerDutyIncidentConfiguration": { - "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.PagerDutyIncidentConfiguration" + "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.PagerDutyIncidentConfiguration", + "markdownDescription": "Details about the PagerDuty service associated with the configuration\\. \n*Required*: Yes \n*Type*: [PagerDutyIncidentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyincidentconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PagerDutyIncidentConfiguration" }, "SecretId": { + "markdownDescription": "The ID of the AWS Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecretId", "type": "string" } }, @@ -166581,6 +171626,8 @@ "additionalProperties": false, "properties": { "ServiceId": { + "markdownDescription": "The ID of the PagerDuty service that the response plan associates with an incident when it launches\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceId", "type": "string" } }, @@ -166606,6 +171653,8 @@ "items": { "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.DynamicSsmParameter" }, + "markdownDescription": "The key\\-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook\\. \n*Required*: No \n*Type*: List of [DynamicSsmParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DynamicParameters", "type": "array" }, "Parameters": { @@ -166692,7 +171741,7 @@ "additionalProperties": false, "properties": { "InstanceArn": { - "markdownDescription": "The ARN of the SSO instance under which the operation will be executed\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the IAM Identity Center instance under which the operation will be executed\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceArn", "type": "string" }, @@ -166702,7 +171751,7 @@ "type": "string" }, "PrincipalId": { - "markdownDescription": "An identifier for an object in AWS SSO, such as a user or group\\. PrincipalIds are GUIDs \\(For example, f81d4fae\\-7dec\\-11d0\\-a765\\-00a0c91e6bf6\\)\\. For more information about PrincipalIds in AWS SSO, see the [AWS SSO Identity Store API Reference](/singlesignon/latest/IdentityStoreAPIReference/welcome.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `47` \n*Pattern*: `^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An identifier for an object in IAM Identity Center, such as a user or group\\. PrincipalIds are GUIDs \\(For example, f81d4fae\\-7dec\\-11d0\\-a765\\-00a0c91e6bf6\\)\\. For more information about PrincipalIds in IAM Identity Center, see the [IAM Identity Center Identity Store API Reference](/singlesignon/latest/IdentityStoreAPIReference/welcome.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `47` \n*Pattern*: `^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PrincipalId", "type": "string" }, @@ -166792,12 +171841,12 @@ "items": { "$ref": "#/definitions/AWS::SSO::InstanceAccessControlAttributeConfiguration.AccessControlAttribute" }, - "markdownDescription": "Lists the attributes that are configured for ABAC in the specified AWS SSO instance\\. \n*Required*: No \n*Type*: List of [AccessControlAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Lists the attributes that are configured for ABAC in the specified IAM Identity Center instance\\. \n*Required*: No \n*Type*: List of [AccessControlAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessControlAttributes", "type": "array" }, "InstanceArn": { - "markdownDescription": "The ARN of the AWS SSO instance under which the operation will be executed\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the IAM Identity Center instance under which the operation will be executed\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceArn", "type": "string" } @@ -166832,7 +171881,7 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The name of the attribute associated with your identities in your identity source\\. This is used to map a specified attribute in your identity source with an attribute in AWS SSO\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the attribute associated with your identities in your identity source\\. This is used to map a specified attribute in your identity source with an attribute in IAM Identity Center\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, @@ -166855,7 +171904,7 @@ "items": { "type": "string" }, - "markdownDescription": "The identity source to use when mapping a specified attribute to AWS SSO\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identity source to use when mapping a specified attribute to IAM Identity Center\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Source", "type": "array" } @@ -166904,20 +171953,22 @@ "items": { "$ref": "#/definitions/AWS::SSO::PermissionSet.CustomerManagedPolicyReference" }, + "markdownDescription": "Specifies the names and paths of the customer managed policies that you have attached to your permission set\\. \n*Required*: No \n*Type*: List of [CustomerManagedPolicyReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-customermanagedpolicyreference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomerManagedPolicyReferences", "type": "array" }, "Description": { - "markdownDescription": "The description of the [AWS::SSO::PermissionSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-resource-sso-permissionset.html#aws-resource-sso-permissionset)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `700` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A0-\\u00FF]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the [AWS::SSO::PermissionSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-resource-sso-permissionset.html#aws-resource-sso-permissionset)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `700` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "InlinePolicy": { - "markdownDescription": "The IAM inline policy that is attached to the permission set\\. \n*Required*: No \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `10240` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The inline policy that is attached to the permission set\\. \nFor `Length Constraints`, if a valid ARN is provided for a permission set, it is possible for an empty inline policy to be returned\\.\n*Required*: No \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `10240` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InlinePolicy", "type": "object" }, "InstanceArn": { - "markdownDescription": "The ARN of the SSO instance under which the operation will be executed\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the IAM Identity Center instance under which the operation will be executed\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceArn", "type": "string" }, @@ -166925,7 +171976,7 @@ "items": { "type": "string" }, - "markdownDescription": "A structure that stores the details of the IAM managed policy\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A structure that stores the details of the AWS managed policy\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ManagedPolicies", "type": "array" }, @@ -166935,7 +171986,9 @@ "type": "string" }, "PermissionsBoundary": { - "$ref": "#/definitions/AWS::SSO::PermissionSet.PermissionsBoundary" + "$ref": "#/definitions/AWS::SSO::PermissionSet.PermissionsBoundary", + "markdownDescription": "Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary\\. Specify either `CustomerManagedPolicyReference` to use the name and path of a customer managed policy, or `ManagedPolicyArn` to use the ARN of an AWS managed policy\\. A permissions boundary represents the maximum permissions that any policy can grant your role\\. For more information, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*\\. \nPolicies used as permissions boundaries don't provide permissions\\. You must also attach an IAM policy to the role\\. To learn how the effective permissions for a role are evaluated, see [IAM JSON policy evaluation logic](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) in the *IAM User Guide*\\.\n*Required*: No \n*Type*: [PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-permissionsboundary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PermissionsBoundary" }, "RelayStateType": { "markdownDescription": "Used to redirect users within the application during the federation authentication process\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `240` \n*Pattern*: `[a-zA-Z0-9&$@#\\\\\\/%?=~\\-_'\"|!:,.;*+\\[\\]\\ \\(\\)\\{\\}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -166987,9 +172040,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the IAM policy that you have configured in each account where you want to deploy your permission set\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\w+=,.@-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Path": { + "markdownDescription": "The path to the IAM policy that you have configured in each account where you want to deploy your permission set\\. The default is `/`\\. 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*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `((/[A-Za-z0-9\\.,\\+@=_-]+)*)/` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Path", "type": "string" } }, @@ -167002,9 +172059,13 @@ "additionalProperties": false, "properties": { "CustomerManagedPolicyReference": { - "$ref": "#/definitions/AWS::SSO::PermissionSet.CustomerManagedPolicyReference" + "$ref": "#/definitions/AWS::SSO::PermissionSet.CustomerManagedPolicyReference", + "markdownDescription": "Specifies the name and path of a customer managed policy\\. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set\\. \n*Required*: No \n*Type*: [CustomerManagedPolicyReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-customermanagedpolicyreference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomerManagedPolicyReference" }, "ManagedPolicyArn": { + "markdownDescription": "The AWS managed policy ARN that you want to attach to a permission set as a permissions boundary\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::aws:policy/[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManagedPolicyArn", "type": "string" } }, @@ -167051,7 +172112,7 @@ "type": "string" }, "AppType": { - "markdownDescription": "The type of app\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of app\\. \n*Allowed Values*: `JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard | Canvas` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AppType", "type": "string" }, @@ -167062,7 +172123,7 @@ }, "ResourceSpec": { "$ref": "#/definitions/AWS::SageMaker::App.ResourceSpec", - "markdownDescription": "Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on\\. \n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on\\. \n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceSpec" }, "Tags": { @@ -167112,7 +172173,7 @@ "additionalProperties": false, "properties": { "InstanceType": { - "markdownDescription": "The instance type that the image version runs on\\. \nJupyterServer Apps only support the `system` value\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3dn.24xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.large | ml.r5.xlarge | ml.t3.2xlarge | ml.t3.large | ml.t3.medium | ml.t3.micro | ml.t3.small | ml.t3.xlarge | system` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The instance type that the image version runs on\\. \n **JupyterServer apps** only support the `system` value\\. \nFor **KernelGateway apps**, the `system` value is translated to `ml.t3.medium`\\. KernelGateway apps also support all other values for available instance types\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.2xlarge | ml.g5.48xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3dn.24xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.large | ml.r5.xlarge | ml.t3.2xlarge | ml.t3.large | ml.t3.medium | ml.t3.micro | ml.t3.small | ml.t3.xlarge | system` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InstanceType", "type": "string" }, @@ -167431,6 +172492,8 @@ "title": "DataQualityJobOutputConfig" }, "EndpointName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndpointName", "type": "string" }, "JobDefinitionName": { @@ -167501,18 +172564,28 @@ "additionalProperties": false, "properties": { "DataCapturedDestinationS3Uri": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataCapturedDestinationS3Uri", "type": "string" }, "DatasetFormat": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.DatasetFormat" + "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.DatasetFormat", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [DatasetFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-datasetformat.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatasetFormat" }, "LocalPath": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LocalPath", "type": "string" }, "S3DataDistributionType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3DataDistributionType", "type": "string" }, "S3InputMode": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3InputMode", "type": "string" } }, @@ -167532,7 +172605,7 @@ "type": "number" }, "InstanceType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ML compute instance type for the processing job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, @@ -167569,6 +172642,8 @@ "additionalProperties": false, "properties": { "Header": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Header", "type": "boolean" } }, @@ -167650,11 +172725,13 @@ "additionalProperties": false, "properties": { "BatchTransformInput": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.BatchTransformInput" + "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.BatchTransformInput", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [BatchTransformInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BatchTransformInput" }, "EndpointInput": { "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.EndpointInput", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Input object for the endpoint \n*Required*: No \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EndpointInput" } }, @@ -167664,12 +172741,18 @@ "additionalProperties": false, "properties": { "Csv": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.Csv" + "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.Csv", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Csv](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-csv.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Csv" }, "Json": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.Json" + "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.Json", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-json.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Json" }, "Parquet": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Parquet", "type": "boolean" } }, @@ -167709,6 +172792,8 @@ "additionalProperties": false, "properties": { "Line": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Line", "type": "boolean" } }, @@ -167825,7 +172910,7 @@ "additionalProperties": false, "properties": { "MaxRuntimeInSeconds": { - "markdownDescription": "The maximum length of time, in seconds, that a training or compilation job can run\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum length of time, in seconds, that a training or compilation job can run before it is stopped\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \nThe maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaxRuntimeInSeconds", "type": "number" } @@ -167902,7 +172987,7 @@ "title": "Device" }, "DeviceFleetName": { - "markdownDescription": "The name of the fleet the device belongs to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the fleet the device belongs to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeviceFleetName", "type": "string" }, @@ -167950,7 +173035,7 @@ "type": "string" }, "DeviceName": { - "markdownDescription": "The name of the device\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the device\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DeviceName", "type": "string" }, @@ -168117,15 +173202,19 @@ "type": "string" }, "AppSecurityGroupManagement": { + "markdownDescription": "The entity that creates and manages the required security groups for inter\\-app communication in `VpcOnly` mode\\. Required when `CreateDomain.AppNetworkAccessType` is `VpcOnly` and `DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn` is provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppSecurityGroupManagement", "type": "string" }, "AuthMode": { - "markdownDescription": "The mode of authentication that members use to access the domain\\. \n*Valid Values*: `SSO | IAM` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The mode of authentication that members use to access the Domain\\. \n*Valid Values*: `SSO | IAM` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AuthMode", "type": "string" }, "DefaultSpaceSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.DefaultSpaceSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.DefaultSpaceSettings", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DefaultSpaceSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultSpaceSettings" }, "DefaultUserSettings": { "$ref": "#/definitions/AWS::SageMaker::Domain.UserSettings", @@ -168138,10 +173227,12 @@ "type": "string" }, "DomainSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.DomainSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.DomainSettings", + "markdownDescription": "A collection of settings that apply to the `SageMaker Domain`\\. These settings are specified through the `CreateDomain` API call\\. \n*Required*: No \n*Type*: [DomainSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DomainSettings" }, "KmsKeyId": { - "markdownDescription": "SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed customer master key \\(CMK\\) by default\\. For more control, specify a customer managed CMK\\. \n*Length Constraints*: Maximum length of 2048\\. \n*Pattern*: `.*` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key \\(CMK\\) by default\\. For more control, specify a customer managed CMK\\. \n*Length Constraints*: Maximum length of 2048\\. \n*Pattern*: `.*` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" }, @@ -168157,12 +173248,12 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to associated with the Domain\\. Each tag consists of a key and an optional value\\. Tag keys must be unique per resource\\. Tags are searchable using the Search API\\. \nTags that you specify for the Domain are also added to all Apps that are launched in the Domain\\. \n*Array members*: Minimum number of 0 items\\. Maximum number of 50 items\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Tags to associated with the Domain\\. Each tag consists of a key and an optional value\\. Tag keys must be unique per resource\\. Tags are searchable using the Search API\\. \nTags that you specify for the Domain are also added to all apps that are launched in the Domain\\. \n*Array members*: Minimum number of 0 items\\. Maximum number of 50 items\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Tags", "type": "array" }, "VpcId": { - "markdownDescription": "The ID of the Amazon Virtual Private Cloud \\(VPC\\) that Studio uses for communication\\. \n*Length Constraints*: Maximum length of 32\\. \n*Pattern*: `[-0-9a-zA-Z]+` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the Amazon Virtual Private Cloud \\(Amazon VPC\\) that Studio uses for communication\\. \n*Length Constraints*: Maximum length of 32\\. \n*Pattern*: `[-0-9a-zA-Z]+` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VpcId", "type": "string" } @@ -168226,18 +173317,26 @@ "additionalProperties": false, "properties": { "ExecutionRole": { + "markdownDescription": "The execution role for the space\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExecutionRole", "type": "string" }, "JupyterServerAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.JupyterServerAppSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.JupyterServerAppSettings", + "markdownDescription": "The JupyterServer app settings\\. \n*Required*: No \n*Type*: [JupyterServerAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterserverappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "JupyterServerAppSettings" }, "KernelGatewayAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.KernelGatewayAppSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.KernelGatewayAppSettings", + "markdownDescription": "The KernelGateway app settings\\. \n*Required*: No \n*Type*: [KernelGatewayAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-kernelgatewayappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KernelGatewayAppSettings" }, "SecurityGroups": { "items": { "type": "string" }, + "markdownDescription": "The security groups for the Amazon Virtual Private Cloud that the space uses for communication\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroups", "type": "array" } }, @@ -168247,12 +173346,16 @@ "additionalProperties": false, "properties": { "RStudioServerProDomainSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.RStudioServerProDomainSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.RStudioServerProDomainSettings", + "markdownDescription": "A collection of settings that configure the `RStudioServerPro` Domain\\-level app\\. \n*Required*: No \n*Type*: [RStudioServerProDomainSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RStudioServerProDomainSettings" }, "SecurityGroupIds": { "items": { "type": "string" }, + "markdownDescription": "The security groups for the Amazon Virtual Private Cloud that the `Domain` uses for communication between Domain\\-level apps and user apps\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroupIds", "type": "array" } }, @@ -168295,10 +173398,14 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::Domain.CustomImage" }, + "markdownDescription": "A list of custom SageMaker images that are configured to run as a RSession app\\. \n*Required*: No \n*Type*: List of [CustomImage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customimage.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomImages", "type": "array" }, "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec" + "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec", + "markdownDescription": "Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on\\. \n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultResourceSpec" } }, "type": "object" @@ -168307,9 +173414,13 @@ "additionalProperties": false, "properties": { "AccessStatus": { + "markdownDescription": "Indicates whether the current user has access to the `RStudioServerPro` app\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessStatus", "type": "string" }, "UserGroup": { + "markdownDescription": "The level of permissions that the user has within the `RStudioServerPro` app\\. This value defaults to `User`\\. The `Admin` value allows the user access to the RStudio Administrative Dashboard\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `R_STUDIO_ADMIN | R_STUDIO_USER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserGroup", "type": "string" } }, @@ -168319,15 +173430,23 @@ "additionalProperties": false, "properties": { "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec" + "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec", + "markdownDescription": "A collection that defines the default `InstanceType`, `SageMakerImageArn`, and `SageMakerImageVersionArn` for the Domain\\. \n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DefaultResourceSpec" }, "DomainExecutionRoleArn": { + "markdownDescription": "The ARN of the execution role for the `RStudioServerPro` Domain\\-level app\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DomainExecutionRoleArn", "type": "string" }, "RStudioConnectUrl": { + "markdownDescription": "A URL pointing to an RStudio Connect server\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RStudioConnectUrl", "type": "string" }, "RStudioPackageManagerUrl": { + "markdownDescription": "A URL pointing to an RStudio Package Manager server\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RStudioPackageManagerUrl", "type": "string" } }, @@ -168340,20 +173459,22 @@ "additionalProperties": false, "properties": { "InstanceType": { - "markdownDescription": "The instance type that the image version runs on\\. \nJupyterServer Apps only support the `system` value\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3dn.24xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.large | ml.r5.xlarge | ml.t3.2xlarge | ml.t3.large | ml.t3.medium | ml.t3.micro | ml.t3.small | ml.t3.xlarge | system` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The instance type that the image version runs on\\. \n **JupyterServer apps** only support the `system` value\\. \nFor **KernelGateway apps**, the `system` value is translated to `ml.t3.medium`\\. KernelGateway apps also support all other values for available instance types\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.2xlarge | ml.g5.48xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3dn.24xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.large | ml.r5.xlarge | ml.t3.2xlarge | ml.t3.large | ml.t3.medium | ml.t3.micro | ml.t3.small | ml.t3.xlarge | system` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "InstanceType", "type": "string" }, "LifecycleConfigArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Lifecycle Configuration attached to the Resource\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "LifecycleConfigArn", "type": "string" }, "SageMakerImageArn": { - "markdownDescription": "The ARN of the SageMaker image that the image version belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN of the SageMaker image that the image version belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "SageMakerImageArn", "type": "string" }, "SageMakerImageVersionArn": { - "markdownDescription": "The ARN of the image version created on the instance\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN of the image version created on the instance\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "SageMakerImageVersionArn", "type": "string" } @@ -168400,10 +173521,14 @@ "title": "KernelGatewayAppSettings" }, "RSessionAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.RSessionAppSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.RSessionAppSettings", + "markdownDescription": "A collection of settings that configure the `RSessionGateway` app\\. \n*Required*: No \n*Type*: [RSessionAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rsessionappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RSessionAppSettings" }, "RStudioServerProAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.RStudioServerProAppSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.RStudioServerProAppSettings", + "markdownDescription": "A collection of settings that configure user interaction with the `RStudioServerPro` app\\. \n*Required*: No \n*Type*: [RStudioServerProAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverproappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RStudioServerProAppSettings" }, "SecurityGroups": { "items": { @@ -168709,7 +173834,9 @@ "type": "string" }, "ExplainerConfig": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ExplainerConfig" + "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ExplainerConfig", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ExplainerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-explainerconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExplainerConfig" }, "KmsKeyId": { "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint\\. \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`\nThe KMS key policy must grant permission to the IAM role that you specify in your `CreateEndpoint`, `UpdateEndpoint` requests\\. For more information, refer to the AWS Key Management Service section [Using Key Policies in AWS KMS ](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) \nCertain 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 `KmsKeyId` when using an instance type with local storage\\. If any of the models that you specify in the `ProductionVariants` parameter use nitro\\-based instances with local storage, do not specify a value for the `KmsKeyId` parameter\\. If you specify a value for `KmsKeyId` when using any nitro\\-based instances with local storage, the call to `CreateEndpointConfig` fails\\. \nFor 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)\\. \nFor 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*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -168728,6 +173855,8 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ProductionVariant" }, + "markdownDescription": "Array of `ProductionVariant` objects\\. There is one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on `ProductionVariants`\\. If you use this field, you can only specify one variant for `ProductionVariants` and one variant for `ShadowProductionVariants`\\. \n*Required*: No \n*Type*: List of [ProductionVariant](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html) \n*Maximum*: `10` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ShadowProductionVariants", "type": "array" }, "Tags": { @@ -168875,13 +174004,19 @@ "additionalProperties": false, "properties": { "EnableExplanations": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EnableExplanations", "type": "string" }, "InferenceConfig": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyInferenceConfig" + "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyInferenceConfig", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ClarifyInferenceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InferenceConfig" }, "ShapConfig": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyShapConfig" + "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyShapConfig", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [ClarifyShapConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ShapConfig" } }, "required": [ @@ -168903,45 +174038,67 @@ "additionalProperties": false, "properties": { "ContentTemplate": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContentTemplate", "type": "string" }, "FeatureHeaders": { "items": { "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyHeader" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ClarifyHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyheader.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FeatureHeaders", "type": "array" }, "FeatureTypes": { "items": { "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyFeatureType" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ClarifyFeatureType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyfeaturetype.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FeatureTypes", "type": "array" }, "FeaturesAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FeaturesAttribute", "type": "string" }, "LabelAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LabelAttribute", "type": "string" }, "LabelHeaders": { "items": { "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyHeader" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ClarifyHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyheader.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LabelHeaders", "type": "array" }, "LabelIndex": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LabelIndex", "type": "number" }, "MaxPayloadInMB": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaxPayloadInMB", "type": "number" }, "MaxRecordCount": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaxRecordCount", "type": "number" }, "ProbabilityAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProbabilityAttribute", "type": "string" }, "ProbabilityIndex": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProbabilityIndex", "type": "number" } }, @@ -168951,12 +174108,18 @@ "additionalProperties": false, "properties": { "MimeType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MimeType", "type": "string" }, "ShapBaseline": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ShapBaseline", "type": "string" }, "ShapBaselineUri": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ShapBaselineUri", "type": "string" } }, @@ -168966,18 +174129,28 @@ "additionalProperties": false, "properties": { "NumberOfSamples": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NumberOfSamples", "type": "number" }, "Seed": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Seed", "type": "number" }, "ShapBaselineConfig": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyShapBaselineConfig" + "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyShapBaselineConfig", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [ClarifyShapBaselineConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ShapBaselineConfig" }, "TextConfig": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyTextConfig" + "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyTextConfig", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ClarifyTextConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifytextconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TextConfig" }, "UseLogit": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "UseLogit", "type": "boolean" } }, @@ -168990,9 +174163,13 @@ "additionalProperties": false, "properties": { "Granularity": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Granularity", "type": "string" }, "Language": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Language", "type": "string" } }, @@ -169050,7 +174227,9 @@ "additionalProperties": false, "properties": { "ClarifyExplainerConfig": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyExplainerConfig" + "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyExplainerConfig", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ClarifyExplainerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyexplainerconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ClarifyExplainerConfig" } }, "type": "object" @@ -169064,6 +174243,8 @@ "type": "string" }, "ContainerStartupHealthCheckTimeoutInSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContainerStartupHealthCheckTimeoutInSeconds", "type": "number" }, "InitialInstanceCount": { @@ -169077,11 +174258,13 @@ "type": "number" }, "InstanceType": { - "markdownDescription": "The ML compute instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.c4.large | ml.c4.xlarge | ml.c5.18xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.c5d.18xlarge | ml.c5d.2xlarge | ml.c5d.4xlarge | ml.c5d.9xlarge | ml.c5d.large | ml.c5d.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.inf1.24xlarge | ml.inf1.2xlarge | ml.inf1.6xlarge | ml.inf1.xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p2.16xlarge | ml.p2.8xlarge | ml.p2.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.r5.12xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.large | ml.r5.xlarge | ml.r5d.12xlarge | ml.r5d.24xlarge | ml.r5d.2xlarge | ml.r5d.4xlarge | ml.r5d.large | ml.r5d.xlarge | ml.t2.2xlarge | ml.t2.large | ml.t2.medium | ml.t2.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ML compute instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.c4.large | ml.c4.xlarge | ml.c5.18xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.c5d.18xlarge | ml.c5d.2xlarge | ml.c5d.4xlarge | ml.c5d.9xlarge | ml.c5d.large | ml.c5d.xlarge | ml.c6g.12xlarge | ml.c6g.16xlarge | ml.c6g.2xlarge | ml.c6g.4xlarge | ml.c6g.8xlarge | ml.c6g.large | ml.c6g.xlarge | ml.c6gd.12xlarge | ml.c6gd.16xlarge | ml.c6gd.2xlarge | ml.c6gd.4xlarge | ml.c6gd.8xlarge | ml.c6gd.large | ml.c6gd.xlarge | ml.c6gn.12xlarge | ml.c6gn.16xlarge | ml.c6gn.2xlarge | ml.c6gn.4xlarge | ml.c6gn.8xlarge | ml.c6gn.large | ml.c6gn.xlarge | ml.c6i.12xlarge | ml.c6i.16xlarge | ml.c6i.24xlarge | ml.c6i.2xlarge | ml.c6i.32xlarge | ml.c6i.4xlarge | ml.c6i.8xlarge | ml.c6i.large | ml.c6i.xlarge | ml.c7g.12xlarge | ml.c7g.16xlarge | ml.c7g.2xlarge | ml.c7g.4xlarge | ml.c7g.8xlarge | ml.c7g.large | ml.c7g.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.2xlarge | ml.g5.48xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.xlarge | ml.inf1.24xlarge | ml.inf1.2xlarge | ml.inf1.6xlarge | ml.inf1.xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.large | ml.m5d.xlarge | ml.m6g.12xlarge | ml.m6g.16xlarge | ml.m6g.2xlarge | ml.m6g.4xlarge | ml.m6g.8xlarge | ml.m6g.large | ml.m6g.xlarge | ml.m6gd.12xlarge | ml.m6gd.16xlarge | ml.m6gd.2xlarge | ml.m6gd.4xlarge | ml.m6gd.8xlarge | ml.m6gd.large | ml.m6gd.xlarge | ml.p2.16xlarge | ml.p2.8xlarge | ml.p2.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p4d.24xlarge | ml.p4de.24xlarge | ml.r5.12xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.large | ml.r5.xlarge | ml.r5d.12xlarge | ml.r5d.24xlarge | ml.r5d.2xlarge | ml.r5d.4xlarge | ml.r5d.large | ml.r5d.xlarge | ml.r6g.12xlarge | ml.r6g.16xlarge | ml.r6g.2xlarge | ml.r6g.4xlarge | ml.r6g.8xlarge | ml.r6g.large | ml.r6g.xlarge | ml.r6gd.12xlarge | ml.r6gd.16xlarge | ml.r6gd.2xlarge | ml.r6gd.4xlarge | ml.r6gd.8xlarge | ml.r6gd.large | ml.r6gd.xlarge | ml.t2.2xlarge | ml.t2.large | ml.t2.medium | ml.t2.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, "ModelDataDownloadTimeoutInSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelDataDownloadTimeoutInSeconds", "type": "number" }, "ModelName": { @@ -169091,7 +174274,7 @@ }, "ServerlessConfig": { "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ServerlessConfig", - "markdownDescription": "The serverless configuration for an endpoint\\. Specifies a serverless endpoint configuration instead of an instance\\-based endpoint configuration\\. \nServerless Inference is in preview release for Amazon SageMaker and is subject to change\\. We do not recommend using this feature in production environments\\.\n*Required*: No \n*Type*: [ServerlessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-serverlessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The serverless configuration for an endpoint\\. Specifies a serverless endpoint configuration instead of an instance\\-based endpoint configuration\\. \n*Required*: No \n*Type*: [ServerlessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-serverlessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServerlessConfig" }, "VariantName": { @@ -169100,6 +174283,8 @@ "type": "string" }, "VolumeSizeInGB": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VolumeSizeInGB", "type": "number" } }, @@ -169114,7 +174299,7 @@ "additionalProperties": false, "properties": { "MaxConcurrency": { - "markdownDescription": "The maximum number of concurrent invocations your serverless endpoint can process\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum number of concurrent invocations your serverless endpoint can process\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `200` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaxConcurrency", "type": "number" }, @@ -169179,7 +174364,7 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.FeatureDefinition" }, - "markdownDescription": "A list of `Feature`s\\. Each `Feature` must include a `FeatureName` and a `FeatureType`\\. \nValid `FeatureType`s are `Integral`, `Fractional` and `String`\\. \n `FeatureName`s cannot be any of the following: `is_deleted`, `write_time`, `api_invocation_time`\\. \nYou can create up to 2,500 `FeatureDefinition`s per `FeatureGroup`\\. \n*Required*: Yes \n*Type*: List of [FeatureDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html) \n*Maximum*: `2500` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of `Feature`s\\. Each `Feature` must include a `FeatureName` and a `FeatureType`\\. \nValid `FeatureType`s are `Integral`, `Fractional` and `String`\\. \n `FeatureName`s cannot be any of the following: `is_deleted`, `write_time`, `api_invocation_time`\\. \nYou can create up to 2,500 `FeatureDefinition`s per `FeatureGroup`\\. \n*Required*: Yes \n*Type*: List of [FeatureDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html) \n*Maximum*: `2500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FeatureDefinitions", "type": "array" }, @@ -169190,12 +174375,12 @@ }, "OfflineStoreConfig": { "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.OfflineStoreConfig", - "markdownDescription": "The configuration of an `OfflineStore`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The configuration of an `OfflineStore`\\. \n*Required*: No \n*Type*: [OfflineStoreConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "OfflineStoreConfig" }, "OnlineStoreConfig": { "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.OnlineStoreConfig", - "markdownDescription": "The configuration of an `OnlineStore`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The configuration of an `OnlineStore`\\. \n*Required*: No \n*Type*: [OnlineStoreConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "OnlineStoreConfig" }, "RecordIdentifierFeatureName": { @@ -169250,12 +174435,18 @@ "additionalProperties": false, "properties": { "Catalog": { + "markdownDescription": "The name of the Glue table catalog\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Catalog", "type": "string" }, "Database": { + "markdownDescription": "The name of the Glue table database\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Database", "type": "string" }, "TableName": { + "markdownDescription": "The name of the Glue table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableName", "type": "string" } }, @@ -169270,12 +174461,12 @@ "additionalProperties": false, "properties": { "FeatureName": { - "markdownDescription": "The name of a feature\\. The type must be a string\\. `FeatureName` cannot be any of the following: `is_deleted`, `write_time`, `api_invocation_time`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of a feature\\. The type must be a string\\. `FeatureName` cannot be any of the following: `is_deleted`, `write_time`, `api_invocation_time`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FeatureName", "type": "string" }, "FeatureType": { - "markdownDescription": "The value type of a feature\\. Valid values are Integral, Fractional, or String\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Fractional | Integral | String` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The value type of a feature\\. Valid values are Integral, Fractional, or String\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Fractional | Integral | String` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FeatureType", "type": "string" } @@ -169290,15 +174481,23 @@ "additionalProperties": false, "properties": { "DataCatalogConfig": { - "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.DataCatalogConfig" + "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.DataCatalogConfig", + "markdownDescription": "The meta data of the Glue table that is autogenerated when an `OfflineStore` is created\\. \n*Required*: No \n*Type*: [DataCatalogConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataCatalogConfig" }, "DisableGlueTableCreation": { + "markdownDescription": "Set to `True` to disable the automatic creation of an AWS Glue table when configuring an `OfflineStore`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DisableGlueTableCreation", "type": "boolean" }, "S3StorageConfig": { - "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.S3StorageConfig" + "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.S3StorageConfig", + "markdownDescription": "The Amazon Simple Storage \\(Amazon S3\\) location of `OfflineStore`\\. \n*Required*: Yes \n*Type*: [S3StorageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-s3storageconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3StorageConfig" }, "TableFormat": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableFormat", "type": "string" } }, @@ -169311,10 +174510,14 @@ "additionalProperties": false, "properties": { "EnableOnlineStore": { + "markdownDescription": "Turn `OnlineStore` off by specifying `False` for the `EnableOnlineStore` flag\\. Turn `OnlineStore` on by specifying `True` for the `EnableOnlineStore` flag\\. \nThe default value is `False`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EnableOnlineStore", "type": "boolean" }, "SecurityConfig": { - "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.OnlineStoreSecurityConfig" + "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.OnlineStoreSecurityConfig", + "markdownDescription": "Use to specify KMS Key ID \\(`KMSKeyId`\\) for at\\-rest encryption of your `OnlineStore`\\. \n*Required*: No \n*Type*: [OnlineStoreSecurityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoresecurityconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SecurityConfig" } }, "type": "object" @@ -169323,6 +174526,8 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "The ID of the AWS Key Management Service \\(AWS KMS\\) key that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server\\-side encryption\\. \nThe caller \\(either IAM user or IAM role\\) of `CreateFeatureGroup` must have below permissions to the `OnlineStore` `KmsKeyId`: \n+ `\"kms:Encrypt\"` \n+ `\"kms:Decrypt\"` \n+ `\"kms:DescribeKey\"` \n+ `\"kms:CreateGrant\"` \n+ `\"kms:RetireGrant\"` \n+ `\"kms:ReEncryptFrom\"` \n+ `\"kms:ReEncryptTo\"` \n+ `\"kms:GenerateDataKey\"` \n+ `\"kms:ListAliases\"` \n+ `\"kms:ListGrants\"` \n+ `\"kms:RevokeGrant\"` \nThe caller \\(either user or IAM role\\) to all DataPlane operations \\(`PutRecord`, `GetRecord`, `DeleteRecord`\\) must have the following permissions to the `KmsKeyId`: \n+ `\"kms:Decrypt\"` \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" } }, @@ -169332,9 +174537,13 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "The AWS Key Management Service \\(KMS\\) key ID of the key used to encrypt any objects written into the `OfflineStore` S3 location\\. \nThe IAM `roleARN` that is passed as a parameter to `CreateFeatureGroup` must have below permissions to the `KmsKeyId`: \n+ `\"kms:GenerateDataKey\"` \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" }, "S3Uri": { + "markdownDescription": "The S3 URI, or location in Amazon S3, of `OfflineStore`\\. \nS3 URIs have a format similar to the following: `s3://example-bucket/prefix/`\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3Uri", "type": "string" } }, @@ -169639,7 +174848,7 @@ "title": "ImageConfig" }, "InferenceSpecificationName": { - "markdownDescription": "The inference specification name in the model package version\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The inference specification name in the model package version\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InferenceSpecificationName", "type": "string" }, @@ -169649,7 +174858,7 @@ "type": "string" }, "ModelDataUrl": { - "markdownDescription": "The S3 path where the model artifacts, which result from model training, are stored\\. This path must point to a single gzip compressed tar archive \\(\\.tar\\.gz suffix\\)\\. The S3 path is required for SageMaker built\\-in algorithms, but not if you use your own algorithms\\. For more information on built\\-in algorithms, see [Common Parameters](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html)\\. \nThe model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating\\.\nIf you provide a value for this parameter, SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide\\. AWS STS is activated in your IAM user account by default\\. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region\\. For more information, see [Activating and Deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the * AWS Identity and Access Management User Guide*\\. \nIf you use a built\\-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in `ModelDataUrl`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The S3 path where the model artifacts, which result from model training, are stored\\. This path must point to a single gzip compressed tar archive \\(\\.tar\\.gz suffix\\)\\. The S3 path is required for SageMaker built\\-in algorithms, but not if you use your own algorithms\\. For more information on built\\-in algorithms, see [Common Parameters](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html)\\. \nThe model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating\\.\nIf you provide a value for this parameter, SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide\\. AWS STS is activated in your AWS account by default\\. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region\\. For more information, see [Activating and Deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the * AWS Identity and Access Management User Guide*\\. \nIf you use a built\\-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in `ModelDataUrl`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ModelDataUrl", "type": "string" }, @@ -169786,6 +174995,8 @@ "additionalProperties": false, "properties": { "EndpointName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndpointName", "type": "string" }, "JobDefinitionName": { @@ -169876,36 +175087,58 @@ "additionalProperties": false, "properties": { "DataCapturedDestinationS3Uri": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataCapturedDestinationS3Uri", "type": "string" }, "DatasetFormat": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.DatasetFormat" + "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.DatasetFormat", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [DatasetFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-datasetformat.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatasetFormat" }, "EndTimeOffset": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EndTimeOffset", "type": "string" }, "FeaturesAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FeaturesAttribute", "type": "string" }, "InferenceAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InferenceAttribute", "type": "string" }, "LocalPath": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LocalPath", "type": "string" }, "ProbabilityAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProbabilityAttribute", "type": "string" }, "ProbabilityThresholdAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProbabilityThresholdAttribute", "type": "number" }, "S3DataDistributionType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3DataDistributionType", "type": "string" }, "S3InputMode": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3InputMode", "type": "string" }, "StartTimeOffset": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StartTimeOffset", "type": "string" } }, @@ -169920,22 +175153,22 @@ "additionalProperties": false, "properties": { "InstanceCount": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The number of ML compute instances to use in the model monitoring job\\. For distributed processing jobs, specify a value greater than 1\\. The default value is 1\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceCount", "type": "number" }, "InstanceType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ML compute instance type for the processing job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, "VolumeKmsKeyId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The AWS Key Management Service \\(AWS KMS\\) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance\\(s\\) that run the model monitoring job\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VolumeKmsKeyId", "type": "string" }, "VolumeSizeInGB": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The size of the ML storage volume, in gigabytes, that you want to provision\\. You must specify sufficient ML storage for your scenario\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VolumeSizeInGB", "type": "number" } @@ -169962,6 +175195,8 @@ "additionalProperties": false, "properties": { "Header": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Header", "type": "boolean" } }, @@ -169971,12 +175206,18 @@ "additionalProperties": false, "properties": { "Csv": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.Csv" + "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.Csv", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Csv](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-csv.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Csv" }, "Json": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.Json" + "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.Json", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-json.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Json" }, "Parquet": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Parquet", "type": "boolean" } }, @@ -170046,6 +175287,8 @@ "additionalProperties": false, "properties": { "Line": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Line", "type": "boolean" } }, @@ -170055,7 +175298,7 @@ "additionalProperties": false, "properties": { "ConfigUri": { - "markdownDescription": "JSON formatted S3 file that defines bias parameters\\. For more information on this JSON configuration file, see [Configure bias parameters](https://docs.aws.amazon.com/sagemaker/latest/json-bias-parameter-config.html)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "JSON formatted S3 file that defines bias parameters\\. For more information on this JSON configuration file, see [Configure bias parameters](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-bias-parameters.html)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ConfigUri", "type": "string" }, @@ -170102,11 +175345,13 @@ "additionalProperties": false, "properties": { "BatchTransformInput": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.BatchTransformInput" + "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.BatchTransformInput", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [BatchTransformInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-batchtransforminput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BatchTransformInput" }, "EndpointInput": { "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.EndpointInput", - "markdownDescription": "Input object for the endpoint\\. \n*Required*: Yes \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Input object for the endpoint \n*Required*: No \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EndpointInput" }, "GroundTruthS3Input": { @@ -170234,7 +175479,7 @@ "additionalProperties": false, "properties": { "MaxRuntimeInSeconds": { - "markdownDescription": "The maximum length of time, in seconds, that a training or compilation job can run\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum length of time, in seconds, that a training or compilation job can run before it is stopped\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \nThe maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaxRuntimeInSeconds", "type": "number" } @@ -170306,27 +175551,41 @@ "additionalProperties": false, "properties": { "Content": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.Content" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.Content", + "markdownDescription": "The content of the model card\\. Content uses the [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema)\\. \n*Required*: Yes \n*Type*: [Content](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Content" }, "CreatedBy": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.UserContext" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.UserContext", + "markdownDescription": "Information about the user who created or modified one or more of the following: \n+ Experiment\n+ Trial\n+ Trial component\n+ Lineage group\n+ Project\n+ Model Card\n*Required*: No \n*Type*: [UserContext](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreatedBy" }, "LastModifiedBy": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.UserContext" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.UserContext", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [UserContext](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LastModifiedBy" }, "ModelCardName": { + "markdownDescription": "The unique name of the model card\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelCardName", "type": "string" }, "ModelCardStatus": { + "markdownDescription": "The approval status of the model card within your organization\\. Different organizations might have different criteria for model card review and approval\\. \n+ `Draft`: The model card is a work in progress\\.\n+ `PendingReview`: The model card is pending review\\.\n+ `Approved`: The model card is approved\\.\n+ `Archived`: The model card is archived\\. No more updates should be made to the model card, but it can still be exported\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `Approved | Archived | Draft | PendingReview` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelCardStatus", "type": "string" }, "SecurityConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.SecurityConfig" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.SecurityConfig", + "markdownDescription": "The security configuration used to protect model card data\\. \n*Required*: No \n*Type*: [SecurityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-securityconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SecurityConfig" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Key\\-value pairs used to manage metadata for the model card\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -170362,18 +175621,24 @@ "additionalProperties": false, "properties": { "CaveatsAndRecommendations": { + "markdownDescription": "Caveats and recommendations for those who might use this model in their applications\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CaveatsAndRecommendations", "type": "string" }, "CustomDetails": { "additionalProperties": true, + "markdownDescription": "Any additional information to document about the model\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "CustomDetails", "type": "object" }, "EthicalConsiderations": { + "markdownDescription": "Any ethical considerations documented by the model card author\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EthicalConsiderations", "type": "string" } }, @@ -170383,12 +175648,18 @@ "additionalProperties": false, "properties": { "BusinessProblem": { + "markdownDescription": "The specific business problem that the model is trying to solve\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BusinessProblem", "type": "string" }, "BusinessStakeholders": { + "markdownDescription": "The relevant stakeholders for the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BusinessStakeholders", "type": "string" }, "LineOfBusiness": { + "markdownDescription": "The broader business need that the model is serving\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LineOfBusiness", "type": "string" } }, @@ -170398,25 +175669,37 @@ "additionalProperties": false, "properties": { "AdditionalInformation": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.AdditionalInformation" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.AdditionalInformation", + "markdownDescription": "Additional information about the model\\. \n*Required*: No \n*Type*: [AdditionalInformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-additionalinformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalInformation" }, "BusinessDetails": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.BusinessDetails" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.BusinessDetails", + "markdownDescription": "Information about how the model supports business goals\\. \n*Required*: No \n*Type*: [BusinessDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-businessdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BusinessDetails" }, "EvaluationDetails": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.EvaluationDetail" }, + "markdownDescription": "An overview about the model's evaluation\\. \n*Required*: No \n*Type*: List of [EvaluationDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EvaluationDetails", "type": "array" }, "IntendedUses": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.IntendedUses" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.IntendedUses", + "markdownDescription": "The intended usage of the model\\. \n*Required*: No \n*Type*: [IntendedUses](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntendedUses" }, "ModelOverview": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.ModelOverview" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.ModelOverview", + "markdownDescription": "An overview about the model \n*Required*: No \n*Type*: [ModelOverview](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelOverview" }, "TrainingDetails": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingDetails" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingDetails", + "markdownDescription": "An overview about model training\\. \n*Required*: No \n*Type*: [TrainingDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingDetails" } }, "type": "object" @@ -170428,30 +175711,42 @@ "items": { "type": "string" }, + "markdownDescription": "The location of the datasets used to evaluate the model\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Datasets", "type": "array" }, "EvaluationJobArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the evaluation job\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EvaluationJobArn", "type": "string" }, "EvaluationObservation": { + "markdownDescription": "Any observations made during the model evaluation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EvaluationObservation", "type": "string" }, "Metadata": { "additionalProperties": true, + "markdownDescription": "Additional attributes associated with the evaluation results\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Metadata", "type": "object" }, "MetricGroups": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.MetricGroup" }, + "markdownDescription": "An evaluation Metric Group object\\. \n*Required*: No \n*Type*: List of [MetricGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricgroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetricGroups", "type": "array" }, "Name": { + "markdownDescription": "The evaluation job name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -170464,12 +175759,18 @@ "additionalProperties": false, "properties": { "Condition": { + "markdownDescription": "An optional description of any conditions of your objective function metric\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Condition", "type": "string" }, "Facet": { + "markdownDescription": "The metric of the model's objective function\\. For example, *loss* or *rmse*\\. The following list shows examples of the values that you can specify for the metric: \n+ `ACCURACY`\n+ `AUC`\n+ `LOSS`\n+ `MAE`\n+ `RMSE`\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Facet", "type": "string" }, "Function": { + "markdownDescription": "The optimization direction of the model's objective function\\. You must specify one of the following values: \n+ `Maximize`\n+ `Minimize`\n*Required*: No \n*Type*: [String](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-sagemaker-modelcard-function.html#aws-properties-sagemaker-modelcard-function) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Function", "type": "string" } }, @@ -170482,6 +175783,8 @@ "items": { "type": "string" }, + "markdownDescription": "The container used to run the inference environment\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContainerImage", "type": "array" } }, @@ -170491,18 +175794,28 @@ "additionalProperties": false, "properties": { "ExplanationsForRiskRating": { + "markdownDescription": "An explanation of why your organization categorizes the model with its risk rating\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExplanationsForRiskRating", "type": "string" }, "FactorsAffectingModelEfficiency": { + "markdownDescription": "Factors affecting model efficacy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FactorsAffectingModelEfficiency", "type": "string" }, "IntendedUses": { + "markdownDescription": "The intended use cases for the model\\. \n*Required*: No \n*Type*: [String](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-sagemaker-modelcard-intendeduses.html#aws-properties-sagemaker-modelcard-intendeduses) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntendedUses", "type": "string" }, "PurposeOfModel": { + "markdownDescription": "The general purpose of the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PurposeOfModel", "type": "string" }, "RiskRating": { + "markdownDescription": "Your organization's risk rating\\. You can specify one the following values as the risk rating: \n+ High\n+ Medium\n+ Low\n+ Unknown\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RiskRating", "type": "string" } }, @@ -170512,27 +175825,39 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The names of the metrics\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Notes": { + "markdownDescription": "Any notes to add to the metric\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Notes", "type": "string" }, "Type": { + "markdownDescription": "You must specify one of the following data types: \n+ Bar Chart \u2013 `bar_char`\n+ Boolean \u2013 `boolean`\n+ Linear Graph \u2013 `linear_graph`\n+ Matrix \u2013 `matrix`\n+ Number \u2013 `number`\n+ String \u2013 `string`\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "Value": { + "markdownDescription": "The datatype of the metric\\. The metric's *value* must be compatible with the metric's *type*\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "object" }, "XAxisName": { "items": { "type": "string" }, + "markdownDescription": "The name of the x axis\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "XAxisName", "type": "array" }, "YAxisName": { "items": { "type": "string" }, + "markdownDescription": "The name of the y axis\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "YAxisName", "type": "array" } }, @@ -170550,9 +175875,13 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.MetricDataItems" }, + "markdownDescription": "A list of metric objects\\. The `MetricDataItems` list can have one of the following values: \n+ `bar_chart_metric`\n+ `matrix_metric`\n+ `simple_metric`\n+ `linear_graph_metric`\nFor more information about the metric schema, see the definition section of the [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema)\\. \n*Required*: Yes \n*Type*: List of [MetricDataItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricdataitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetricData", "type": "array" }, "Name": { + "markdownDescription": "The metric group name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -170566,36 +175895,56 @@ "additionalProperties": false, "properties": { "AlgorithmType": { + "markdownDescription": "The algorithm used to solve the problem\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlgorithmType", "type": "string" }, "InferenceEnvironment": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.InferenceEnvironment" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.InferenceEnvironment", + "markdownDescription": "An overview about model inference\\. \n*Required*: No \n*Type*: [InferenceEnvironment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-inferenceenvironment.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InferenceEnvironment" }, "ModelArtifact": { "items": { "type": "string" }, + "markdownDescription": "The location of the model artifact\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelArtifact", "type": "array" }, "ModelCreator": { + "markdownDescription": "The creator of the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelCreator", "type": "string" }, "ModelDescription": { + "markdownDescription": "A description of the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelDescription", "type": "string" }, "ModelId": { + "markdownDescription": "The SageMaker Model ARN or non\\-SageMaker Model ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelId", "type": "string" }, "ModelName": { + "markdownDescription": "The name of the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelName", "type": "string" }, "ModelOwner": { + "markdownDescription": "The owner of the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelOwner", "type": "string" }, "ModelVersion": { + "markdownDescription": "The version of the model\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelVersion", "type": "number" }, "ProblemType": { + "markdownDescription": "The problem being solved with the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ProblemType", "type": "string" } }, @@ -170605,9 +175954,13 @@ "additionalProperties": false, "properties": { "Function": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.Function" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.Function", + "markdownDescription": "A function object that details optimization direction, metric, and additional descriptions\\. \n*Required*: No \n*Type*: [Function](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-function.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Function" }, "Notes": { + "markdownDescription": "Notes about the object function, including other considerations for possible objective functions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Notes", "type": "string" } }, @@ -170617,6 +175970,8 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "A AWS Key Management Service [key ID](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) used to encrypt a model card\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" } }, @@ -170626,12 +175981,18 @@ "additionalProperties": false, "properties": { "ObjectiveFunction": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.ObjectiveFunction" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.ObjectiveFunction", + "markdownDescription": "The function that is optimized during model training\\. \n*Required*: No \n*Type*: [ObjectiveFunction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-objectivefunction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObjectiveFunction" }, "TrainingJobDetails": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingJobDetails" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingJobDetails", + "markdownDescription": "Details about any associated training jobs\\. \n*Required*: No \n*Type*: [TrainingJobDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingJobDetails" }, "TrainingObservations": { + "markdownDescription": "Any observations about training\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingObservations", "type": "string" } }, @@ -170644,6 +176005,8 @@ "items": { "type": "string" }, + "markdownDescription": "SageMaker inference image URI\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContainerImage", "type": "array" } }, @@ -170653,9 +176016,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the hyper parameter\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Value": { + "markdownDescription": "The value specified for the hyper parameter\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -170672,36 +176039,50 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingHyperParameter" }, + "markdownDescription": "The hyper parameters used in the training job\\. \n*Required*: No \n*Type*: List of [TrainingHyperParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-traininghyperparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HyperParameters", "type": "array" }, "TrainingArn": { + "markdownDescription": "The SageMaker training job Amazon Resource Name \\(ARN\\) \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingArn", "type": "string" }, "TrainingDatasets": { "items": { "type": "string" }, + "markdownDescription": "The location of the datasets used to train the model\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingDatasets", "type": "array" }, "TrainingEnvironment": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingEnvironment" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingEnvironment", + "markdownDescription": "The SageMaker training job image URI\\. \n*Required*: No \n*Type*: [TrainingEnvironment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingenvironment.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingEnvironment" }, "TrainingMetrics": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingMetric" }, + "markdownDescription": "The SageMaker training job results\\. \n*Required*: No \n*Type*: List of [TrainingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingMetrics", "type": "array" }, "UserProvidedHyperParameters": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingHyperParameter" }, + "markdownDescription": "Additional hyper parameters that you've specified when training the model\\. \n*Required*: No \n*Type*: List of [TrainingHyperParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-traininghyperparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserProvidedHyperParameters", "type": "array" }, "UserProvidedTrainingMetrics": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingMetric" }, + "markdownDescription": "Custom training job results\\. \n*Required*: No \n*Type*: List of [TrainingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserProvidedTrainingMetrics", "type": "array" } }, @@ -170711,12 +176092,18 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the result from the SageMaker training job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Notes": { + "markdownDescription": "Any additional notes describing the result of the training job\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Notes", "type": "string" }, "Value": { + "markdownDescription": "The value of a result from the SageMaker training job\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "number" } }, @@ -170730,12 +176117,18 @@ "additionalProperties": false, "properties": { "DomainId": { + "markdownDescription": "The domain associated with the user\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DomainId", "type": "string" }, "UserProfileArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the user's profile\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserProfileArn", "type": "string" }, "UserProfileName": { + "markdownDescription": "The name of the user's profile\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserProfileName", "type": "string" } }, @@ -170777,6 +176170,8 @@ "additionalProperties": false, "properties": { "EndpointName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndpointName", "type": "string" }, "JobDefinitionName": { @@ -170821,7 +176216,7 @@ }, "StoppingCondition": { "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.StoppingCondition", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [StoppingCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-stoppingcondition.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A time limit for how long the monitoring job is allowed to run before stopping\\. \n*Required*: No \n*Type*: [StoppingCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-stoppingcondition.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StoppingCondition" }, "Tags": { @@ -170867,27 +176262,43 @@ "additionalProperties": false, "properties": { "DataCapturedDestinationS3Uri": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataCapturedDestinationS3Uri", "type": "string" }, "DatasetFormat": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.DatasetFormat" + "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.DatasetFormat", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [DatasetFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-datasetformat.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatasetFormat" }, "FeaturesAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FeaturesAttribute", "type": "string" }, "InferenceAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InferenceAttribute", "type": "string" }, "LocalPath": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LocalPath", "type": "string" }, "ProbabilityAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProbabilityAttribute", "type": "string" }, "S3DataDistributionType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3DataDistributionType", "type": "string" }, "S3InputMode": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3InputMode", "type": "string" } }, @@ -170944,6 +176355,8 @@ "additionalProperties": false, "properties": { "Header": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Header", "type": "boolean" } }, @@ -170953,12 +176366,18 @@ "additionalProperties": false, "properties": { "Csv": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.Csv" + "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.Csv", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Csv](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-csv.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Csv" }, "Json": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.Json" + "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.Json", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-json.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Json" }, "Parquet": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Parquet", "type": "boolean" } }, @@ -171013,6 +176432,8 @@ "additionalProperties": false, "properties": { "Line": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Line", "type": "boolean" } }, @@ -171022,7 +176443,7 @@ "additionalProperties": false, "properties": { "ConfigUri": { - "markdownDescription": "JSON formatted S3 file that defines explainability parameters\\. For more information on this JSON configuration file, see [Configure model explainability parameters](https://docs.aws.amazon.com/sagemaker/latest/json-model-explainability-parameter-config.html)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "JSON formatted S3 file that defines explainability parameters\\. For more information on this JSON configuration file, see [Configure model explainability parameters](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-model-explainability-parameters.html)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ConfigUri", "type": "string" }, @@ -171069,11 +176490,13 @@ "additionalProperties": false, "properties": { "BatchTransformInput": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.BatchTransformInput" + "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.BatchTransformInput", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [BatchTransformInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-batchtransforminput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BatchTransformInput" }, "EndpointInput": { "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.EndpointInput", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EndpointInput" } }, @@ -171144,7 +176567,7 @@ }, "VpcConfig": { "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.VpcConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-vpcconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a VPC that your training jobs and hosted models have access to\\. Control access to and from your training and model containers by configuring the VPC\\. \n*Required*: No \n*Type*: [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-vpcconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VpcConfig" } }, @@ -171179,7 +176602,7 @@ "additionalProperties": false, "properties": { "MaxRuntimeInSeconds": { - "markdownDescription": "The maximum length of time, in seconds, that a training or compilation job can run\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum length of time, in seconds, that a training or compilation job can run before it is stopped\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \nThe maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaxRuntimeInSeconds", "type": "number" } @@ -171251,109 +176674,165 @@ "additionalProperties": false, "properties": { "AdditionalInferenceSpecificationDefinition": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition", + "markdownDescription": "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 \n*Required*: No \n*Type*: [AdditionalInferenceSpecificationDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalInferenceSpecificationDefinition" }, "AdditionalInferenceSpecifications": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition" }, + "markdownDescription": "An array of additional Inference Specification objects\\. \n*Required*: No \n*Type*: List of [AdditionalInferenceSpecificationDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html) \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalInferenceSpecifications", "type": "array" }, "AdditionalInferenceSpecificationsToAdd": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition" }, + "markdownDescription": "An array of additional Inference Specification objects to be added to the existing array\\. The total number of additional Inference Specification objects cannot exceed 15\\. Each additional Inference Specification object specifies artifacts based on this model package that can be used on inference endpoints\\. Generally used with SageMaker Neo to store the compiled artifacts\\. \n*Required*: No \n*Type*: List of [AdditionalInferenceSpecificationDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalInferenceSpecificationsToAdd", "type": "array" }, "ApprovalDescription": { + "markdownDescription": "A description provided when the model approval is set\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApprovalDescription", "type": "string" }, "CertifyForMarketplace": { + "markdownDescription": "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)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertifyForMarketplace", "type": "boolean" }, "ClientToken": { + "markdownDescription": "A unique token that guarantees that the call to this API is idempotent\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ClientToken", "type": "string" }, "CreatedBy": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.UserContext" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.UserContext", + "markdownDescription": "Information about the user who created or modified an experiment, trial, trial component, lineage group, or project\\. \n*Required*: No \n*Type*: [UserContext](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-usercontext.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreatedBy" }, "CustomerMetadataProperties": { "additionalProperties": true, + "markdownDescription": "The metadata properties for the model package\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "CustomerMetadataProperties", "type": "object" }, "Domain": { + "markdownDescription": "The machine learning domain of your model package and its components\\. Common machine learning domains include computer vision and natural language processing\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Domain", "type": "string" }, "DriftCheckBaselines": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckBaselines" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckBaselines", + "markdownDescription": "Represents the drift check baselines that can be used when the model monitor is set using the model package\\. \n*Required*: No \n*Type*: [DriftCheckBaselines](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckbaselines.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DriftCheckBaselines" }, "Environment": { "additionalProperties": true, + "markdownDescription": "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\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Environment", "type": "object" }, "InferenceSpecification": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.InferenceSpecification" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.InferenceSpecification", + "markdownDescription": "Defines how to perform inference generation after a training job is run\\. \n*Required*: No \n*Type*: [InferenceSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-inferencespecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InferenceSpecification" }, "LastModifiedBy": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.UserContext" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.UserContext", + "markdownDescription": "Information about the user who created or modified an experiment, trial, trial component, lineage group, or project\\. \n*Required*: No \n*Type*: [UserContext](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-usercontext.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LastModifiedBy" }, "LastModifiedTime": { + "markdownDescription": "The last time the model package was modified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LastModifiedTime", "type": "string" }, "MetadataProperties": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetadataProperties" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetadataProperties", + "markdownDescription": "Metadata properties of the tracking entity, trial, or trial component\\. \n*Required*: No \n*Type*: [MetadataProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metadataproperties.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MetadataProperties" }, "ModelApprovalStatus": { + "markdownDescription": "The approval status of the model\\. This can be one of the following values\\. \n+ `APPROVED` \\- The model is approved\n+ `REJECTED` \\- The model is rejected\\.\n+ `PENDING_MANUAL_APPROVAL` \\- The model is waiting for manual approval\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `Approved | PendingManualApproval | Rejected` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelApprovalStatus", "type": "string" }, "ModelMetrics": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelMetrics" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelMetrics", + "markdownDescription": "Metrics for the model\\. \n*Required*: No \n*Type*: [ModelMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelmetrics.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelMetrics" }, "ModelPackageDescription": { + "markdownDescription": "The description of the model package\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelPackageDescription", "type": "string" }, "ModelPackageGroupName": { + "markdownDescription": "The model group to which the model belongs\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelPackageGroupName", "type": "string" }, "ModelPackageName": { + "markdownDescription": "The name of the model\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelPackageName", "type": "string" }, "ModelPackageStatusDetails": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageStatusDetails" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageStatusDetails", + "markdownDescription": "Specifies the validation and image scan statuses of the model package\\. \n*Required*: No \n*Type*: [ModelPackageStatusDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagestatusdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelPackageStatusDetails" }, "ModelPackageStatusItem": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageStatusItem" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageStatusItem", + "markdownDescription": "Represents the overall status of a model package\\. \n*Required*: No \n*Type*: [ModelPackageStatusItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagestatusitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelPackageStatusItem" }, "ModelPackageVersion": { + "markdownDescription": "The version number of a versioned model\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelPackageVersion", "type": "number" }, "SamplePayloadUrl": { + "markdownDescription": "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\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SamplePayloadUrl", "type": "string" }, "SourceAlgorithmSpecification": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.SourceAlgorithmSpecification" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.SourceAlgorithmSpecification", + "markdownDescription": "A list of algorithms that were used to create a model package\\. \n*Required*: No \n*Type*: [SourceAlgorithmSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-sourcealgorithmspecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceAlgorithmSpecification" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "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*\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "Task": { + "markdownDescription": "The machine learning task your model package accomplishes\\. Common machine learning tasks include object detection and image classification\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Task", "type": "string" }, "ValidationSpecification": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ValidationSpecification" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ValidationSpecification", + "markdownDescription": "Specifies batch transform jobs that SageMaker runs to validate your model package\\. \n*Required*: No \n*Type*: [ValidationSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-validationspecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ValidationSpecification" } }, "type": "object" @@ -171385,36 +176864,50 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageContainerDefinition" }, + "markdownDescription": "The Amazon ECR registry path of the Docker image that contains the inference code\\. \n*Required*: Yes \n*Type*: List of [ModelPackageContainerDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html) \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Containers", "type": "array" }, "Description": { + "markdownDescription": "A description of the additional Inference specification \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "SupportedContentTypes": { "items": { "type": "string" }, + "markdownDescription": "The supported MIME types for the input data\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SupportedContentTypes", "type": "array" }, "SupportedRealtimeInferenceInstanceTypes": { "items": { "type": "string" }, + "markdownDescription": "A list of the instance types that are used to generate inferences in real\\-time\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SupportedRealtimeInferenceInstanceTypes", "type": "array" }, "SupportedResponseMIMETypes": { "items": { "type": "string" }, + "markdownDescription": "The supported MIME types for the output data\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SupportedResponseMIMETypes", "type": "array" }, "SupportedTransformInstanceTypes": { "items": { "type": "string" }, + "markdownDescription": "A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SupportedTransformInstanceTypes", "type": "array" } }, @@ -171428,13 +176921,19 @@ "additionalProperties": false, "properties": { "PostTrainingReport": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The post\\-training bias report for a model\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PostTrainingReport" }, "PreTrainingReport": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The pre\\-training bias report for a model\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PreTrainingReport" }, "Report": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The bias report for a model \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Report" } }, "type": "object" @@ -171443,7 +176942,9 @@ "additionalProperties": false, "properties": { "S3DataSource": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.S3DataSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.S3DataSource", + "markdownDescription": "The S3 location of the data source that is associated with a channel\\. \n*Required*: Yes \n*Type*: [S3DataSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-s3datasource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3DataSource" } }, "required": [ @@ -171455,16 +176956,24 @@ "additionalProperties": false, "properties": { "Bias": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckBias" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckBias", + "markdownDescription": "Represents the drift check bias baselines that can be used when the model monitor is set using the model package\\. \n*Required*: No \n*Type*: [DriftCheckBias](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckbias.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Bias" }, "Explainability": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckExplainability" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckExplainability", + "markdownDescription": "Represents the drift check explainability baselines that can be used when the model monitor is set using the model package\\. \n*Required*: No \n*Type*: [DriftCheckExplainability](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckexplainability.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Explainability" }, "ModelDataQuality": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckModelDataQuality" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckModelDataQuality", + "markdownDescription": "Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package\\. \n*Required*: No \n*Type*: [DriftCheckModelDataQuality](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckmodeldataquality.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelDataQuality" }, "ModelQuality": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckModelQuality" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckModelQuality", + "markdownDescription": "Represents the drift check model quality baselines that can be used when the model monitor is set using the model package\\. \n*Required*: No \n*Type*: [DriftCheckModelQuality](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckmodelquality.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelQuality" } }, "type": "object" @@ -171473,13 +176982,19 @@ "additionalProperties": false, "properties": { "ConfigFile": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.FileSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.FileSource", + "markdownDescription": "The bias config file for a model\\. \n*Required*: No \n*Type*: [FileSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-filesource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConfigFile" }, "PostTrainingConstraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The post\\-training constraints\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PostTrainingConstraints" }, "PreTrainingConstraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The pre\\-training constraints\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PreTrainingConstraints" } }, "type": "object" @@ -171488,10 +177003,14 @@ "additionalProperties": false, "properties": { "ConfigFile": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.FileSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.FileSource", + "markdownDescription": "The explainability config file for the model\\. \n*Required*: No \n*Type*: [FileSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-filesource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConfigFile" }, "Constraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The drift check explainability constraints\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Constraints" } }, "type": "object" @@ -171500,10 +177019,14 @@ "additionalProperties": false, "properties": { "Constraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The drift check model data quality constraints\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Constraints" }, "Statistics": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The drift check model data quality statistics\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Statistics" } }, "type": "object" @@ -171512,10 +177035,14 @@ "additionalProperties": false, "properties": { "Constraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The drift check model quality constraints\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Constraints" }, "Statistics": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The drift check model quality statistics\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Statistics" } }, "type": "object" @@ -171524,7 +177051,9 @@ "additionalProperties": false, "properties": { "Report": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The explainability report for a model\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Report" } }, "type": "object" @@ -171533,12 +177062,18 @@ "additionalProperties": false, "properties": { "ContentDigest": { + "markdownDescription": "The digest of the file source\\. \n*Required*: No \n*Type*: String \n*Maximum*: `72` \n*Pattern*: `^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContentDigest", "type": "string" }, "ContentType": { + "markdownDescription": "The type of content stored in the file source\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContentType", "type": "string" }, "S3Uri": { + "markdownDescription": "The Amazon S3 URI for the file source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3Uri", "type": "string" } }, @@ -171554,30 +177089,40 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageContainerDefinition" }, + "markdownDescription": "The Amazon ECR registry path of the Docker image that contains the inference code\\. \n*Required*: Yes \n*Type*: List of [ModelPackageContainerDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html) \n*Maximum*: `15` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Containers", "type": "array" }, "SupportedContentTypes": { "items": { "type": "string" }, + "markdownDescription": "The supported MIME types for the input data\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SupportedContentTypes", "type": "array" }, "SupportedRealtimeInferenceInstanceTypes": { "items": { "type": "string" }, + "markdownDescription": "A list of the instance types that are used to generate inferences in real\\-time\\. \nThis parameter is required for unversioned models, and optional for versioned models\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SupportedRealtimeInferenceInstanceTypes", "type": "array" }, "SupportedResponseMIMETypes": { "items": { "type": "string" }, + "markdownDescription": "The supported MIME types for the output data\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SupportedResponseMIMETypes", "type": "array" }, "SupportedTransformInstanceTypes": { "items": { "type": "string" }, + "markdownDescription": "A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed\\. \nThis parameter is required for unversioned models, and optional for versioned models\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SupportedTransformInstanceTypes", "type": "array" } }, @@ -171592,15 +177137,23 @@ "additionalProperties": false, "properties": { "CommitId": { + "markdownDescription": "The commit ID\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CommitId", "type": "string" }, "GeneratedBy": { + "markdownDescription": "The entity this entity was generated by\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "GeneratedBy", "type": "string" }, "ProjectId": { + "markdownDescription": "The project ID\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProjectId", "type": "string" }, "Repository": { + "markdownDescription": "The repository\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Repository", "type": "string" } }, @@ -171610,12 +177163,18 @@ "additionalProperties": false, "properties": { "ContentDigest": { + "markdownDescription": "The hash key used for the metrics source\\. \n*Required*: No \n*Type*: String \n*Maximum*: `72` \n*Pattern*: `^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContentDigest", "type": "string" }, "ContentType": { + "markdownDescription": "The metric source content type\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContentType", "type": "string" }, "S3Uri": { + "markdownDescription": "The S3 URI for the metrics source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3Uri", "type": "string" } }, @@ -171629,10 +177188,14 @@ "additionalProperties": false, "properties": { "Constraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "Data quality constraints for a model\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Constraints" }, "Statistics": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "Data quality statistics for a model\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Statistics" } }, "type": "object" @@ -171641,6 +177204,8 @@ "additionalProperties": false, "properties": { "DataInputConfig": { + "markdownDescription": "The input configuration object for the model\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `[\\S\\s]+` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "DataInputConfig", "type": "string" } }, @@ -171653,16 +177218,24 @@ "additionalProperties": false, "properties": { "Bias": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.Bias" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.Bias", + "markdownDescription": "Metrics that measure bais in a model\\. \n*Required*: No \n*Type*: [Bias](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-bias.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Bias" }, "Explainability": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.Explainability" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.Explainability", + "markdownDescription": "Metrics that help explain a model\\. \n*Required*: No \n*Type*: [Explainability](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-explainability.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Explainability" }, "ModelDataQuality": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelDataQuality" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelDataQuality", + "markdownDescription": "Metrics that measure the quality of the input data for a model\\. \n*Required*: No \n*Type*: [ModelDataQuality](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modeldataquality.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelDataQuality" }, "ModelQuality": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelQuality" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelQuality", + "markdownDescription": "Metrics that measure the quality of a model\\. \n*Required*: No \n*Type*: [ModelQuality](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelquality.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelQuality" } }, "type": "object" @@ -171671,39 +177244,59 @@ "additionalProperties": false, "properties": { "ContainerHostname": { + "markdownDescription": "The DNS host name for the Docker container\\. \n*Required*: No \n*Type*: String \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "ContainerHostname", "type": "string" }, "Environment": { "additionalProperties": true, + "markdownDescription": "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\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Environment", "type": "object" }, "Framework": { + "markdownDescription": "The machine learning framework of the model package container image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "Framework", "type": "string" }, "FrameworkVersion": { + "markdownDescription": "The framework version of the Model Package Container Image\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `10` \n*Pattern*: `[0-9]\\.[A-Za-z0-9.-]+` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "FrameworkVersion", "type": "string" }, "Image": { + "markdownDescription": "The Amazon EC2 Container Registry \\(Amazon ECR\\) path where inference code is stored\\. \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)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `[\\S]+` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "Image", "type": "string" }, "ImageDigest": { + "markdownDescription": "An MD5 hash of the training algorithm that identifies the Docker image used for training\\. \n*Required*: No \n*Type*: String \n*Maximum*: `72` \n*Pattern*: `^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "ImageDigest", "type": "string" }, "ModelDataUrl": { + "markdownDescription": "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\\)\\. \nThe model artifacts must be in an S3 bucket that is in the same region as the model package\\.\n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "ModelDataUrl", "type": "string" }, "ModelInput": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelInput" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelInput", + "markdownDescription": "A structure with Model Input details\\. \n*Required*: No \n*Type*: [ModelInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelinput.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "ModelInput" }, "NearestModelName": { + "markdownDescription": "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`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "NearestModelName", "type": "string" }, "ProductId": { + "markdownDescription": "The AWS Marketplace product ID of the model package\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "ProductId", "type": "string" } }, @@ -171719,12 +177312,16 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageStatusItem" }, + "markdownDescription": "The status of the scan of the Docker image container for the model package\\. \n*Required*: No \n*Type*: List of [ModelPackageStatusItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagestatusitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImageScanStatuses", "type": "array" }, "ValidationStatuses": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageStatusItem" }, + "markdownDescription": "The validation status of the model package\\. \n*Required*: Yes \n*Type*: List of [ModelPackageStatusItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagestatusitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ValidationStatuses", "type": "array" } }, @@ -171737,12 +177334,18 @@ "additionalProperties": false, "properties": { "FailureReason": { + "markdownDescription": "if the overall status is `Failed`, the reason for the failure\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailureReason", "type": "string" }, "Name": { + "markdownDescription": "The name of the model package for which the overall status is being reported\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Status": { + "markdownDescription": "The current status\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Completed | Failed | InProgress | NotStarted` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" } }, @@ -171756,10 +177359,14 @@ "additionalProperties": false, "properties": { "Constraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "Model quality constraints\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Constraints" }, "Statistics": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "Model quality statistics\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Statistics" } }, "type": "object" @@ -171768,9 +177375,13 @@ "additionalProperties": false, "properties": { "S3DataType": { + "markdownDescription": "If you choose `S3Prefix`, `S3Uri` identifies a key name prefix\\. SageMaker uses all objects that match the specified key name prefix for model training\\. \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\\. \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`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AugmentedManifestFile | ManifestFile | S3Prefix` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3DataType", "type": "string" }, "S3Uri": { + "markdownDescription": "Depending on the value specified for the `S3DataType`, identifies either a key name prefix or a manifest\\. For example: \n+ A key name prefix might look like this: `s3://bucketname/exampleprefix` \n+ A manifest might look like this: `s3://bucketname/example.manifest`", + "title": "S3Uri", "type": "string" } }, @@ -171784,9 +177395,13 @@ "additionalProperties": false, "properties": { "AlgorithmName": { + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `170` \n*Pattern*: `(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? Type](https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type)\\.\n+ You can use this value to update an existing instance\\.\n+ To register a new instance, you must specify a value that's unique among instances that you register by using the same service\\. \n+ If you specify an existing `InstanceId` and `ServiceId`, AWS Cloud Map updates the existing DNS records, if any\\. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one\\. \n**Note** \nThe health check isn't deleted immediately, so it will still appear for a while if you submit a `ListHealthChecks` request, for example\\.\n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Pattern*: `^[0-9a-zA-Z_/:.@-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An identifier that you want to associate with the instance\\. Note the following: \n+ If the service that's specified by `ServiceId` includes settings for an `SRV` record, the value of `InstanceId` is automatically included as part of the value for the `SRV` record\\. For more information, see [DnsRecord > Type](https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type)\\.\n+ You can use this value to update an existing instance\\.\n+ To register a new instance, you must specify a value that's unique among instances that you register by using the same service\\. \n+ If you specify an existing `InstanceId` and `ServiceId`, AWS Cloud Map updates the existing DNS records, if any\\. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one\\. \n**Note** \nThe health check isn't deleted immediately, so it will still appear for a while if you submit a `ListHealthChecks` request, for example\\.\nDo not include sensitive information in `InstanceId` if the namespace is discoverable by public DNS queries and any `Type` member of `DnsRecord` for the service contains `SRV` because the `InstanceId` is discoverable by public DNS queries\\.\n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Pattern*: `^[0-9a-zA-Z_/:.@-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceId", "type": "string" }, @@ -177391,7 +183312,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The name that you want to assign to this namespace\\. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route\u00a053 private hosted zone that has the same name as the namespace\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^[!-~]{1,1024}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name that you want to assign to this namespace\\. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route\u00a053 private hosted zone that has the same name as the namespace\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^[!-~]{1,253}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -177515,7 +183436,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The name that you want to assign to this namespace\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name that you want to assign to this namespace\\. \nDo not include sensitive information in the name\\. The name is publicly available using DNS queries\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -177634,7 +183555,7 @@ }, "DnsConfig": { "$ref": "#/definitions/AWS::ServiceDiscovery::Service.DnsConfig", - "markdownDescription": "A complex type that contains information about the Route\u00a053 DNS records that you want AWS Cloud Map to create when you register an instance\\. \n*Required*: No \n*Type*: [DnsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains information about the Route\u00a053 DNS records that you want AWS Cloud Map to create when you register an instance\\. \nThe record types of a service can only be changed by deleting the service and recreating it with a new `Dnsconfig`\\.\n*Required*: No \n*Type*: [DnsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DnsConfig" }, "HealthCheckConfig": { @@ -177997,13 +183918,19 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the simulation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "RoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS Identity and Access Management \\(IAM\\) role that the simulation assumes to perform actions\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. For more information about IAM roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *AWS Identity and Access Management User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "SchemaS3Location": { - "$ref": "#/definitions/AWS::SimSpaceWeaver::Simulation.S3Location" + "$ref": "#/definitions/AWS::SimSpaceWeaver::Simulation.S3Location", + "markdownDescription": "The location of the simulation schema in Amazon Simple Storage Service \\(Amazon S3\\)\\. For more information about Amazon S3, see the [https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html)\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-simspaceweaver-simulation-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SchemaS3Location" } }, "type": "object" @@ -178032,9 +183959,13 @@ "additionalProperties": false, "properties": { "BucketName": { + "markdownDescription": "The name of an Amazon S3 bucket\\. For more information about buckets, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the *Amazon Simple Storage Service User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketName", "type": "string" }, "ObjectKey": { + "markdownDescription": "The key name of an object in Amazon S3\\. For more information about Amazon S3 objects and object keys, see [Uploading, downloading, and working with objects in Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html) in the *Amazon Simple Storage Service User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObjectKey", "type": "string" } }, @@ -178182,7 +184113,7 @@ "additionalProperties": false, "properties": { "Definition": { - "markdownDescription": "The Amazon States Language definition of the state machine\\. The state machine definition must be in JSON or YAML, and the format of the object must match the format of your AWS Step Functions template file\\. See [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html)\\. \n*Required*: No \n*Type*: [Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-definition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon States Language definition of the state machine\\. The state machine definition must be in JSON or YAML, and the format of the object must match the format of your AWS Step Functions template file\\. See [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Definition", "type": "object" }, @@ -178198,7 +184129,7 @@ }, "DefinitionSubstitutions": { "additionalProperties": true, - "markdownDescription": "A map \\(string to string\\) that specifies the mappings for placeholder variables in the state machine definition\\. This enables the customer to inject values obtained at runtime, for example from intrinsic functions, in the state machine definition\\. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key\\-value map\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A map \\(string to string\\) that specifies the mappings for placeholder variables in the state machine definition\\. This enables the customer to inject values obtained at runtime, for example from intrinsic functions, in the state machine definition\\. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key\\-value map\\. \n*Required*: No \n*Type*: Map of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "object" @@ -178405,6 +184336,8 @@ "additionalProperties": false, "properties": { "AccountAlias": { + "markdownDescription": "An alias or short name for an AWS account\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccountAlias", "type": "string" } }, @@ -178470,27 +184403,43 @@ "additionalProperties": false, "properties": { "ChannelId": { + "markdownDescription": "The channel ID in Slack\\. This ID identifies a channel within a Slack workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ChannelId", "type": "string" }, "ChannelName": { + "markdownDescription": "The channel name in Slack\\. This is the channel where you invite the AWS Support App\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ChannelName", "type": "string" }, "ChannelRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IAM role for this Slack channel configuration\\. The AWS Support App uses this role to perform AWS Support and Service Quotas actions on your behalf\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ChannelRoleArn", "type": "string" }, "NotifyOnAddCorrespondenceToCase": { + "markdownDescription": "Whether to get notified when a correspondence is added to your support cases\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotifyOnAddCorrespondenceToCase", "type": "boolean" }, "NotifyOnCaseSeverity": { + "markdownDescription": "The case severity for your support cases that you want to receive notifications\\. You can specify `none`, `all`, or `high`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotifyOnCaseSeverity", "type": "string" }, "NotifyOnCreateOrReopenCase": { + "markdownDescription": "Whether to get notified when your support cases are created or reopened \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotifyOnCreateOrReopenCase", "type": "boolean" }, "NotifyOnResolveCase": { + "markdownDescription": "Whether to get notified when your support cases are resolved\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotifyOnResolveCase", "type": "boolean" }, "TeamId": { + "markdownDescription": "The team ID in Slack\\. This ID uniquely identifies a Slack workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TeamId", "type": "string" } }, @@ -178559,9 +184508,13 @@ "additionalProperties": false, "properties": { "TeamId": { + "markdownDescription": "The team ID in Slack\\. This ID uniquely identifies a Slack workspace, such as `T012ABCDEFG`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TeamId", "type": "string" }, "VersionId": { + "markdownDescription": "An identifier used to update an existing Slack workspace configuration in AWS CloudFormation, such as `100`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VersionId", "type": "string" } }, @@ -178642,6 +184595,8 @@ "title": "Code" }, "DeleteLambdaResourcesOnCanaryDeletion": { + "markdownDescription": "Specifies whether AWS CloudFormation is to also delete the Lambda functions and layers used by this canary, when the canary is deleted\\. The default is false\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeleteLambdaResourcesOnCanaryDeletion", "type": "boolean" }, "ExecutionRoleArn": { @@ -178958,18 +184913,24 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "A name for the group\\. It can include any Unicode characters\\. \nThe names for all groups in your account, across all Regions, must be unique\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "ResourceArns": { "items": { "type": "string" }, + "markdownDescription": "The ARNs of the canaries that you want to associate with this group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceArns", "type": "array" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value pairs that are associated with the group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -178999,6 +184960,114 @@ ], "type": "object" }, + "AWS::SystemsManagerSAP::Application": { + "additionalProperties": false, + "properties": { + "Condition": { + "type": "string" + }, + "DeletionPolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + }, + "DependsOn": { + "anyOf": [ + { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + { + "items": { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "type": "array" + } + ] + }, + "Metadata": { + "type": "object" + }, + "Properties": { + "additionalProperties": false, + "properties": { + "ApplicationId": { + "type": "string" + }, + "ApplicationType": { + "type": "string" + }, + "Credentials": { + "items": { + "$ref": "#/definitions/AWS::SystemsManagerSAP::Application.Credential" + }, + "type": "array" + }, + "Instances": { + "items": { + "type": "string" + }, + "type": "array" + }, + "SapInstanceNumber": { + "type": "string" + }, + "Sid": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "required": [ + "ApplicationId", + "ApplicationType" + ], + "type": "object" + }, + "Type": { + "enum": [ + "AWS::SystemsManagerSAP::Application" + ], + "type": "string" + }, + "UpdateReplacePolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Properties" + ], + "type": "object" + }, + "AWS::SystemsManagerSAP::Application.Credential": { + "additionalProperties": false, + "properties": { + "CredentialType": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "SecretId": { + "type": "string" + } + }, + "type": "object" + }, "AWS::Timestream::Database": { "additionalProperties": false, "properties": { @@ -179539,7 +185608,9 @@ "additionalProperties": false, "properties": { "S3Configuration": { - "$ref": "#/definitions/AWS::Timestream::Table.S3Configuration" + "$ref": "#/definitions/AWS::Timestream::Table.S3Configuration", + "markdownDescription": "Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes\\. \n*Required*: No \n*Type*: [S3Configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3Configuration" } }, "type": "object" @@ -179548,10 +185619,14 @@ "additionalProperties": false, "properties": { "EnableMagneticStoreWrites": { + "markdownDescription": "A flag to enable magnetic store writes\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableMagneticStoreWrites", "type": "boolean" }, "MagneticStoreRejectedDataLocation": { - "$ref": "#/definitions/AWS::Timestream::Table.MagneticStoreRejectedDataLocation" + "$ref": "#/definitions/AWS::Timestream::Table.MagneticStoreRejectedDataLocation", + "markdownDescription": "The location to write error reports for records rejected asynchronously during magnetic store writes\\. \n*Required*: No \n*Type*: [MagneticStoreRejectedDataLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorerejecteddatalocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MagneticStoreRejectedDataLocation" } }, "required": [ @@ -179563,9 +185638,13 @@ "additionalProperties": false, "properties": { "MagneticStoreRetentionPeriodInDays": { + "markdownDescription": "The duration for which data must be stored in the magnetic store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MagneticStoreRetentionPeriodInDays", "type": "string" }, "MemoryStoreRetentionPeriodInHours": { + "markdownDescription": "The duration for which data must be stored in the memory store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MemoryStoreRetentionPeriodInHours", "type": "string" } }, @@ -179575,15 +185654,23 @@ "additionalProperties": false, "properties": { "BucketName": { + "markdownDescription": "The bucket name of the customer S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketName", "type": "string" }, "EncryptionOption": { + "markdownDescription": "The encryption option for the customer S3 location\\. Options are S3 server\\-side encryption with an S3 managed key or AWS managed key\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SSE_KMS | SSE_S3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionOption", "type": "string" }, "KmsKeyId": { + "markdownDescription": "The AWS KMS key ID for the customer S3 location when encrypting with an AWS managed key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "ObjectKeyPrefix": { + "markdownDescription": "The object key preview for the customer S3 location\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `928` \n*Pattern*: `[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObjectKeyPrefix", "type": "string" } }, @@ -179629,30 +185716,46 @@ "additionalProperties": false, "properties": { "AccessRole": { + "markdownDescription": "With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths`\\. We use the file\u2019s parent directory \\(for example, for `--send-file-paths /bucket/dir/file.txt`, parent directory is `/bucket/dir/`\\) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission\\. So, the `AccessRole` needs to provide read and write access to the parent directory of the file location used in the `StartFileTransfer` request\\. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with `StartFileTransfer`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessRole", "type": "string" }, "BaseDirectory": { + "markdownDescription": "The landing directory \\(folder\\) for files that are transferred by using the AS2 protocol\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^$|/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BaseDirectory", "type": "string" }, "Description": { + "markdownDescription": "The name or short description that's used to identify the agreement\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `200` \n*Pattern*: `^[\\p{Graph}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "LocalProfileId": { + "markdownDescription": "A unique identifier for the AS2 local profile\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `19` \n*Maximum*: `19` \n*Pattern*: `^p-([0-9a-f]{17})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LocalProfileId", "type": "string" }, "PartnerProfileId": { + "markdownDescription": "A unique identifier for the partner profile used in the agreement\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `19` \n*Maximum*: `19` \n*Pattern*: `^p-([0-9a-f]{17})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PartnerProfileId", "type": "string" }, "ServerId": { + "markdownDescription": "A system\\-assigned unique identifier for a server instance\\. This identifier indicates the specific server that the agreement uses\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `19` \n*Maximum*: `19` \n*Pattern*: `^s-([0-9a-f]{17})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ServerId", "type": "string" }, "Status": { + "markdownDescription": "The current status of the agreement, either `ACTIVE` or `INACTIVE`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | INACTIVE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Key\\-value pairs that can be used to group and search for agreements\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -179722,30 +185825,46 @@ "additionalProperties": false, "properties": { "ActiveDate": { + "markdownDescription": "An optional date that specifies when the certificate becomes active\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActiveDate", "type": "string" }, "Certificate": { + "markdownDescription": "The file name for the certificate\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16384` \n*Pattern*: `^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Certificate", "type": "string" }, "CertificateChain": { + "markdownDescription": "The list of certificates that make up the chain for the certificate\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2097152` \n*Pattern*: `^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CertificateChain", "type": "string" }, "Description": { + "markdownDescription": "The name or description that's used to identity the certificate\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `200` \n*Pattern*: `^[\\p{Graph}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "InactiveDate": { + "markdownDescription": "An optional date that specifies when the certificate becomes inactive\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InactiveDate", "type": "string" }, "PrivateKey": { + "markdownDescription": "The file that contains the private key for the certificate that's being imported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PrivateKey", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Key\\-value pairs that can be used to group and search for certificates\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "Usage": { + "markdownDescription": "Specifies whether this certificate is used for signing or encryption\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ENCRYPTION | SIGNING` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Usage", "type": "string" } }, @@ -179812,21 +185931,31 @@ "additionalProperties": false, "properties": { "AccessRole": { + "markdownDescription": "With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths`\\. We use the file\u2019s parent directory \\(for example, for `--send-file-paths /bucket/dir/file.txt`, parent directory is `/bucket/dir/`\\) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission\\. So, the `AccessRole` needs to provide read and write access to the parent directory of the file location used in the `StartFileTransfer` request\\. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with `StartFileTransfer`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessRole", "type": "string" }, "As2Config": { - "$ref": "#/definitions/AWS::Transfer::Connector.As2Config" + "$ref": "#/definitions/AWS::Transfer::Connector.As2Config", + "markdownDescription": "A structure that contains the parameters for a connector object\\. \n*Required*: Yes \n*Type*: [As2Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "As2Config" }, "LoggingRole": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS Identity and Access Management \\(IAM\\) role that allows a connector to turn on CloudWatch logging for Amazon S3 events\\. When set, you can view connector activity in your CloudWatch logs\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LoggingRole", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Key\\-value pairs that can be used to group and search for connectors\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "Url": { + "markdownDescription": "The URL of the partner's AS2 endpoint\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Url", "type": "string" } }, @@ -179862,27 +185991,43 @@ "additionalProperties": false, "properties": { "Compression": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Compression", "type": "string" }, "EncryptionAlgorithm": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionAlgorithm", "type": "string" }, "LocalProfileId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LocalProfileId", "type": "string" }, "MdnResponse": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MdnResponse", "type": "string" }, "MdnSigningAlgorithm": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MdnSigningAlgorithm", "type": "string" }, "MessageSubject": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageSubject", "type": "string" }, "PartnerProfileId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PartnerProfileId", "type": "string" }, "SigningAlgorithm": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SigningAlgorithm", "type": "string" } }, @@ -179924,21 +186069,29 @@ "additionalProperties": false, "properties": { "As2Id": { + "markdownDescription": "The `As2Id` is the *AS2\\-name*, as defined in the [RFC 4130](https://datatracker.ietf.org/doc/html/rfc4130)\\. For inbound transfers, this is the `AS2-From` header for the AS2 messages sent from the partner\\. For outbound connectors, this is the `AS2-To` header for the AS2 messages sent to the partner using the `StartFileTransfer` API operation\\. This ID cannot include spaces\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\p{Print}\\s]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "As2Id", "type": "string" }, "CertificateIds": { "items": { "type": "string" }, + "markdownDescription": "An array of identifiers for the imported certificates\\. You use this identifier for working with profiles and partner profiles\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertificateIds", "type": "array" }, "ProfileType": { + "markdownDescription": "Indicates whether to list only `LOCAL` type profiles or only `PARTNER` type profiles\\. If not supplied in the request, the command lists all types of profiles\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `LOCAL | PARTNER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProfileType", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Key\\-value pairs that can be used to group and search for profiles\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -180016,7 +186169,7 @@ }, "EndpointDetails": { "$ref": "#/definitions/AWS::Transfer::Server.EndpointDetails", - "markdownDescription": "The virtual private cloud \\(VPC\\) endpoint settings that are configured for your server\\. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet\\. Your VPC's default security groups are automatically assigned to your endpoint\\. \n*Required*: No \n*Type*: [EndpointDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The virtual private cloud \\(VPC\\) endpoint settings that are configured for your server\\. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet\\. Your VPC's default security groups are automatically assigned to your endpoint\\. \n*Required*: No \n*Type*: [EndpointDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EndpointDetails" }, "EndpointType": { @@ -180030,35 +186183,35 @@ "title": "IdentityProviderDetails" }, "IdentityProviderType": { - "markdownDescription": "Specifies the mode of authentication for a server\\. The default value is `SERVICE_MANAGED`, which allows you to store and access user credentials within the AWS Transfer Family service\\. \nUse `AWS_DIRECTORY_SERVICE` to provide access to Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your on\\-premises environment or in AWS using AD Connectors\\. This option also requires you to provide a Directory ID using the `IdentityProviderDetails` parameter\\. \nUse the `API_GATEWAY` value to integrate with an identity provider of your choosing\\. The `API_GATEWAY` setting requires you to provide an API Gateway endpoint URL to call for authentication using the `IdentityProviderDetails` parameter\\. \nUse the `AWS_LAMBDA` value to directly use a Lambda function as your identity provider\\. If you choose this value, you must specify the ARN for the lambda function in the `Function` parameter for the `IdentityProviderDetails` data type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA | SERVICE_MANAGED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The mode of authentication for a server\\. The default value is `SERVICE_MANAGED`, which allows you to store and access user credentials within the AWS Transfer Family service\\. \nUse `AWS_DIRECTORY_SERVICE` to provide access to Active Directory groups in AWS Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on\\-premises environment or in AWS using AD Connector\\. This option also requires you to provide a Directory ID by using the `IdentityProviderDetails` parameter\\. \nUse the `API_GATEWAY` value to integrate with an identity provider of your choosing\\. The `API_GATEWAY` setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the `IdentityProviderDetails` parameter\\. \nUse the `AWS_LAMBDA` value to directly use an AWS Lambda function as your identity provider\\. If you choose this value, you must specify the ARN for the Lambda function in the `Function` parameter or the `IdentityProviderDetails` data type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA | SERVICE_MANAGED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IdentityProviderType", "type": "string" }, "LoggingRole": { - "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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 EFSevents\\. When set, you can view user activity in your CloudWatch logs\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoggingRole", "type": "string" }, "PostAuthenticationLoginBanner": { - "markdownDescription": "Specify a string to display when users connect to a server\\. This string is displayed after the user authenticates\\. \nThe SFTP protocol does not support post\\-authentication display banners\\.\n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\x09-\\x0D\\x20-\\x7E]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a string to display when users connect to a server\\. This string is displayed after the user authenticates\\. \nThe SFTP protocol does not support post\\-authentication display banners\\.\n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\x09-\\x0D\\x20-\\x7E]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PostAuthenticationLoginBanner", "type": "string" }, "PreAuthenticationLoginBanner": { - "markdownDescription": "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 `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.` \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\x09-\\x0D\\x20-\\x7E]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies 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 `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.` \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\x09-\\x0D\\x20-\\x7E]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PreAuthenticationLoginBanner", "type": "string" }, "ProtocolDetails": { "$ref": "#/definitions/AWS::Transfer::Server.ProtocolDetails", - "markdownDescription": "The protocol settings that are configured for your server\\. \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\\. \nUse the `TlsSessionResumptionMode` parameter to determine whether or not your Transfer server resumes recent, negotiated sessions through a unique session ID\\. \n*Required*: No \n*Type*: [ProtocolDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The protocol settings that are configured for your server\\. \n+ To indicate passive mode \\(for FTP and FTPS protocols\\), use the `PassiveIp` parameter\\. Enter a single dotted\\-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer\\. \n+ To ignore the error that is generated when the client attempts to use the `SETSTAT` command on a file that you are uploading to an Amazon S3 bucket, use the `SetStatOption` parameter\\. To have the AWS Transfer Family server ignore the `SETSTAT` command and upload files without needing to make any changes to your SFTP client, set the value to `ENABLE_NO_OP`\\. If you set the `SetStatOption` parameter to `ENABLE_NO_OP`, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a `SETSTAT` call\\.\n+ To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the `TlsSessionResumptionMode` parameter\\.\n+ `As2Transports` indicates the transport method for the AS2 messages\\. Currently, only HTTP is supported\\.\n*Required*: No \n*Type*: [ProtocolDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProtocolDetails" }, "Protocols": { "items": { "$ref": "#/definitions/AWS::Transfer::Server.Protocol" }, - "markdownDescription": "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+ `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\nIf 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\\. \nIf `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType` must be `VPC` and the `IdentityProviderType` must be `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`\\. \nIf `Protocol` includes `FTP`, then `AddressAllocationIds` cannot be associated\\. \nIf `Protocol` is set only to `SFTP`, the `EndpointType` can be set to `PUBLIC` and the `IdentityProviderType` can be set to `SERVICE_MANAGED`\\.\n*Required*: No \n*Type*: List of [Protocol](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocol.html) \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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+ `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+ `AS2` \\(Applicability Statement 2\\): used for transporting structured business\\-to\\-business data\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+ If `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType` must be `VPC` and the `IdentityProviderType` must be either `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`\\.\n+ If `Protocol` includes `FTP`, then `AddressAllocationIds` cannot be associated\\.\n+ If `Protocol` is set only to `SFTP`, the `EndpointType` can be set to `PUBLIC` and the `IdentityProviderType` can be set any of the supported identity types: `SERVICE_MANAGED`, `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`\\.\n+ If `Protocol` includes `AS2`, then the `EndpointType` must be `VPC`, and domain must be Amazon S3\\.\n*Required*: No \n*Type*: List of [Protocol](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocol.html) \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Protocols", "type": "array" }, @@ -180077,7 +186230,7 @@ }, "WorkflowDetails": { "$ref": "#/definitions/AWS::Transfer::Server.WorkflowDetails", - "markdownDescription": "Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow\\. \n*Required*: No \n*Type*: [WorkflowDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow\\. \nIn addition to a workflow to execute when a file is uploaded completely, `WorkflowDetails` can also contain a workflow ID \\(and execution role\\) for a workflow to execute on partial upload\\. A partial upload occurs when a file is open when the session disconnects\\. \n*Required*: No \n*Type*: [WorkflowDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WorkflowDetails" } }, @@ -180186,18 +186339,22 @@ "items": { "$ref": "#/definitions/AWS::Transfer::Server.As2Transport" }, + "markdownDescription": "List of `As2Transport` objects\\. \n*Required*: No \n*Type*: List of [As2Transport](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-as2transport.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "As2Transports", "type": "array" }, "PassiveIp": { - "markdownDescription": "Indicates 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*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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 `aws transfer update-server --protocol-details PassiveIp=0.0.0.0` \nReplace `0.0.0.0` in the example above with the actual IP address you want to use\\. \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](http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/)\\. \n *Special values* \nThe `AUTO` and `0.0.0.0` are special values for the `PassiveIp` parameter\\. The value `PassiveIp=AUTO` is assigned by default to FTP and FTPS type servers\\. In this case, the server automatically responds with one of the endpoint IPs within the PASV response\\. `PassiveIp=0.0.0.0` has a more unique application for its usage\\. For example, if you have a High Availability \\(HA\\) Network Load Balancer \\(NLB\\) environment, where you have 3 subnets, you can only specify a single IP address using the `PassiveIp` parameter\\. This reduces the effectiveness of having High Availability\\. In this case, you can specify `PassiveIp=0.0.0.0`\\. This tells the client to use the same IP address as the Control connection and utilize all AZs for their connections\\. Note, however, that not all FTP clients support the `PassiveIp=0.0.0.0` response\\. FileZilla and WinSCP do support it\\. If you are using other clients, check to see if your client supports the `PassiveIp=0.0.0.0` response\\. \n*Required*: No \n*Type*: String \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PassiveIp", "type": "string" }, "SetStatOption": { + "markdownDescription": "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\\. \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\\. \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 Amazon CloudWatch Logs, so you can determine when the client is making a `SETSTAT` call\\. \nIf 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\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `DEFAULT | ENABLE_NO_OP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SetStatOption", "type": "string" }, "TlsSessionResumptionMode": { - "markdownDescription": "A property used with Transfer 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+ `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**Note** \nNot 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\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED | ENFORCED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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+ `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**Note** \nNot 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\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED | ENFORCED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TlsSessionResumptionMode", "type": "string" } @@ -180231,13 +186388,15 @@ "items": { "$ref": "#/definitions/AWS::Transfer::Server.WorkflowDetail" }, + "markdownDescription": "A trigger that starts a workflow if a file is only partially uploaded\\. You can attach a workflow to a server that executes whenever there is a partial upload\\. \nA *partial upload* occurs when a file is open when the session disconnects\\. \n*Required*: No \n*Type*: List of [WorkflowDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OnPartialUpload", "type": "array" }, "OnUpload": { "items": { "$ref": "#/definitions/AWS::Transfer::Server.WorkflowDetail" }, - "markdownDescription": "A trigger that starts a workflow: the workflow begins to execute after a file is uploaded\\. \nTo remove an associated workflow from a server, you can provide an empty `OnUpload` object, as in the following example\\. \n `aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'` \n*Required*: Yes \n*Type*: List of [WorkflowDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A trigger that starts a workflow: the workflow begins to execute after a file is uploaded\\. \nTo remove an associated workflow from a server, you can provide an empty `OnUpload` object, as in the following example\\. \n `aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'` \n*Required*: No \n*Type*: List of [WorkflowDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OnUpload", "type": "array" } @@ -180293,7 +186452,7 @@ "type": "array" }, "HomeDirectoryType": { - "markdownDescription": "The type of landing directory \\(folder\\) you want your users' home directory to be when they log into the server\\. If you set it to `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients\\. If you set it `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings` for how you want to make Amazon S3 or EFS paths visible to your users\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `LOGICAL | PATH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of landing directory \\(folder\\) that you want your users' home directory to be when they log in to the server\\. If you set it to `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients\\. If you set it `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon EFS paths visible to your users\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `LOGICAL | PATH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HomeDirectoryType", "type": "string" }, @@ -180308,7 +186467,7 @@ "title": "PosixProfile" }, "Role": { - "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system\\. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system\\. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS Identity and Access Management \\(IAM\\) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system\\. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system\\. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Role", "type": "string" }, @@ -180515,15 +186674,23 @@ "additionalProperties": false, "properties": { "DestinationFileLocation": { - "$ref": "#/definitions/AWS::Transfer::Workflow.S3FileLocation" + "$ref": "#/definitions/AWS::Transfer::Workflow.S3FileLocation", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [S3FileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3filelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DestinationFileLocation" }, "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "OverwriteExisting": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OverwriteExisting", "type": "string" }, "SourceFileLocation": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceFileLocation", "type": "string" } }, @@ -180533,15 +186700,23 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SourceFileLocation": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceFileLocation", "type": "string" }, "Target": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Target", "type": "string" }, "TimeoutSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TimeoutSeconds", "type": "number" } }, @@ -180551,18 +186726,28 @@ "additionalProperties": false, "properties": { "DestinationFileLocation": { - "$ref": "#/definitions/AWS::Transfer::Workflow.InputFileLocation" + "$ref": "#/definitions/AWS::Transfer::Workflow.InputFileLocation", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [InputFileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-inputfilelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DestinationFileLocation" }, "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "OverwriteExisting": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OverwriteExisting", "type": "string" }, "SourceFileLocation": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceFileLocation", "type": "string" }, "Type": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -180572,9 +186757,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SourceFileLocation": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceFileLocation", "type": "string" } }, @@ -180584,9 +186773,13 @@ "additionalProperties": false, "properties": { "FileSystemId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemId", "type": "string" }, "Path": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Path", "type": "string" } }, @@ -180596,10 +186789,14 @@ "additionalProperties": false, "properties": { "EfsFileLocation": { - "$ref": "#/definitions/AWS::Transfer::Workflow.EfsInputFileLocation" + "$ref": "#/definitions/AWS::Transfer::Workflow.EfsInputFileLocation", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [EfsInputFileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-efsinputfilelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EfsFileLocation" }, "S3FileLocation": { - "$ref": "#/definitions/AWS::Transfer::Workflow.S3InputFileLocation" + "$ref": "#/definitions/AWS::Transfer::Workflow.S3InputFileLocation", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [S3InputFileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3inputfilelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3FileLocation" } }, "type": "object" @@ -180608,7 +186805,9 @@ "additionalProperties": false, "properties": { "S3FileLocation": { - "$ref": "#/definitions/AWS::Transfer::Workflow.S3InputFileLocation" + "$ref": "#/definitions/AWS::Transfer::Workflow.S3InputFileLocation", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [S3InputFileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3inputfilelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3FileLocation" } }, "type": "object" @@ -180617,9 +186816,13 @@ "additionalProperties": false, "properties": { "Bucket": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Bucket", "type": "string" }, "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" } }, @@ -180629,9 +186832,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "string" } }, @@ -180645,15 +186852,21 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SourceFileLocation": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceFileLocation", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/AWS::Transfer::Workflow.S3Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [S3Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3tag.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Tags", "type": "array" } }, @@ -180664,29 +186877,31 @@ "properties": { "CopyStepDetails": { "$ref": "#/definitions/AWS::Transfer::Workflow.CopyStepDetails", - "markdownDescription": "Details for a step that performs a file copy\\. \n Consists of the following values: \n+ A description\n+ An S3 location for the destination of the file copy\\.\n+ A flag that indicates whether or not to overwrite an existing file of the same name\\. The default is `FALSE`\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Details for a step that performs a file copy\\. \n Consists of the following values: \n+ A description\n+ An Amazon S3 location for the destination of the file copy\\.\n+ A flag that indicates whether to overwrite an existing file of the same name\\. The default is `FALSE`\\.\n*Required*: No \n*Type*: [CopyStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-copystepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CopyStepDetails" }, "CustomStepDetails": { "$ref": "#/definitions/AWS::Transfer::Workflow.CustomStepDetails", - "markdownDescription": "Details for a step that invokes a lambda function\\. \n Consists of the lambda function name, target, and timeout \\(in seconds\\)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Details for a step that invokes an AWS Lambda function\\. \nConsists of the Lambda function's name, target, and timeout \\(in seconds\\)\\. \n*Required*: No \n*Type*: [CustomStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-customstepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CustomStepDetails" }, "DecryptStepDetails": { - "$ref": "#/definitions/AWS::Transfer::Workflow.DecryptStepDetails" + "$ref": "#/definitions/AWS::Transfer::Workflow.DecryptStepDetails", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DecryptStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-decryptstepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DecryptStepDetails" }, "DeleteStepDetails": { "$ref": "#/definitions/AWS::Transfer::Workflow.DeleteStepDetails", - "markdownDescription": "Details for a step that deletes the file\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Details for a step that deletes the file\\. \n*Required*: No \n*Type*: [DeleteStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-deletestepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DeleteStepDetails" }, "TagStepDetails": { "$ref": "#/definitions/AWS::Transfer::Workflow.TagStepDetails", - "markdownDescription": "Details for a step that creates one or more tags\\. \nYou specify one or more tags: each tag contains a key/value pair\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Details for a step that creates one or more tags\\. \nYou specify one or more tags\\. Each tag contains a key\\-value pair\\. \n*Required*: No \n*Type*: [TagStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-tagstepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TagStepDetails" }, "Type": { - "markdownDescription": "Currently, the following step types are supported\\. \n+ *Copy*: copy the file to another location\n+ *Custom*: custom step with a lambda target\n+ *Delete*: delete the file\n+ *Tag*: add a tag to the file\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Currently, the following step types are supported\\. \n+ ** `COPY` ** \\- Copy the file to another location\\.\n+ ** `CUSTOM` ** \\- Perform a custom step with an AWS Lambda function target\\.\n+ ** `DECRYPT` ** \\- Decrypt a file that was encrypted before it was uploaded\\.\n+ ** `DELETE` ** \\- Delete the file\\.\n+ ** `TAG` ** \\- Add a tag to the file\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -180729,18 +186944,26 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The client\\-provided description of the domain\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The client\\-provided name for the domain\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ServerSideEncryptionConfiguration": { - "$ref": "#/definitions/AWS::VoiceID::Domain.ServerSideEncryptionConfiguration" + "$ref": "#/definitions/AWS::VoiceID::Domain.ServerSideEncryptionConfiguration", + "markdownDescription": "The server\\-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data\\. \n*Required*: Yes \n*Type*: [ServerSideEncryptionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-voiceid-domain-serversideencryptionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerSideEncryptionConfiguration" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -180775,6 +186998,8 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "The identifier of the KMS key to use to encrypt data stored by Voice ID\\. Voice ID doesn't support asymmetric customer managed keys\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" } }, @@ -182812,7 +189037,7 @@ "items": { "type": "string" }, - "markdownDescription": "Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0\\. \nExamples: \n+ To configure AWS WAF to allow, block, or count requests that originated from the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses\\. All addresses must be specified using Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for `/0`\\. \nExample address strings: \n+ To configure AWS WAF to allow, block, or count requests that originated from the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \nExample JSON `Addresses` specifications: \n+ Empty array: `\"Addresses\": []` \n+ Array with one address: `\"Addresses\": [\"192.0.2.44/32\"]` \n+ Array with three addresses: `\"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]` \n+ INVALID specification: `\"Addresses\": [\"\"]` INVALID \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Addresses", "type": "array" }, @@ -182822,17 +189047,17 @@ "type": "string" }, "IPAddressVersion": { - "markdownDescription": "Specify IPV4 or IPV6\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IPV4 | IPV6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the IP addresses, either `IPV4` or `IPV6`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IPV4 | IPV6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IPAddressVersion", "type": "string" }, "Name": { - "markdownDescription": "The descriptive name of the IP set\\. You cannot change the name of an `IPSet` after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the IP set\\. You cannot change the name of an `IPSet` after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, "Scope": { - "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, or an Amazon Cognito user pool\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Scope", "type": "string" }, @@ -182912,13 +189137,13 @@ "items": { "type": "string" }, - "markdownDescription": "The logging destination configuration that you want to associate with the web ACL\\. \nYou can associate one logging destination to a web ACL\\.\nIf logging destination target is a CloudWatch Log Group, it is required that the reference Log Group's name begin with the prefix 'aws-waf-logs-'\\.\n*Required*: Yes \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The logging destination configuration that you want to associate with the web ACL\\. \nYou can associate one logging destination to a web ACL\\.\n*Required*: Yes \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogDestinationConfigs", "type": "array" }, "LoggingFilter": { "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.LoggingFilter", - "markdownDescription": "Filtering that specifies which web requests are kept in the logs and which are dropped\\. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Filtering that specifies which web requests are kept in the logs and which are dropped\\. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation\\. \n*Required*: No \n*Type*: [LoggingFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-loggingfilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoggingFilter" }, "RedactedFields": { @@ -182966,6 +189191,8 @@ "additionalProperties": false, "properties": { "Action": { + "markdownDescription": "The action setting that a log record must contain in order to meet the condition\\. This is the action that AWS WAF applied to the web request\\. \nFor rule groups, this is either the configured rule action setting, or if you've applied a rule action override to the rule, it's the override action\\. The value `EXCLUDED_AS_COUNT` matches on excluded rules and also on rules that have a rule action override of Count\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALLOW | BLOCK | CAPTCHA | CHALLENGE | COUNT | EXCLUDED_AS_COUNT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Action", "type": "string" } }, @@ -182978,10 +189205,14 @@ "additionalProperties": false, "properties": { "ActionCondition": { - "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.ActionCondition" + "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.ActionCondition", + "markdownDescription": "A single action condition\\. This is the action setting that a log record must contain in order to meet the condition\\. \n*Required*: No \n*Type*: [ActionCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-actioncondition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActionCondition" }, "LabelNameCondition": { - "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.LabelNameCondition" + "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.LabelNameCondition", + "markdownDescription": "A single label name condition\\. This is the fully qualified label name that a log record must contain in order to meet the condition\\. 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\\. \n*Required*: No \n*Type*: [LabelNameCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-labelnamecondition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LabelNameCondition" } }, "type": "object" @@ -182991,26 +189222,26 @@ "properties": { "JsonBody": { "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.JsonBody", - "markdownDescription": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-bytematchstatement) or [RegexPatternSetReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-regexpatternsetreferencestatement), with a [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-sizeconstraintstatement) that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Redact the request body JSON\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "JsonBody" }, "Method": { - "markdownDescription": "Inspect the HTTP method\\. The method indicates the type of operation that the request is asking the origin to perform\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Redact the indicated HTTP method\\. The method indicates the type of operation that the request is asking the origin to perform\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Method", "type": "object" }, "QueryString": { - "markdownDescription": "Inspect the query string\\. This is the part of a URL that appears after a `?` character, if any\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Redact the query string\\. This is the part of a URL that appears after a `?` character, if any\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "QueryString", "type": "object" }, "SingleHeader": { "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.SingleHeader", - "markdownDescription": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }` \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Redact a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }` \n*Required*: No \n*Type*: [SingleHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-singleheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SingleHeader" }, "UriPath": { - "markdownDescription": "Inspect the request URI path\\. This is the part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Redact the request URI path\\. This is the part of the web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UriPath", "type": "object" } @@ -183021,15 +189252,21 @@ "additionalProperties": false, "properties": { "Behavior": { + "markdownDescription": "How to handle logs that satisfy the filter's conditions and requirement\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DROP | KEEP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Behavior", "type": "string" }, "Conditions": { "items": { "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.Condition" }, + "markdownDescription": "Match conditions for the filter\\. \n*Required*: Yes \n*Type*: List of [Condition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-condition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Conditions", "type": "array" }, "Requirement": { + "markdownDescription": "Logic to apply to the filtering conditions\\. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `MEETS_ALL | MEETS_ANY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Requirement", "type": "string" } }, @@ -183044,12 +189281,18 @@ "additionalProperties": false, "properties": { "InvalidFallbackBehavior": { + "markdownDescription": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \n AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \n AWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InvalidFallbackBehavior", "type": "string" }, "MatchPattern": { - "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.MatchPattern" + "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.MatchPattern", + "markdownDescription": "The patterns to look for in the JSON body\\. AWS WAF inspects the results of these pattern matches against the rule inspection criteria\\. \n*Required*: Yes \n*Type*: [MatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-matchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchPattern" }, "MatchScope": { + "markdownDescription": "The parts of the JSON to match against using the `MatchPattern`\\. If you specify `All`, AWS WAF matches against keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchScope", "type": "string" } }, @@ -183063,6 +189306,8 @@ "additionalProperties": false, "properties": { "LabelName": { + "markdownDescription": "The label name that a log record must contain in order to meet the condition\\. This must be a fully qualified label name\\. 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\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LabelName", "type": "string" } }, @@ -183075,12 +189320,16 @@ "additionalProperties": false, "properties": { "DefaultBehavior": { + "markdownDescription": "Default handling for logs that don't match any of the specified filtering conditions\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DROP | KEEP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultBehavior", "type": "string" }, "Filters": { "items": { "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.Filter" }, + "markdownDescription": "The filters that you want to apply to the logs\\. \n*Required*: Yes \n*Type*: List of [Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Filters", "type": "array" } }, @@ -183094,12 +189343,16 @@ "additionalProperties": false, "properties": { "All": { + "markdownDescription": "Match all of the elements\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "All", "type": "object" }, "IncludedPaths": { "items": { "type": "string" }, + "markdownDescription": "Match only the specified include paths\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludedPaths", "type": "array" } }, @@ -183109,6 +189362,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the query header to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -183158,7 +189413,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The descriptive name of the set\\. You cannot change the name after you create the set\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the set\\. You cannot change the name after you create the set\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -183171,7 +189426,7 @@ "type": "array" }, "Scope": { - "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, or an Amazon Cognito user pool\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Scope", "type": "string" }, @@ -183250,10 +189505,12 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.LabelSummary" }, + "markdownDescription": "The labels that one or more rules in this rule group add to matching web requests\\. These labels are defined in the `RuleLabels` for a Rule\\. \n*Required*: No \n*Type*: List of [LabelSummary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelsummary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AvailableLabels", "type": "array" }, "Capacity": { - "markdownDescription": "The web ACL capacity units \\(WCUs\\) required for this rule group\\. \nWhen you create your own rule group, you define this, and you cannot change it after creation\\. When you add or modify the rules in a rule group, AWS WAF enforces this limit\\. \nAWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs\\. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule\\. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power\\. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group\\. The WCU limit for web ACLs is 1,500\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The web ACL capacity units \\(WCUs\\) required for this rule group\\. \nWhen you create your own rule group, you define this, and you cannot change it after creation\\. When you add or modify the rules in a rule group, AWS WAF enforces this limit\\. \n AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs\\. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule\\. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power\\. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group\\. The WCU limit for web ACLs is 1,500\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Capacity", "type": "number" }, @@ -183261,6 +189518,8 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.LabelSummary" }, + "markdownDescription": "The labels that one or more rules in this rule group match against in label match statements\\. These labels are defined in a `LabelMatchStatement` specification, in the [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) definition of a rule\\. \n*Required*: No \n*Type*: List of [LabelSummary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelsummary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConsumedLabels", "type": "array" }, "CustomResponseBodies": { @@ -183280,7 +189539,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The descriptive name of the rule group\\. You cannot change the name of a rule group after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the rule group\\. You cannot change the name of a rule group after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -183293,7 +189552,7 @@ "type": "array" }, "Scope": { - "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, or an Amazon Cognito user pool\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Scope", "type": "string" }, @@ -183343,7 +189602,9 @@ "additionalProperties": false, "properties": { "CustomRequestHandling": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling", + "markdownDescription": "Defines custom handling for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomRequestHandling" } }, "type": "object" @@ -183369,7 +189630,9 @@ "additionalProperties": false, "properties": { "CustomResponse": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomResponse" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomResponse", + "markdownDescription": "Defines a custom response for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomResponse" } }, "type": "object" @@ -183378,6 +189641,8 @@ "additionalProperties": false, "properties": { "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the body is larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB \\(8192 bytes\\)\\. Only the first 8 KB of the request body are forwarded to AWS WAF by the underlying host service\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the body normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nYou can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB\\. \nDefault: `CONTINUE` \n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -183388,16 +189653,16 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "PositionalConstraint": { - "markdownDescription": "The area within the portion of a web request that you want AWS WAF to search for `SearchString`\\. Valid values include the following: \n **CONTAINS** \nThe specified part of the web request must include the value of `SearchString`, but the location doesn't matter\\. \n **CONTAINS\\_WORD** \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+ `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 **EXACTLY** \nThe value of the specified part of the web request must exactly match the value of `SearchString`\\. \n **STARTS\\_WITH** \nThe value of `SearchString` must appear at the beginning of the specified part of the web request\\. \n **ENDS\\_WITH** \nThe value of `SearchString` must appear at the end of the specified part of the web request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTAINS | CONTAINS_WORD | ENDS_WITH | EXACTLY | STARTS_WITH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The area within the portion of the web request that you want AWS WAF to search for `SearchString`\\. Valid values include the following: \n **CONTAINS** \nThe specified part of the web request must include the value of `SearchString`, but the location doesn't matter\\. \n **CONTAINS\\_WORD** \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+ `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 **EXACTLY** \nThe value of the specified part of the web request must exactly match the value of `SearchString`\\. \n **STARTS\\_WITH** \nThe value of `SearchString` must appear at the beginning of the specified part of the web request\\. \n **ENDS\\_WITH** \nThe value of `SearchString` must appear at the end of the specified part of the web request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTAINS | CONTAINS_WORD | ENDS_WITH | EXACTLY | STARTS_WITH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PositionalConstraint", "type": "string" }, "SearchString": { - "markdownDescription": "A string value that you want AWS WAF to search for\\. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch`\\. The maximum length of the value is 50 bytes\\. For alphabetic characters A\\-Z and a\\-z, the value is case sensitive\\. \nDon't encode this string\\. Provide the value that you want AWS WAF to search for\\. AWS CloudFormation automatically base64 encodes the value for you\\. \nFor example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent`\\. If you want to search the `User-Agent` header for the value `BadBot`, you provide the string `BadBot` in the value of `SearchString`\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string value that you want AWS WAF to search for\\. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch`\\. The maximum length of the value is 200 bytes\\. For alphabetic characters A\\-Z and a\\-z, the value is case sensitive\\. \nDon't encode this string\\. Provide the value that you want AWS WAF to search for\\. AWS CloudFormation automatically base64 encodes the value for you\\. \nFor example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent`\\. If you want to search the `User-Agent` header for the value `BadBot`, you provide the string `BadBot` in the value of `SearchString`\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SearchString", "type": "string" }, @@ -183410,7 +189675,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -183426,7 +189691,9 @@ "additionalProperties": false, "properties": { "CustomRequestHandling": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling", + "markdownDescription": "Defines custom handling for the web request, used when the `CAPTCHA` inspection determines that the request's token is valid and unexpired\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomRequestHandling" } }, "type": "object" @@ -183436,7 +189703,7 @@ "properties": { "ImmunityTimeProperty": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ImmunityTimeProperty", - "markdownDescription": "Determines how long a `CAPTCHA` token remains valid after the client successfully solves a `CAPTCHA` puzzle\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines how long a `CAPTCHA` timestamp in the token remains valid after the client successfully solves a `CAPTCHA` puzzle\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ImmunityTimeProperty" } }, @@ -183446,7 +189713,9 @@ "additionalProperties": false, "properties": { "CustomRequestHandling": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling", + "markdownDescription": "Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomRequestHandling" } }, "type": "object" @@ -183455,7 +189724,9 @@ "additionalProperties": false, "properties": { "ImmunityTimeProperty": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ImmunityTimeProperty" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ImmunityTimeProperty", + "markdownDescription": "Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImmunityTimeProperty" } }, "type": "object" @@ -183464,18 +189735,24 @@ "additionalProperties": false, "properties": { "All": { + "markdownDescription": "Inspect all cookies\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "All", "type": "object" }, "ExcludedCookies": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the cookies whose keys don't match any of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExcludedCookies", "type": "array" }, "IncludedCookies": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the cookies that have a key that matches one of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludedCookies", "type": "array" } }, @@ -183485,12 +189762,18 @@ "additionalProperties": false, "properties": { "MatchPattern": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CookieMatchPattern" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CookieMatchPattern", + "markdownDescription": "The filter to use to identify the subset of cookies to inspect in a web request\\. \nYou must specify exactly one setting: either `All`, `IncludedCookies`, or `ExcludedCookies`\\. \nExample JSON: `\"MatchPattern\": { \"IncludedCookies\": {\"KeyToInclude1\", \"KeyToInclude2\", \"KeyToInclude3\"} }` \n*Required*: Yes \n*Type*: [CookieMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookiematchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchPattern" }, "MatchScope": { + "markdownDescription": "The parts of the cookies to inspect with the rule inspection criteria\\. If you specify `All`, AWS WAF inspects both keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchScope", "type": "string" }, "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the cookies of the request are larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB \\(8192 bytes\\) or 200 total cookies\\. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the cookies normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -183505,7 +189788,9 @@ "additionalProperties": false, "properties": { "CustomRequestHandling": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling", + "markdownDescription": "Defines custom handling for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomRequestHandling" } }, "type": "object" @@ -183514,9 +189799,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the custom header\\. \nFor custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name `x-amzn-waf-`, to avoid confusion with the headers that are already in the request\\. For example, for the header name `sample`, AWS WAF inserts the header `x-amzn-waf-sample`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9._$-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Value": { + "markdownDescription": "The value of the custom header\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -183533,6 +189822,8 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomHTTPHeader" }, + "markdownDescription": "The HTTP headers to insert into the request\\. Duplicate header names are not allowed\\. \nFor information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: Yes \n*Type*: List of [CustomHTTPHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customhttpheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InsertHeaders", "type": "array" } }, @@ -183545,15 +189836,21 @@ "additionalProperties": false, "properties": { "CustomResponseBodyKey": { + "markdownDescription": "References the response body that you want AWS WAF to return to the web request client\\. You can define a custom response for a rule action or a default web ACL action that is set to block\\. To do this, you first define the response body key and value in the `CustomResponseBodies` setting for the [AWS::WAFv2::WebACL](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html) or [AWS::WAFv2::RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html) where you want to use it\\. Then, in the rule action or web ACL default action `BlockAction` setting, you reference the response body using this key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomResponseBodyKey", "type": "string" }, "ResponseCode": { + "markdownDescription": "The HTTP status code to return to the client\\. \nFor a list of status codes that you can use in your custom responses, see [Supported status codes for custom response](https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `200` \n*Maximum*: `599` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResponseCode", "type": "number" }, "ResponseHeaders": { "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomHTTPHeader" }, + "markdownDescription": "The HTTP headers to use in the response\\. Duplicate header names are not allowed\\. \nFor information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: List of [CustomHTTPHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customhttpheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResponseHeaders", "type": "array" } }, @@ -183592,18 +189889,22 @@ }, "Body": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Body", - "markdownDescription": "Inspect the request body, which immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the `ByteMatchStatement` or `RegexPatternSetReferenceStatement`, with a `SizeConstraintStatement` that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect the request body as plain text\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nOnly the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. For information about how to handle oversized request bodies, see the `Body` object configuration\\. \n*Required*: No \n*Type*: [Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-body.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Body" }, "Cookies": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Cookies" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Cookies", + "markdownDescription": "Inspect the request cookies\\. You must configure scope and pattern matching filters in the `Cookies` object, to define the set of cookies and the parts of the cookies that AWS WAF inspects\\. \nOnly the first 8 KB \\(8192 bytes\\) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service\\. You must configure how to handle any oversize cookie content in the `Cookies` object\\. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service\\. \n*Required*: No \n*Type*: [Cookies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookies.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cookies" }, "Headers": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Headers" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Headers", + "markdownDescription": "Inspect the request headers\\. You must configure scope and pattern matching filters in the `Headers` object, to define the set of headers to and the parts of the headers that AWS WAF inspects\\. \nOnly the first 8 KB \\(8192 bytes\\) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service\\. You must configure how to handle any oversize header content in the `Headers` object\\. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service\\. \n*Required*: No \n*Type*: [Headers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headers.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Headers" }, "JsonBody": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.JsonBody", - "markdownDescription": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the `ByteMatchStatement` or `RegexPatternSetReferenceStatement`, with a `SizeConstraintStatement` that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nOnly the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. For information about how to handle oversized request bodies, see the `JsonBody` object configuration\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "JsonBody" }, "Method": { @@ -183618,16 +189919,16 @@ }, "SingleHeader": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SingleHeader", - "markdownDescription": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }` \nAlternately, you can filter and inspect all headers with the `Headers` `FieldToMatch` setting\\. \n*Required*: No \n*Type*: [SingleHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-singleheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SingleHeader" }, "SingleQueryArgument": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SingleQueryArgument", - "markdownDescription": "Inspect a single query argument\\. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*\\. The name can be up to 30 characters long and isn't case sensitive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect a single query argument\\. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*\\. The name can be up to 30 characters long and isn't case sensitive\\. \nExample JSON: `\"SingleQueryArgument\": { \"Name\": \"myArgument\" }` \n*Required*: No \n*Type*: [SingleQueryArgument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-singlequeryargument.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SingleQueryArgument" }, "UriPath": { - "markdownDescription": "Inspect the request URI path\\. This is the part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect the request URI path\\. This is the part of the web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UriPath", "type": "object" } @@ -183661,7 +189962,7 @@ "items": { "type": "string" }, - "markdownDescription": "An array of two\\-character country codes, for example, `[ \"US\", \"CN\" ]`, from the alpha\\-2 country ISO codes of the ISO 3166 international standard\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of two\\-character country codes that you want to match against, for example, `[ \"US\", \"CN\" ]`, from the alpha\\-2 country ISO codes of the ISO 3166 international standard\\. \nWhen you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate\\. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches\\. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CountryCodes", "type": "array" }, @@ -183677,18 +189978,24 @@ "additionalProperties": false, "properties": { "All": { + "markdownDescription": "Inspect all headers\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "All", "type": "object" }, "ExcludedHeaders": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the headers whose keys don't match any of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExcludedHeaders", "type": "array" }, "IncludedHeaders": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the headers that have a key that matches one of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludedHeaders", "type": "array" } }, @@ -183698,12 +190005,18 @@ "additionalProperties": false, "properties": { "MatchPattern": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.HeaderMatchPattern" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.HeaderMatchPattern", + "markdownDescription": "The filter to use to identify the subset of headers to inspect in a web request\\. \nYou must specify exactly one setting: either `All`, `IncludedHeaders`, or `ExcludedHeaders`\\. \nExample JSON: `\"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }` \n*Required*: Yes \n*Type*: [HeaderMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headermatchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchPattern" }, "MatchScope": { + "markdownDescription": "The parts of the headers to match with the rule inspection criteria\\. If you specify `All`, AWS WAF inspects both keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchScope", "type": "string" }, "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the headers of the request are larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB \\(8192 bytes\\) or 200 total headers\\. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the headers normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -183763,7 +190076,7 @@ "additionalProperties": false, "properties": { "ImmunityTime": { - "markdownDescription": "The amount of time, in seconds, that a `CAPTCHA` token is valid\\. The default setting is 300\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of time, in seconds, that a `CAPTCHA` or challenge timestamp is considered valid by AWS WAF\\. The default setting is 300\\. \nFor the Challenge action, the minimum setting is 300\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ImmunityTime", "type": "number" } @@ -183777,7 +190090,7 @@ "additionalProperties": false, "properties": { "InvalidFallbackBehavior": { - "markdownDescription": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \nAWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \nAWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \n AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \n AWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InvalidFallbackBehavior", "type": "string" }, @@ -183792,6 +190105,8 @@ "type": "string" }, "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the body is larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB \\(8192 bytes\\)\\. Only the first 8 KB of the request body are forwarded to AWS WAF by the underlying host service\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the body normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nYou can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB\\. \nDefault: `CONTINUE` \n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -183805,7 +190120,7 @@ "additionalProperties": false, "properties": { "All": { - "markdownDescription": "Match all of the elements\\. See also `MatchScope` in `JsonBody`\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Match all of the elements\\. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "All", "type": "object" }, @@ -183813,7 +190128,7 @@ "items": { "type": "string" }, - "markdownDescription": "Match only the specified include paths\\. See also `MatchScope` in `JsonBody`\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Match only the specified include paths\\. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludedPaths", "type": "array" } @@ -183824,7 +190139,7 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The label string\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The label string\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" } @@ -183838,12 +190153,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The string to match against\\. The setting you provide for this depends on the match statement's `Scope` setting: \n+ If the `Scope` indicates `LABEL`, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name\\. \n+ If the `Scope` indicates `NAMESPACE`, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates\\.\nLabels are case sensitive and components of a label must be separated by colon, for example `NS1:NS2:name`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The string to match against\\. The setting you provide for this depends on the match statement's `Scope` setting: \n+ If the `Scope` indicates `LABEL`, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name\\. \n+ If the `Scope` indicates `NAMESPACE`, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates\\.\nLabels are case sensitive and components of a label must be separated by colon, for example `NS1:NS2:name`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Scope": { - "markdownDescription": "Specify whether you want to match using the label name or just the namespace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify whether you want to match using the label name or just the namespace\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `LABEL | NAMESPACE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Scope", "type": "string" } @@ -183858,7 +190173,7 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "An individual label specification\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An individual label specification\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" } @@ -183916,7 +190231,7 @@ }, "ScopeDownStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Statement", - "markdownDescription": "An optional nested statement that narrows the scope of the rate\\-based statement to matching web requests\\. This can be any nestable statement, and you can nest statements at any level below this scope\\-down statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional nested statement that narrows the scope of the web requests that are evaluated by the rate\\-based statement\\. Requests are only tracked by the rate\\-based statement if they match the scope\\-down statement\\. You can use any nestable statement in the scope\\-down statement, and you can nest statements at any level, the same as you can for a rule statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScopeDownStatement" } }, @@ -183931,7 +190246,7 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. For more information, see `FieldToMatch`\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "RegexString": { @@ -183959,20 +190274,20 @@ "additionalProperties": false, "properties": { "Arn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the regular expression pattern set that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the [AWS::WAFv2::RegexPatternSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html) that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Arn", "type": "string" }, "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "TextTransformations": { "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -183989,7 +190304,7 @@ "properties": { "Action": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.RuleAction", - "markdownDescription": "The action that AWS WAF should take on a web request when it matches the rule's statement\\. Settings at the web ACL level can override the rule action setting\\. \n*Required*: No \n*Type*: [RuleAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action that AWS WAF should take on a web request when it matches the rule statement\\. Settings at the web ACL level can override the rule action setting\\. \n*Required*: No \n*Type*: [RuleAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Action" }, "CaptchaConfig": { @@ -183998,10 +190313,12 @@ "title": "CaptchaConfig" }, "ChallengeConfig": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ChallengeConfig" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ChallengeConfig", + "markdownDescription": "Specifies how AWS WAF should handle `Challenge` evaluations\\. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL\\. \n*Required*: No \n*Type*: [ChallengeConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-challengeconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ChallengeConfig" }, "Name": { - "markdownDescription": "The descriptive name of the rule\\. You can't change the name of a `Rule` after you create it\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the rule\\. You can't change the name of a `Rule` after you create it\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -184020,7 +190337,7 @@ }, "Statement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Statement", - "markdownDescription": "The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS WAF processing statement for the rule, for example [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-bytematchstatement) or [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-sizeconstraintstatement)\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Statement" }, "VisibilityConfig": { @@ -184042,12 +190359,12 @@ "properties": { "Allow": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.AllowAction", - "markdownDescription": "Instructs AWS WAF to allow the web request\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instructs AWS WAF to allow the web request\\. \n*Required*: No \n*Type*: [AllowAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-allowaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Allow" }, "Block": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.BlockAction", - "markdownDescription": "Instructs AWS WAF to block the web request\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instructs AWS WAF to block the web request\\. \n*Required*: No \n*Type*: [BlockAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-blockaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Block" }, "Captcha": { @@ -184056,11 +190373,13 @@ "title": "Captcha" }, "Challenge": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ChallengeAction" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ChallengeAction", + "markdownDescription": "Instructs AWS WAF to run a `Challenge` check against the web request\\. \n*Required*: No \n*Type*: [ChallengeAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-challengeaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Challenge" }, "Count": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CountAction", - "markdownDescription": "Instructs AWS WAF to count the web request and allow it\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL\\. \n*Required*: No \n*Type*: [CountAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-countaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Count" } }, @@ -184070,6 +190389,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the query header to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -184082,6 +190403,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the query argument to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -184100,7 +190423,7 @@ }, "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "Size": { @@ -184112,7 +190435,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -184130,17 +190453,19 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "SensitivityLevel": { + "markdownDescription": "The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks\\. \n `HIGH` detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings\\. For information about identifying and mitigating false positives, see [Testing and tuning](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-testing.html) in the * AWS WAF Developer Guide*\\. \n `LOW` is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives\\. \nDefault: `LOW` \n*Required*: No \n*Type*: String \n*Allowed values*: `HIGH | LOW` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SensitivityLevel", "type": "string" }, "TextTransformations": { "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -184156,17 +190481,17 @@ "properties": { "AndStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.AndStatement", - "markdownDescription": "A logical rule statement used to combine other rule statements with AND logic\\. You provide more than one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `AndStatement`\\. \n*Required*: No \n*Type*: [AndStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A logical rule statement used to combine other rule statements with AND logic\\. You provide more than one `Statement` within the `AndStatement`\\. \n*Required*: No \n*Type*: [AndStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AndStatement" }, "ByteMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ByteMatchStatement", - "markdownDescription": "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 refered to as a string match statement\\. \n*Required*: No \n*Type*: [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ByteMatchStatement" }, "GeoMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.GeoMatchStatement", - "markdownDescription": "A rule statement used to identify web requests based on country of origin\\. \n*Required*: No \n*Type*: [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A rule statement that labels web requests by country and region and that matches against web requests based on country code\\. A geo match rule labels every request that it inspects regardless of whether it finds a match\\. \n+ To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the `CountryCodes` array\\. \n+ Otherwise, configure your geo match rule with Count action so that it only labels requests\\. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed\\. \n AWS WAF labels requests using the alpha\\-2 country and region codes from the International Organization for Standardization \\(ISO\\) 3166 standard\\. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match `ForwardedIPConfig`\\. \nIf you use the web request origin, the label formats are `awswaf:clientip:geo:region:-` and `awswaf:clientip:geo:country:`\\. \nIf you use a forwarded IP address, the label formats are `awswaf:forwardedip:geo:region:-` and `awswaf:forwardedip:geo:country:`\\. \nFor additional details, see [Geographic match rule statement](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "GeoMatchStatement" }, "IPSetReferenceStatement": { @@ -184176,22 +190501,22 @@ }, "LabelMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.LabelMatchStatement", - "markdownDescription": "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\\. \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\\. \n*Required*: No \n*Type*: [LabelMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL\\. \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\\. \n*Required*: No \n*Type*: [LabelMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LabelMatchStatement" }, "NotStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.NotStatement", - "markdownDescription": "A logical rule statement used to negate the results of another rule statement\\. You provide one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `NotStatement`\\. \n*Required*: No \n*Type*: [NotStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A logical rule statement used to negate the results of another rule statement\\. You provide one `Statement` within the `NotStatement`\\. \n*Required*: No \n*Type*: [NotStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NotStatement" }, "OrStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.OrStatement", - "markdownDescription": "A logical rule statement used to combine other rule statements with OR logic\\. You provide more than one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `OrStatement`\\. \n*Required*: No \n*Type*: [OrStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A logical rule statement used to combine other rule statements with OR logic\\. You provide more than one `Statement` within the `OrStatement`\\. \n*Required*: No \n*Type*: [OrStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OrStatement" }, "RateBasedStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.RateBasedStatement", - "markdownDescription": "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\\. \nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit\\. \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+ 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\\.\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 conditions in the statements are counted\\. If the count exceeds 1,000 requests per five minutes, the rule action triggers\\. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule\\. \nYou cannot nest a `RateBasedStatement`, for example for use inside a `NotStatement` or `OrStatement`\\. It can only be referenced as a top\\-level statement within a rule\\. \n*Required*: No \n*Type*: [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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 AWS 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\\. \nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit\\. \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+ An IP match statement with an IP set that specifies the address 192\\.0\\.2\\.44\\.\n+ A string match statement that searches in the User\\-Agent header for the string BadBot\\.\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\\. \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\\. \n*Required*: No \n*Type*: [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RateBasedStatement" }, "RegexMatchStatement": { @@ -184206,17 +190531,17 @@ }, "SizeConstraintStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SizeConstraintStatement", - "markdownDescription": "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\\. \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 can create a size constraint condition and block requests that have a request body greater than 8192 bytes\\. \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\\. \n*Required*: No \n*Type*: [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \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\\. \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\\. \n*Required*: No \n*Type*: [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SizeConstraintStatement" }, "SqliMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SqliMatchStatement", - "markdownDescription": "Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database\\. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions\\. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect\\. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code\\. \n*Required*: No \n*Type*: [SqliMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: [SqliMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SqliMatchStatement" }, "XssMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.XssMatchStatement", - "markdownDescription": "A rule statement that defines a cross\\-site scripting \\(XSS\\) match search for AWS WAF to apply to web requests\\. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client\\-site scripts into other legitimate web browsers\\. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings\\. \n*Required*: No \n*Type*: [XssMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: [XssMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "XssMatchStatement" } }, @@ -184251,7 +190576,7 @@ "type": "boolean" }, "MetricName": { - "markdownDescription": "The descriptive name of the Amazon CloudWatch metric\\. The name can contain only alphanumeric characters \\(A\\-Z, a\\-z, 0\\-9\\), with length from one to 128 characters\\. It can't contain whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default\\_Action\\.\" You can't change a `MetricName` after you create a `VisibilityConfig`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A name of the Amazon CloudWatch metric dimension\\. The name can contain only the characters: A\\-Z, a\\-z, 0\\-9, \\- \\(hyphen\\), and \\_ \\(underscore\\)\\. The name can be from one to 128 characters long\\. It can't contain whitespace or metric names that are reserved for AWS WAF, for example `All` and `Default_Action`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricName", "type": "string" }, @@ -184273,14 +190598,14 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "TextTransformations": { "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -184332,7 +190657,9 @@ "title": "CaptchaConfig" }, "ChallengeConfig": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ChallengeConfig" + "$ref": "#/definitions/AWS::WAFv2::WebACL.ChallengeConfig", + "markdownDescription": "Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own `ChallengeConfig` settings\\. If you don't specify this, AWS WAF uses its default settings for `ChallengeConfig`\\. \n*Required*: No \n*Type*: [ChallengeConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-challengeconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ChallengeConfig" }, "CustomResponseBodies": { "additionalProperties": false, @@ -184356,7 +190683,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The descriptive name of the web ACL\\. You cannot change the name of a web ACL after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the web ACL\\. You cannot change the name of a web ACL after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -184369,7 +190696,7 @@ "type": "array" }, "Scope": { - "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\nFor information about how to define the association of the web ACL with your resource, see [AWS::WAFv2::WebACLAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, or an Amazon Cognito user pool\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\nFor information about how to define the association of the web ACL with your resource, see [AWS::WAFv2::WebACLAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Scope", "type": "string" }, @@ -184385,6 +190712,8 @@ "items": { "type": "string" }, + "markdownDescription": "Specifies the domains that AWS WAF should accept in a web request token\\. This enables the use of tokens across multiple protected websites\\. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting\\. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource\\. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TokenDomains", "type": "array" }, "VisibilityConfig": { @@ -184425,6 +190754,8 @@ "additionalProperties": false, "properties": { "InspectionLevel": { + "markdownDescription": "The inspection level to use for the Bot Control rule group\\. The common level is the least expensive\\. The targeted level includes all common level rules and adds rules with more advanced inspection criteria\\. For details, see [AWS WAF Bot Control rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InspectionLevel", "type": "string" } }, @@ -184476,6 +190807,8 @@ "additionalProperties": false, "properties": { "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the body is larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB \\(8192 bytes\\)\\. Only the first 8 KB of the request body are forwarded to AWS WAF by the underlying host service\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the body normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nYou can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB\\. \nDefault: `CONTINUE` \n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -184486,16 +190819,16 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "PositionalConstraint": { - "markdownDescription": "The area within the portion of a web request that you want AWS WAF to search for `SearchString`\\. Valid values include the following: \n **CONTAINS** \nThe specified part of the web request must include the value of `SearchString`, but the location doesn't matter\\. \n **CONTAINS\\_WORD** \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+ `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 **EXACTLY** \nThe value of the specified part of the web request must exactly match the value of `SearchString`\\. \n **STARTS\\_WITH** \nThe value of `SearchString` must appear at the beginning of the specified part of the web request\\. \n **ENDS\\_WITH** \nThe value of `SearchString` must appear at the end of the specified part of the web request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTAINS | CONTAINS_WORD | ENDS_WITH | EXACTLY | STARTS_WITH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The area within the portion of the web request that you want AWS WAF to search for `SearchString`\\. Valid values include the following: \n **CONTAINS** \nThe specified part of the web request must include the value of `SearchString`, but the location doesn't matter\\. \n **CONTAINS\\_WORD** \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+ `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 **EXACTLY** \nThe value of the specified part of the web request must exactly match the value of `SearchString`\\. \n **STARTS\\_WITH** \nThe value of `SearchString` must appear at the beginning of the specified part of the web request\\. \n **ENDS\\_WITH** \nThe value of `SearchString` must appear at the end of the specified part of the web request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTAINS | CONTAINS_WORD | ENDS_WITH | EXACTLY | STARTS_WITH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PositionalConstraint", "type": "string" }, "SearchString": { - "markdownDescription": "A string value that you want AWS WAF to search for\\. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch`\\. The maximum length of the value is 50 bytes\\. For alphabetic characters A\\-Z and a\\-z, the value is case sensitive\\. \nDon't encode this string\\. Provide the value that you want AWS WAF to search for\\. AWS CloudFormation automatically base64 encodes the value for you\\. \nFor example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent`\\. If you want to search the `User-Agent` header for the value `BadBot`, you provide the string `BadBot` in the value of `SearchString`\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string value that you want AWS WAF to search for\\. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch`\\. The maximum length of the value is 200 bytes\\. For alphabetic characters A\\-Z and a\\-z, the value is case sensitive\\. \nDon't encode this string\\. Provide the value that you want AWS WAF to search for\\. AWS CloudFormation automatically base64 encodes the value for you\\. \nFor example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent`\\. If you want to search the `User-Agent` header for the value `BadBot`, you provide the string `BadBot` in the value of `SearchString`\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SearchString", "type": "string" }, @@ -184508,7 +190841,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -184525,7 +190858,7 @@ "properties": { "CustomRequestHandling": { "$ref": "#/definitions/AWS::WAFv2::WebACL.CustomRequestHandling", - "markdownDescription": "Defines custom handling for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Defines custom handling for the web request, used when the `CAPTCHA` inspection determines that the request's token is valid and unexpired\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomRequestHandling" } }, @@ -184536,7 +190869,7 @@ "properties": { "ImmunityTimeProperty": { "$ref": "#/definitions/AWS::WAFv2::WebACL.ImmunityTimeProperty", - "markdownDescription": "Determines how long a `CAPTCHA` token remains valid after the client successfully solves a `CAPTCHA` puzzle\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines how long a `CAPTCHA` timestamp in the token remains valid after the client successfully solves a `CAPTCHA` puzzle\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ImmunityTimeProperty" } }, @@ -184546,7 +190879,9 @@ "additionalProperties": false, "properties": { "CustomRequestHandling": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.CustomRequestHandling" + "$ref": "#/definitions/AWS::WAFv2::WebACL.CustomRequestHandling", + "markdownDescription": "Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomRequestHandling" } }, "type": "object" @@ -184555,7 +190890,9 @@ "additionalProperties": false, "properties": { "ImmunityTimeProperty": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ImmunityTimeProperty" + "$ref": "#/definitions/AWS::WAFv2::WebACL.ImmunityTimeProperty", + "markdownDescription": "Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImmunityTimeProperty" } }, "type": "object" @@ -184564,18 +190901,24 @@ "additionalProperties": false, "properties": { "All": { + "markdownDescription": "Inspect all cookies\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "All", "type": "object" }, "ExcludedCookies": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the cookies whose keys don't match any of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExcludedCookies", "type": "array" }, "IncludedCookies": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the cookies that have a key that matches one of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludedCookies", "type": "array" } }, @@ -184585,12 +190928,18 @@ "additionalProperties": false, "properties": { "MatchPattern": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.CookieMatchPattern" + "$ref": "#/definitions/AWS::WAFv2::WebACL.CookieMatchPattern", + "markdownDescription": "The filter to use to identify the subset of cookies to inspect in a web request\\. \nYou must specify exactly one setting: either `All`, `IncludedCookies`, or `ExcludedCookies`\\. \nExample JSON: `\"MatchPattern\": { \"IncludedCookies\": {\"KeyToInclude1\", \"KeyToInclude2\", \"KeyToInclude3\"} }` \n*Required*: Yes \n*Type*: [CookieMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookiematchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchPattern" }, "MatchScope": { + "markdownDescription": "The parts of the cookies to inspect with the rule inspection criteria\\. If you specify `All`, AWS WAF inspects both keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchScope", "type": "string" }, "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the cookies of the request are larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB \\(8192 bytes\\) or 200 total cookies\\. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the cookies normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -184658,7 +191007,7 @@ "type": "string" }, "ResponseCode": { - "markdownDescription": "The HTTP status code to return to the client\\. \nFor a list of status codes that you can use in your custom reqponses, see [Supported status codes for custom response](https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `200` \n*Maximum*: `599` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The HTTP status code to return to the client\\. \nFor a list of status codes that you can use in your custom responses, see [Supported status codes for custom response](https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `200` \n*Maximum*: `599` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResponseCode", "type": "number" }, @@ -184716,7 +191065,7 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of the rule to exclude\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the rule whose action you want to override to `Count`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" } @@ -184750,18 +191099,22 @@ }, "Body": { "$ref": "#/definitions/AWS::WAFv2::WebACL.Body", - "markdownDescription": "Inspect the request body, which immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the `ByteMatchStatement` or `RegexPatternSetReferenceStatement`, with a `SizeConstraintStatement` that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect the request body as plain text\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nOnly the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. For information about how to handle oversized request bodies, see the `Body` object configuration\\. \n*Required*: No \n*Type*: [Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-body.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Body" }, "Cookies": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.Cookies" + "$ref": "#/definitions/AWS::WAFv2::WebACL.Cookies", + "markdownDescription": "Inspect the request cookies\\. You must configure scope and pattern matching filters in the `Cookies` object, to define the set of cookies and the parts of the cookies that AWS WAF inspects\\. \nOnly the first 8 KB \\(8192 bytes\\) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service\\. You must configure how to handle any oversize cookie content in the `Cookies` object\\. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service\\. \n*Required*: No \n*Type*: [Cookies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookies.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cookies" }, "Headers": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.Headers" + "$ref": "#/definitions/AWS::WAFv2::WebACL.Headers", + "markdownDescription": "Inspect the request headers\\. You must configure scope and pattern matching filters in the `Headers` object, to define the set of headers to and the parts of the headers that AWS WAF inspects\\. \nOnly the first 8 KB \\(8192 bytes\\) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service\\. You must configure how to handle any oversize header content in the `Headers` object\\. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service\\. \n*Required*: No \n*Type*: [Headers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headers.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Headers" }, "JsonBody": { "$ref": "#/definitions/AWS::WAFv2::WebACL.JsonBody", - "markdownDescription": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the `ByteMatchStatement` or `RegexPatternSetReferenceStatement`, with a `SizeConstraintStatement` that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nOnly the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. For information about how to handle oversized request bodies, see the `JsonBody` object configuration\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "JsonBody" }, "Method": { @@ -184776,16 +191129,16 @@ }, "SingleHeader": { "$ref": "#/definitions/AWS::WAFv2::WebACL.SingleHeader", - "markdownDescription": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }` \nAlternately, you can filter and inspect all headers with the `Headers` `FieldToMatch` setting\\. \n*Required*: No \n*Type*: [SingleHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-singleheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SingleHeader" }, "SingleQueryArgument": { "$ref": "#/definitions/AWS::WAFv2::WebACL.SingleQueryArgument", - "markdownDescription": "Inspect a single query argument\\. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*\\. The name can be up to 30 characters long and isn't case sensitive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect a single query argument\\. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*\\. The name can be up to 30 characters long and isn't case sensitive\\. \nExample JSON: `\"SingleQueryArgument\": { \"Name\": \"myArgument\" }` \n*Required*: No \n*Type*: [SingleQueryArgument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-singlequeryargument.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SingleQueryArgument" }, "UriPath": { - "markdownDescription": "Inspect the request URI path\\. This is the part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect the request URI path\\. This is the part of the web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UriPath", "type": "object" } @@ -184819,7 +191172,7 @@ "items": { "type": "string" }, - "markdownDescription": "An array of two\\-character country codes, for example, `[ \"US\", \"CN\" ]`, from the alpha\\-2 country ISO codes of the ISO 3166 international standard\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of two\\-character country codes that you want to match against, for example, `[ \"US\", \"CN\" ]`, from the alpha\\-2 country ISO codes of the ISO 3166 international standard\\. \nWhen you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate\\. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches\\. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CountryCodes", "type": "array" }, @@ -184835,18 +191188,24 @@ "additionalProperties": false, "properties": { "All": { + "markdownDescription": "Inspect all headers\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "All", "type": "object" }, "ExcludedHeaders": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the headers whose keys don't match any of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExcludedHeaders", "type": "array" }, "IncludedHeaders": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the headers that have a key that matches one of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludedHeaders", "type": "array" } }, @@ -184856,12 +191215,18 @@ "additionalProperties": false, "properties": { "MatchPattern": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.HeaderMatchPattern" + "$ref": "#/definitions/AWS::WAFv2::WebACL.HeaderMatchPattern", + "markdownDescription": "The filter to use to identify the subset of headers to inspect in a web request\\. \nYou must specify exactly one setting: either `All`, `IncludedHeaders`, or `ExcludedHeaders`\\. \nExample JSON: `\"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }` \n*Required*: Yes \n*Type*: [HeaderMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headermatchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchPattern" }, "MatchScope": { + "markdownDescription": "The parts of the headers to match with the rule inspection criteria\\. If you specify `All`, AWS WAF inspects both keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchScope", "type": "string" }, "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the headers of the request are larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB \\(8192 bytes\\) or 200 total headers\\. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the headers normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -184902,7 +191267,7 @@ "additionalProperties": false, "properties": { "Arn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IP set that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the [AWS::WAFv2::IPSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html) that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Arn", "type": "string" }, @@ -184921,7 +191286,7 @@ "additionalProperties": false, "properties": { "ImmunityTime": { - "markdownDescription": "The amount of time, in seconds, that a `CAPTCHA` token is valid\\. The default setting is 300\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of time, in seconds, that a `CAPTCHA` or challenge timestamp is considered valid by AWS WAF\\. The default setting is 300\\. \nFor the Challenge action, the minimum setting is 300\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ImmunityTime", "type": "number" } @@ -184935,7 +191300,7 @@ "additionalProperties": false, "properties": { "InvalidFallbackBehavior": { - "markdownDescription": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \nAWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \nAWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \n AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \n AWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InvalidFallbackBehavior", "type": "string" }, @@ -184945,11 +191310,13 @@ "title": "MatchPattern" }, "MatchScope": { - "markdownDescription": "The parts of the JSON to match against using the `MatchPattern`\\. If you specify `All`, AWS WAF matches against keys and values\\. \nValid Values: `ALL` \\| `KEY` \\| `VALUE` \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The parts of the JSON to match against using the `MatchPattern`\\. If you specify `All`, AWS WAF matches against keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MatchScope", "type": "string" }, "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the body is larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB \\(8192 bytes\\)\\. Only the first 8 KB of the request body are forwarded to AWS WAF by the underlying host service\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the body normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nYou can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB\\. \nDefault: `CONTINUE` \n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -184963,7 +191330,7 @@ "additionalProperties": false, "properties": { "All": { - "markdownDescription": "Match all of the elements\\. See also `MatchScope` in `JsonBody`\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Match all of the elements\\. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "All", "type": "object" }, @@ -184971,7 +191338,7 @@ "items": { "type": "string" }, - "markdownDescription": "Match only the specified include paths\\. See also `MatchScope` in `JsonBody`\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Match only the specified include paths\\. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludedPaths", "type": "array" } @@ -184996,12 +191363,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The string to match against\\. The setting you provide for this depends on the match statement's `Scope` setting: \n+ If the `Scope` indicates `LABEL`, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name\\. \n+ If the `Scope` indicates `NAMESPACE`, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates\\.\nLabels are case sensitive and components of a label must be separated by colon, for example `NS1:NS2:name`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The string to match against\\. The setting you provide for this depends on the match statement's `Scope` setting: \n+ If the `Scope` indicates `LABEL`, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name\\. \n+ If the `Scope` indicates `NAMESPACE`, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates\\.\nLabels are case sensitive and components of a label must be separated by colon, for example `NS1:NS2:name`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Scope": { - "markdownDescription": "Specify whether you want to match using the label name or just the namespace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify whether you want to match using the label name or just the namespace\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `LABEL | NAMESPACE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Scope", "type": "string" } @@ -185016,26 +191383,28 @@ "additionalProperties": false, "properties": { "AWSManagedRulesBotControlRuleSet": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.AWSManagedRulesBotControlRuleSet" + "$ref": "#/definitions/AWS::WAFv2::WebACL.AWSManagedRulesBotControlRuleSet", + "markdownDescription": "Additional configuration for using the Bot Control managed rule group\\. Use this to specify the inspection level that you want to use\\. For information about using the Bot Control managed rule group, see [AWS WAF Bot Control rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html) and [AWS WAF Bot Control](https://docs.aws.amazon.com/waf/latest/developerguide/waf-bot-control.html) in the * AWS WAF Developer Guide*\\. \n*Required*: No \n*Type*: [AWSManagedRulesBotControlRuleSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesbotcontrolruleset.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AWSManagedRulesBotControlRuleSet" }, "LoginPath": { - "markdownDescription": "The path of the login endpoint for your application\\. For example, for the URL `https://example.com/web/login`, you would provide the path `/web/login`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoginPath", "type": "string" }, "PasswordField": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldIdentifier", - "markdownDescription": "Details about your login page password field\\. \n*Required*: No \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet` `RequestInspection`\\. \n*Required*: No \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PasswordField" }, "PayloadType": { - "markdownDescription": "The payload type for your login endpoint, either JSON or form encoded\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `FORM_ENCODED | JSON` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet` `RequestInspection`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `FORM_ENCODED | JSON` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PayloadType", "type": "string" }, "UsernameField": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldIdentifier", - "markdownDescription": "Details about your login page username field\\. \n*Required*: No \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet` `RequestInspection`\\. \n*Required*: No \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UsernameField" } }, @@ -185048,7 +191417,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.ExcludedRule" }, - "markdownDescription": "The rules whose actions are set to `COUNT` by the web ACL, regardless of the action that is configured in the rule\\. This effectively excludes the rule from acting on web requests\\. \n*Required*: No \n*Type*: List of [ExcludedRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Rules in the referenced rule group whose actions are set to `Count`\\. \nInstead of this option, use `RuleActionOverrides`\\. It accepts any valid action setting, including `Count`\\.\n*Required*: No \n*Type*: List of [ExcludedRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExcludedRules", "type": "array" }, @@ -185056,7 +191425,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.ManagedRuleGroupConfig" }, - "markdownDescription": "Additional information that's used by a managed rule group\\. Most managed rule groups don't require this\\. \nUse this for the account takeover prevention managed rule group `AWSManagedRulesATPRuleSet`, to provide information about the sign\\-in page of your application\\. \nYou can provide multiple individual `ManagedRuleGroupConfig` objects for any rule group configuration, for example `UsernameField` and `PasswordField`\\. The configuration that you provide depends on the needs of the managed rule group\\. For the ATP managed rule group, you provide the following individual configuration objects: `LoginPath`, `PasswordField`, `PayloadType` and `UsernameField`\\. \n*Required*: No \n*Type*: List of [ManagedRuleGroupConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Additional information that's used by a managed rule group\\. Many managed rule groups don't require this\\. \nUse the `AWSManagedRulesATPRuleSet` configuration object for the account takeover prevention managed rule group, to provide information such as the sign\\-in page of your application and the type of content to accept or reject from the client\\. \nUse the `AWSManagedRulesBotControlRuleSet` configuration object to configure the protection level that you want the Bot Control rule group to use\\. \n*Required*: No \n*Type*: List of [ManagedRuleGroupConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ManagedRuleGroupConfigs", "type": "array" }, @@ -185069,11 +191438,13 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleActionOverride" }, + "markdownDescription": "Action settings to use in the place of the rule actions that are configured inside the rule group\\. You specify one override for each rule whose action you want to change\\. \nYou can use overrides for testing, for example you can override all of rule actions to `Count` and then monitor the resulting count metrics to understand how the rule group would handle your web traffic\\. You can also permanently override some or all actions, to modify how the rule group manages your web traffic\\. \n*Required*: No \n*Type*: List of [RuleActionOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleactionoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RuleActionOverrides", "type": "array" }, "ScopeDownStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.Statement", - "markdownDescription": "Statement nested inside a managed rule group statement to narrow the scope of the requests that AWS WAF evaluates using the rule group\\. Requests that match the scope\\-down statement are evaluated using the rule group\\. Requests that don't match the scope\\-down statement are not a match for the managed rule group statement, without any further evaluation\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group\\. Requests are only evaluated by the rule group if they match the scope\\-down statement\\. You can use any nestable [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) in the scope\\-down statement, and you can nest statements at any level, the same as you can for a rule statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScopeDownStatement" }, "VendorName": { @@ -185082,7 +191453,7 @@ "type": "string" }, "Version": { - "markdownDescription": "The version of the managed rule group to use\\. If you specify this, the version setting is fixed until you change it\\. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the managed rule group to use\\. If you specify this, the version setting is fixed until you change it\\. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -185128,12 +191499,12 @@ "additionalProperties": false, "properties": { "Count": { - "markdownDescription": "Override the rule action settings to count\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Override the rule group evaluation result to count only\\. \nThis option is usually set to none\\. It does not affect how the rules in the rule group are evaluated\\. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with `Count` action, in your rule group reference statement settings\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Count", "type": "object" }, "None": { - "markdownDescription": "Don't override the rule action settings\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Don't override the rule group evaluation result\\. This is the most common setting\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "None", "type": "object" } @@ -185160,7 +191531,7 @@ }, "ScopeDownStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.Statement", - "markdownDescription": "An optional nested statement that narrows the scope of the rate\\-based statement to matching web requests\\. This can be any nestable statement, and you can nest statements at any level below this scope\\-down statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional nested statement that narrows the scope of the web requests that are evaluated by the rate\\-based statement\\. Requests are only tracked by the rate\\-based statement if they match the scope\\-down statement\\. You can use any nestable `Statement` in the scope\\-down statement, and you can nest statements at any level, the same as you can for a rule statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScopeDownStatement" } }, @@ -185175,7 +191546,7 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. For more information, see `FieldToMatch`\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "RegexString": { @@ -185203,20 +191574,20 @@ "additionalProperties": false, "properties": { "Arn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the regular expression pattern set that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the [AWS::WAFv2::RegexPatternSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html) that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Arn", "type": "string" }, "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "TextTransformations": { "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -185242,10 +191613,12 @@ "title": "CaptchaConfig" }, "ChallengeConfig": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ChallengeConfig" + "$ref": "#/definitions/AWS::WAFv2::WebACL.ChallengeConfig", + "markdownDescription": "Specifies how AWS WAF should handle `Challenge` evaluations\\. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL\\. \n*Required*: No \n*Type*: [ChallengeConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-challengeconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ChallengeConfig" }, "Name": { - "markdownDescription": "The descriptive name of the rule\\. You can't change the name of a `Rule` after you create it\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the rule\\. You can't change the name of a `Rule` after you create it\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -185269,7 +191642,7 @@ }, "Statement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.Statement", - "markdownDescription": "The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS WAF processing statement for the rule, for example [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-bytematchstatement) or [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-sizeconstraintstatement)\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Statement" }, "VisibilityConfig": { @@ -185305,11 +191678,13 @@ "title": "Captcha" }, "Challenge": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ChallengeAction" + "$ref": "#/definitions/AWS::WAFv2::WebACL.ChallengeAction", + "markdownDescription": "Instructs AWS WAF to run a `Challenge` check against the web request\\. \n*Required*: No \n*Type*: [ChallengeAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-challengeaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Challenge" }, "Count": { "$ref": "#/definitions/AWS::WAFv2::WebACL.CountAction", - "markdownDescription": "Instructs AWS WAF to count the web request and allow it\\. \n*Required*: No \n*Type*: [CountAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-countaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL\\. \n*Required*: No \n*Type*: [CountAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-countaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Count" } }, @@ -185319,9 +191694,13 @@ "additionalProperties": false, "properties": { "ActionToUse": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleAction" + "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleAction", + "markdownDescription": "The override action to use, in place of the configured action of the rule in the rule group\\. \n*Required*: Yes \n*Type*: [RuleAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActionToUse" }, "Name": { + "markdownDescription": "The name of the rule to override\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -185343,7 +191722,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.ExcludedRule" }, - "markdownDescription": "The rules in the referenced rule group whose actions are set to `Count`\\. When you exclude a rule, AWS WAF evaluates it exactly as it would if the rule action setting were `Count`\\. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic\\. \n*Required*: No \n*Type*: List of [ExcludedRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Rules in the referenced rule group whose actions are set to `Count`\\. \nInstead of this option, use `RuleActionOverrides`\\. It accepts any valid action setting, including `Count`\\.\n*Required*: No \n*Type*: List of [ExcludedRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExcludedRules", "type": "array" }, @@ -185351,6 +191730,8 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleActionOverride" }, + "markdownDescription": "Action settings to use in the place of the rule actions that are configured inside the rule group\\. You specify one override for each rule whose action you want to change\\. \nYou can use overrides for testing, for example you can override all of rule actions to `Count` and then monitor the resulting count metrics to understand how the rule group would handle your web traffic\\. You can also permanently override some or all actions, to modify how the rule group manages your web traffic\\. \n*Required*: No \n*Type*: List of [RuleActionOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleactionoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RuleActionOverrides", "type": "array" } }, @@ -185363,6 +191744,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the query header to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -185375,6 +191758,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the query argument to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -185393,7 +191778,7 @@ }, "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "Size": { @@ -185405,7 +191790,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -185423,17 +191808,19 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "SensitivityLevel": { + "markdownDescription": "The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks\\. \n `HIGH` detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings\\. For information about identifying and mitigating false positives, see [Testing and tuning](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-testing.html) in the * AWS WAF Developer Guide*\\. \n `LOW` is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives\\. \nDefault: `LOW` \n*Required*: No \n*Type*: String \n*Allowed values*: `HIGH | LOW` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SensitivityLevel", "type": "string" }, "TextTransformations": { "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -185454,12 +191841,12 @@ }, "ByteMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.ByteMatchStatement", - "markdownDescription": "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 refered to as a string match statement\\. \n*Required*: No \n*Type*: [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ByteMatchStatement" }, "GeoMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.GeoMatchStatement", - "markdownDescription": "A rule statement used to identify web requests based on country of origin\\. \n*Required*: No \n*Type*: [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A rule statement that labels web requests by country and region and that matches against web requests based on country code\\. A geo match rule labels every request that it inspects regardless of whether it finds a match\\. \n+ To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the `CountryCodes` array\\. \n+ Otherwise, configure your geo match rule with Count action so that it only labels requests\\. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed\\. \n AWS WAF labels requests using the alpha\\-2 country and region codes from the International Organization for Standardization \\(ISO\\) 3166 standard\\. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match `ForwardedIPConfig`\\. \nIf you use the web request origin, the label formats are `awswaf:clientip:geo:region:-` and `awswaf:clientip:geo:country:`\\. \nIf you use a forwarded IP address, the label formats are `awswaf:forwardedip:geo:region:-` and `awswaf:forwardedip:geo:country:`\\. \nFor additional details, see [Geographic match rule statement](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "GeoMatchStatement" }, "IPSetReferenceStatement": { @@ -185469,12 +191856,12 @@ }, "LabelMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.LabelMatchStatement", - "markdownDescription": "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\\. \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\\. \n*Required*: No \n*Type*: [LabelMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-labelmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL\\. \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\\. \n*Required*: No \n*Type*: [LabelMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-labelmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LabelMatchStatement" }, "ManagedRuleGroupStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.ManagedRuleGroupStatement", - "markdownDescription": "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\\. \nYou can't 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\\. \n*Required*: No \n*Type*: [ManagedRuleGroupStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \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\\. \n*Required*: No \n*Type*: [ManagedRuleGroupStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ManagedRuleGroupStatement" }, "NotStatement": { @@ -185484,12 +191871,12 @@ }, "OrStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.OrStatement", - "markdownDescription": "A logical rule statement used to combine other rule statements with OR logic\\. You provide more than one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `OrStatement`\\. \n*Required*: No \n*Type*: [OrStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A logical rule statement used to combine other rule statements with OR logic\\. You provide more than one `Statement` within the `OrStatement`\\. \n*Required*: No \n*Type*: [OrStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OrStatement" }, "RateBasedStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.RateBasedStatement", - "markdownDescription": "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\\. \nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit\\. \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+ 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\\.\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 conditions in the statements are counted\\. If the count exceeds 1,000 requests per five minutes, the rule action triggers\\. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule\\. \nYou cannot nest a `RateBasedStatement`, for example for use inside a `NotStatement` or `OrStatement`\\. It can only be referenced as a top\\-level statement within a rule\\. \n*Required*: No \n*Type*: [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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 AWS 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\\. \nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit\\. \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+ An IP match statement with an IP set that specifies the address 192\\.0\\.2\\.44\\.\n+ A string match statement that searches in the User\\-Agent header for the string BadBot\\.\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\\. \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\\. \n*Required*: No \n*Type*: [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RateBasedStatement" }, "RegexMatchStatement": { @@ -185504,22 +191891,22 @@ }, "RuleGroupReferenceStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleGroupReferenceStatement", - "markdownDescription": "A rule statement used to run the rules that are defined in a [AWS::WAFv2::RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html)\\. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement\\. \nYou cannot nest a `RuleGroupReferenceStatement`, for example for use inside a `NotStatement` or `OrStatement`\\. It can only be referenced as a top\\-level statement within a rule\\. \n*Required*: No \n*Type*: [RuleGroupReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A rule statement used to run the rules that are defined in a [AWS::WAFv2::RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html)\\. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement\\. \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\\. \n*Required*: No \n*Type*: [RuleGroupReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RuleGroupReferenceStatement" }, "SizeConstraintStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.SizeConstraintStatement", - "markdownDescription": "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\\. \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 can create a size constraint condition and block requests that have a request body greater than 8192 bytes\\. \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\\. \n*Required*: No \n*Type*: [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \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\\. \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\\. \n*Required*: No \n*Type*: [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SizeConstraintStatement" }, "SqliMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.SqliMatchStatement", - "markdownDescription": "Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database\\. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions\\. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect\\. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code\\. \n*Required*: No \n*Type*: [SqliMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: [SqliMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SqliMatchStatement" }, "XssMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.XssMatchStatement", - "markdownDescription": "A rule statement that defines a cross\\-site scripting \\(XSS\\) match search for AWS WAF to apply to web requests\\. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client\\-site scripts into other legitimate web browsers\\. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings\\. \n*Required*: No \n*Type*: [XssMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: [XssMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "XssMatchStatement" } }, @@ -185554,7 +191941,7 @@ "type": "boolean" }, "MetricName": { - "markdownDescription": "The descriptive name of the Amazon CloudWatch metric\\. The name can contain only alphanumeric characters \\(A\\-Z, a\\-z, 0\\-9\\), with length from one to 128 characters\\. It can't contain whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default\\_Action\\.\" You can't change a `MetricName` after you create a `VisibilityConfig`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A name of the Amazon CloudWatch metric dimension\\. The name can contain only the characters: A\\-Z, a\\-z, 0\\-9, \\- \\(hyphen\\), and \\_ \\(underscore\\)\\. The name can be from one to 128 characters long\\. It can't contain whitespace or metric names that are reserved for AWS WAF, for example `All` and `Default_Action`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricName", "type": "string" }, @@ -185576,14 +191963,14 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "TextTransformations": { "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -185630,7 +192017,7 @@ "additionalProperties": false, "properties": { "ResourceArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the resource to associate with the web ACL\\. \nThe ARN must be in one of the following formats: \n+ For an Application Load Balancer: `arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id ` \n+ For an Amazon API Gateway REST API: `arn:aws:apigateway:region::/restapis/api-id/stages/stage-name ` \n+ For an AWS AppSync GraphQL API: `arn:aws:appsync:region:account-id:apis/GraphQLApiId`\nFor Amazon CloudFront, define the association in your CloudFront distribution configuration\\. To associate a web ACL, provide the Amazon Resource Name \\(ARN\\) of the [AWS::WAFv2::WebACL](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html) to your CloudFront distribution configuration\\. To disassociate a web ACL, provide an empty ARN\\. For information, see [AWS::CloudFront::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the resource to associate with the web ACL\\. \nThe ARN must be in one of the following formats: \n+ For an Application Load Balancer: `arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id ` \n+ For an Amazon API Gateway REST API: `arn:aws:apigateway:region::/restapis/api-id/stages/stage-name ` \n+ For an AWS AppSync GraphQL API: `arn:aws:appsync:region:account-id:apis/GraphQLApiId ` \n+ For an Amazon Cognito user pool: `arn:aws:cognito-idp:region:account-id:userpool/user-pool-id ` \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceArn", "type": "string" }, @@ -186021,7 +192408,7 @@ "properties": { "AppIntegrations": { "$ref": "#/definitions/AWS::Wisdom::KnowledgeBase.AppIntegrationsConfiguration", - "markdownDescription": "Configuration information for Amazon AppIntegrations to automatically ingest content\\. \n*Required*: No \n*Type*: [AppIntegrationsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-appintegrationsconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Configuration information for Amazon AppIntegrations to automatically ingest content\\. \n*Required*: Yes \n*Type*: [AppIntegrationsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-appintegrationsconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AppIntegrations" } }, @@ -186242,7 +192629,7 @@ "additionalProperties": false, "properties": { "ComputeTypeName": { - "markdownDescription": "The compute type\\. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GRAPHICS | GRAPHICSPRO | PERFORMANCE | POWER | POWERPRO | STANDARD | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The compute type\\. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GRAPHICS | GRAPHICS_G4DN | GRAPHICSPRO | GRAPHICSPRO_G4DN | PERFORMANCE | POWER | POWERPRO | STANDARD | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ComputeTypeName", "type": "string" }, @@ -186252,7 +192639,7 @@ "type": "number" }, "RunningMode": { - "markdownDescription": "The running mode\\. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS_ON | AUTO_STOP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The running mode\\. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html)\\. \nThe `MANUAL` value is only supported by Amazon WorkSpaces Core\\. Contact your account team to be allow\\-listed to use this value\\. For more information, see [Amazon WorkSpaces Core](http://aws.amazon.com/workspaces/core/)\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS_ON | AUTO_STOP | MANUAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RunningMode", "type": "string" }, @@ -186323,7 +192710,7 @@ "items": { "$ref": "#/definitions/AWS::XRay::Group.TagsItems" }, - "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [TagsItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-group-tagsitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -186370,9 +192757,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -186418,12 +192809,18 @@ "additionalProperties": false, "properties": { "BypassPolicyLockoutCheck": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BypassPolicyLockoutCheck", "type": "boolean" }, "PolicyDocument": { + "markdownDescription": "The resource policy document, which can be up to 5kb in size\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyDocument", "type": "string" }, "PolicyName": { + "markdownDescription": "The name of the resource policy\\. Must be unique within a specific AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\w+=,.@-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PolicyName", "type": "string" } }, @@ -186501,7 +192898,7 @@ }, "SamplingRuleRecord": { "$ref": "#/definitions/AWS::XRay::SamplingRule.SamplingRuleRecord", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SamplingRuleRecord](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [SamplingRuleRecord](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SamplingRuleRecord" }, "SamplingRuleUpdate": { @@ -186513,7 +192910,7 @@ "items": { "$ref": "#/definitions/AWS::XRay::SamplingRule.TagsItems" }, - "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [TagsItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-tagsitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -186714,9 +193111,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -195218,9 +201619,15 @@ { "$ref": "#/definitions/AWS::EC2::LocalGatewayRoute" }, + { + "$ref": "#/definitions/AWS::EC2::LocalGatewayRouteTable" + }, { "$ref": "#/definitions/AWS::EC2::LocalGatewayRouteTableVPCAssociation" }, + { + "$ref": "#/definitions/AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation" + }, { "$ref": "#/definitions/AWS::EC2::NatGateway" }, @@ -195590,6 +201997,9 @@ { "$ref": "#/definitions/AWS::FMS::Policy" }, + { + "$ref": "#/definitions/AWS::FMS::ResourceSet" + }, { "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation" }, @@ -196559,6 +202969,9 @@ { "$ref": "#/definitions/AWS::Organizations::Policy" }, + { + "$ref": "#/definitions/AWS::Organizations::ResourcePolicy" + }, { "$ref": "#/definitions/AWS::Panorama::ApplicationInstance" }, @@ -197234,6 +203647,9 @@ { "$ref": "#/definitions/AWS::Synthetics::Group" }, + { + "$ref": "#/definitions/AWS::SystemsManagerSAP::Application" + }, { "$ref": "#/definitions/AWS::Timestream::Database" }, diff --git a/schema_source/cloudformation-docs.json b/schema_source/cloudformation-docs.json index 222a581da..5c4675841 100644 --- a/schema_source/cloudformation-docs.json +++ b/schema_source/cloudformation-docs.json @@ -5,26 +5,36 @@ "CertificateAuthorityArn": "The Amazon Resource Name \\(ARN\\) for the private CA issues the certificate\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "CertificateSigningRequest": "The certificate signing request \\(CSR\\) for the certificate\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SigningAlgorithm": "The name of the algorithm that will be used to sign the certificate to be issued\\. \nThis parameter should not be confused with the `SigningAlgorithm` parameter used to sign a CSR in the `CreateCertificateAuthority` action\\. \nThe specified signing algorithm family \\(RSA or ECDSA\\) must match the algorithm family of the CA's secret key\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `SHA256WITHECDSA | SHA256WITHRSA | SHA384WITHECDSA | SHA384WITHRSA | SHA512WITHECDSA | SHA512WITHRSA` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "TemplateArn": "Specifies a custom configuration template to use when issuing a certificate\\. If this parameter is not provided, ACM Private CA defaults to the `EndEntityCertificate/V1` template\\. For more information about ACM Private CA templates, see [Using Templates](https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TemplateArn": "Specifies a custom configuration template to use when issuing a certificate\\. If this parameter is not provided, AWS Private CA defaults to the `EndEntityCertificate/V1` template\\. For more information about AWS Private CA templates, see [Using Templates](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Validity": "The period of time during which the certificate will be valid\\. \n*Required*: Yes \n*Type*: [Validity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ValidityNotBefore": "Information describing the start of the validity period of the certificate\\. This parameter sets the \u201cNot Before\" date for the certificate\\. \nBy default, when issuing a certificate, ACM Private CA sets the \"Not Before\" date to the issuance time minus 60 minutes\\. This compensates for clock inconsistencies across computer systems\\. The `ValidityNotBefore` parameter can be used to customize the \u201cNot Before\u201d value\\. \nUnlike the `Validity` parameter, the `ValidityNotBefore` parameter is optional\\. \nThe `ValidityNotBefore` value is expressed as an explicit date and time, using the `Validity` type value `ABSOLUTE`\\. \n*Required*: No \n*Type*: [Validity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "ValidityNotBefore": "Information describing the start of the validity period of the certificate\\. This parameter sets the \u201cNot Before\" date for the certificate\\. \nBy default, when issuing a certificate, AWS Private CA sets the \"Not Before\" date to the issuance time minus 60 minutes\\. This compensates for clock inconsistencies across computer systems\\. The `ValidityNotBefore` parameter can be used to customize the \u201cNot Before\u201d value\\. \nUnlike the `Validity` parameter, the `ValidityNotBefore` parameter is optional\\. \nThe `ValidityNotBefore` value is expressed as an explicit date and time, using the `Validity` type value `ABSOLUTE`\\. \n*Required*: No \n*Type*: [Validity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ACMPCA::Certificate ApiPassthrough": { "Extensions": "Specifies X\\.509 extension information for a certificate\\. \n*Required*: No \n*Type*: [Extensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Subject": "Contains information about the certificate subject\\. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate\\. The entity can be a user, computer, device, or service\\. The Subject must contain an X\\.500 distinguished name \\(DN\\)\\. A DN is a sequence of relative distinguished names \\(RDNs\\)\\. The RDNs are separated by commas in the certificate\\. \n*Required*: No \n*Type*: [Subject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::ACMPCA::Certificate CustomAttribute": { + "ObjectIdentifier": "Specifies the object identifier \\(OID\\) of the attribute type of the relative distinguished name \\(RDN\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Value": "Specifies the attribute value of relative distinguished name \\(RDN\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::ACMPCA::Certificate CustomExtension": { + "Critical": "Specifies the critical flag of the X\\.509 extension\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ObjectIdentifier": "Specifies the object identifier \\(OID\\) of the X\\.509 extension\\. For more information, see the [Global OID reference database\\.](https://oidref.com/2.5.29) \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Value": "Specifies the base64\\-encoded value of the X\\.509 extension\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4096` \n*Pattern*: `^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::ACMPCA::Certificate EdiPartyName": { "NameAssigner": "Specifies the name assigner\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PartyName": "Specifies the party name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ACMPCA::Certificate ExtendedKeyUsage": { "ExtendedKeyUsageObjectIdentifier": "Specifies a custom `ExtendedKeyUsage` with an object identifier \\(OID\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ExtendedKeyUsageType": "Specifies a standard `ExtendedKeyUsage` as defined as in [RFC 5280](https://tools.ietf.org/html/rfc5280#section-4.2.1.12)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CERTIFICATE_TRANSPARENCY | CLIENT_AUTH | CODE_SIGNING | DOCUMENT_SIGNING | EMAIL_PROTECTION | OCSP_SIGNING | SERVER_AUTH | SMART_CARD_LOGIN | TIME_STAMPING` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "ExtendedKeyUsageType": "Specifies a standard `ExtendedKeyUsage` as defined as in [RFC 5280](https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CERTIFICATE_TRANSPARENCY | CLIENT_AUTH | CODE_SIGNING | DOCUMENT_SIGNING | EMAIL_PROTECTION | OCSP_SIGNING | SERVER_AUTH | SMART_CARD_LOGIN | TIME_STAMPING` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ACMPCA::Certificate Extensions": { "CertificatePolicies": "Contains a sequence of one or more policy information terms, each of which consists of an object identifier \\(OID\\) and optional qualifiers\\. For more information, see NIST's definition of [Object Identifier \\(OID\\)](https://csrc.nist.gov/glossary/term/Object_Identifier)\\. \nIn an end\\-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used\\. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate\\. \n*Required*: No \n*Type*: List of [PolicyInformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyinformation.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CustomExtensions": "Contains a sequence of one or more X\\.509 extensions, each of which consists of an object identifier \\(OID\\), a base64\\-encoded value, and the critical flag\\. For more information, see the [Global OID reference database\\.](https://oidref.com/2.5.29) \n*Required*: No \n*Type*: List of [CustomExtension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ExtendedKeyUsage": "Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the `KeyUsage` extension\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extendedkeyusage.html) of [ExtendedKeyUsage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extendedkeyusage.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "KeyUsage": "Defines one or more purposes for which the key contained in the certificate can be used\\. Default value for each option is false\\. \n*Required*: No \n*Type*: [KeyUsage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "KeyUsage": "Defines one or more purposes for which the key contained in the certificate can be used\\. Default value for each option is false\\. \n*Required*: No \n*Type*: [KeyUsage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SubjectAlternativeNames": "The subject alternative name extension allows identities to be bound to the subject of the certificate\\. These identities may be included in addition to or in place of the identity in the subject field of the certificate\\. \n*Required*: No \n*Type*: List of [GeneralName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ACMPCA::Certificate GeneralName": { @@ -34,7 +44,7 @@ "IpAddress": "Represents `GeneralName` as an IPv4 or IPv6 address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `39` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "OtherName": "Represents `GeneralName` using an `OtherName` object\\. \n*Required*: No \n*Type*: [OtherName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-othername.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RegisteredId": "Represents `GeneralName` as an object identifier \\(OID\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Rfc822Name": "Represents `GeneralName` as an [RFC 822](https://tools.ietf.org/html/rfc822) email address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Rfc822Name": "Represents `GeneralName` as an [RFC 822](https://datatracker.ietf.org/doc/html/rfc822) email address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "UniformResourceIdentifier": "Represents `GeneralName` as a URI\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ACMPCA::Certificate KeyUsage": { @@ -54,11 +64,11 @@ }, "AWS::ACMPCA::Certificate PolicyInformation": { "CertPolicyId": "Specifies the object identifier \\(OID\\) of the certificate policy under which the certificate was issued\\. For more information, see NIST's definition of [Object Identifier \\(OID\\)](https://csrc.nist.gov/glossary/term/Object_Identifier)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PolicyQualifiers": "Modifies the given `CertPolicyId` with a qualifier\\. ACM Private CA supports the certification practice statement \\(CPS\\) qualifier\\. \n*Required*: No \n*Type*: List of [PolicyQualifierInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "PolicyQualifiers": "Modifies the given `CertPolicyId` with a qualifier\\. AWS Private CA supports the certification practice statement \\(CPS\\) qualifier\\. \n*Required*: No \n*Type*: List of [PolicyQualifierInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ACMPCA::Certificate PolicyQualifierInfo": { "PolicyQualifierId": "Identifies the qualifier modifying a `CertPolicyId`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CPS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Qualifier": "Defines the qualifier type\\. ACM Private CA supports the use of a URI for a CPS qualifier in this field\\. \n*Required*: Yes \n*Type*: [Qualifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-qualifier.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Qualifier": "Defines the qualifier type\\. AWS Private CA supports the use of a URI for a CPS qualifier in this field\\. \n*Required*: Yes \n*Type*: [Qualifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-qualifier.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ACMPCA::Certificate Qualifier": { "CpsUri": "Contains a pointer to a certification practice statement \\(CPS\\) published by the CA\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" @@ -66,12 +76,13 @@ "AWS::ACMPCA::Certificate Subject": { "CommonName": "For CA and end\\-entity certificates in a private PKI, the common name \\(CN\\) can be any string within the length limit\\. \nNote: In publicly trusted certificates, the common name must be a fully qualified domain name \\(FQDN\\) associated with the certificate subject\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Country": "Two\\-digit code that specifies the country in which the certificate subject located\\. \n*Required*: No \n*Type*: String \n*Minimum*: `2` \n*Maximum*: `2` \n*Pattern*: `[A-Za-z]{2}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CustomAttributes": "Contains a sequence of one or more X\\.500 relative distinguished names \\(RDNs\\), each of which consists of an object identifier \\(OID\\) and a value\\. For more information, see NIST\u2019s definition of [Object Identifier \\(OID\\)](https://csrc.nist.gov/glossary/term/Object_Identifier)\\. \nCustom attributes cannot be used in combination with standard attributes\\.\n*Required*: No \n*Type*: List of [CustomAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customattribute.html) \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DistinguishedNameQualifier": "Disambiguating information for the certificate subject\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `[a-zA-Z0-9'()+-.?:/= ]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "GenerationQualifier": "Typically a qualifier appended to the name of an individual\\. Examples include Jr\\. for junior, Sr\\. for senior, and III for third\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `3` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "GivenName": "First name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `16` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Initials": "Concatenation that typically contains the first letter of the **GivenName**, the first letter of the middle name if one exists, and the first letter of the **Surname**\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Locality": "The locality \\(such as a city or town\\) in which the certificate subject is located\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `128` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Organization": "Legal name of the organization with which the certificate subject is affiliated\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Organization": "Legal name of the organization with which the certificate subject is affiliated\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "OrganizationalUnit": "A subdivision or unit of the organization \\(such as sales or finance\\) with which the certificate subject is affiliated\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Pseudonym": "Typically a shortened version of a longer **GivenName**\\. For example, Jonathan is often shortened to John\\. Elizabeth is often shortened to Beth, Liz, or Eliza\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `128` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SerialNumber": "The certificate serial number\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `[a-zA-Z0-9'()+-.?:/= ]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -86,12 +97,13 @@ "AWS::ACMPCA::CertificateAuthority": { "CsrExtensions": "Specifies information to be added to the extension section of the certificate signing request \\(CSR\\)\\. \n*Required*: No \n*Type*: [CsrExtensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-csrextensions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KeyAlgorithm": "Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate\\. When you create a subordinate CA, you must use a key algorithm supported by the parent CA\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `EC_prime256v1 | EC_secp384r1 | RSA_2048 | RSA_4096` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "KeyStorageSecurityStandard": "Specifies a cryptographic key management compliance standard used for handling CA keys\\. \nDefault: FIPS\\_140\\_2\\_LEVEL\\_3\\_OR\\_HIGHER \nNote: `FIPS_140_2_LEVEL_3_OR_HIGHER` is not supported in Region ap\\-northeast\\-3\\. When creating a CA in the ap\\-northeast\\-3, you must provide `FIPS_140_2_LEVEL_2_OR_HIGHER` as the argument for `KeyStorageSecurityStandard`\\. Failure to do this results in an `InvalidArgsException` with the message, \"A certificate authority cannot be created in this region with the specified security standard\\.\" \n*Required*: No \n*Type*: String \n*Allowed values*: `FIPS_140_2_LEVEL_2_OR_HIGHER | FIPS_140_2_LEVEL_3_OR_HIGHER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "RevocationConfiguration": "Information about the certificate revocation list \\(CRL\\) created and maintained by your private CA\\. Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions\\. Your certificate authority can create and maintain a certificate revocation list \\(CRL\\)\\. A CRL contains information about certificates that have been revoked\\. \n*Required*: No \n*Type*: [RevocationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KeyStorageSecurityStandard": "Specifies a cryptographic key management compliance standard used for handling CA keys\\. \nDefault: FIPS\\_140\\_2\\_LEVEL\\_3\\_OR\\_HIGHER \n *Note:* `FIPS_140_2_LEVEL_3_OR_HIGHER` is not supported in the following Regions: \n+ ap\\-northeast\\-3\n+ ap\\-southeast\\-3\nWhen creating a CA in these Regions, you must provide `FIPS_140_2_LEVEL_2_OR_HIGHER` as the argument for `KeyStorageSecurityStandard`\\. Failure to do this results in an `InvalidArgsException` with the message, \"A certificate authority cannot be created in this region with the specified security standard\\.\" \n*Required*: No \n*Type*: String \n*Allowed values*: `FIPS_140_2_LEVEL_2_OR_HIGHER | FIPS_140_2_LEVEL_3_OR_HIGHER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RevocationConfiguration": "Certificate revocation information used by the [CreateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) and [UpdateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) actions\\. Your private certificate authority \\(CA\\) can configure Online Certificate Status Protocol \\(OCSP\\) support and/or maintain a certificate revocation list \\(CRL\\)\\. OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA\\. For more information, see [RevokeCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html) in the *AWS Private CA API Reference* and [Setting up a certificate revocation method](https://docs.aws.amazon.com/privateca/latest/userguide/revocation-setup.html) in the *AWS Private CA User Guide*\\. \nThe following requirements apply to revocation configurations\\. \n+ A configuration disabling CRLs or OCSP must contain only the `Enabled=False` parameter, and will fail if other parameters such as `CustomCname` or `ExpirationInDays` are included\\.\n+ In a CRL configuration, the `S3BucketName` parameter must conform to the [Amazon S3 bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html)\\.\n+ A configuration containing a custom Canonical Name \\(CNAME\\) parameter for CRLs or OCSP must conform to [RFC2396](https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in a CNAME\\. \n+ In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as \"http://\" or \"https://\"\\.\n*Required*: No \n*Type*: [RevocationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SigningAlgorithm": "Name of the algorithm your private CA uses to sign certificate requests\\. \nThis parameter should not be confused with the `SigningAlgorithm` parameter used to sign certificates when they are issued\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SHA256WITHECDSA | SHA256WITHRSA | SHA384WITHECDSA | SHA384WITHRSA | SHA512WITHECDSA | SHA512WITHRSA` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Subject": "Structure that contains X\\.500 distinguished name information for your private CA\\. \n*Required*: Yes \n*Type*: [Subject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-subject.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Key\\-value pairs that will be attached to the new private CA\\. You can associate up to 50 tags with a private CA\\. For information using tags with IAM to manage permissions, see [Controlling Access Using IAM Tags](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Type": "Type of your private CA\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ROOT | SUBORDINATE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Type": "Type of your private CA\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ROOT | SUBORDINATE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "UsageMode": "Specifies whether the CA issues general\\-purpose certificates that typically require a revocation mechanism, or short\\-lived certificates that may optionally omit revocation because they expire quickly\\. Short\\-lived certificate validity is limited to seven days\\. \nThe default value is GENERAL\\_PURPOSE\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GENERAL_PURPOSE | SHORT_LIVED_CERTIFICATE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ACMPCA::CertificateAuthority AccessDescription": { "AccessLocation": "The location of `AccessDescription` information\\. \n*Required*: Yes \n*Type*: [GeneralName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-generalname.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -102,15 +114,19 @@ "CustomObjectIdentifier": "An object identifier \\(OID\\) specifying the `AccessMethod`\\. The OID must satisfy the regular expression shown below\\. For more information, see NIST's definition of [Object Identifier \\(OID\\)](https://csrc.nist.gov/glossary/term/Object_Identifier)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ACMPCA::CertificateAuthority CrlConfiguration": { - "CustomCname": "Name inserted into the certificate **CRL Distribution Points** extension that enables the use of an alias for the CRL distribution point\\. Use this value if you don't want the name of your S3 bucket to be public\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomCname": "Name inserted into the certificate **CRL Distribution Points** extension that enables the use of an alias for the CRL distribution point\\. Use this value if you don't want the name of your S3 bucket to be public\\. \nThe content of a Canonical Name \\(CNAME\\) record must conform to [RFC2396](https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in URIs\\. Additionally, the value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\"\\.\n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Pattern*: `^[-a-zA-Z0-9;/?:@&=+$,%_.!~*()']*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "Boolean value that specifies whether certificate revocation lists \\(CRLs\\) are enabled\\. You can use this value to enable certificate revocation for a new CA when you call the `CreateCertificateAuthority` operation or for an existing CA when you call the `UpdateCertificateAuthority` operation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExpirationInDays": "Validity period of the CRL in days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `5000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3BucketName": "Name of the S3 bucket that contains the CRL\\. If you do not provide a value for the **CustomCname** argument, the name of your S3 bucket is placed into the **CRL Distribution Points** extension of the issued certificate\\. You can change the name of your bucket by calling the [UpdateCertificateAuthority](https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html) operation\\. You must specify a [bucket policy](https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-policies) that allows ACM Private CA to write the CRL to your bucket\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3ObjectAcl": "Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket\\. If you choose PUBLIC\\_READ, the CRL will be accessible over the public internet\\. If you choose BUCKET\\_OWNER\\_FULL\\_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access\\. \nIf no value is specified, the default is PUBLIC\\_READ\\. \nThis default can cause CA creation to fail in some circumstances\\. If you have enabled the Block Public Access \\(BPA\\) feature in your S3 account, then you must specify the value of this parameter as `BUCKET_OWNER_FULL_CONTROL`, and not doing so results in an error\\. If you have disabled BPA in S3, then you can specify either `BUCKET_OWNER_FULL_CONTROL` or `PUBLIC_READ` as the value\\.\nFor more information, see [Blocking public access to the S3 bucket](https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-bpa)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "S3BucketName": "Name of the S3 bucket that contains the CRL\\. If you do not provide a value for the **CustomCname** argument, the name of your S3 bucket is placed into the **CRL Distribution Points** extension of the issued certificate\\. You can change the name of your bucket by calling the [UpdateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) operation\\. You must specify a [bucket policy](https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-policies) that allows AWS Private CA to write the CRL to your bucket\\. \nThe `S3BucketName` parameter must conform to the [S3 bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html)\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `^[-a-zA-Z0-9._/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3ObjectAcl": "Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket\\. If you choose PUBLIC\\_READ, the CRL will be accessible over the public internet\\. If you choose BUCKET\\_OWNER\\_FULL\\_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access\\. \nIf no value is specified, the default is PUBLIC\\_READ\\. \n*Note:* This default can cause CA creation to fail in some circumstances\\. If you have have enabled the Block Public Access \\(BPA\\) feature in your S3 account, then you must specify the value of this parameter as `BUCKET_OWNER_FULL_CONTROL`, and not doing so results in an error\\. If you have disabled BPA in S3, then you can specify either `BUCKET_OWNER_FULL_CONTROL` or `PUBLIC_READ` as the value\\. \nFor more information, see [Blocking public access to the S3 bucket](https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-bpa)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ACMPCA::CertificateAuthority CsrExtensions": { "KeyUsage": "Indicates the purpose of the certificate and of the key contained in the certificate\\. \n*Required*: No \n*Type*: [KeyUsage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-keyusage.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SubjectInformationAccess": "For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy\\. For more information, see [Subject Information Access](https://tools.ietf.org/html/rfc5280#section-4.2.2.2) in RFC 5280\\. \n*Required*: No \n*Type*: List of [AccessDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "SubjectInformationAccess": "For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy\\. For more information, see [Subject Information Access](https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2) in RFC 5280\\. \n*Required*: No \n*Type*: List of [AccessDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::ACMPCA::CertificateAuthority CustomAttribute": { + "ObjectIdentifier": "Specifies the object identifier \\(OID\\) of the attribute type of the relative distinguished name \\(RDN\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Value": "Specifies the attribute value of relative distinguished name \\(RDN\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ACMPCA::CertificateAuthority EdiPartyName": { "NameAssigner": "Specifies the name assigner\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -123,7 +139,7 @@ "IpAddress": "Represents `GeneralName` as an IPv4 or IPv6 address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `39` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "OtherName": "Represents `GeneralName` using an `OtherName` object\\. \n*Required*: No \n*Type*: [OtherName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-othername.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RegisteredId": "Represents `GeneralName` as an object identifier \\(OID\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Rfc822Name": "Represents `GeneralName` as an [RFC 822](https://tools.ietf.org/html/rfc822) email address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Rfc822Name": "Represents `GeneralName` as an [RFC 822](https://datatracker.ietf.org/doc/html/rfc822) email address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "UniformResourceIdentifier": "Represents `GeneralName` as a URI\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ACMPCA::CertificateAuthority KeyUsage": { @@ -139,7 +155,7 @@ }, "AWS::ACMPCA::CertificateAuthority OcspConfiguration": { "Enabled": "Flag enabling use of the Online Certificate Status Protocol \\(OCSP\\) for validating certificate revocation status\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OcspCustomCname": "By default, ACM Private CA injects an Amazon domain into certificates being validated by the Online Certificate Status Protocol \\(OCSP\\)\\. A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain\\. \nNote: The value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\"\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "OcspCustomCname": "By default, AWS Private CA injects an Amazon domain into certificates being validated by the Online Certificate Status Protocol \\(OCSP\\)\\. A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain\\. \nThe content of a Canonical Name \\(CNAME\\) record must conform to [RFC2396](https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in URIs\\. Additionally, the value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\"\\.\n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Pattern*: `^[-a-zA-Z0-9;/?:@&=+$,%_.!~*()']*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ACMPCA::CertificateAuthority OtherName": { "TypeId": "Specifies an OID\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -152,6 +168,7 @@ "AWS::ACMPCA::CertificateAuthority Subject": { "CommonName": "Fully qualified domain name \\(FQDN\\) associated with the certificate subject\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Country": "Two\\-digit code that specifies the country in which the certificate subject located\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CustomAttributes": "Contains a sequence of one or more X\\.500 relative distinguished names \\(RDNs\\), each of which consists of an object identifier \\(OID\\) and a value\\. For more information, see NIST\u2019s definition of [Object Identifier \\(OID\\)](https://csrc.nist.gov/glossary/term/Object_Identifier)\\. \nCustom attributes cannot be used in combination with standard attributes\\.\n*Required*: No \n*Type*: List of [CustomAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-customattribute.html) \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DistinguishedNameQualifier": "Disambiguating information for the certificate subject\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "GenerationQualifier": "Typically a qualifier appended to the name of an individual\\. Examples include Jr\\. for junior, Sr\\. for senior, and III for third\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "GivenName": "First name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -186,8 +203,12 @@ "AWS::APS::Workspace": { "AlertManagerDefinition": "The alert manager definition for the workspace, as a string\\. For more information, see [ Alert manager and templating](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alert-manager.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Alias": "An alias that you assign to this workspace to help you identify it\\. It does not need to be unique\\. \n The alias can be as many as 100 characters and can include any type of characters\\. Amazon Managed Service for Prometheus automatically strips any blank spaces from the beginning and end of the alias that you specify\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LoggingConfiguration": "The LoggingConfiguration attribute is used to set the logging configuration for the workspace\\. \n*Required*: No \n*Type*: [LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-loggingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A list of tag keys and values to associate with the workspace\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::APS::Workspace LoggingConfiguration": { + "LogGroupArn": "The Amazon Resource Name \\(ARN\\) of the CloudWatch log group the logs are emitted to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AccessAnalyzer::Analyzer": { "AnalyzerName": "The name of the analyzer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ArchiveRules": "Specifies the archive rules to add for the analyzer\\. \n*Required*: No \n*Type*: List of [ArchiveRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-archiverule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -287,18 +308,19 @@ "Revision": "The revision number of the configuration\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Amplify::App": { - "AccessToken": "Personal Access token for 3rd party source control system for an Amplify app, used to create webhook and read\\-only deploy key\\. Token is not stored\\. \n*Length Constraints:* Minimum length of 1\\. Maximum length of 255\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AccessToken": "The personal access token for a GitHub repository for an Amplify app\\. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App\\. The token is not stored\\. \nUse `AccessToken` for GitHub repositories only\\. To authorize access to a repository provider such as Bitbucket or CodeCommit, use `OauthToken`\\. \nYou must specify either `AccessToken` or `OauthToken` when you create a new app\\. \nExisting Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD\\. However, we strongly recommend that you migrate these apps to use the GitHub App\\. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* \\. \n*Length Constraints:* Minimum length of 1\\. Maximum length of 255\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AutoBranchCreationConfig": "Sets the configuration for your automatic branch creation\\. \n*Required*: No \n*Type*: [AutoBranchCreationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-autobranchcreationconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BasicAuthConfig": "The credentials for basic authorization for an Amplify app\\. You must base64\\-encode the authorization credentials and provide them in the format `user:password`\\. \n*Required*: No \n*Type*: [BasicAuthConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-basicauthconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BuildSpec": "The build specification \\(build spec\\) for an Amplify app\\. \n*Length Constraints:* Minimum length of 1\\. Maximum length of 25000\\. \n*Pattern:* \\(?s\\)\\.\\+ \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomHeaders": "The custom HTTP headers for an Amplify app\\. \n*Length Constraints:* Minimum length of 0\\. Maximum length of 25000\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomRules": "The custom rewrite and redirect rules for an Amplify app\\. \n*Required*: No \n*Type*: List of [CustomRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-customrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "The description for an Amplify app\\. \n*Length Constraints:* Maximum length of 1000\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EnableBranchAutoDeletion": "Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableBranchAutoDeletion": "Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnvironmentVariables": "The environment variables map for an Amplify app\\. \n*Required*: No \n*Type*: List of [EnvironmentVariable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IAMServiceRole": "The AWS Identity and Access Management \\(IAM\\) service role for the Amazon Resource Name \\(ARN\\) of the Amplify app\\. \n*Length Constraints:* Minimum length of 0\\. Maximum length of 1000\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name for an Amplify app\\. \n*Length Constraints:* Minimum length of 1\\. Maximum length of 255\\. \n*Pattern:* \\(?s\\)\\.\\+ \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OauthToken": "The OAuth token for a third\\-party source control system for an Amplify app\\. The OAuth token is used to create a webhook and a read\\-only deploy key\\. The OAuth token is not stored\\. \n*Length Constraints:* Maximum length of 1000\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OauthToken": "The OAuth token for a third\\-party source control system for an Amplify app\\. The OAuth token is used to create a webhook and a read\\-only deploy key using SSH cloning\\. The OAuth token is not stored\\. \nUse `OauthToken` for repository providers other than GitHub, such as Bitbucket or CodeCommit\\. To authorize access to GitHub as your repository provider, use `AccessToken`\\. \nYou must specify either `OauthToken` or `AccessToken` when you create a new app\\. \nExisting Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD\\. However, we strongly recommend that you migrate these apps to use the GitHub App\\. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* \\. \n*Length Constraints:* Maximum length of 1000\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Platform": "The platform for the Amplify app\\. For a static app, set the platform type to `WEB`\\. For a dynamic server\\-side rendered \\(SSR\\) app, set the platform type to `WEB_COMPUTE`\\. For an app requiring Amplify Hosting's original SSR support only, set the platform type to `WEB_DYNAMIC`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Repository": "The repository for an Amplify app\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tag for an Amplify app\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -309,9 +331,10 @@ "EnableAutoBranchCreation": "Enables automated branch creation for the Amplify app\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnableAutoBuild": "Enables auto building for the auto created branch\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnablePerformanceMode": "Enables performance mode for the branch\\. \nPerformance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval\\. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EnablePullRequestPreview": "Sets whether pull request previews are enabled for each branch that Amplify Console automatically creates for your app\\. Amplify Console creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch\\. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch\\. \nTo provide backend support for your preview, the Amplify Console automatically provisions a temporary backend environment that it deletes when the pull request is closed\\. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property\\. \nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Console User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnablePullRequestPreview": "Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app\\. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch\\. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch\\. \nTo provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed\\. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property\\. \nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnvironmentVariables": "Environment variables for the auto created branch\\. \n*Required*: No \n*Type*: List of [EnvironmentVariable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-app-environmentvariable.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PullRequestEnvironmentName": "If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews\\. For example, you could specify an environment named `prod`, `test`, or `dev` that you initialized with the Amplify CLI\\. \nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true`\\. \nIf you don't specify an environment, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment\\. Amplify Console deletes this environment when the pull request is closed\\. \nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Console User Guide*\\. \n*Length Constraints:* Maximum length of 20\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Framework": "The framework for the autocreated branch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PullRequestEnvironmentName": "If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews\\. For example, you could specify an environment named `prod`, `test`, or `dev` that you initialized with the Amplify CLI\\. \nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true`\\. \nIf you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment\\. Amplify deletes this environment when the pull request is closed\\. \nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide*\\. \n*Length Constraints:* Maximum length of 20\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Stage": "Stage for the auto created branch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Amplify::App BasicAuthConfig": { @@ -337,9 +360,10 @@ "Description": "The description for the branch that is part of an Amplify app\\. \n*Length Constraints:* Maximum length of 1000\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnableAutoBuild": "Enables auto building for the branch\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnablePerformanceMode": "Enables performance mode for the branch\\. \nPerformance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval\\. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EnablePullRequestPreview": "Sets whether the Amplify Console creates a preview for each pull request that is made for this branch\\. If this property is enabled, the Amplify Console deploys your app to a unique preview URL after each pull request is opened\\. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch\\. \nTo provide backend support for your preview, the Amplify Console automatically provisions a temporary backend environment that it deletes when the pull request is closed\\. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property\\. \nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Console User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnablePullRequestPreview": "Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch\\. If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened\\. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch\\. \nTo provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed\\. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property\\. \nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnvironmentVariables": "The environment variables for the branch\\. \n*Required*: No \n*Type*: List of [EnvironmentVariable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplify-branch-environmentvariable.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PullRequestEnvironmentName": "If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews\\. For example, you could specify an environment named `prod`, `test`, or `dev` that you initialized with the Amplify CLI and mapped to this branch\\. \nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true`\\. \nIf you don't specify an environment, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment\\. Amplify Console deletes this environment when the pull request is closed\\. \nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Console User Guide*\\. \n*Length Constraints:* Maximum length of 20\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Framework": "The framework for the branch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PullRequestEnvironmentName": "If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews\\. For example, you could specify an environment named `prod`, `test`, or `dev` that you initialized with the Amplify CLI and mapped to this branch\\. \nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true`\\. \nIf you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment\\. Amplify Hosting deletes this environment when the pull request is closed\\. \nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide*\\. \n*Length Constraints:* Maximum length of 20\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Stage": "Describes the current stage for the branch\\. \n*Valid Values:* PRODUCTION \\| BETA \\| DEVELOPMENT \\| EXPERIMENTAL \\| PULL\\_REQUEST \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tag for the branch\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -365,13 +389,15 @@ "Prefix": "The prefix setting for the subdomain\\. \n*Length Constraints:* Maximum length of 255\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AmplifyUIBuilder::Component": { + "AppId": "The unique ID of the Amplify app associated with the component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BindingProperties": "The information to connect a component's properties to data at runtime\\. You can't specify `tags` as a valid property for `bindingProperties`\\. \n \n*Required*: Yes \n*Type*: Map of [ComponentBindingPropertiesValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Children": "A list of the component's `ComponentChild` instances\\. \n*Required*: No \n*Type*: List of [ComponentChild](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CollectionProperties": "The data binding configuration for the component's properties\\. Use this for a collection component\\. You can't specify `tags` as a valid property for `collectionProperties`\\. \n*Required*: No \n*Type*: Map of [ComponentDataConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ComponentType": "The type of the component\\. This can be an Amplify custom UI component or another custom component\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnvironmentName": "The name of the backend environment that is a part of the Amplify app\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Events": "Describes the events that can be raised on the component\\. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components\\. \n*Required*: No \n*Type*: Map of [ComponentEvent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the component\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Overrides": "Describes the component's properties that can be overriden in a customized instance of the component\\. You can't specify `tags` as a valid property for `overrides`\\. \n*Required*: Yes \n*Type*: Map of [ComponentOverridesValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentoverridesvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Overrides": "Describes the component's properties that can be overriden in a customized instance of the component\\. You can't specify `tags` as a valid property for `overrides`\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Properties": "Describes the component's properties\\. You can't specify `tags` as a valid property for `properties`\\. \n*Required*: Yes \n*Type*: Map of [ComponentProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SchemaVersion": "The schema version of the component when it was imported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourceId": "The unique ID of the component in its original source system, such as Figma\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -380,7 +406,7 @@ }, "AWS::AmplifyUIBuilder::Component ActionParameters": { "Anchor": "The HTML anchor link to the location to open\\. Specify this value for a navigation action\\. \n*Required*: No \n*Type*: [ComponentProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Fields": "A dictionary of key\\-value pairs mapping Amplify Studio properties to fields in a data model\\. Use when the action performs an operation on an Amplify DataStore model\\. \n*Required*: No \n*Type*: [ComponentProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Fields": "A dictionary of key\\-value pairs mapping Amplify Studio properties to fields in a data model\\. Use when the action performs an operation on an Amplify DataStore model\\. \n*Required*: No \n*Type*: Map of [ComponentProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Global": "Specifies whether the user should be signed out globally\\. Specify this value for an auth sign out action\\. \n*Required*: No \n*Type*: [ComponentProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Id": "The unique ID of the component that the `ActionParameters` apply to\\. \n*Required*: No \n*Type*: [ComponentProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Model": "The name of the data model\\. Use when the action performs an operation on an Amplify DataStore model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -406,9 +432,9 @@ "AWS::AmplifyUIBuilder::Component ComponentChild": { "Children": "The list of `ComponentChild` instances for this component\\. \n*Required*: No \n*Type*: List of [ComponentChild](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-amplifyuibuilder-component-componentchild.html#aws-properties-amplifyuibuilder-component-componentchild) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ComponentType": "The type of the child component\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Events": "Describes the events that can be raised on the child component\\. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components\\. \n*Required*: No \n*Type*: [ComponentEvents](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevents.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Events": "Describes the events that can be raised on the child component\\. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components\\. \n*Required*: No \n*Type*: Map of [ComponentEvent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the child component\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Properties": "Describes the properties of the child component\\. You can't specify `tags` as a valid property for `properties`\\. \n*Required*: Yes \n*Type*: [ComponentProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Properties": "Describes the properties of the child component\\. You can't specify `tags` as a valid property for `properties`\\. \n*Required*: Yes \n*Type*: Map of [ComponentProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AmplifyUIBuilder::Component ComponentConditionProperty": { "Else": "The value to assign to the property if the condition is not met\\. \n*Required*: No \n*Type*: [ComponentProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -431,7 +457,7 @@ }, "AWS::AmplifyUIBuilder::Component ComponentProperty": { "BindingProperties": "The information to bind the component property to data at runtime\\. \n*Required*: No \n*Type*: [ComponentPropertyBindingProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentpropertybindingproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Bindings": "The information to bind the component property to form data\\. \n*Required*: No \n*Type*: [FormBindings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-formbindings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Bindings": "The information to bind the component property to form data\\. \n*Required*: No \n*Type*: Map of [FormBindingElement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-formbindingelement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CollectionBindingProperties": "The information to bind the component property to data at runtime\\. Use this for collection components\\. \n*Required*: No \n*Type*: [ComponentPropertyBindingProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentpropertybindingproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ComponentName": "The name of the component that is affected by an event\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Concat": "A list of component properties to concatenate to create the value to assign to this component property\\. \n*Required*: No \n*Type*: List of [ComponentProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-amplifyuibuilder-component-componentproperty.html#aws-properties-amplifyuibuilder-component-componentproperty) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -451,8 +477,12 @@ "Property": "The component property to bind to the data field\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AmplifyUIBuilder::Component ComponentVariant": { - "Overrides": "The properties of the component variant that can be overriden when customizing an instance of the component\\. You can't specify `tags` as a valid property for `overrides`\\. \n*Required*: No \n*Type*: [ComponentOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentoverrides.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VariantValues": "The combination of variants that comprise this variant\\. \n*Required*: No \n*Type*: [ComponentVariantValues](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentvariantvalues.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Overrides": "The properties of the component variant that can be overriden when customizing an instance of the component\\. You can't specify `tags` as a valid property for `overrides`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VariantValues": "The combination of variants that comprise this variant\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AmplifyUIBuilder::Component FormBindingElement": { + "Element": "The name of the component to retrieve a value from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Property": "The property to retrieve a value from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AmplifyUIBuilder::Component MutationActionSetStateParameter": { "ComponentName": "The name of the component that is being modified\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -470,7 +500,99 @@ "Direction": "The direction of the sort, either ascending or descending\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Field": "The field to perform the sort on\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AmplifyUIBuilder::Form": { + "AppId": "The unique ID of the Amplify app associated with the form\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Cta": "Stores the call to action configuration for the form\\. \n*Required*: No \n*Type*: [FormCTA](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataType": "The type of data source to use to create the form\\. \n*Required*: Yes \n*Type*: [FormDataTypeConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formdatatypeconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnvironmentName": "The name of the backend environment that is a part of the Amplify app\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Fields": "Stores the information about the form's fields\\. \n*Required*: Yes \n*Type*: Map of [FieldConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FormActionType": "The operation to perform on the specified form\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the form\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SchemaVersion": "The schema version of the form when it was imported\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SectionalElements": "Stores the visual helper elements for the form that are not associated with any data\\. \n*Required*: Yes \n*Type*: Map of [SectionalElement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Style": "Stores the configuration for the form's style\\. \n*Required*: Yes \n*Type*: [FormStyle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyle.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "One or more key\\-value pairs to use when tagging the form\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::AmplifyUIBuilder::Form FieldConfig": { + "Excluded": "Specifies whether to hide a field\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InputType": "Describes the configuration for the default input value to display for a field\\. \n*Required*: No \n*Type*: [FieldInputConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Label": "The label for the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Position": "Specifies the field position\\. \n*Required*: No \n*Type*: [FieldPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Validations": "The validations to perform on the value in the field\\. \n*Required*: No \n*Type*: List of [FieldValidationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AmplifyUIBuilder::Form FieldInputConfig": { + "DefaultChecked": "Specifies whether a field has a default value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefaultCountryCode": "The default country code for a phone number\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefaultValue": "The default value for the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DescriptiveText": "The text to display to describe the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsArray": "Specifies whether to render the field as an array\\. This property is ignored if the `dataSourceType` for the form is a Data Store\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxValue": "The maximum value to display for the field\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MinValue": "The minimum value to display for the field\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Placeholder": "The text to display as a placeholder for the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReadOnly": "Specifies a read only field\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Required": "Specifies a field that requires input\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Step": "The stepping increment for a numeric value in a field\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The input type for the field\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The value for the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ValueMappings": "The information to use to customize the input fields with data at runtime\\. \n*Required*: No \n*Type*: [ValueMappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemappings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AmplifyUIBuilder::Form FieldPosition": { + "Below": "The field position is below the field specified by the string\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Fixed": "The field position is fixed and doesn't change in relation to other fields\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RightOf": "The field position is to the right of the field specified by the string\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AmplifyUIBuilder::Form FieldValidationConfiguration": { + "NumValues": "The validation to perform on a number value\\. \n*Required*: No \n*Type*: List of Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StrValues": "The validation to perform on a string value\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The validation to perform on an object type\\.`` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ValidationMessage": "The validation message to display\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AmplifyUIBuilder::Form FormButton": { + "Children": "Describes the button's properties\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Excluded": "Specifies whether the button is visible on the form\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Position": "The position of the button\\. \n*Required*: No \n*Type*: [FieldPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AmplifyUIBuilder::Form FormCTA": { + "Cancel": "Displays a cancel button\\. \n*Required*: No \n*Type*: [FormButton](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Clear": "Displays a clear button\\. \n*Required*: No \n*Type*: [FormButton](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Position": "The position of the button\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Submit": "Displays a submit button\\. \n*Required*: No \n*Type*: [FormButton](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AmplifyUIBuilder::Form FormDataTypeConfig": { + "DataSourceType": "The data source type, either an Amplify DataStore model or a custom data type\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataTypeName": "The unique name of the data type you are using as the data source for the form\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AmplifyUIBuilder::Form FormInputValueProperty": { + "Value": "The value to assign to the input field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AmplifyUIBuilder::Form FormStyle": { + "HorizontalGap": "The spacing for the horizontal gap\\. \n*Required*: No \n*Type*: [FormStyleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OuterPadding": "The size of the outer padding for the form\\. \n*Required*: No \n*Type*: [FormStyleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VerticalGap": "The spacing for the vertical gap\\. \n*Required*: No \n*Type*: [FormStyleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AmplifyUIBuilder::Form FormStyleConfig": { + "TokenReference": "A reference to a design token to use to bind the form's style properties to an existing theme\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The value of the style setting\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AmplifyUIBuilder::Form SectionalElement": { + "Excluded": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Level": "Specifies the size of the font for a `Heading` sectional element\\. Valid values are `1 | 2 | 3 | 4 | 5 | 6`\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Orientation": "Specifies the orientation for a `Divider` sectional element\\. Valid values are `horizontal` or `vertical`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Position": "Specifies the position of the text in a field for a `Text` sectional element\\. \n*Required*: No \n*Type*: [FieldPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Text": "The text for a `Text` sectional element\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of sectional element\\. Valid values are `Heading`, `Text`, and `Divider`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AmplifyUIBuilder::Form ValueMapping": { + "DisplayValue": "The value to display for the complex object\\. \n*Required*: No \n*Type*: [FormInputValueProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The complex object\\. \n*Required*: Yes \n*Type*: [FormInputValueProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AmplifyUIBuilder::Form ValueMappings": { + "Values": "The value and display value pairs\\. \n*Required*: Yes \n*Type*: List of [ValueMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemapping.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AmplifyUIBuilder::Theme": { + "AppId": "The unique ID for the Amplify app associated with the theme\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnvironmentName": "The name of the backend environment that is a part of the Amplify app\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the theme\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Overrides": "Describes the properties that can be overriden to customize a theme\\. \n*Required*: No \n*Type*: List of [ThemeValues](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-theme-themevalues.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "One or more key\\-value pairs to use when tagging the theme\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -485,82 +607,82 @@ "Value": "The value of the property\\. \n*Required*: No \n*Type*: [ThemeValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-theme-themevalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Account": { - "CloudWatchRoleArn": "The Amazon Resource Name \\(ARN\\) of an IAM role that has write access to CloudWatch Logs in your account\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CloudWatchRoleArn": "The ARN of an Amazon CloudWatch role for the current Account\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::ApiKey": { - "CustomerId": "An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "A description of the purpose of the API key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Enabled": "Indicates whether the API key can be used by clients\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "GenerateDistinctId": "Specifies whether the key identifier is distinct from the created API key value\\. This parameter is deprecated and should not be used\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CustomerId": "An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the ApiKey\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Enabled": "Specifies whether the ApiKey can be used by callers\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "GenerateDistinctId": "Specifies whether \\(`true`\\) or not \\(`false`\\) the key identifier is distinct from the created API key value\\. This parameter is deprecated and should not be used\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "A name for the API key\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StageKeys": "A list of stages to associate with this API key\\. \n*Required*: No \n*Type*: List of [StageKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the API key\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Value": "The value of the API key\\. Must be at least 20 characters long\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "StageKeys": "DEPRECATED FOR USAGE PLANS \\- Specifies stages associated with the API key\\. \n*Required*: No \n*Type*: List of [StageKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The key\\-value map of strings\\. The valid character set is \\[a\\-zA\\-Z\\+\\-=\\.\\_:/\\]\\. The tag key can be up to 128 characters and must not start with `aws:`\\. The tag value can be up to 256 characters\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "Specifies a value of the API key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ApiGateway::ApiKey StageKey": { - "RestApiId": "The ID of a `RestApi` resource that includes the stage with which you want to associate the API key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StageName": "The name of the stage with which to associate the API key\\. The stage must be included in the `RestApi` resource that you specified in the `RestApiId` property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "RestApiId": "The string identifier of the associated RestApi\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StageName": "The stage name associated with the stage key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Authorizer": { - "AuthType": "An optional customer\\-defined field that's used in OpenApi imports and exports without functional impact\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AuthorizerCredentials": "The credentials that are required for the authorizer\\. To specify an IAM role that API Gateway assumes, specify the role's Amazon Resource Name \\(ARN\\)\\. To use resource\\-based permissions on the Lambda function, specify null\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AuthorizerResultTtlInSeconds": "The time\\-to\\-live \\(TTL\\) period, in seconds, that specifies how long API Gateway caches authorizer results\\. If you specify a value greater than 0, API Gateway caches the authorizer responses\\. By default, API Gateway sets this property to 300\\. The maximum value is 3600, or 1 hour\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AuthorizerUri": "The authorizer's Uniform Resource Identifier \\(URI\\)\\. If you specify `TOKEN` for the authorizer's `Type` property, specify a Lambda function URI that has the form `arn:aws:apigateway:region:lambda:path/path`\\. The path usually has the form /2015\\-03\\-31/functions/*LambdaFunctionARN*/invocations\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IdentitySource": "The source of the identity in an incoming request\\. \nIf you specify `TOKEN` or `COGNITO_USER_POOLS` for the `Type` property, this property is required\\. Specify a header mapping expression using the form `method.request.header.name`, where *name* is the name of a custom authorization header that clients submit as part of their requests\\. \nIf you specify `REQUEST` for the `Type` property, this property is required when authorization caching is enabled\\. Specify a comma\\-separated string of one or more mapping expressions of the specified request parameter using the form `method.request.parameter.name`\\. For supported parameter types, see [Configure Lambda Authorizer Using the API Gateway Console](https://docs.aws.amazon.com/apigateway/latest/developerguide/configure-api-gateway-lambda-authorization-with-console.html) in the *API Gateway Developer Guide*\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IdentityValidationExpression": "A validation expression for the incoming identity\\. If you specify `TOKEN` for the authorizer's `Type` property, specify a regular expression\\. API Gateway uses the expression to attempt to match the incoming client token, and proceeds if the token matches\\. If the token doesn't match, API Gateway responds with a 401 \\(unauthorized request\\) error code\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthType": "Optional customer\\-defined field, used in OpenAPI imports and exports without functional impact\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthorizerCredentials": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer\\. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name \\(ARN\\)\\. To use resource\\-based permissions on the Lambda function, specify null\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthorizerResultTtlInSeconds": "The TTL in seconds of cached authorizer results\\. If it equals 0, authorization caching is disabled\\. If it is greater than 0, API Gateway will cache authorizer responses\\. If this field is not set, the default value is 300\\. The maximum value is 3600, or 1 hour\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthorizerUri": "Specifies the authorizer's Uniform Resource Identifier \\(URI\\)\\. For `TOKEN` or `REQUEST` authorizers, this must be a well\\-formed Lambda function URI, for example, `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations`\\. In general, the URI has this form `arn:aws:apigateway:{region}:lambda:path/{service_api}`, where `{region}` is the same as the region hosting the Lambda function, `path` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial `/`\\. For Lambda functions, this is usually of the form `/2015-03-31/functions/[FunctionARN]/invocations`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IdentitySource": "The identity source for which authorization is requested\\. For a `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client\\. For example, if the token header name is `Auth`, the header mapping expression is `method.request.header.Auth`\\. For the `REQUEST` authorizer, this is required when authorization caching is enabled\\. The value is a comma\\-separated string of one or more mapping expressions of the specified request parameters\\. For example, if an `Auth` header, a `Name` query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`\\. These parameters will be used to derive the authorization caching key and to perform runtime validation of the `REQUEST` authorizer by verifying all of the identity\\-related request parameters are present, not null and non\\-empty\\. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function\\. The valid value is a string of comma\\-separated mapping expressions of the specified request parameters\\. When the authorization caching is not enabled, this property is optional\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IdentityValidationExpression": "A validation expression for the incoming identity token\\. For `TOKEN` authorizers, this value is a regular expression\\. For `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud` field of the incoming token from the client against the specified regular expression\\. It will invoke the authorizer's Lambda function when there is a match\\. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function\\. The validation expression does not apply to the `REQUEST` authorizer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the authorizer\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ProviderARNs": "A list of the Amazon Cognito user pool Amazon Resource Names \\(ARNs\\) to associate with this authorizer\\. Required if you specify `COGNITO_USER_POOLS` as the authorizer `Type`\\. For more information, see [Use Amazon Cognito User Pools](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html#apigateway-enable-cognito-user-pool) in the *API Gateway Developer Guide*\\. \n*Required*: Conditional \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RestApiId": "The ID of the `RestApi` resource that API Gateway creates the authorizer in\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Type": "The type of authorizer\\. Valid values include: \n+ `TOKEN`: A custom authorizer that uses a Lambda function\\.\n+ `COGNITO_USER_POOLS`: An authorizer that uses Amazon Cognito user pools\\.\n+ `REQUEST`: An authorizer that uses a Lambda function using incoming request parameters\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ProviderARNs": "A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer\\. Each element is of this format: `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}`\\. For a `TOKEN` or `REQUEST` authorizer, this is not defined\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RestApiId": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Type": "The authorizer type\\. Valid values are `TOKEN` for a Lambda function using a single authorization token submitted in a custom header, `REQUEST` for a Lambda function using incoming request parameters, and `COGNITO_USER_POOLS` for using an Amazon Cognito user pool\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::BasePathMapping": { - "BasePath": "The base path name that callers of the API must provide in the URL after the domain name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DomainName": "The `DomainName` of an [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Id": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RestApiId": "The ID of the API\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Stage": "The name of the API's stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "BasePath": "The base path name that callers of the API must provide as part of the URL after the domain name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DomainName": "The domain name of the BasePathMapping resource to be described\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Id": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RestApiId": "The string identifier of the associated RestApi\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Stage": "The name of the associated stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::ClientCertificate": { - "Description": "A description of the client certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the client certificate\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Description": "The description of the client certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Deployment": { - "DeploymentCanarySettings": "Specifies settings for the canary deployment\\. \n*Required*: No \n*Type*: [DeploymentCanarySettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Description": "A description of the purpose of the API Gateway deployment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RestApiId": "The ID of the `RestApi` resource to deploy\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StageDescription": "Configures the stage that API Gateway creates with this deployment\\. \n*Required*: No \n*Type*: [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StageName": "A name for the stage that API Gateway creates with this deployment\\. Use only alphanumeric characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DeploymentCanarySettings": "The input configuration for a canary deployment\\. \n*Required*: No \n*Type*: [DeploymentCanarySettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Description": "The description for the Deployment resource to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RestApiId": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StageDescription": "The description of the Stage resource for the Deployment resource to create\\. \n*Required*: No \n*Type*: [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StageName": "The name of the Stage resource for the Deployment resource to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Deployment AccessLogSetting": { "DestinationArn": "The Amazon Resource Name \\(ARN\\) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs\\. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with `amazon-apigateway-`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Format": "A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference)\\. The format must include at least `$context.requestId`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Format": "A single line format of the access logs of data, as specified by selected $context variables\\. The format must include at least `$context.requestId`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Deployment CanarySetting": { "PercentTraffic": "The percent \\(0\\-100\\) of traffic diverted to a canary deployment\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StageVariableOverrides": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary\\. These stage variables are represented as a string\\-to\\-string map between stage variable names and their values\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UseStageCache": "Whether the canary deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "UseStageCache": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Deployment DeploymentCanarySettings": { - "PercentTraffic": "The percentage \\(0\\-100\\) of traffic diverted to a canary deployment\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StageVariableOverrides": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary\\. These stage variables are represented as a string\\-to\\-string map between stage variable names and their values\\. \nDuplicates are not allowed\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "UseStageCache": "Whether the canary deployment uses the stage cache\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "PercentTraffic": "The percentage \\(0\\.0\\-100\\.0\\) of traffic routed to the canary deployment\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StageVariableOverrides": "A stage variable overrides used for the canary release deployment\\. They can override existing stage variables or add new stage variables for the canary release deployment\\. These stage variables are represented as a string\\-to\\-string map between stage variable names and their values\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "UseStageCache": "A Boolean flag to indicate whether the canary release deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ApiGateway::Deployment MethodSetting": { - "CacheDataEncrypted": "Indicates whether the cached responses are encrypted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CacheTtlInSeconds": "The time\\-to\\-live \\(TTL\\) period, in seconds, that specifies how long API Gateway caches responses\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CachingEnabled": "Indicates whether responses are cached and returned for requests\\. You must enable a cache cluster on the stage to cache responses\\. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DataTraceEnabled": "Indicates whether data trace logging is enabled for methods in the stage\\. API Gateway pushes these logs to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CacheDataEncrypted": "Specifies whether the cached responses are encrypted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CacheTtlInSeconds": "Specifies the time to live \\(TTL\\), in seconds, for cached responses\\. The higher the TTL, the longer the response will be cached\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CachingEnabled": "Specifies whether responses should be cached and returned for requests\\. A cache cluster must be enabled on the stage for responses to be cached\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataTraceEnabled": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HttpMethod": "The HTTP method\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LoggingLevel": "The logging level for this method\\. For valid values, see the `loggingLevel` property of the [Stage](https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the *Amazon API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MetricsEnabled": "Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LoggingLevel": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs\\. Valid values are `OFF`, `ERROR`, and `INFO`\\. Choose `ERROR` to write only error\\-level entries to CloudWatch Logs, or choose `INFO` to include all `ERROR` events as well as extra informational events\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MetricsEnabled": "Specifies whether Amazon CloudWatch metrics are enabled for this method\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResourcePath": "The resource path for this method\\. Forward slashes \\(`/`\\) are encoded as `~1` and the initial slash must include a forward slash\\. For example, the path value `/resource/subresource` must be encoded as `/~1resource~1subresource`\\. To specify the root path, use only a slash \\(`/`\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ThrottlingBurstLimit": "The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account\\. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ThrottlingRateLimit": "The number of steady\\-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account\\. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ThrottlingBurstLimit": "Specifies the throttling burst limit\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ThrottlingRateLimit": "Specifies the throttling rate limit\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Deployment StageDescription": { "AccessLogSetting": "Specifies settings for logging access in this stage\\. \n*Required*: No \n*Type*: [AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CacheClusterEnabled": "Indicates whether cache clustering is enabled for the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CacheClusterSize": "The size of the stage's cache cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CacheClusterEnabled": "Specifies whether a cache cluster is enabled for the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CacheClusterSize": "The size of the stage's cache cluster\\. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CacheDataEncrypted": "Indicates whether the cached responses are encrypted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CacheTtlInSeconds": "The time\\-to\\-live \\(TTL\\) period, in seconds, that specifies how long API Gateway caches responses\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CachingEnabled": "Indicates whether responses are cached and returned for requests\\. You must enable a cache cluster on the stage to cache responses\\. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -569,7 +691,7 @@ "DataTraceEnabled": "Indicates whether data trace logging is enabled for methods in the stage\\. API Gateway pushes these logs to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description of the purpose of the stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DocumentationVersion": "The version identifier of the API documentation snapshot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LoggingLevel": "The logging level for this method\\. For valid values, see the `loggingLevel` property of the [Stage](https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the *Amazon API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LoggingLevel": "The logging level for this method\\. For valid values, see the `loggingLevel` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MethodSettings": "Configures settings for all of the stage's methods\\. \n*Required*: No \n*Type*: List of [MethodSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MetricsEnabled": "Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the stage\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -579,127 +701,127 @@ "Variables": "A map that defines the stage variables\\. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: `[A-Za-z0-9-._~:/?#&=,]+`\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::DocumentationPart": { - "Location": "The location of the API entity that the documentation applies to\\. \n*Required*: Yes \n*Type*: [Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Properties": "The documentation content map of the targeted API entity\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RestApiId": "The identifier of the targeted API entity\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Location": "The location of the targeted API entity of the to\\-be\\-created documentation part\\. \n*Required*: Yes \n*Type*: [Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Properties": "The new documentation content map of the targeted API entity\\. Enclosed key\\-value pairs are API\\-specific, but only OpenAPI\\-compliant key\\-value pairs can be exported and, hence, published\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RestApiId": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ApiGateway::DocumentationPart Location": { - "Method": "The HTTP verb of a method\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Name": "The name of the targeted API entity\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Path": "The URL path of the target\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StatusCode": "The HTTP status code of a response\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Type": "The type of API entity that the documentation content applies to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Method": "The HTTP verb of a method\\. It is a valid field for the API entity types of `METHOD`, `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`\\. The default value is `*` for any method\\. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other `location` attributes, the child entity's `method` attribute must match that of the parent entity exactly\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the targeted API entity\\. It is a valid and required field for the API entity types of `AUTHORIZER`, `MODEL`, `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY` and `RESPONSE_HEADER`\\. It is an invalid field for any other entity type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Path": "The URL path of the target\\. It is a valid field for the API entity types of `RESOURCE`, `METHOD`, `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`\\. The default value is `/` for the root resource\\. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other `location` attributes, the child entity's `path` attribute must match that of the parent entity as a prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StatusCode": "The HTTP status code of a response\\. It is a valid field for the API entity types of `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`\\. The default value is `*` for any status code\\. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other `location` attributes, the child entity's `statusCode` attribute must match that of the parent entity exactly\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^([1-5]\\d\\d|\\*|\\s*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Type": "The type of API entity to which the documentation content applies\\. Valid values are `API`, `AUTHORIZER`, `MODEL`, `RESOURCE`, `METHOD`, `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`\\. Content inheritance does not apply to any entity of the `API`, `AUTHORIZER`, `METHOD`, `MODEL`, `REQUEST_BODY`, or `RESOURCE` type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `API | AUTHORIZER | METHOD | MODEL | PATH_PARAMETER | QUERY_PARAMETER | REQUEST_BODY | REQUEST_HEADER | RESOURCE | RESPONSE | RESPONSE_BODY | RESPONSE_HEADER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ApiGateway::DocumentationVersion": { - "Description": "The description of the API documentation snapshot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DocumentationVersion": "The version identifier of the API documentation snapshot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "RestApiId": "The identifier of the API\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Description": "A description about the new documentation snapshot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DocumentationVersion": "The version identifier of the to\\-be\\-updated documentation version\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RestApiId": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ApiGateway::DomainName": { - "CertificateArn": "The reference to an AWS\\-managed certificate for use by the edge\\-optimized endpoint for this domain name\\. AWS Certificate Manager is the only supported source\\. For requirements and additional information about setting up certificates, see [Get Certificates Ready in AWS Certificate Manager](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html#how-to-custom-domains-prerequisites) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DomainName": "The custom domain name for your API\\. Uppercase letters are not supported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "EndpointConfiguration": "A list of the endpoint types of the domain name\\. \n*Required*: No \n*Type*: [EndpointConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MutualTlsAuthentication": "The mutual TLS authentication configuration for a custom domain name\\. \n*Required*: No \n*Type*: [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CertificateArn": "The reference to an AWS\\-managed certificate that will be used by edge\\-optimized endpoint for this domain name\\. AWS Certificate Manager is the only supported source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DomainName": "The custom domain name as an API host name, for example, `my-api.example.com`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EndpointConfiguration": "The endpoint configuration of this DomainName showing the endpoint types of the domain name\\. \n*Required*: No \n*Type*: [EndpointConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MutualTlsAuthentication": "The mutual TLS authentication configuration for a custom domain name\\. If specified, API Gateway performs two\\-way authentication between the client and the server\\. Clients must present a trusted certificate to access your API\\. \n*Required*: No \n*Type*: [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OwnershipVerificationCertificateArn": "The ARN of the public certificate issued by ACM to validate ownership of your custom domain\\. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RegionalCertificateArn": "The reference to an AWS\\-managed certificate for use by the regional endpoint for the domain name\\. AWS Certificate Manager is the only supported source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecurityPolicy": "The Transport Layer Security \\(TLS\\) version \\+ cipher suite for this domain name\\. \nValid values include `TLS_1_0` and `TLS_1_2`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the domain name\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "RegionalCertificateArn": "The reference to an AWS\\-managed certificate that will be used for validating the regional domain name\\. AWS Certificate Manager is the only supported source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecurityPolicy": "The Transport Layer Security \\(TLS\\) version \\+ cipher suite for this DomainName\\. The valid values are `TLS_1_0` and `TLS_1_2`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `TLS_1_0 | TLS_1_2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::DomainName EndpointConfiguration": { - "Types": "A list of endpoint types of an API or its custom domain name\\. For an edge\\-optimized API and its custom domain name, the endpoint type is `EDGE`\\. For a regional API and its custom domain name, the endpoint type is `REGIONAL`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Types": "A list of endpoint types of an API \\(RestApi\\) or its custom domain name \\(DomainName\\)\\. For an edge\\-optimized API and its custom domain name, the endpoint type is `\"EDGE\"`\\. For a regional API and its custom domain name, the endpoint type is `REGIONAL`\\. For a private API, the endpoint type is `PRIVATE`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::DomainName MutualTlsAuthentication": { - "TruststoreUri": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, `s3://bucket-name/key-name`\\. The truststore can contain certificates from public or private certificate authorities\\. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version\\. To update the truststore, you must have permissions to access the S3 object\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TruststoreUri": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example `s3://bucket-name/key-name`\\. The truststore can contain certificates from public or private certificate authorities\\. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version\\. To update the truststore, you must have permissions to access the S3 object\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TruststoreVersion": "The version of the S3 object that contains your truststore\\. To specify a version, you must have versioning enabled for the S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::GatewayResponse": { - "ResponseParameters": "The response parameters \\(paths, query strings, and headers\\) for the response\\. Duplicates not allowed\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResponseTemplates": "The response templates for the response\\. Duplicates not allowed\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResponseType": "The response type\\. For valid values, see [GatewayResponse](https://docs.aws.amazon.com/apigateway/api-reference/resource/gateway-response/) in the *API Gateway API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "RestApiId": "The identifier of the API\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StatusCode": "The HTTP status code for the response\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ResponseParameters": "Response parameters \\(paths, query strings and headers\\) of the GatewayResponse as a string\\-to\\-string map of key\\-value pairs\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResponseTemplates": "Response templates of the GatewayResponse as a string\\-to\\-string map of key\\-value pairs\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResponseType": "The response type of the associated GatewayResponse\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ACCESS_DENIED | API_CONFIGURATION_ERROR | AUTHORIZER_CONFIGURATION_ERROR | AUTHORIZER_FAILURE | BAD_REQUEST_BODY | BAD_REQUEST_PARAMETERS | DEFAULT_4XX | DEFAULT_5XX | EXPIRED_TOKEN | INTEGRATION_FAILURE | INTEGRATION_TIMEOUT | INVALID_API_KEY | INVALID_SIGNATURE | MISSING_AUTHENTICATION_TOKEN | QUOTA_EXCEEDED | REQUEST_TOO_LARGE | RESOURCE_NOT_FOUND | THROTTLED | UNAUTHORIZED | UNSUPPORTED_MEDIA_TYPE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RestApiId": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StatusCode": "The HTTP status code for this GatewayResponse\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Method": { - "ApiKeyRequired": "Indicates whether the method requires clients to submit a valid API key\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AuthorizationScopes": "A list of authorization scopes configured on the method\\. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation\\. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request\\. The method invocation is authorized if any method scopes match a claimed scope in the access token\\. Otherwise, the invocation is not authorized\\. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AuthorizationType": "The method's authorization type\\. This parameter is required\\. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/api-reference/resource/method/) in the *API Gateway API Reference*\\. \nIf you specify the `AuthorizerId` property, specify `CUSTOM` or `COGNITO_USER_POOLS` for this property\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AuthorizerId": "The identifier of the [authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html) to use on this method\\. If you specify this property, specify `CUSTOM` or `COGNITO_USER_POOLS` for the `AuthorizationType` property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "HttpMethod": "The HTTP method that clients use to call this method\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Integration": "The backend system that the method calls when it receives a request\\. \n*Required*: No \n*Type*: [Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MethodResponses": "The responses that can be sent to the client who calls the method\\. \n*Required*: No \n*Type*: List of [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OperationName": "A friendly operation name for the method\\. For example, you can assign the `OperationName` of `ListPets` for the `GET /pets` method\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RequestModels": "The resources that are used for the request's content type\\. Specify request models as key\\-value pairs \\(string\\-to\\-string mapping\\), with a content type as the key and a `Model` resource name as the value\\. To use the same model regardless of the content type, specify `$default` as the key\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RequestParameters": "The request parameters that API Gateway accepts\\. Specify request parameters as key\\-value pairs \\(string\\-to\\-Boolean mapping\\), with a source as the key and a Boolean as the value\\. The Boolean specifies whether a parameter is required\\. A source must match the format `method.request.location.name`, where the location is querystring, path, or header, and *name* is a valid, unique parameter name\\. \n*Required*: No \n*Type*: Map of Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RequestValidatorId": "The ID of the associated request validator\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResourceId": "The ID of an API Gateway [resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html)\\. For root resource methods, specify the `RestApi` root resource ID, such as `{ \"Fn::GetAtt\": [\"MyRestApi\", \"RootResourceId\"] }`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RestApiId": "The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which API Gateway creates the method\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ApiKeyRequired": "A boolean flag specifying whether a valid ApiKey is required to invoke this method\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthorizationScopes": "A list of authorization scopes configured on the method\\. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation\\. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request\\. The method invocation is authorized if any method scopes matches a claimed scope in the access token\\. Otherwise, the invocation is not authorized\\. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthorizationType": "The method's authorization type\\. This parameter is required\\. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*\\. \nIf you specify the `AuthorizerId` property, specify `CUSTOM` or `COGNITO_USER_POOLS` for this property\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthorizerId": "The identifier of an Authorizer to use on this method\\. The `authorizationType` must be `CUSTOM`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HttpMethod": "The method's HTTP verb\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Integration": "Represents an `HTTP`, `HTTP_PROXY`, `AWS`, `AWS_PROXY`, or Mock integration\\. \n*Required*: No \n*Type*: [Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MethodResponses": "Gets a method response associated with a given HTTP status code\\. \n*Required*: No \n*Type*: List of [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OperationName": "A human\\-friendly operation identifier for the method\\. For example, you can assign the `operationName` of `ListPets` for the `GET /pets` method in the `PetStore` example\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RequestModels": "A key\\-value map specifying data schemas, represented by Model resources, \\(as the mapped value\\) of the request payloads of given content types \\(as the mapping key\\)\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RequestParameters": "A key\\-value map defining required or optional method request parameters that can be accepted by API Gateway\\. A key is a method request parameter name matching the pattern of `method.request.{location}.{name}`, where `location` is `querystring`, `path`, or `header` and `name` is a valid and unique parameter name\\. The value associated with the key is a Boolean flag indicating whether the parameter is required \\(`true`\\) or optional \\(`false`\\)\\. The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates\\. \n*Required*: No \n*Type*: Map of Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RequestValidatorId": "The identifier of a RequestValidator for request validation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceId": "The Resource identifier for the MethodResponse resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RestApiId": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Method Integration": { - "CacheKeyParameters": "A list of request parameters whose values API Gateway caches\\. For cases where the integration type allows for RequestParameters to be set, these parameters must also be specified in [RequestParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters) to be supported in `CacheKeyParameters`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CacheNamespace": "An API\\-specific tag group of related cached parameters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ConnectionId": "The ID of the `VpcLink` used for the integration when `connectionType=VPC_LINK`, otherwise undefined\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ConnectionType": "The type of the network connection to the integration endpoint\\. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC\\. The default value is `INTERNET`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ContentHandling": "Specifies how to handle request payload content type conversions\\. Valid values are: \n+ `CONVERT_TO_BINARY`: Converts a request payload from a base64\\-encoded string to a binary blob\\.\n+ `CONVERT_TO_TEXT`: Converts a request payload from a binary blob to a base64\\-encoded string\\.\nIf this property isn't defined, the request payload is passed through from the method request to the integration request without modification, provided that the `PassthroughBehaviors` property is configured to support payload pass\\-through\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Credentials": "The credentials that are required for the integration\\. To specify an AWS Identity and Access Management \\(IAM\\) role that API Gateway assumes, specify the role's Amazon Resource Name \\(ARN\\)\\. To require that the caller's identity be passed through from the request, specify arn:aws:iam::\\*:user/\\*\\. \nTo use resource\\-based permissions on the AWS Lambda \\(Lambda\\) function, don't specify this property\\. Use the [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) resource to permit API Gateway to call the function\\. For more information, see [Allow Amazon API Gateway to Invoke a Lambda Function](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html#access-control-resource-based-example-apigateway-invoke-function) in the *AWS Lambda Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IntegrationHttpMethod": "The integration's HTTP method type\\. \nFor the `Type` property, if you specify `MOCK`, this property is optional\\. For all other types, you must specify this property\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IntegrationResponses": "The response that API Gateway provides after a method's backend completes processing a request\\. API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses\\. For example, you can map the backend status codes to codes that you define\\. \n*Required*: No \n*Type*: List of [IntegrationResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PassthroughBehavior": "Indicates when API Gateway passes requests to the targeted backend\\. This behavior depends on the request's `Content-Type` header and whether you defined a mapping template for it\\. \nFor more information and valid values, see the [passthroughBehavior](https://docs.aws.amazon.com/apigateway/api-reference/link-relation/integration-put/#passthroughBehavior) field in the *API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RequestParameters": "The request parameters that API Gateway sends with the backend request\\. Specify request parameters as key\\-value pairs \\(string\\-to\\-string mappings\\), with a destination as the key and a source as the value\\. \nSpecify the destination by using the following pattern `integration.request.location.name`, where *location* is query string, path, or header, and *name* is a valid, unique parameter name\\. \nThe source must be an existing method request parameter or a static value\\. You must enclose static values in single quotation marks and pre\\-encode these values based on their destination in the request\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RequestTemplates": "A map of Apache Velocity templates that are applied on the request payload\\. The template that API Gateway uses is based on the value of the `Content-Type` header that's sent by the client\\. The content type value is the key, and the template is the value \\(specified as a string\\), such as the following snippet: \n`\"application/json\": \"{\\n \\\"statusCode\\\": 200\\n}\"` \nFor more information about templates, see [API Gateway Mapping Template and Access Logging Variable Reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CacheKeyParameters": "A list of request parameters whose values API Gateway caches\\. To be valid values for `cacheKeyParameters`, these parameters must also be specified for Method `requestParameters`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CacheNamespace": "Specifies a group of related cached parameters\\. By default, API Gateway uses the resource ID as the `cacheNamespace`\\. You can specify the same `cacheNamespace` across resources to return the same cached data for requests to different resources\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectionId": "The ID of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectionType": "The type of the network connection to the integration endpoint\\. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC\\. The default value is `INTERNET`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `INTERNET | VPC_LINK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContentHandling": "Specifies how to handle request payload content type conversions\\. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors: \nIf this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the `passthroughBehavior` is configured to support payload pass\\-through\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CONVERT_TO_BINARY | CONVERT_TO_TEXT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Credentials": "Specifies the credentials required for the integration, if any\\. For AWS integrations, three options are available\\. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name \\(ARN\\)\\. To require that the caller's identity be passed through from the request, specify the string `arn:aws:iam::\\*:user/\\*`\\. To use resource\\-based permissions on supported AWS services, specify null\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IntegrationHttpMethod": "Specifies the integration's HTTP method type\\. For the Type property, if you specify `MOCK`, this property is optional\\. For Lambda integrations, you must set the integration method to `POST`\\. For all other types, you must specify this property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IntegrationResponses": "Specifies the integration's responses\\. \n*Required*: No \n*Type*: List of [IntegrationResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PassthroughBehavior": "Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation\\. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in `requestTemplates`\\. The valid value is one of the following: `WHEN_NO_MATCH`: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request\\. `WHEN_NO_TEMPLATES`: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request\\. If a template is defined when this option is selected, the method request of an unmapped content\\-type will be rejected with an HTTP 415 Unsupported Media Type response\\. `NEVER`: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RequestParameters": "A key\\-value map specifying request parameters that are passed from the method request to the back end\\. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre\\-encoded as required by the back end\\. The method request parameter value must match the pattern of `method.request.{location}.{name}`, where `location` is `querystring`, `path`, or `header` and `name` must be a valid and unique method request parameter name\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RequestTemplates": "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content\\-Type header sent by the client\\. The content type value is the key in this map, and the template \\(as a String\\) is the value\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TimeoutInMillis": "Custom timeout between 50 and 29,000 milliseconds\\. The default value is 29,000 milliseconds or 29 seconds\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Type": "The type of backend that your method is running, such as `HTTP` or `MOCK`\\. For all of the valid values, see the [type](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#type) property for the `Integration` resource in the *Amazon API Gateway REST API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Uri": "The Uniform Resource Identifier \\(URI\\) for the integration\\. \nIf you specify `HTTP` for the `Type` property, specify the API endpoint URL\\. \nIf you specify `MOCK` for the `Type` property, don't specify this property\\. \nIf you specify `AWS` for the `Type` property, specify an AWS service that follows this form: arn:aws:apigateway:*region*:*subdomain*\\.*service\\|service*:*path\\|action*/*service\\_api*\\. For example, a Lambda function URI follows this form: arn:aws:apigateway:*region*:lambda:path/*path*\\. The path is usually in the form /2015\\-03\\-31/functions/*LambdaFunctionARN*/invocations\\. For more information, see the `uri` property of the [Integration](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/) resource in the Amazon API Gateway REST API Reference\\. \nIf you specified `HTTP` or `AWS` for the `Type` property, you must specify this property\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Type": "Specifies an API method integration type\\. The valid value is one of the following: \nFor the HTTP and HTTP proxy integrations, each integration can specify a protocol \\(`http/https`\\), port and path\\. Standard 80 and 443 ports are supported as well as custom ports above 1024\\. An HTTP or HTTP proxy integration with a `connectionType` of `VPC_LINK` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AWS | AWS_PROXY | HTTP | HTTP_PROXY | MOCK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Uri": "Specifies Uniform Resource Identifier \\(URI\\) of the integration endpoint\\. \nFor `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully formed, encoded HTTP\\(S\\) URL according to the RFC\\-3986 specification for standard integrations\\. If `connectionType` is `VPC_LINK` specify the Network Load Balancer DNS name\\. For `AWS` or `AWS_PROXY` integrations, the URI is of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}`\\. Here, \\{Region\\} is the API Gateway region \\(e\\.g\\., us\\-east\\-1\\); \\{service\\} is the name of the integrated AWS service \\(e\\.g\\., s3\\); and \\{subdomain\\} is a designated subdomain supported by certain AWS service for fast host\\-name lookup\\. action can be used for an AWS service action\\-based API, using an Action=\\{name\\}&\\{p1\\}=\\{v1\\}&p2=\\{v2\\}\\.\\.\\. query string\\. The ensuing \\{service\\_api\\} refers to a supported action \\{name\\} plus any required input parameters\\. Alternatively, path can be used for an AWS service path\\-based API\\. The ensuing service\\_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable\\. For example, for integration with the S3 API of GetObject, the uri can be either `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}` or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Method IntegrationResponse": { - "ContentHandling": "Specifies how to handle request payload content type conversions\\. Valid values are: \n+ `CONVERT_TO_BINARY`: Converts a request payload from a base64\\-encoded string to a binary blob\\.\n+ `CONVERT_TO_TEXT`: Converts a request payload from a binary blob to a base64\\-encoded string\\.\nIf this property isn't defined, the request payload is passed through from the method request to the integration request without modification\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResponseParameters": "The response parameters from the backend response that API Gateway sends to the method response\\. Specify response parameters as key\\-value pairs \\([string\\-to\\-string mappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html)\\)\\. \nUse the destination as the key and the source as the value: \n+ The destination must be an existing response parameter in the [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) property\\.\n+ The source must be an existing method request parameter or a static value\\. You must enclose static values in single quotation marks and pre\\-encode these values based on the destination specified in the request\\.\nFor more information about templates, see [API Gateway Mapping Template and Access Logging Variable Reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResponseTemplates": "The templates that are used to transform the integration response body\\. Specify templates as key\\-value pairs \\(string\\-to\\-string mappings\\), with a content type as the key and a template as the value\\. For more information, see [API Gateway Mapping Template and Access Logging Variable Reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SelectionPattern": "A [regular expression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-regexes.html) that specifies which error strings or status codes from the backend map to the integration response\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StatusCode": "The status code that API Gateway uses to map the integration response to a [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) status code\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ContentHandling": "Specifies how to handle response payload content type conversions\\. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors: \nIf this property is not defined, the response payload will be passed through from the integration response to the method response without modification\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CONVERT_TO_BINARY | CONVERT_TO_TEXT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResponseParameters": "A key\\-value map specifying response parameters that are passed to the method response from the back end\\. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body\\. The mapping key must match the pattern of `method.response.header.{name}`, where `name` is a valid and unique header name\\. The mapped non\\-static value must match the pattern of `integration.response.header.{name}` or `integration.response.body.{JSON-expression}`, where `name` is a valid and unique response header name and `JSON-expression` is a valid JSON expression without the `$` prefix\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResponseTemplates": "Specifies the templates used to transform the integration response body\\. Response templates are represented as a key/value map, with a content\\-type as the key and a template as the value\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SelectionPattern": "Specifies the regular expression \\(regex\\) pattern used to choose an integration response based on the response from the back end\\. For example, if the success response returns nothing and the error response returns some string, you could use the `.+` regex to match error response\\. However, make sure that the error response does not contain any newline \\(`\\n`\\) character in such cases\\. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched\\. For all other HTTP and AWS back ends, the HTTP status code is matched\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StatusCode": "Specifies the status code that is used to map the integration response to an existing MethodResponse\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Method MethodResponse": { - "ResponseModels": "The resources used for the response's content type\\. Specify response models as key\\-value pairs \\(string\\-to\\-string maps\\), with a content type as the key and a [Model](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html) resource name as the value\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResponseParameters": "Response parameters that API Gateway sends to the client that called a method\\. Specify response parameters as key\\-value pairs \\(string\\-to\\-Boolean maps\\), with a destination as the key and a Boolean as the value\\. Specify the destination using the following pattern: `method.response.header.name`, where *name* is a valid, unique header name\\. The Boolean specifies whether a parameter is required\\. \n*Required*: No \n*Type*: Map of Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StatusCode": "The method response's status code, which you map to an [IntegrationResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ResponseModels": "Specifies the Model resources used for the response's content\\-type\\. Response models are represented as a key/value map, with a content\\-type as the key and a Model name as the value\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResponseParameters": "A key\\-value map specifying required or optional response parameters that API Gateway can send back to the caller\\. A key defines a method response header and the value specifies whether the associated method response header is required or not\\. The expression of the key must match the pattern `method.response.header.{name}`, where `name` is a valid and unique header name\\. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse\\. The integration response data that can be mapped include an integration response header expressed in `integration.response.header.{name}`, a static value enclosed within a pair of single quotes \\(e\\.g\\., `'application/json'`\\), or a JSON expression from the back\\-end response payload in the form of `integration.response.body.{JSON-expression}`, where `JSON-expression` is a valid JSON expression without the `$` prefix\\.\\) \n*Required*: No \n*Type*: Map of Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StatusCode": "The method response's status code\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Model": { - "ContentType": "The content type for the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Description": "A description that identifies this model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContentType": "The content\\-type for the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Description": "The description of the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A name for the model\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "RestApiId": "The ID of a REST API with which to associate this model\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Schema": "The schema to use to transform data to one or more output formats\\. Specify null \\(`{}`\\) if you don't want to specify a schema\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "RestApiId": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Schema": "The schema for the model\\. For `application/json` models, this should be JSON schema draft 4 model\\. Do not include \"\\\\\\*/\" characters in the description of any properties because such \"\\\\\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::RequestValidator": { - "Name": "The name of this request validator\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "RestApiId": "The identifier of the targeted API entity\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ValidateRequestBody": "Indicates whether to validate the request body according to the configured schema for the targeted API and method\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ValidateRequestParameters": "Indicates whether to validate request parameters\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "The name of this RequestValidator \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RestApiId": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ValidateRequestBody": "A Boolean flag to indicate whether to validate a request body according to the configured Model schema\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ValidateRequestParameters": "A Boolean flag to indicate whether to validate request parameters \\(`true`\\) or not \\(`false`\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Resource": { - "ParentId": "If you want to create a child resource, the ID of the parent resource\\. For resources without a parent, specify the `RestApi` root resource ID, such as `{ \"Fn::GetAtt\": [\"MyRestApi\", \"RootResourceId\"] }`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PathPart": "A path name for the resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "RestApiId": "The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which you want to create this resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "ParentId": "The parent resource's identifier\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PathPart": "The last path segment for this resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RestApiId": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ApiGateway::RestApi": { - "ApiKeySourceType": "The source of the API key for metering requests according to a usage plan\\. Valid values are: \n+ `HEADER` to read the API key from the `X-API-Key` header of a request\\.\n+ `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a Lambda authorizer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "BinaryMediaTypes": "The list of binary media types that are supported by the `RestApi` resource\\. Use `~1` instead of `/` in the media types, for example `image~1png` or `application~1octet-stream`\\. By default, `RestApi` supports only UTF\\-8\\-encoded text payloads\\. Duplicates are not allowed\\. For more information, see [Enable Support for Binary Payloads in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ApiKeySourceType": "The source of the API key for metering requests according to a usage plan\\. Valid values are: `HEADER` to read the API key from the `X-API-Key` header of a request\\. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BinaryMediaTypes": "The list of binary media types supported by the RestApi\\. By default, the RestApi supports only UTF\\-8\\-encoded text payloads\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Body": "An OpenAPI specification that defines a set of RESTful APIs in JSON format\\. For YAML templates, you can also provide the specification in YAML format\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BodyS3Location": "The Amazon Simple Storage Service \\(Amazon S3\\) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CloneFrom": "The ID of the `RestApi` resource that you want to clone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "A description of the `RestApi` resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DisableExecuteApiEndpoint": "Specifies whether clients can invoke your API by using the default `execute-api` endpoint\\. By default, clients can invoke your API with the default https://\\{api\\_id\\}\\.execute\\-api\\.\\{region\\}\\.amazonaws\\.com endpoint\\. To require that clients use a custom domain name to invoke your API, disable the default endpoint\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CloneFrom": "The ID of the RestApi that you want to clone from\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the RestApi\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DisableExecuteApiEndpoint": "Specifies whether clients can invoke your API by using the default `execute-api` endpoint\\. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint\\. To require that clients use a custom domain name to invoke your API, disable the default endpoint \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EndpointConfiguration": "A list of the endpoint types of the API\\. Use this property when creating an API\\. When importing an existing API, specify the endpoint configuration types using the `Parameters` property\\. \n*Required*: No \n*Type*: [EndpointConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FailOnWarnings": "Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the `RestApi` resource\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailOnWarnings": "A query parameter to indicate whether to rollback the API update \\(`true`\\) or not \\(`false`\\) when a warning is encountered\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MinimumCompressionSize": "A nullable integer that is used to enable compression \\(with non\\-negative between 0 and 10485760 \\(10M\\) bytes, inclusive\\) or disable compression \\(with a null value\\) on an API\\. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value\\. Setting it to zero allows compression for any payload size\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Mode": "This property applies only when you use OpenAPI to define your REST API\\. The `Mode` determines how API Gateway handles resource updates\\. \nValid values are `overwrite` or `merge`\\. \nFor `overwrite`, the new API definition replaces the existing one\\. The existing API identifier remains unchanged\\. \n For `merge`, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API\\. Use `merge` to define top\\-level `RestApi` properties in addition to using OpenAPI\\. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties\\. \nIf you don't specify this property, a default value is chosen\\. For REST APIs created before March 29, 2021, the default is `overwrite`\\. Otherwise, the default value is `merge`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "A name for the `RestApi` resource\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Parameters": "Custom header parameters for the request\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the RestApi\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Parameters": "Custom header parameters as part of the request\\. For example, to exclude DocumentationParts from an imported API, set `ignore=documentation` as a `parameters` value, as in the AWS CLI command of `aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'`\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Policy": "A policy document that contains the permissions for the `RestApi` resource\\. To set the ARN for the policy, use the `!Join` intrinsic function with `\"\"` as delimiter and values of `\"execute-api:/\"` and `\"*\"`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the API\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Tags": "The key\\-value map of strings\\. The valid character set is \\[a\\-zA\\-Z\\+\\-=\\.\\_:/\\]\\. The tag key can be up to 128 characters and must not start with `aws:`\\. The tag value can be up to 256 characters\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::RestApi EndpointConfiguration": { - "Types": "A list of endpoint types of an API or its custom domain name\\. Valid values include: \n+ `EDGE`: For an edge\\-optimized API and its custom domain name\\.\n+ `REGIONAL`: For a regional API and its custom domain name\\.\n+ `PRIVATE`: For a private API\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VpcEndpointIds": "A list of VPC endpoint IDs of an API \\([AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html)\\) against which to create Route53 ALIASes\\. It is only supported for `PRIVATE` endpoint type\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Types": "A list of endpoint types of an API \\(RestApi\\) or its custom domain name \\(DomainName\\)\\. For an edge\\-optimized API and its custom domain name, the endpoint type is `\"EDGE\"`\\. For a regional API and its custom domain name, the endpoint type is `REGIONAL`\\. For a private API, the endpoint type is `PRIVATE`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcEndpointIds": "A list of VpcEndpointIds of an API \\(RestApi\\) against which to create Route53 ALIASes\\. It is only supported for `PRIVATE` endpoint type\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::RestApi S3Location": { "Bucket": "The name of the S3 bucket where the OpenAPI file is stored\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -708,19 +830,19 @@ "Version": "For versioning\\-enabled buckets, a specific version of the OpenAPI file\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Stage": { - "AccessLogSetting": "Specifies settings for logging access in this stage\\. \n*Required*: No \n*Type*: [AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CacheClusterEnabled": "Indicates whether cache clustering is enabled for the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CacheClusterSize": "The stage's cache cluster size\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CanarySetting": "Specifies settings for the canary deployment in this stage\\. \n*Required*: No \n*Type*: [CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ClientCertificateId": "The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeploymentId": "The ID of the deployment that the stage is associated with\\. This parameter is required to create a stage\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "A description of the stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DocumentationVersion": "The version ID of the API documentation snapshot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MethodSettings": "Settings for all methods in the stage\\. \n*Required*: No \n*Type*: List of [MethodSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RestApiId": "The ID of the `RestApi` resource that you're deploying with this stage\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StageName": "The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier \\(URI\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the stage\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TracingEnabled": "Specifies whether active X\\-Ray tracing is enabled for this stage\\. \nFor more information, see [Trace API Gateway API Execution with AWS X\\-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AccessLogSetting": "Access log settings, including the access log format and access log destination ARN\\. \n*Required*: No \n*Type*: [AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CacheClusterEnabled": "Specifies whether a cache cluster is enabled for the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CacheClusterSize": "The stage's cache capacity in GB\\. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `0.5 | 1.6 | 118 | 13.5 | 237 | 28.4 | 58.2 | 6.1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CanarySetting": "Settings for the canary deployment in this stage\\. \n*Required*: No \n*Type*: [CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientCertificateId": "The identifier of a client certificate for an API stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeploymentId": "The identifier of the Deployment that the stage points to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The stage's description\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DocumentationVersion": "The version of the associated API documentation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MethodSettings": "A map that defines the method settings for a Stage resource\\. Keys \\(designated as `/{method_setting_key` below\\) are method paths defined as `{resource_path}/{http_method}` for an individual method override, or `/\\*/\\*` for overriding all methods in the stage\\. \n*Required*: No \n*Type*: List of [MethodSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RestApiId": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StageName": "The name of the stage is the first path segment in the Uniform Resource Identifier \\(URI\\) of a call to API Gateway\\. Stage names can only contain alphanumeric characters, hyphens, and underscores\\. Maximum length is 128 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TracingEnabled": "Specifies whether active tracing with X\\-ray is enabled for the Stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Variables": "A map \\(string\\-to\\-string map\\) that defines the stage variables, where the variable name is the key and the variable value is the value\\. Variable names are limited to alphanumeric characters\\. Values must match the following regular expression: `[A-Za-z0-9-._~:/?#&=,]+`\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Stage AccessLogSetting": { @@ -728,55 +850,55 @@ "Format": "A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference)\\. The format must include at least `$context.requestId`\\. This parameter is required to enable access logging\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Stage CanarySetting": { - "DeploymentId": "The identifier of the deployment that the stage points to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PercentTraffic": "The percentage \\(0\\-100\\) of traffic diverted to a canary deployment\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StageVariableOverrides": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary\\. These stage variables are represented as a string\\-to\\-string map between stage variable names and their values\\. \nDuplicates are not allowed\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UseStageCache": "Whether the canary deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DeploymentId": "The ID of the canary deployment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PercentTraffic": "The percent \\(0\\-100\\) of traffic diverted to a canary deployment\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StageVariableOverrides": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary\\. These stage variables are represented as a string\\-to\\-string map between stage variable names and their values\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseStageCache": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::Stage MethodSetting": { - "CacheDataEncrypted": "Indicates whether the cached responses are encrypted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CacheTtlInSeconds": "The time\\-to\\-live \\(TTL\\) period, in seconds, that specifies how long API Gateway caches responses\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CachingEnabled": "Indicates whether responses are cached and returned for requests\\. You must enable a cache cluster on the stage to cache responses\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DataTraceEnabled": "Indicates whether data trace logging is enabled for methods in the stage\\. API Gateway pushes these logs to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CacheDataEncrypted": "Specifies whether the cached responses are encrypted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CacheTtlInSeconds": "Specifies the time to live \\(TTL\\), in seconds, for cached responses\\. The higher the TTL, the longer the response will be cached\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CachingEnabled": "Specifies whether responses should be cached and returned for requests\\. A cache cluster must be enabled on the stage for responses to be cached\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataTraceEnabled": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HttpMethod": "The HTTP method\\. To apply settings to multiple resources and methods, specify an asterisk \\(`*`\\) for the `HttpMethod` and `/*` for the `ResourcePath`\\. This parameter is required when you specify a `MethodSetting`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LoggingLevel": "The logging level for this method\\. For valid values, see the `loggingLevel` property of the [Stage](https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the *Amazon API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MetricsEnabled": "Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LoggingLevel": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs\\. Valid values are `OFF`, `ERROR`, and `INFO`\\. Choose `ERROR` to write only error\\-level entries to CloudWatch Logs, or choose `INFO` to include all `ERROR` events as well as extra informational events\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MetricsEnabled": "Specifies whether Amazon CloudWatch metrics are enabled for this method\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResourcePath": "The resource path for this method\\. Forward slashes \\(`/`\\) are encoded as `~1` and the initial slash must include a forward slash\\. For example, the path value `/resource/subresource` must be encoded as `/~1resource~1subresource`\\. To specify the root path, use only a slash \\(`/`\\)\\. To apply settings to multiple resources and methods, specify an asterisk \\(`*`\\) for the `HttpMethod` and `/*` for the `ResourcePath`\\. This parameter is required when you specify a `MethodSetting`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ThrottlingBurstLimit": "The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account\\. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ThrottlingRateLimit": "The number of steady\\-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account\\. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ThrottlingBurstLimit": "Specifies the throttling burst limit\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ThrottlingRateLimit": "Specifies the throttling rate limit\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::UsagePlan": { - "ApiStages": "The API stages to associate with this usage plan\\. \n*Required*: No \n*Type*: List of [ApiStage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "A description of the usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Quota": "Configures the number of requests that users can make within a given interval\\. \n*Required*: No \n*Type*: [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the usage plan\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Throttle": "Configures the overall request rate \\(average requests per second\\) and burst capacity\\. \n*Required*: No \n*Type*: [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UsagePlanName": "A name for the usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ApiStages": "The associated API stages of a usage plan\\. \n*Required*: No \n*Type*: List of [ApiStage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of a usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Quota": "The target maximum number of permitted requests per a given unit time interval\\. \n*Required*: No \n*Type*: [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Throttle": "A map containing method level throttling information for API stage in a usage plan\\. \n*Required*: No \n*Type*: [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UsagePlanName": "The name of a usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::UsagePlan ApiStage": { - "ApiId": "The ID of an API that is in the specified `Stage` property that you want to associate with the usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Stage": "The name of the stage to associate with the usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Throttle": "Map containing method\\-level throttling information for an API stage in a usage plan\\. The key for the map is the path and method for which to configure custom throttling, for example, \"/pets/GET\"\\. \nDuplicates are not allowed\\. \n*Required*: No \n*Type*: Map of [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ApiId": "API Id of the associated API stage in a usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Stage": "API stage name of the associated API stage in a usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Throttle": "Map containing method level throttling information for API stage in a usage plan\\. \n*Required*: No \n*Type*: Map of [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::UsagePlan QuotaSettings": { "Limit": "The target maximum number of requests that can be made in a given time period\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Offset": "The day that a time period starts\\. For example, with a time period of `WEEK`, an offset of `0` starts on Sunday, and an offset of `1` starts on Monday\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Period": "The time period for which the target maximum limit of requests applies, such as `DAY` or `WEEK`\\. For valid values, see the period property for the [UsagePlan](https://docs.aws.amazon.com/apigateway/api-reference/resource/usage-plan) resource in the *Amazon API Gateway REST API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Offset": "The number of requests subtracted from the given limit in the initial time period\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Period": "The time period in which the limit applies\\. Valid values are \"DAY\", \"WEEK\" or \"MONTH\"\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAY | MONTH | WEEK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::UsagePlan ThrottleSettings": { - "BurstLimit": "The API target request burst rate limit\\. This allows more requests through for a period of time than the target rate limit\\. For more information about request throttling, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RateLimit": "The API target request steady\\-state rate limit\\. For more information about request throttling, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "BurstLimit": "The API target request burst rate limit\\. This allows more requests through for a period of time than the target rate limit\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RateLimit": "The API target request rate limit\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGateway::UsagePlanKey": { - "KeyId": "The ID of the usage plan key\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "KeyType": "The type of usage plan key\\. Currently, the only valid key type is `API_KEY`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "UsagePlanId": "The ID of the usage plan\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "KeyId": "The Id of the UsagePlanKey resource to be deleted\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "KeyType": "The type of a UsagePlanKey resource for a plan customer\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "UsagePlanId": "The Id of the UsagePlan resource representing the usage plan containing the to\\-be\\-deleted UsagePlanKey resource representing a plan customer\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ApiGateway::VpcLink": { - "Description": "A description of the VPC link\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "A name for the VPC link\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the VPC link\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name used to label and identify the VPC link\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the VPC link\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TargetArns": "The ARN of network load balancer of the VPC targeted by the VPC link\\. The network load balancer must be owned by the same AWS account of the API owner\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "TargetArns": "The ARN of the network load balancer of the VPC targeted by the VPC link\\. The network load balancer must be owned by the same AWS account of the API owner\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ApiGatewayV2::Api": { "ApiKeySelectionExpression": "An API key selection expression\\. Supported only for WebSocket APIs\\. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -793,7 +915,7 @@ "ProtocolType": "The API protocol\\. Valid values are `WEBSOCKET` or `HTTP`\\. Required unless you specify an OpenAPI definition for `Body` or `S3BodyLocation`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RouteKey": "This property is part of quick create\\. If you don't specify a `routeKey`, a default route of `$default` is created\\. The `$default` route acts as a catch\\-all for any request made to your API, for a particular stage\\. The `$default` route key can't be modified\\. You can add routes after creating the API, and you can update the route keys of additional routes\\. Supported only for HTTP APIs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RouteSelectionExpression": "The route selection expression for the API\\. For HTTP APIs, the `routeSelectionExpression` must be `${request.method} ${request.path}`\\. If not provided, this will be the default for HTTP APIs\\. This property is required for WebSocket APIs\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Target": "This property is part of quick create\\. Quick create produces an API with an integration, a default catch\\-all route, and a default stage which is configured to automatically deploy changes\\. For HTTP integrations, specify a fully qualified URL\\. For Lambda integrations, specify a function ARN\\. The type of the integration will be HTTP\\_PROXY or AWS\\_PROXY, respectively\\. Supported only for HTTP APIs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Version": "A version identifier for the API\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -850,7 +972,7 @@ "StageVariables": "A map that defines the stage variables for a `Stage`\\. Variable names can have alphanumeric and underscore characters, and the values must match \\[A\\-Za\\-z0\\-9\\-\\.\\_\\~:/?\\#&=,\\]\\+\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGatewayV2::ApiMapping": { - "ApiId": "The identifier of the API\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ApiId": "The identifier of the API\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ApiMappingKey": "The API mapping key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DomainName": "The domain name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Stage": "The API stage\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -887,7 +1009,7 @@ "CertificateArn": "An AWS\\-managed certificate that will be used by the edge\\-optimized endpoint for this domain name\\. AWS Certificate Manager is the only supported source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CertificateName": "The user\\-friendly name of the certificate that will be used by the edge\\-optimized endpoint for this domain name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EndpointType": "The endpoint type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OwnershipVerificationCertificateArn": "The ARN of the public certificate issued by ACM to validate ownership of your custom domain\\. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OwnershipVerificationCertificateArn": "The Amazon resource name \\(ARN\\) for the public certificate issued by AWS Certificate Manager\\. This ARN is used to validate custom domain ownership\\. It's required only if you configure mutual TLS and use either an ACM\\-imported or a private CA certificate ARN as the regionalCertificateArn\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityPolicy": "The Transport Layer Security \\(TLS\\) version of the security policy for this domain name\\. The valid values are `TLS_1_0` and `TLS_1_2`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ApiGatewayV2::DomainName MutualTlsAuthentication": { @@ -997,7 +1119,7 @@ "Name": "The name of the VPC link\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityGroupIds": "A list of security group IDs for the VPC link\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SubnetIds": "A list of subnet IDs to include in the VPC link\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Tags": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppConfig::Application": { "Description": "A description of the application\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -1011,8 +1133,8 @@ "AWS::AppConfig::ConfigurationProfile": { "ApplicationId": "The application ID\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[a-z0-9]{4,7}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "A description of the configuration profile\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LocationUri": "A URI to locate the configuration\\. You can specify the AWS AppConfig hosted configuration store, Systems Manager \\(SSM\\) document, an SSM Parameter Store parameter, or an Amazon S3 object\\. For the hosted configuration store and for feature flags, specify `hosted`\\. For an SSM document, specify either the document name in the format `ssm-document://` or the Amazon Resource Name \\(ARN\\)\\. For a parameter, specify either the parameter name in the format `ssm-parameter://` or the ARN\\. For an Amazon S3 object, specify the URI in the following format: `s3:/// `\\. Here is an example: `s3://my-bucket/my-app/us-east-1/my-config.json` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Name": "A name for the configuration profile\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LocationUri": "A URI to locate the configuration\\. You can specify the following: \n+ For the AWS AppConfig hosted configuration store and for feature flags, specify `hosted`\\.\n+ For an AWS Systems Manager Parameter Store parameter, specify either the parameter name in the format `ssm-parameter://` or the ARN\\.\n+ For an AWS Secrets Manager secret, specify the URI in the following format: `secrets-manager`://\\.\n+ For an Amazon S3 object, specify the URI in the following format: `s3:/// `\\. Here is an example: `s3://my-bucket/my-app/us-east-1/my-config.json` \n+ For an SSM document, specify either the document name in the format `ssm-document://` or the Amazon Resource Name \\(ARN\\)\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "A name for the configuration profile\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RetrievalRoleArn": "The ARN of an IAM role with permission to access the configuration at the specified `LocationUri`\\. \nA retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store\\. It is required for all other sources that store your configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `^((https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/arn.html):(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/iam.html)::\\d{12}:role[/].*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Metadata to assign to the configuration profile\\. Tags help organize and categorize your AWS AppConfig resources\\. Each tag consists of a key and an optional value, both of which you define\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-tags.html) of [Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Type": "The type of configurations contained in the profile\\. AWS AppConfig supports `feature flags` and `freeform` configurations\\. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application\\. When calling this API, enter one of the following values for `Type`: \n `AWS.AppConfig.FeatureFlags` \n `AWS.Freeform` \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z\\.]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -1029,11 +1151,12 @@ "AWS::AppConfig::Deployment": { "ApplicationId": "The application ID\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[a-z0-9]{4,7}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ConfigurationProfileId": "The configuration profile ID\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[a-z0-9]{4,7}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ConfigurationVersion": "The configuration version to deploy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ConfigurationVersion": "The configuration version to deploy\\. If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DeploymentStrategyId": "The deployment strategy ID\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[a-z0-9]{4,7}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "A description of the deployment\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EnvironmentId": "The environment ID\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[a-z0-9]{4,7}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "Metadata to assign to the deployment\\. Tags help organize and categorize your AWS AppConfig resources\\. Each tag consists of a key and an optional value, both of which you define\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html) of [Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "KmsKeyIdentifier": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Metadata to assign to the deployment\\. Tags help organize and categorize your AWS AppConfig resources\\. Each tag consists of a key and an optional value, both of which you define\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html) of [Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::AppConfig::Deployment Tags": { "Key": "The key\\-value string map\\. The valid character set is `[a-zA-Z+-=._:/]`\\. The tag key can be up to 128 characters and must not start with `aws:`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -1042,7 +1165,7 @@ "AWS::AppConfig::DeploymentStrategy": { "DeploymentDurationInMinutes": "Total amount of time for a deployment to last\\. \n*Required*: Yes \n*Type*: Double \n*Minimum*: `0` \n*Maximum*: `1440` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description of the deployment strategy\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FinalBakeTimeInMinutes": "The amount of time AWS AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Maximum*: `1440` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FinalBakeTimeInMinutes": "Specifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete\\. If an alarm is triggered during this time, AWS AppConfig rolls back the deployment\\. You must configure permissions for AWS AppConfig to roll back based on CloudWatch alarms\\. For more information, see [Configuring permissions for rollback based on Amazon CloudWatch alarms](https://docs.aws.amazon.com/appconfig/latest/userguide/getting-started-with-appconfig-cloudwatch-alarms-permissions.html) in the * AWS AppConfig User Guide*\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Maximum*: `1440` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GrowthFactor": "The percentage of targets to receive a deployed configuration during each interval\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GrowthType": "The algorithm used to define how percentage grows over time\\. AWS AppConfig supports the following growth types: \n **Linear**: For this type, AWS AppConfig processes the deployment by dividing the total number of targets by the value specified for `Step percentage`\\. For example, a linear deployment that uses a `Step percentage` of 10 deploys the configuration to 10 percent of the hosts\\. After those deployments are complete, the system deploys the configuration to the next 10 percent\\. This continues until 100% of the targets have successfully received the configuration\\. \n **Exponential**: For this type, AWS AppConfig processes the deployment exponentially using the following formula: `G*(2^N)`\\. In this formula, `G` is the growth factor specified by the user and `N` is the number of steps until the configuration is deployed to all targets\\. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows: \n `2*(2^0)` \n `2*(2^1)` \n `2*(2^2)` \nExpressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EXPONENTIAL | LINEAR` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A name for the deployment strategy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -1076,34 +1199,57 @@ "Description": "A description of the configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "LatestVersionNumber": "An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version\\. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::AppFlow::Connector": { + "ConnectorLabel": "The label used for registering the connector\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9][\\w!@#.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ConnectorProvisioningConfig": "The configuration required for registering the connector\\. \n*Required*: Yes \n*Type*: [ConnectorProvisioningConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connector-connectorprovisioningconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectorProvisioningType": "The provisioning type used to register the connector\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `LAMBDA` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "A description of the connector entity field\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `[\\s\\w/!@#+=.-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppFlow::Connector ConnectorProvisioningConfig": { + "Lambda": "Contains information about the configuration of the lambda which is being registered as the connector\\. \n*Required*: No \n*Type*: [LambdaConnectorProvisioningConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connector-lambdaconnectorprovisioningconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppFlow::Connector LambdaConnectorProvisioningConfig": { + "LambdaArn": "Lambda ARN of the connector being registered\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `arn:aws:.*:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppFlow::ConnectorProfile": { "ConnectionMode": "Indicates the connection mode and if it is public or private\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Private | Public` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectorLabel": "The label for the connector profile being created\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9][\\w!@#.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConnectorProfileConfig": "Defines the connector\\-specific configuration and credentials\\. \n*Required*: No \n*Type*: [ConnectorProfileConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConnectorProfileName": "The name of the connector profile\\. The name is unique for each `ConnectorProfile` in the AWS account\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[\\w/!@#+=.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ConnectorType": "The type of connector, such as Salesforce, Amplitude, and so on\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Amplitude | CustomConnector | CustomerProfiles | Datadog | Dynatrace | EventBridge | Googleanalytics | Honeycode | Infornexus | LookoutMetrics | Marketo | Redshift | S3 | Salesforce | SAPOData | Servicenow | Singular | Slack | Snowflake | Trendmicro | Upsolver | Veeva | Zendesk` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ConnectorType": "The type of connector, such as Salesforce, Amplitude, and so on\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Amplitude | CustomConnector | CustomerProfiles | Datadog | Dynatrace | EventBridge | Googleanalytics | Honeycode | Infornexus | LookoutMetrics | Marketo | Pardot | Redshift | S3 | Salesforce | SAPOData | Servicenow | Singular | Slack | Snowflake | Trendmicro | Upsolver | Veeva | Zendesk` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KMSArn": "The ARN \\(Amazon Resource Name\\) of the Key Management Service \\(KMS\\) key you provide for encryption\\. This is required if you do not want to use the Amazon AppFlow\\-managed KMS key\\. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow\\-managed KMS key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:aws:kms:.*:[0-9]+:.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::AppFlow::ConnectorProfile AmplitudeConnectorProfileCredentials": { "ApiKey": "A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecretKey": "The Secret Access Key portion of the credentials\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AppFlow::ConnectorProfile ApiKeyCredentials": { + "ApiKey": "The API key required for API key authentication\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ApiSecretKey": "The API secret key required for API key authentication\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppFlow::ConnectorProfile BasicAuthCredentials": { + "Password": "The password to use to connect to a resource\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Username": "The username to use to connect to a resource\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppFlow::ConnectorProfile ConnectorOAuthRequest": { - "AuthCode": "The code provided by the connector when it has been authenticated via the connected app\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthCode": "The code provided by the connector when it has been authenticated via the connected app\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RedirectUri": "The URL to which the authentication server redirects the browser after authorization has been granted\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile ConnectorProfileConfig": { - "ConnectorProfileCredentials": "The connector\\-specific credentials required by each connector\\. \n*Required*: Yes \n*Type*: [ConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectorProfileCredentials": "The connector\\-specific credentials required by each connector\\. \n*Required*: No \n*Type*: [ConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConnectorProfileProperties": "The connector\\-specific properties of the profile configuration\\. \n*Required*: No \n*Type*: [ConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile ConnectorProfileCredentials": { "Amplitude": "The connector\\-specific credentials required when using Amplitude\\. \n*Required*: No \n*Type*: [AmplitudeConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-amplitudeconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomConnector": "The connector\\-specific profile credentials that are required when using the custom connector\\. \n*Required*: No \n*Type*: [CustomConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Datadog": "The connector\\-specific credentials required when using Datadog\\. \n*Required*: No \n*Type*: [DatadogConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-datadogconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Dynatrace": "The connector\\-specific credentials required when using Dynatrace\\. \n*Required*: No \n*Type*: [DynatraceConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-dynatraceconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GoogleAnalytics": "The connector\\-specific credentials required when using Google Analytics\\. \n*Required*: No \n*Type*: [GoogleAnalyticsConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InforNexus": "The connector\\-specific credentials required when using Infor Nexus\\. \n*Required*: No \n*Type*: [InforNexusConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Marketo": "The connector\\-specific credentials required when using Marketo\\. \n*Required*: No \n*Type*: [MarketoConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Pardot": "The connector\\-specific credentials required when using Salesforce Pardot\\. \n*Required*: No \n*Type*: [PardotConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Redshift": "The connector\\-specific credentials required when using Amazon Redshift\\. \n*Required*: No \n*Type*: [RedshiftConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SAPOData": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SAPODataConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SAPOData": "The connector\\-specific profile credentials required when using SAPOData\\. \n*Required*: No \n*Type*: [SAPODataConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Salesforce": "The connector\\-specific credentials required when using Salesforce\\. \n*Required*: No \n*Type*: [SalesforceConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceNow": "The connector\\-specific credentials required when using ServiceNow\\. \n*Required*: No \n*Type*: [ServiceNowConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-servicenowconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Singular": "The connector\\-specific credentials required when using Singular\\. \n*Required*: No \n*Type*: [SingularConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-singularconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -1114,12 +1260,14 @@ "Zendesk": "The connector\\-specific credentials required when using Zendesk\\. \n*Required*: No \n*Type*: [ZendeskConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile ConnectorProfileProperties": { + "CustomConnector": "The properties required by the custom connector\\. \n*Required*: No \n*Type*: [CustomConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Datadog": "The connector\\-specific properties required by Datadog\\. \n*Required*: No \n*Type*: [DatadogConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-datadogconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Dynatrace": "The connector\\-specific properties required by Dynatrace\\. \n*Required*: No \n*Type*: [DynatraceConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-dynatraceconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InforNexus": "The connector\\-specific properties required by Infor Nexus\\. \n*Required*: No \n*Type*: [InforNexusConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Marketo": "The connector\\-specific properties required by Marketo\\. \n*Required*: No \n*Type*: [MarketoConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Pardot": "The connector\\-specific properties required by Salesforce Pardot\\. \n*Required*: No \n*Type*: [PardotConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Redshift": "The connector\\-specific properties required by Amazon Redshift\\. \n*Required*: No \n*Type*: [RedshiftConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SAPOData": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SAPODataConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SAPOData": "The connector\\-specific profile properties required when using SAPOData\\. \n*Required*: No \n*Type*: [SAPODataConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Salesforce": "The connector\\-specific properties required by Salesforce\\. \n*Required*: No \n*Type*: [SalesforceConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceNow": "The connector\\-specific properties required by serviceNow\\. \n*Required*: No \n*Type*: [ServiceNowConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-servicenowconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Slack": "The connector\\-specific properties required by Slack\\. \n*Required*: No \n*Type*: [SlackConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-slackconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -1127,6 +1275,21 @@ "Veeva": "The connector\\-specific properties required by Veeva\\. \n*Required*: No \n*Type*: [VeevaConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-veevaconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Zendesk": "The connector\\-specific properties required by Zendesk\\. \n*Required*: No \n*Type*: [ZendeskConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AppFlow::ConnectorProfile CustomAuthCredentials": { + "CredentialsMap": "A map that holds custom authentication credentials\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomAuthenticationType": "The custom authentication type that the connector uses\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppFlow::ConnectorProfile CustomConnectorProfileCredentials": { + "ApiKey": "The API keys required for the authentication of the user\\. \n*Required*: No \n*Type*: [ApiKeyCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-apikeycredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthenticationType": "The authentication type that the custom connector uses for authenticating while creating a connector profile\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `APIKEY | BASIC | CUSTOM | OAUTH2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Basic": "The basic credentials that are required for the authentication of the user\\. \n*Required*: No \n*Type*: [BasicAuthCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-basicauthcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Custom": "If the connector uses the custom authentication mechanism, this holds the required credentials\\. \n*Required*: No \n*Type*: [CustomAuthCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customauthcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Oauth2": "The OAuth 2\\.0 credentials required for the authentication of the user\\. \n*Required*: No \n*Type*: [OAuth2Credentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppFlow::ConnectorProfile CustomConnectorProfileProperties": { + "OAuth2Properties": "The OAuth 2\\.0 properties required for OAuth 2\\.0 authentication\\. \n*Required*: No \n*Type*: [OAuth2Properties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2properties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProfileProperties": "A map of properties that are required to create a profile for the custom connector\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppFlow::ConnectorProfile DatadogConnectorProfileCredentials": { "ApiKey": "A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ApplicationKey": "Application keys, in conjunction with your API key, give you full access to Datadog\u2019s programmatic API\\. Application keys are associated with the user account that created them\\. The application key is used to log all requests made to the API\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -1141,11 +1304,11 @@ "InstanceUrl": "The location of the Dynatrace resource\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile GoogleAnalyticsConnectorProfileCredentials": { - "AccessToken": "The credentials used to access protected Google Analytics resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AccessToken": "The credentials used to access protected Google Analytics resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClientId": "The identifier for the desired client\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClientSecret": "The client secret used by the OAuth client to authenticate to the authorization server\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConnectorOAuthRequest": "Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RefreshToken": "The credentials used to acquire new access tokens\\. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "RefreshToken": "The credentials used to acquire new access tokens\\. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile InforNexusConnectorProfileCredentials": { "AccessKeyId": "The Access Key portion of the credentials\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -1157,7 +1320,7 @@ "InstanceUrl": "The location of the Infor Nexus resource\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile MarketoConnectorProfileCredentials": { - "AccessToken": "The credentials used to access protected Marketo resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AccessToken": "The credentials used to access protected Marketo resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClientId": "The identifier for the desired client\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClientSecret": "The client secret used by the OAuth client to authenticate to the authorization server\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConnectorOAuthRequest": "Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -1165,39 +1328,74 @@ "AWS::AppFlow::ConnectorProfile MarketoConnectorProfileProperties": { "InstanceUrl": "The location of the Marketo resource\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AppFlow::ConnectorProfile OAuth2Credentials": { + "AccessToken": "The access token used to access the connector on your behalf\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientId": "The identifier for the desired client\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientSecret": "The client secret used by the OAuth client to authenticate to the authorization server\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OAuthRequest": "Property description not available\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RefreshToken": "The refresh token used to refresh an expired access token\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppFlow::ConnectorProfile OAuth2Properties": { + "OAuth2GrantType": "The OAuth 2\\.0 grant type used by connector for OAuth 2\\.0 authentication\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AUTHORIZATION_CODE | CLIENT_CREDENTIALS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TokenUrl": "The token URL required for OAuth 2\\.0 authentication\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TokenUrlCustomProperties": "Associates your token URL with a map of properties that you define\\. Use this parameter to provide any additional details that the connector requires to authenticate your request\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppFlow::ConnectorProfile OAuthCredentials": { + "AccessToken": "The access token used to access protected SAPOData resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientId": "The identifier for the desired client\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientSecret": "The client secret used by the OAuth client to authenticate to the authorization server\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectorOAuthRequest": "Property description not available\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RefreshToken": "The refresh token used to refresh expired access token\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppFlow::ConnectorProfile OAuthProperties": { - "AuthCodeUrl": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OAuthScopes": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TokenUrl": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AuthCodeUrl": "The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OAuthScopes": "The OAuth scopes required for OAuth type authentication\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TokenUrl": "The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppFlow::ConnectorProfile PardotConnectorProfileCredentials": { + "AccessToken": "The credentials used to access protected Salesforce Pardot resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientCredentialsArn": "The secret manager ARN, which contains the client ID and client secret of the connected app\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:aws:secretsmanager:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectorOAuthRequest": "Property description not available\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RefreshToken": "The credentials used to acquire new access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppFlow::ConnectorProfile PardotConnectorProfileProperties": { + "BusinessUnitId": "The business unit id of Salesforce Pardot instance\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `18` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InstanceUrl": "The location of the Salesforce Pardot resource\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsSandboxEnvironment": "Indicates whether the connector profile applies to a sandbox or production environment\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile RedshiftConnectorProfileCredentials": { - "Password": "The password that corresponds to the user name\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Username": "The name of the user\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Password": "The password that corresponds to the user name\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Username": "The name of the user\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile RedshiftConnectorProfileProperties": { "BucketName": "A name for the associated Amazon S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BucketPrefix": "The object key for the destination bucket in which Amazon AppFlow places the files\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DatabaseUrl": "The JDBC URL of the Amazon Redshift cluster\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RoleArn": "The Amazon Resource Name \\(ARN\\) of the IAM role\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `arn:aws:iam:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ClusterIdentifier": "The unique ID that's assigned to an Amazon Redshift cluster\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataApiRoleArn": "The Amazon Resource Name \\(ARN\\) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API\\. For more information, and for the polices that you attach to this role, see [Allow Amazon AppFlow to access Amazon Redshift databases with the Data API](https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#access-redshift)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `arn:aws:iam:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DatabaseName": "The name of an Amazon Redshift database\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DatabaseUrl": "The JDBC URL of the Amazon Redshift cluster\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsRedshiftServerless": "Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleArn": "The Amazon Resource Name \\(ARN\\) of IAM role that grants Amazon Redshift read\\-only access to Amazon S3\\. For more information, and for the polices that you attach to this role, see [Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3](https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#redshift-access-s3)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `arn:aws:iam:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WorkgroupName": "The name of an Amazon Redshift workgroup\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile SAPODataConnectorProfileCredentials": { - "BasicAuthCredentials": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OAuthCredentials": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "BasicAuthCredentials": "The SAPOData basic authentication credentials\\. \n*Required*: No \n*Type*: [BasicAuthCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-basicauthcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OAuthCredentials": "The SAPOData OAuth type authentication credentials\\. \n*Required*: No \n*Type*: [OAuthCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile SAPODataConnectorProfileProperties": { - "ApplicationHostUrl": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ApplicationServicePath": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ClientNumber": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LogonLanguage": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OAuthProperties": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [OAuthProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PortNumber": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PrivateLinkServiceName": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ApplicationHostUrl": "The location of the SAPOData resource\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ApplicationServicePath": "The application path to catalog service\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientNumber": "The client number for the client creating the connection\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `3` \n*Pattern*: `^\\d{3}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LogonLanguage": "The logon language of SAPOData instance\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2` \n*Pattern*: `^[a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OAuthProperties": "The SAPOData OAuth properties required for OAuth type authentication\\. \n*Required*: No \n*Type*: [OAuthProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PortNumber": "The port number of the SAPOData instance\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PrivateLinkServiceName": "The SAPOData Private Link service name to be used for private data transfers\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `^$|com.amazonaws.vpce.[\\w/!:@#.\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile SalesforceConnectorProfileCredentials": { - "AccessToken": "The credentials used to access protected Salesforce resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AccessToken": "The credentials used to access protected Salesforce resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClientCredentialsArn": "The secret manager ARN, which contains the client ID and client secret of the connected app\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:aws:secretsmanager:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConnectorOAuthRequest": "Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RefreshToken": "The credentials used to acquire new access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "RefreshToken": "The credentials used to acquire new access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile SalesforceConnectorProfileProperties": { "InstanceUrl": "The location of the Salesforce resource\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -1214,7 +1412,7 @@ "ApiKey": "A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile SlackConnectorProfileCredentials": { - "AccessToken": "The credentials used to access protected Slack resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AccessToken": "The credentials used to access protected Slack resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClientId": "The identifier for the client\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClientSecret": "The client secret used by the OAuth client to authenticate to the authorization server\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConnectorOAuthRequest": "Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -1246,7 +1444,7 @@ "InstanceUrl": "The location of the Veeva resource\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::ConnectorProfile ZendeskConnectorProfileCredentials": { - "AccessToken": "The credentials used to access protected Zendesk resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AccessToken": "The credentials used to access protected Zendesk resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClientId": "The identifier for the desired client\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClientSecret": "The client secret used by the OAuth client to authenticate to the authorization server\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConnectorOAuthRequest": "Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -1259,26 +1457,30 @@ "DestinationFlowConfigList": "The configuration that controls how Amazon AppFlow places data in the destination connector\\. \n*Required*: Yes \n*Type*: List of [DestinationFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FlowName": "The specified name of the flow\\. Spaces are not allowed\\. Use underscores \\(\\_\\) or hyphens \\(\\-\\) only\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9][\\w!@#.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KMSArn": "The ARN \\(Amazon Resource Name\\) of the Key Management Service \\(KMS\\) key you provide for encryption\\. This is required if you do not want to use the Amazon AppFlow\\-managed KMS key\\. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow\\-managed KMS key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:aws:kms:.*:[0-9]+:.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MetadataCatalogConfig": "Property description not available\\. \n*Required*: No \n*Type*: [MetadataCatalogConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-metadatacatalogconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourceFlowConfig": "Contains information about the configuration of the source connector used in the flow\\. \n*Required*: Yes \n*Type*: [SourceFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sourceflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags used to organize, track, or control access for your flow\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tasks": "A list of tasks that Amazon AppFlow performs while transferring the data in the flow run\\. \n*Required*: Yes \n*Type*: List of [Task](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-task.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TriggerConfig": "The trigger settings that determine how and when Amazon AppFlow runs the specified flow\\. \n*Required*: Yes \n*Type*: [TriggerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-triggerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow AggregationConfig": { - "AggregationType": "Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `None | SingleFile` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AggregationType": "Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `None | SingleFile` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetFileSize": "The desired file size, in MB, for each output file that Amazon AppFlow writes to the flow destination\\. For each file, Amazon AppFlow attempts to achieve the size that you specify\\. The actual file sizes might differ from this target based on the number and size of the records that each file contains\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow AmplitudeSourceProperties": { "Object": "The object specified in the Amplitude flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow ConnectorOperator": { "Amplitude": "The operation to be performed on the provided Amplitude source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `BETWEEN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomConnector": "Operators supported by the custom connector\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Datadog": "The operation to be performed on the provided Datadog source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | DIVISION | EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Dynatrace": "The operation to be performed on the provided Dynatrace source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | DIVISION | EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GoogleAnalytics": "The operation to be performed on the provided Google Analytics source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `BETWEEN | PROJECTION` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InforNexus": "The operation to be performed on the provided Infor Nexus source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | DIVISION | EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Marketo": "The operation to be performed on the provided Marketo source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | DIVISION | GREATER_THAN | LESS_THAN | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Pardot": "The operation to be performed on the provided Salesforce Pardot source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | DIVISION | EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3": "The operation to be performed on the provided Amazon S3 source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SAPOData": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SAPOData": "The operation to be performed on the provided SAPOData source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Salesforce": "The operation to be performed on the provided Salesforce source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceNow": "The operation to be performed on the provided ServiceNow source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Singular": "The operation to be performed on the provided Singular source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | DIVISION | EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -1287,10 +1489,22 @@ "Veeva": "The operation to be performed on the provided Veeva source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Zendesk": "The operation to be performed on the provided Zendesk source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | DIVISION | GREATER_THAN | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AppFlow::Flow CustomConnectorDestinationProperties": { + "CustomProperties": "The custom properties that are specific to the connector when it's used as a destination in the flow\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EntityName": "The entity specified in the custom connector as a destination in the flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ErrorHandlingConfig": "The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IdFieldNames": "The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete, or upsert\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WriteOperationType": "Specifies the type of write operation to be performed in the custom connector when it's used as destination\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DELETE | INSERT | UPDATE | UPSERT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppFlow::Flow CustomConnectorSourceProperties": { + "CustomProperties": "Custom properties that are required to use the custom connector as a source\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EntityName": "The entity specified in the custom connector as a source in the flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppFlow::Flow DatadogSourceProperties": { "Object": "The object specified in the Datadog flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow DestinationConnectorProperties": { + "CustomConnector": "The properties that are required to query the custom Connector\\. \n*Required*: No \n*Type*: [CustomConnectorDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectordestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EventBridge": "The properties required to query Amazon EventBridge\\. \n*Required*: No \n*Type*: [EventBridgeDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-eventbridgedestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LookoutMetrics": "The properties required to query Amazon Lookout for Metrics\\. \n*Required*: No \n*Type*: [LookoutMetricsDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-lookoutmetricsdestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Marketo": "The properties required to query Marketo\\. \n*Required*: No \n*Type*: [MarketoDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-marketodestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -1300,9 +1514,10 @@ "Salesforce": "The properties required to query Salesforce\\. \n*Required*: No \n*Type*: [SalesforceDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-salesforcedestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Snowflake": "The properties required to query Snowflake\\. \n*Required*: No \n*Type*: [SnowflakeDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-snowflakedestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Upsolver": "The properties required to query Upsolver\\. \n*Required*: No \n*Type*: [UpsolverDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-upsolverdestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Zendesk": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ZendeskDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Zendesk": "The properties required to query Zendesk\\. \n*Required*: No \n*Type*: [ZendeskDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow DestinationFlowConfig": { + "ApiVersion": "The API version that the destination connector uses\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConnectorProfileName": "The name of the connector profile\\. This name must be unique for each connector profile in the AWS account\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[\\w/!@#+=.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConnectorType": "The type of destination connector, such as Sales force, Amazon S3, and so on\\. \n*Allowed Values*: `EventBridge | Redshift | S3 | Salesforce | Snowflake` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DestinationConnectorProperties": "This stores the information that is required to query a particular connector\\. \n*Required*: Yes \n*Type*: [DestinationConnectorProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-destinationconnectorproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -1319,6 +1534,11 @@ "ErrorHandlingConfig": "The object specified in the Amplitude flow source\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Object": "The object specified in the Amazon EventBridge flow destination\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AppFlow::Flow GlueDataCatalog": { + "DatabaseName": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleArn": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TablePrefix": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppFlow::Flow GoogleAnalyticsSourceProperties": { "Object": "The object specified in the Google Analytics flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -1332,14 +1552,21 @@ "Object": "The object specified in the Amazon Lookout for Metrics flow destination\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow MarketoDestinationProperties": { - "ErrorHandlingConfig": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ErrorHandlingConfig": "The settings that determine how Amazon AppFlow handles an error when placing data in the destination\\. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure\\. `ErrorHandlingConfig` is a part of the destination connector details\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Object": "The object specified in the Marketo flow destination\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow MarketoSourceProperties": { "Object": "The object specified in the Marketo flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AppFlow::Flow MetadataCatalogConfig": { + "GlueDataCatalog": "Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the AWS Glue Data Catalog\\. \n*Required*: No \n*Type*: [GlueDataCatalog](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-gluedatacatalog.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppFlow::Flow PardotSourceProperties": { + "Object": "The object specified in the Salesforce Pardot flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppFlow::Flow PrefixConfig": { - "PrefixFormat": "Determines the level of granularity that's included in the prefix\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAY | HOUR | MINUTE | MONTH | YEAR` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PathPrefixHierarchy": "Specifies whether the destination file path includes either or both of the following elements: \nEXECUTION\\_ID \nThe ID that Amazon AppFlow assigns to the flow run\\. \nSCHEMA\\_VERSION \nThe version number of your data schema\\. Amazon AppFlow assigns this version number\\. The version number increases by one when you change any of the following settings in your flow configuration: \n+ Source\\-to\\-destination field mappings\n+ Field data types\n+ Partition keys\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PrefixFormat": "Determines the level of granularity for the date and time that's included in the prefix\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAY | HOUR | MINUTE | MONTH | YEAR` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PrefixType": "Determines the format of the prefix, and whether it applies to the file name, file path, or both\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `FILENAME | PATH | PATH_AND_FILENAME` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow RedshiftDestinationProperties": { @@ -1354,46 +1581,51 @@ "S3OutputFormatConfig": "The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination\\. \n*Required*: No \n*Type*: [S3OutputFormatConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3outputformatconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow S3InputFormatConfig": { - "S3InputFileType": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "S3InputFileType": "The file type that Amazon AppFlow gets from your Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CSV | JSON` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow S3OutputFormatConfig": { "AggregationConfig": "The aggregation settings that you can use to customize the output format of your flow data\\. \n*Required*: No \n*Type*: [AggregationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-aggregationconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FileType": "Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CSV | JSON | PARQUET` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PrefixConfig": "Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket\\. You can name folders according to the flow frequency and date\\. \n*Required*: No \n*Type*: [PrefixConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-prefixconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "PrefixConfig": "Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket\\. You can name folders according to the flow frequency and date\\. \n*Required*: No \n*Type*: [PrefixConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-prefixconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PreserveSourceDataTyping": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow S3SourceProperties": { "BucketName": "The Amazon S3 bucket name where the source files are stored\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BucketPrefix": "The object key for the Amazon S3 bucket in which the source files are stored\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3InputFormatConfig": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [S3InputFormatConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3inputformatconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "S3InputFormatConfig": "When you use Amazon S3 as the source, the configuration format that you provide the flow input data\\. \n*Required*: No \n*Type*: [S3InputFormatConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3inputformatconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow SAPODataDestinationProperties": { - "ErrorHandlingConfig": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IdFieldNames": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ErrorHandlingConfig": "The settings that determine how Amazon AppFlow handles an error when placing data in the destination\\. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure\\. `ErrorHandlingConfig` is a part of the destination connector details\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IdFieldNames": "A list of field names that can be used as an ID field when performing a write operation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ObjectPath": "The object path specified in the SAPOData flow destination\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SuccessResponseHandlingConfig": "Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data\\. \nFor example, this setting would determine where to write the response from a destination connector upon a successful insert operation\\. \n*Required*: No \n*Type*: [SuccessResponseHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-successresponsehandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "WriteOperationType": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "WriteOperationType": "The possible write operations in the destination connector\\. When this value is not provided, this defaults to the `INSERT` operation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow SAPODataSourceProperties": { - "ObjectPath": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ObjectPath": "The object path specified in the SAPOData flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow SalesforceDestinationProperties": { + "DataTransferApi": "Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce\\. \nAUTOMATIC \nThe default\\. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to Salesforce\\. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API\\. If your flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2\\.0\\. \nEach of these Salesforce APIs structures data differently\\. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next\\. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2\\.0 on the next day to transfer 1,100 records\\. For each of these flow runs, the respective Salesforce API formats the data differently\\. Some of the differences include how dates are formatted and null values are represented\\. Also, Bulk API 2\\.0 doesn't transfer Salesforce compound fields\\. \nBy choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output\\. \nBULKV2 \nAmazon AppFlow uses only Salesforce Bulk API 2\\.0\\. This API runs asynchronous data transfers, and it's optimal for large sets of data\\. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers\\. \nNote that Bulk API 2\\.0 does not transfer Salesforce compound fields\\. \nREST\\_SYNC \nAmazon AppFlow uses only Salesforce REST API\\. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2\\.0\\. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | BULKV2 | REST_SYNC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ErrorHandlingConfig": "The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination\\. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure\\. `ErrorHandlingConfig` is a part of the destination connector details\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IdFieldNames": "The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Object": "The object specified in the Salesforce flow destination\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WriteOperationType": "This specifies the type of write operation to be performed in Salesforce\\. When the value is `UPSERT`, then `idFieldNames` is required\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DELETE | INSERT | UPDATE | UPSERT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow SalesforceSourceProperties": { + "DataTransferApi": "Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce\\. \nAUTOMATIC \nThe default\\. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from Salesforce\\. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API\\. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2\\.0\\. \nEach of these Salesforce APIs structures data differently\\. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next\\. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2\\.0 on the next day to transfer 1,100,000 records\\. For each of these flow runs, the respective Salesforce API formats the data differently\\. Some of the differences include how dates are formatted and null values are represented\\. Also, Bulk API 2\\.0 doesn't transfer Salesforce compound fields\\. \nBy choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output\\. \nBULKV2 \nAmazon AppFlow uses only Salesforce Bulk API 2\\.0\\. This API runs asynchronous data transfers, and it's optimal for large sets of data\\. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers\\. \nNote that Bulk API 2\\.0 does not transfer Salesforce compound fields\\. \nREST\\_SYNC \nAmazon AppFlow uses only Salesforce REST API\\. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2\\.0\\. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | BULKV2 | REST_SYNC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnableDynamicFieldUpdate": "The flag that enables dynamic fetching of new \\(recently added\\) fields in the Salesforce objects while running a flow\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeDeletedRecords": "Indicates whether Amazon AppFlow includes deleted files in the flow run\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Object": "The object specified in the Salesforce flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow ScheduledTriggerProperties": { "DataPullMode": "Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Complete | Incremental` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ScheduleEndTime": "Specifies the scheduled end time for a schedule\\-triggered flow\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ScheduleExpression": "The scheduling expression that determines the rate at which the scheduled flow will run, for example: `rate(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/5minutes.html)`\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FirstExecutionFrom": "Specifies the date range for the records to import from the connector in the first flow run\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FlowErrorDeactivationThreshold": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ScheduleEndTime": "The time at which the scheduled flow ends\\. The time is formatted as a timestamp that follows the ISO 8601 standard, such as `2022-04-27T13:00:00-07:00`\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ScheduleExpression": "The scheduling expression that determines the rate at which the schedule will run, for example `rate(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/5minutes.html)`\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ScheduleOffset": "Specifies the optional offset that is added to the time interval for a schedule\\-triggered flow\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ScheduleStartTime": "Specifies the scheduled start time for a schedule\\-triggered flow\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimeZone": "Specifies the time zone used when referring to the date and time of a scheduled\\-triggered flow, such as `America/New_York`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ScheduleStartTime": "The time at which the scheduled flow starts\\. The time is formatted as a timestamp that follows the ISO 8601 standard, such as `2022-04-26T13:00:00-07:00`\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TimeZone": "Specifies the time zone used when referring to the dates and times of a scheduled flow, such as `America/New_York`\\. This time zone is only a descriptive label\\. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow\\. \nIf you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps\\. For example, the UTC offsets for the `America/New_York` timezone are `-04:00` EDT and `-05:00 EST`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow ServiceNowSourceProperties": { "Object": "The object specified in the ServiceNow flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -1412,13 +1644,15 @@ }, "AWS::AppFlow::Flow SourceConnectorProperties": { "Amplitude": "Specifies the information that is required for querying Amplitude\\. \n*Required*: No \n*Type*: [AmplitudeSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-amplitudesourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomConnector": "The properties that are applied when the custom connector is being used as a source\\. \n*Required*: No \n*Type*: [CustomConnectorSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectorsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Datadog": "Specifies the information that is required for querying Datadog\\. \n*Required*: No \n*Type*: [DatadogSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-datadogsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Dynatrace": "Specifies the information that is required for querying Dynatrace\\. \n*Required*: No \n*Type*: [DynatraceSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-dynatracesourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GoogleAnalytics": "Specifies the information that is required for querying Google Analytics\\. \n*Required*: No \n*Type*: [GoogleAnalyticsSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-googleanalyticssourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InforNexus": "Specifies the information that is required for querying Infor Nexus\\. \n*Required*: No \n*Type*: [InforNexusSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-infornexussourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Marketo": "Specifies the information that is required for querying Marketo\\. \n*Required*: No \n*Type*: [MarketoSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-marketosourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Pardot": "Specifies the information that is required for querying Salesforce Pardot\\. \n*Required*: No \n*Type*: [PardotSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-pardotsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3": "Specifies the information that is required for querying Amazon S3\\. \n*Required*: No \n*Type*: [S3SourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3sourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SAPOData": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SAPODataSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatasourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SAPOData": "The properties that are applied when using SAPOData as a flow source\\. \n*Required*: No \n*Type*: [SAPODataSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatasourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Salesforce": "Specifies the information that is required for querying Salesforce\\. \n*Required*: No \n*Type*: [SalesforceSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-salesforcesourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceNow": "Specifies the information that is required for querying ServiceNow\\. \n*Required*: No \n*Type*: [ServiceNowSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-servicenowsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Singular": "Specifies the information that is required for querying Singular\\. \n*Required*: No \n*Type*: [SingularSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-singularsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -1428,6 +1662,7 @@ "Zendesk": "Specifies the information that is required for querying Zendesk\\. \n*Required*: No \n*Type*: [ZendeskSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendesksourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow SourceFlowConfig": { + "ApiVersion": "The API version of the connector when it's used as a source in the flow\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConnectorProfileName": "The name of the connector profile\\. This name must be unique for each connector profile in the AWS account\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[\\w/!@#+=.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConnectorType": "The type of source connector, such as Salesforce, Amplitude, and so on\\. \n*Allowed Values*: S3 \\| Amplitude \\| Datadog \\| Dynatrace \\| Googleanalytics \\| Infornexus \\| Salesforce \\| Servicenow \\| Singular \\| Slack \\| Trendmicro \\| Veeva \\| Zendesk \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncrementalPullConfig": "Defines the configuration for a scheduled incremental data pull\\. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull\\. \n*Required*: No \n*Type*: [IncrementalPullConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-incrementalpullconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -1463,20 +1698,20 @@ "AWS::AppFlow::Flow UpsolverS3OutputFormatConfig": { "AggregationConfig": "The aggregation settings that you can use to customize the output format of your flow data\\. \n*Required*: No \n*Type*: [AggregationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-aggregationconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FileType": "Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CSV | JSON | PARQUET` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PrefixConfig": "Determines the prefix that Amazon AppFlow applies to the destination folder name\\. You can name your destination folders according to the flow frequency and date\\. \n*Required*: Yes \n*Type*: [PrefixConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-prefixconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "PrefixConfig": "Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination\\. \n*Required*: Yes \n*Type*: [PrefixConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-prefixconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow VeevaSourceProperties": { - "DocumentType": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IncludeAllVersions": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IncludeRenditions": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IncludeSourceFiles": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DocumentType": "The document type specified in the Veeva document extract flow\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\s\\w_-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeAllVersions": "Boolean value to include All Versions of files in Veeva document extract flow\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeRenditions": "Boolean value to include file renditions in Veeva document extract flow\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeSourceFiles": "Boolean value to include source files in Veeva document extract flow\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Object": "The object specified in the Veeva flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow ZendeskDestinationProperties": { - "ErrorHandlingConfig": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IdFieldNames": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Object": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "WriteOperationType": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ErrorHandlingConfig": "The settings that determine how Amazon AppFlow handles an error when placing data in the destination\\. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure\\. `ErrorHandlingConfig` is a part of the destination connector details\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IdFieldNames": "A list of field names that can be used as an ID field when performing a write operation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Object": "The object specified in the Zendesk flow destination\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WriteOperationType": "The possible write operations in the destination connector\\. When this value is not provided, this defaults to the `INSERT` operation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppFlow::Flow ZendeskSourceProperties": { "Object": "The object specified in the Zendesk flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -1548,6 +1783,7 @@ "Priority": "The ordering of the gateway routes spec\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::GatewayRoute GatewayRouteTarget": { + "Port": "The port number of the gateway route target\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VirtualService": "An object that represents a virtual service gateway route target\\. \n*Required*: Yes \n*Type*: [GatewayRouteVirtualService](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutevirtualservice.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::GatewayRoute GatewayRouteVirtualService": { @@ -1564,6 +1800,7 @@ "AWS::AppMesh::GatewayRoute GrpcGatewayRouteMatch": { "Hostname": "The gateway route host name to be matched on\\. \n*Required*: No \n*Type*: [GatewayRouteHostnameMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Metadata": "The gateway route metadata to be matched on\\. \n*Required*: No \n*Type*: List of [GrpcGatewayRouteMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Port": "The gateway route port to be matched on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceName": "The fully qualified domain name for the service to match from the request\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::GatewayRoute GrpcGatewayRouteMetadata": { @@ -1599,6 +1836,7 @@ "Hostname": "The host name to match on\\. \n*Required*: No \n*Type*: [GatewayRouteHostnameMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Method": "The method to match on\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CONNECT | DELETE | GET | HEAD | OPTIONS | PATCH | POST | PUT | TRACE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Path": "The path to match on\\. \n*Required*: No \n*Type*: [HttpPathMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httppathmatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Port": "The port number to match on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Prefix": "Specifies the path to match requests with\\. This parameter must always start with `/`, which by itself matches all requests to the virtual service name\\. You can also match for path\\-based routing of requests\\. For example, if your virtual service name is `my-service.local` and you want the route to match requests to `my-service.local/metrics`, your prefix should be `/metrics`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "QueryParameters": "The query parameter to match on\\. \n*Required*: No \n*Type*: List of [QueryParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-queryparameter.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -1631,10 +1869,14 @@ "Tags": "Optional metadata that you can apply to the service mesh to assist with categorization and organization\\. Each tag consists of a key and an optional value, both of which you define\\. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::Mesh EgressFilter": { - "Type": "The egress filter type\\. By default, the type is `DROP_ALL`, which allows egress only from virtual nodes to other defined resources in the service mesh \\(and any traffic to `*.amazonaws.com` for AWS API calls\\)\\. You can set the egress filter type to `ALLOW_ALL` to allow egress to any endpoint inside or outside of the service mesh\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALLOW_ALL | DROP_ALL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Type": "The egress filter type\\. By default, the type is `DROP_ALL`, which allows egress only from virtual nodes to other defined resources in the service mesh \\(and any traffic to `*.amazonaws.com` for AWS API calls\\)\\. You can set the egress filter type to `ALLOW_ALL` to allow egress to any endpoint inside or outside of the service mesh\\. \nIf you specify any backends on a virtual node when using `ALLOW_ALL`, you must specifiy all egress for that virtual node as backends\\. Otherwise, `ALLOW_ALL` will no longer work for that virtual node\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALLOW_ALL | DROP_ALL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppMesh::Mesh MeshServiceDiscovery": { + "IpPreference": "The IP version to use to control traffic within the mesh\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IPv4_ONLY | IPv4_PREFERRED | IPv6_ONLY | IPv6_PREFERRED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::Mesh MeshSpec": { - "EgressFilter": "The egress filter rules for the service mesh\\. \n*Required*: No \n*Type*: [EgressFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-egressfilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "EgressFilter": "The egress filter rules for the service mesh\\. \n*Required*: No \n*Type*: [EgressFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-egressfilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServiceDiscovery": "Property description not available\\. \n*Required*: No \n*Type*: [MeshServiceDiscovery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshservicediscovery.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::Route": { "MeshName": "The name of the service mesh to create the route in\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -1667,6 +1909,7 @@ "AWS::AppMesh::Route GrpcRouteMatch": { "Metadata": "An object that represents the data to match from the request\\. \n*Required*: No \n*Type*: List of [GrpcRouteMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-grpcroutemetadata.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MethodName": "The method name to match from the request\\. If you specify a name, you must also specify a `serviceName`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Port": "The port number to match on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceName": "The fully qualified domain name for the service to match from the request\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::Route GrpcRouteMetadata": { @@ -1723,6 +1966,7 @@ "Headers": "The client request headers to match on\\. \n*Required*: No \n*Type*: List of [HttpRouteHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httprouteheader.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Method": "The client request method to match on\\. Specify only one\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CONNECT | DELETE | GET | HEAD | OPTIONS | PATCH | POST | PUT | TRACE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Path": "The client request path to match on\\. \n*Required*: No \n*Type*: [HttpPathMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httppathmatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Port": "The port number to match on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Prefix": "Specifies the path to match requests with\\. This parameter must always start with `/`, which by itself matches all requests to the virtual service name\\. You can also match for path\\-based routing of requests\\. For example, if your virtual service name is `my-service.local` and you want the route to match requests to `my-service.local/metrics`, your prefix should be `/metrics`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "QueryParameters": "The client request query parameters to match on\\. \n*Required*: No \n*Type*: List of [QueryParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-queryparameter.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Scheme": "The client request scheme to match on\\. Specify only one\\. Applicable only for HTTP2 routes\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `http | https` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -1748,15 +1992,20 @@ }, "AWS::AppMesh::Route TcpRoute": { "Action": "The action to take if a match is determined\\. \n*Required*: Yes \n*Type*: [TcpRouteAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcprouteaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Match": "An object that represents the criteria for determining a request match\\. \n*Required*: No \n*Type*: [TcpRouteMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproutematch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Timeout": "An object that represents types of timeouts\\. \n*Required*: No \n*Type*: [TcpTimeout](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcptimeout.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::Route TcpRouteAction": { "WeightedTargets": "An object that represents the targets that traffic is routed to when a request matches the route\\. \n*Required*: Yes \n*Type*: List of [WeightedTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-weightedtarget.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AppMesh::Route TcpRouteMatch": { + "Port": "The port number to match on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppMesh::Route TcpTimeout": { "Idle": "An object that represents an idle timeout\\. An idle timeout bounds the amount of time that a connection may be idle\\. The default value is none\\. \n*Required*: No \n*Type*: [Duration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-duration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::Route WeightedTarget": { + "Port": "The targeted port of the weighted object\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VirtualNode": "The virtual node to associate with the weighted target\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Weight": "The relative weight of the weighted target\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -1767,6 +2016,14 @@ "Tags": "Optional metadata that you can apply to the virtual gateway to assist with categorization and organization\\. Each tag consists of a key and an optional value, both of which you define\\. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VirtualGatewayName": "The name of the virtual gateway\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::AppMesh::VirtualGateway JsonFormatRef": { + "Key": "The specified key for the JSON\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The specified value for the JSON\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppMesh::VirtualGateway LoggingFormat": { + "Json": "The logging format for JSON\\. \n*Required*: No \n*Type*: List of [JsonFormatRef](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-jsonformatref.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Text": "The logging format for text\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppMesh::VirtualGateway SubjectAlternativeNameMatchers": { "Exact": "The values sent must match the specified values exactly\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -1798,6 +2055,7 @@ "HTTP2": "An object that represents a type of connection pool\\. \n*Required*: No \n*Type*: [VirtualGatewayHttp2ConnectionPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayhttp2connectionpool.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::VirtualGateway VirtualGatewayFileAccessLog": { + "Format": "The specified format for the virtual gateway access logs\\. It can be either `json_format` or `text_format`\\. \n*Required*: No \n*Type*: [LoggingFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-loggingformat.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Path": "The file path to write access logs to\\. You can use `/dev/stdout` to send access logs to standard out and configure your Envoy container to use a log driver, such as `awslogs`, to export the access logs to a log storage service such as Amazon CloudWatch Logs\\. You can also specify a path in the Envoy container's file system to write the files to disk\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::VirtualGateway VirtualGatewayGrpcConnectionPool": { @@ -1862,7 +2120,7 @@ }, "AWS::AppMesh::VirtualGateway VirtualGatewaySpec": { "BackendDefaults": "A reference to an object that represents the defaults for backends\\. \n*Required*: No \n*Type*: [VirtualGatewayBackendDefaults](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaybackenddefaults.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Listeners": "The listeners that the mesh endpoint is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: Yes \n*Type*: List of [VirtualGatewayListener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistener.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Listeners": "The listeners that the mesh endpoint is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: Yes \n*Type*: List of [VirtualGatewayListener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistener.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Logging": "An object that represents logging information\\. \n*Required*: No \n*Type*: [VirtualGatewayLogging](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylogging.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::VirtualGateway VirtualGatewayTlsValidationContext": { @@ -1899,6 +2157,7 @@ }, "AWS::AppMesh::VirtualNode AwsCloudMapServiceDiscovery": { "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\\. \n*Required*: No \n*Type*: List of [AwsCloudMapInstanceAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-awscloudmapinstanceattribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IPv4_ONLY | IPv4_PREFERRED | IPv6_ONLY | IPv6_PREFERRED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NamespaceName": "The name of the AWS Cloud Map namespace to use\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceName": "The name of the AWS Cloud Map service to use\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -1923,6 +2182,7 @@ }, "AWS::AppMesh::VirtualNode DnsServiceDiscovery": { "Hostname": "Specifies the DNS service discovery hostname for the virtual node\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IPv4_ONLY | IPv4_PREFERRED | IPv6_ONLY | IPv6_PREFERRED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResponseType": "Specifies the DNS response type for the virtual node\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ENDPOINTS | LOADBALANCER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::VirtualNode Duration": { @@ -1930,6 +2190,7 @@ "Value": "A number of time units\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::VirtualNode FileAccessLog": { + "Format": "The specified format for the logs\\. The format is either `json_format` or `text_format`\\. \n*Required*: No \n*Type*: [LoggingFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-loggingformat.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Path": "The file path to write access logs to\\. You can use `/dev/stdout` to send access logs to standard out and configure your Envoy container to use a log driver, such as `awslogs`, to export the access logs to a log storage service such as Amazon CloudWatch Logs\\. You can also specify a path in the Envoy container's file system to write the files to disk\\. \nThe Envoy process must have write permissions to the path that you specify here\\. Otherwise, Envoy fails to bootstrap properly\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::VirtualNode GrpcTimeout": { @@ -1949,6 +2210,10 @@ "Idle": "An object that represents an idle timeout\\. An idle timeout bounds the amount of time that a connection may be idle\\. The default value is none\\. \n*Required*: No \n*Type*: [Duration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-duration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PerRequest": "An object that represents a per request timeout\\. The default value is 15 seconds\\. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation\\. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route\\. \n*Required*: No \n*Type*: [Duration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-duration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AppMesh::VirtualNode JsonFormatRef": { + "Key": "The specified key for the JSON\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The specified value for the JSON\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppMesh::VirtualNode Listener": { "ConnectionPool": "The connection pool information for the listener\\. \n*Required*: No \n*Type*: [VirtualNodeConnectionPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-virtualnodeconnectionpool.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HealthCheck": "The health check information for the listener\\. \n*Required*: No \n*Type*: [HealthCheck](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -1994,6 +2259,10 @@ "AWS::AppMesh::VirtualNode Logging": { "AccessLog": "The access log configuration for a virtual node\\. \n*Required*: No \n*Type*: [AccessLog](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-accesslog.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AppMesh::VirtualNode LoggingFormat": { + "Json": "The logging format for JSON\\. \n*Required*: No \n*Type*: List of [JsonFormatRef](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-jsonformatref.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Text": "The logging format for text\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppMesh::VirtualNode OutlierDetection": { "BaseEjectionDuration": "The base amount of time for which a host is ejected\\. \n*Required*: Yes \n*Type*: [Duration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-duration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Interval": "The time interval between ejection sweep analysis\\. \n*Required*: Yes \n*Type*: [Duration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-duration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -2018,7 +2287,7 @@ "Idle": "An object that represents an idle timeout\\. An idle timeout bounds the amount of time that a connection may be idle\\. The default value is none\\. \n*Required*: No \n*Type*: [Duration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-duration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::VirtualNode TlsValidationContext": { - "SubjectAlternativeNames": "A reference to an object that represents the SANs for a Transport Layer Security \\(TLS\\) validation context\\. \n*Required*: No \n*Type*: [SubjectAlternativeNames](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-subjectalternativenames.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SubjectAlternativeNames": "A reference to an object that represents the SANs for a Transport Layer Security \\(TLS\\) validation context\\. If you don't specify SANs on the *terminating* mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate\\. If you don't specify SANs on the *originating* mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration\\. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name\\. \n*Required*: No \n*Type*: [SubjectAlternativeNames](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-subjectalternativenames.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Trust": "A reference to where to retrieve the trust chain when validating a peer\u2019s Transport Layer Security \\(TLS\\) certificate\\. \n*Required*: Yes \n*Type*: [TlsValidationContextTrust](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-tlsvalidationcontexttrust.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::VirtualNode TlsValidationContextAcmTrust": { @@ -2053,8 +2322,8 @@ }, "AWS::AppMesh::VirtualNode VirtualNodeSpec": { "BackendDefaults": "A reference to an object that represents the defaults for backends\\. \n*Required*: No \n*Type*: [BackendDefaults](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backenddefaults.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Backends": "The backends that the virtual node is expected to send outbound traffic to\\. \n*Required*: No \n*Type*: List of [Backend](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backend.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Listeners": "The listener that the virtual node is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: No \n*Type*: List of [Listener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Backends": "The backends that the virtual node is expected to send outbound traffic to\\. \nApp Mesh doesn't validate the existence of those virtual services specified in backends\\. This is to prevent a cyclic dependency between virtual nodes and virtual services creation\\. Make sure the virtual service name is correct\\. The virtual service can be created afterwards if it doesn't already exist\\. \n*Required*: No \n*Type*: List of [Backend](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backend.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Listeners": "The listener that the virtual node is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: No \n*Type*: List of [Listener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Logging": "The inbound and outbound access logging information for the virtual node\\. \n*Required*: No \n*Type*: [Logging](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-logging.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceDiscovery": "The service discovery information for the virtual node\\. If your virtual node does not expect ingress traffic, you can omit this parameter\\. If you specify a `listener`, then you must specify service discovery information\\. \n*Required*: No \n*Type*: [ServiceDiscovery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-servicediscovery.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -2063,7 +2332,7 @@ }, "AWS::AppMesh::VirtualNode VirtualServiceBackend": { "ClientPolicy": "A reference to an object that represents the client policy for a backend\\. \n*Required*: No \n*Type*: [ClientPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-clientpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VirtualServiceName": "The name of the virtual service that is acting as a virtual node backend\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "VirtualServiceName": "The name of the virtual service that is acting as a virtual node backend\\. \nApp Mesh doesn't validate the existence of those virtual services specified in backends\\. This is to prevent a cyclic dependency between virtual nodes and virtual services creation\\. Make sure the virtual service name is correct\\. The virtual service can be created afterwards if it doesn't already exist\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::VirtualRouter": { "MeshName": "The name of the service mesh to create the virtual router in\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -2080,7 +2349,7 @@ "PortMapping": "The port mapping information for the listener\\. \n*Required*: Yes \n*Type*: [PortMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-portmapping.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::VirtualRouter VirtualRouterSpec": { - "Listeners": "The listeners that the virtual router is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: Yes \n*Type*: List of [VirtualRouterListener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Listeners": "The listeners that the virtual router is expected to receive inbound traffic from\\. \n*Required*: Yes \n*Type*: List of [VirtualRouterListener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppMesh::VirtualService": { "MeshName": "The name of the service mesh to create the virtual service in\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -2102,13 +2371,22 @@ "AWS::AppMesh::VirtualService VirtualServiceSpec": { "Provider": "The App Mesh object that is acting as the provider for a virtual service\\. You can specify a single virtual node or virtual router\\. \n*Required*: No \n*Type*: [VirtualServiceProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualserviceprovider.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AppRunner::ObservabilityConfiguration": { + "ObservabilityConfigurationName": "A name for the observability configuration\\. When you use it for the first time in an AWS Region, App Runner creates revision number `1` of this name\\. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration\\. \nThe name `DefaultConfiguration` is reserved\\. You can't use it to create a new observability configuration, and you can't create a revision of it\\. \nWhen you want to use your own observability configuration for your App Runner service, *create a configuration with a different name*, and then provide it when you create or update your service\\.\nIf you don't specify a name, AWS CloudFormation generates a name for your observability configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `32` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "A list of metadata items that you can associate with your observability configuration resource\\. A tag is a key\\-value pair\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TraceConfiguration": "The configuration of the tracing feature within this observability configuration\\. If you don't specify it, App Runner doesn't enable tracing\\. \n*Required*: No \n*Type*: [TraceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-observabilityconfiguration-traceconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::AppRunner::ObservabilityConfiguration TraceConfiguration": { + "Vendor": "The implementation provider chosen for tracing App Runner services\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AWSXRAY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::AppRunner::Service": { - "AutoScalingConfigurationArn": "The Amazon Resource Name \\(ARN\\) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service\\. If not provided, App Runner associates the latest revision of a default auto scaling configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AutoScalingConfigurationArn": "The Amazon Resource Name \\(ARN\\) of an App Runner automatic scaling configuration resource that you want to associate with your service\\. If not provided, App Runner associates the latest revision of a default auto scaling configuration\\. \nSpecify an ARN with a name and a revision number to associate that revision\\. For example: `arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3` \nSpecify just the name to associate the latest revision\\. For example: `arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability` \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EncryptionConfiguration": "An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs\\. By default, App Runner uses an AWS managed key\\. \n*Required*: No \n*Type*: [EncryptionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-encryptionconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "HealthCheckConfiguration": "The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service\\. \n*Required*: No \n*Type*: [HealthCheckConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InstanceConfiguration": "The runtime configuration of instances \\(scaling units\\) of the App Runner service\\. \n*Required*: No \n*Type*: [InstanceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InstanceConfiguration": "The runtime configuration of instances \\(scaling units\\) of your service\\. \n*Required*: No \n*Type*: [InstanceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NetworkConfiguration": "Configuration settings related to network traffic of the web application that the App Runner service runs\\. \n*Required*: No \n*Type*: [NetworkConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-networkconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServiceName": "A name for the App Runner service\\. It must be unique across all the running App Runner services in your AWS account in the AWS Region\\. \nIf you don't specify a name, AWS CloudFormation generates a name for your Service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `40` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9-_]{3,39}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ObservabilityConfiguration": "The observability configuration of your service\\. \n*Required*: No \n*Type*: [ServiceObservabilityConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServiceName": "A name for the App Runner service\\. It must be unique across all the running App Runner services in your AWS account in the AWS Region\\. \nIf you don't specify a name, AWS CloudFormation generates a name for your service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `40` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9-_]{3,39}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SourceConfiguration": "The source to deploy to the App Runner service\\. It can be a code or an image repository\\. \n*Required*: Yes \n*Type*: [SourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An optional list of metadata items that you can associate with the App Runner service resource\\. A tag is a key\\-value pair\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -2121,14 +2399,15 @@ "ConfigurationSource": "The source of the App Runner configuration\\. Values are interpreted as follows: \n+ `REPOSITORY` \u2013 App Runner reads configuration values from the `apprunner.yaml` file in the source code repository and ignores `CodeConfigurationValues`\\.\n+ `API` \u2013 App Runner uses configuration values provided in `CodeConfigurationValues` and ignores the `apprunner.yaml` file in the source code repository\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `API | REPOSITORY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppRunner::Service CodeConfigurationValues": { - "BuildCommand": "The command App Runner runs to build your application\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BuildCommand": "The command App Runner runs to build your application\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[^\\x0a\\x0d]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Port": "The port that your application listens to in the container\\. \nDefault: `8080` \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `51200` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Runtime": "A runtime environment type for building and running an App Runner service\\. It represents a programming language runtime\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CORRETTO_11 | CORRETTO_8 | NODEJS_12 | NODEJS_14 | PYTHON_3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RuntimeEnvironmentVariables": "The environment variables that are available to your running App Runner service\\. An array of key\\-value pairs\\. Keys with a prefix of `AWSAPPRUNNER` are reserved for system use and aren't valid\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StartCommand": "The command App Runner runs to start your application\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Runtime": "A runtime environment type for building and running an App Runner service\\. It represents a programming language runtime\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CORRETTO_11 | CORRETTO_8 | DOTNET_6 | GO_1 | NODEJS_12 | NODEJS_14 | NODEJS_16 | PHP_81 | PYTHON_3 | RUBY_31` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RuntimeEnvironmentSecrets": "An array of key\\-value pairs representing the secrets and parameters that get referenced to your service as an environment variable\\. The supported values are either the full Amazon Resource Name \\(ARN\\) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store\\. \n+ If the AWS Systems Manager Parameter Store parameter exists in the same AWS Region as the service that you're launching, you can use either the full ARN or name of the secret\\. If the parameter exists in a different Region, then the full ARN must be specified\\. \n+ Currently, cross account referencing of AWS Systems Manager Parameter Store parameter is not supported\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RuntimeEnvironmentVariables": "The environment variables that are available to your running AWS App Runner service\\. An array of key\\-value pairs\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartCommand": "The command App Runner runs to start your application\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[^\\x0a\\x0d]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppRunner::Service CodeRepository": { - "CodeConfiguration": "Configuration for building and running the service from a source code repository\\. \n*Required*: No \n*Type*: [CodeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CodeConfiguration": "Configuration for building and running the service from a source code repository\\. \n `CodeConfiguration` is required only for `CreateService` request\\.\n*Required*: No \n*Type*: [CodeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RepositoryUrl": "The location of the repository that contains the source code\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `51200` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourceCodeVersion": "The version that should be used within the source code repository\\. \n*Required*: Yes \n*Type*: [SourceCodeVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-sourcecodeversion.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -2149,14 +2428,18 @@ }, "AWS::AppRunner::Service ImageConfiguration": { "Port": "The port that your application listens to in the container\\. \nDefault: `8080` \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `51200` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RuntimeEnvironmentVariables": "Environment variables that are available to your running App Runner service\\. An array of key\\-value pairs\\. Keys with a prefix of `AWSAPPRUNNER` are reserved for system use and aren't valid\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StartCommand": "An optional command that App Runner runs to start the application in the source image\\. If specified, this command overrides the Docker image\u2019s default start command\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `51200` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "RuntimeEnvironmentSecrets": "An array of key\\-value pairs representing the secrets and parameters that get referenced to your service as an environment variable\\. The supported values are either the full Amazon Resource Name \\(ARN\\) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store\\. \n+ If the AWS Systems Manager Parameter Store parameter exists in the same AWS Region as the service that you're launching, you can use either the full ARN or name of the secret\\. If the parameter exists in a different Region, then the full ARN must be specified\\. \n+ Currently, cross account referencing of AWS Systems Manager Parameter Store parameter is not supported\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RuntimeEnvironmentVariables": "Environment variables that are available to your running App Runner service\\. An array of key\\-value pairs\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartCommand": "An optional command that App Runner runs to start the application in the source image\\. If specified, this command overrides the Docker image\u2019s default start command\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[^\\x0a\\x0d]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppRunner::Service ImageRepository": { "ImageConfiguration": "Configuration for running the identified image\\. \n*Required*: No \n*Type*: [ImageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-imageconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ImageIdentifier": "The identifier of an image\\. \nFor an image in Amazon Elastic Container Registry \\(Amazon ECR\\), this is an image name\\. For the image name format, see [Pulling an image](https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html) in the *Amazon ECR User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `([0-9]{12}.dkr.ecr.[a-z\\-]+-[0-9]{1}.amazonaws.com\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(:([\\w\\d+\\-=._:\\/@])+|@([\\w\\d\\:]+))?)|(^public\\.ecr\\.aws\\/.+\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(:([\\w\\d+\\-=._:\\/@])+|@([\\w\\d\\:]+))?)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ImageRepositoryType": "The type of the image repository\\. This reflects the repository provider and whether the repository is private or public\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ECR | ECR_PUBLIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AppRunner::Service IngressConfiguration": { + "IsPubliclyAccessible": "Specifies whether your App Runner service is publicly accessible\\. To make the service publicly accessible set it to `True`\\. To make the service privately accessible, from only within an Amazon VPC set it to `False`\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppRunner::Service InstanceConfiguration": { "Cpu": "The number of CPU units reserved for each instance of your App Runner service\\. \nDefault: `1 vCPU` \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `6` \n*Pattern*: `1024|2048|(1|2) vCPU` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InstanceRoleArn": "The Amazon Resource Name \\(ARN\\) of an IAM role that provides permissions to your App Runner service\\. These are permissions that your code needs when it calls any AWS APIs\\. \n*Required*: No \n*Type*: String \n*Minimum*: `29` \n*Maximum*: `1024` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::[0-9]{12}:(role|role\\/service-role)\\/[\\w+=,.@\\-/]{1,1000}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -2167,7 +2450,12 @@ "Value": "The value string to which the key name is mapped\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppRunner::Service NetworkConfiguration": { - "EgressConfiguration": "Network configuration settings for outbound message traffic\\. \n*Required*: Yes \n*Type*: [EgressConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "EgressConfiguration": "Network configuration settings for outbound message traffic\\. \n*Required*: No \n*Type*: [EgressConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IngressConfiguration": "Network configuration settings for inbound message traffic\\. \n*Required*: No \n*Type*: [IngressConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-ingressconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::AppRunner::Service ServiceObservabilityConfiguration": { + "ObservabilityConfigurationArn": "The Amazon Resource Name \\(ARN\\) of the observability configuration that is associated with the service\\. Specified only when `ObservabilityEnabled` is `true`\\. \nSpecify an ARN with a name and a revision number to associate that revision\\. For example: `arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3` \nSpecify just the name to associate the latest revision\\. For example: `arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing` \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ObservabilityEnabled": "When `true`, an observability configuration resource is associated with the service, and an `ObservabilityConfigurationArn` is specified\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AppRunner::Service SourceCodeVersion": { "Type": "The type of version identifier\\. \nFor a git\\-based repository, branches represent versions\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BRANCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -2181,10 +2469,20 @@ }, "AWS::AppRunner::VpcConnector": { "SecurityGroups": "A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets\\. If not specified, App Runner uses the default security group of the Amazon VPC\\. The default security group allows all outbound traffic\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Subnets": "A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC\\. Specify IDs of subnets of a single Amazon VPC\\. App Runner determines the Amazon VPC from the subnets you specify\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Subnets": "A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC\\. Specify IDs of subnets of a single Amazon VPC\\. App Runner determines the Amazon VPC from the subnets you specify\\. \n App Runner currently only provides support for IPv4\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "A list of metadata items that you can associate with your VPC connector resource\\. A tag is a key\\-value pair\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "VpcConnectorName": "A name for the VPC connector\\. \nIf you don't specify a name, AWS CloudFormation generates a name for your VPC connector\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `40` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9\\-_]{3,39}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::AppRunner::VpcIngressConnection": { + "IngressVpcConfiguration": "Specifications for the customer\u2019s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource\\. \n*Required*: Yes \n*Type*: [IngressVpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-vpcingressconnection-ingressvpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServiceArn": "The Amazon Resource Name \\(ARN\\) for this App Runner service that is used to create the VPC Ingress Connection resource\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "An optional list of metadata items that you can associate with the VPC Ingress Connection resource\\. A tag is a key\\-value pair\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "VpcIngressConnectionName": "The customer\\-provided VPC Ingress Connection name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `40` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9\\-_]{3,39}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::AppRunner::VpcIngressConnection IngressVpcConfiguration": { + "VpcEndpointId": "The ID of the VPC endpoint that your App Runner service connects to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `51200` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcId": "The ID of the VPC that is used for the VPC endpoint\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `51200` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppStream::AppBlock": { "Description": "The description of the app block\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DisplayName": "The display name of the app block\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -2231,10 +2529,15 @@ "FleetName": "The name of the fleet\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::AppStream::DirectoryConfig": { + "CertificateBasedAuthProperties": "The certificate\\-based authentication properties used to authenticate SAML 2\\.0 Identity Provider \\(IdP\\) user identities to Active Directory domain\\-joined streaming instances\\. \n*Required*: No \n*Type*: [CertificateBasedAuthProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-certificatebasedauthproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DirectoryName": "The fully qualified name of the directory \\(for example, corp\\.example\\.com\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "OrganizationalUnitDistinguishedNames": "The distinguished names of the organizational units for computer accounts\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceAccountCredentials": "The credentials for the service account used by the streaming instance to connect to the directory\\. Do not use this parameter directly\\. Use `ServiceAccountCredentials` as an input parameter with `noEcho` as shown in the [Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html)\\. For best practices information, see [Do Not Embed Credentials in Your Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html#creds)\\. \n*Required*: Yes \n*Type*: [ServiceAccountCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-serviceaccountcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AppStream::DirectoryConfig CertificateBasedAuthProperties": { + "CertificateAuthorityArn": "The ARN of the AWS Certificate Manager Private CA resource\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^arn:aws(?:\\-cn|\\-iso\\-b|\\-iso|\\-us\\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\\\-]{0,1023}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "The status of the certificate\\-based authentication properties\\. Fallback is turned on by default when certificate\\-based authentication is **Enabled**\\. Fallback allows users to log in using their AD domain password if certificate\\-based authentication is unsuccessful, or to unlock a desktop lock screen\\. **Enabled\\_no\\_directory\\_login\\_fallback** enables certificate\\-based authentication, but does not allow users to log in using their AD domain password\\. Users will be disconnected to re\\-authenticate using certificates\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED | ENABLED_NO_DIRECTORY_LOGIN_FALLBACK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::AppStream::DirectoryConfig ServiceAccountCredentials": { "AccountName": "The user name of the account\\. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AccountPassword": "The password for the account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `127` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -2267,6 +2570,7 @@ "MaxUserDurationInSeconds": "The maximum amount of time that a streaming session can remain active, in seconds\\. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected\\. After this time elapses, the instance is terminated and replaced by a new instance\\. \nSpecify a value between 600 and 360000\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A unique name for the fleet\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Platform": "The platform of the fleet\\. Platform is a required setting for Elastic fleets, and is not used for other fleet types\\. \n*Allowed Values*: `WINDOWS_SERVER_2019` \\| `AMAZON_LINUX2` \n*Required*: No \n*Type*: String \n*Allowed values*: `AMAZON_LINUX2 | WINDOWS | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SessionScriptS3Location": "The S3 location of the session scripts configuration zip file\\. This only applies to Elastic fleets\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StreamView": "The AppStream 2\\.0 view that is displayed to your users when they stream from the fleet\\. When `APP` is specified, only the windows of applications opened by users display\\. When `DESKTOP` is specified, the standard desktop that is provided by the operating system displays\\. \nThe default value is `APP`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `APP | DESKTOP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UsbDeviceFilterStrings": "The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client\\. This is allowed but not required for Elastic fleets\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -2279,6 +2583,10 @@ "DirectoryName": "The fully qualified name of the directory \\(for example, corp\\.example\\.com\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OrganizationalUnitDistinguishedName": "The distinguished name of the organizational unit for computer accounts\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::AppStream::Fleet S3Location": { + "S3Bucket": "The S3 bucket of the S3 object\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `^[0-9a-z\\.\\-]*(?/ is the final portion of the load balancer ARN\n+ targetgroup// is the final portion of the target group ARN\\.\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation\\. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1023` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AutoScaling::ScalingPolicy PredictiveScalingConfiguration": { "MaxCapacityBreachBehavior": "Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group\\. Defaults to `HonorMaxCapacity` if not specified\\. \nThe following are possible values: \n+ `HonorMaxCapacity` \\- Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum capacity\\. The maximum capacity is enforced as a hard limit\\. \n+ `IncreaseMaxCapacity` \\- Amazon EC2 Auto Scaling can scale out capacity higher than the maximum capacity when the forecast capacity is close to or exceeds the maximum capacity\\. The upper limit is determined by the forecasted capacity and the value for `MaxCapacityBuffer`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `HonorMaxCapacity | IncreaseMaxCapacity` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxCapacityBuffer": "The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity\\. The value is specified as a percentage relative to the forecast capacity\\. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55\\. \nIf set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity\\. \nRequired if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity`, and cannot be used otherwise\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MetricSpecifications": "An array that contains information about the metrics and target utilization to use for predictive scaling\\. \nAdding more than one predictive scaling metric specification to the array is currently not supported\\.\n*Required*: Yes \n*Type*: List of [PredictiveScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MetricSpecifications": "This structure includes the metrics and target utilization to use for predictive scaling\\. \nThis is an array, but we currently only support a single metric specification\\. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric\\. \n*Required*: Yes \n*Type*: List of [PredictiveScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Mode": "The predictive scaling mode\\. Defaults to `ForecastOnly` if not specified\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ForecastAndScale | ForecastOnly` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SchedulingBufferTime": "The amount of time, in seconds, by which the instance launch time can be advanced\\. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre\\-launch instances by 5 minutes\\. In that case, the instances will be launched at 9:55 AM\\. The intention is to give resources time to be provisioned\\. It can take a few minutes to launch an EC2 instance\\. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete\\. \nThe value must be less than the forecast interval duration of 3600 seconds \\(60 minutes\\)\\. Defaults to 300 seconds if not specified\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -3059,9 +3382,9 @@ "CustomizedCapacityMetricSpecification": "The customized capacity metric specification\\. \n*Required*: No \n*Type*: [PredictiveScalingCustomizedCapacityMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingcustomizedcapacitymetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomizedLoadMetricSpecification": "The customized load metric specification\\. \n*Required*: No \n*Type*: [PredictiveScalingCustomizedLoadMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingcustomizedloadmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomizedScalingMetricSpecification": "The customized scaling metric specification\\. \n*Required*: No \n*Type*: [PredictiveScalingCustomizedScalingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingcustomizedscalingmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PredefinedLoadMetricSpecification": "The load metric specification\\. \nIf you specify `PredefinedMetricPairSpecification`, don't specify this property\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedLoadMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PredefinedMetricPairSpecification": "The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use\\. \nWith predictive scaling, you must specify either a metric pair, or a load metric and a scaling metric individually\\. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy\\. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric\\.\n*Required*: No \n*Type*: [PredictiveScalingPredefinedMetricPair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PredefinedScalingMetricSpecification": "The scaling metric specification\\. \nIf you specify `PredefinedMetricPairSpecification`, don't specify this property\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedScalingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PredefinedLoadMetricSpecification": "The predefined load metric specification\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedLoadMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PredefinedMetricPairSpecification": "The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedMetricPair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PredefinedScalingMetricSpecification": "The predefined scaling metric specification\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedScalingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TargetValue": "Specifies the target utilization\\. \nSome metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue\\. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one\\-minute interval\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AutoScaling::ScalingPolicy PredictiveScalingPredefinedLoadMetric": { @@ -3070,7 +3393,7 @@ }, "AWS::AutoScaling::ScalingPolicy PredictiveScalingPredefinedMetricPair": { "PredefinedMetricType": "Indicates which metrics to use\\. There are two different types of metrics for each metric type: one is a load metric and one is a scaling metric\\. For example, if the metric type is `ASGCPUUtilization`, the Auto Scaling group's total CPU metric is used as the load metric, and the average CPU metric is used for the scaling metric\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALBRequestCount | ASGCPUUtilization | ASGNetworkIn | ASGNetworkOut` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResourceLabel": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group\\. You can't specify a resource label unless the target group is attached to the Auto Scaling group\\. \nYou create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash \\(/\\)\\. The format of the resource label is: \n `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff`\\. \nWhere: \n+ app// is the final portion of the load balancer ARN\n+ targetgroup// is the final portion of the target group ARN\\.\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation\\. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ResourceLabel": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group\\. You can't specify a resource label unless the target group is attached to the Auto Scaling group\\. \nYou create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash \\(/\\)\\. The format of the resource label is: \n `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff`\\. \nWhere: \n+ app// is the final portion of the load balancer ARN\n+ targetgroup// is the final portion of the target group ARN\\.\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation\\. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1023` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AutoScaling::ScalingPolicy PredictiveScalingPredefinedScalingMetric": { "PredefinedMetricType": "The metric type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALBRequestCountPerTarget | ASGAverageCPUUtilization | ASGAverageNetworkIn | ASGAverageNetworkOut` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3078,27 +3401,27 @@ }, "AWS::AutoScaling::ScalingPolicy StepAdjustment": { "MetricIntervalLowerBound": "The lower bound for the difference between the alarm threshold and the CloudWatch metric\\. If the metric value is above the breach threshold, the lower bound is inclusive \\(the metric must be greater than or equal to the threshold plus the lower bound\\)\\. Otherwise, it is exclusive \\(the metric must be greater than the threshold plus the lower bound\\)\\. A null value indicates negative infinity\\. \n*Required*: Conditional \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MetricIntervalUpperBound": "The upper bound for the difference between the alarm threshold and the CloudWatch metric\\. If the metric value is above the breach threshold, the upper bound is exclusive \\(the metric must be less than the threshold plus the upper bound\\)\\. Otherwise, it is inclusive \\(the metric must be less than or equal to the threshold plus the upper bound\\)\\. A null value indicates positive infinity\\. \n*Required*: Conditional \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ScalingAdjustment": "The amount by which to scale\\. The adjustment is based on the value that you specified in the `AdjustmentType` property \\(either an absolute number or a percentage\\)\\. A positive value adds to the current capacity and a negative number subtracts from the current capacity\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "MetricIntervalUpperBound": "The upper bound for the difference between the alarm threshold and the CloudWatch metric\\. If the metric value is above the breach threshold, the upper bound is exclusive \\(the metric must be less than the threshold plus the upper bound\\)\\. Otherwise, it is inclusive \\(the metric must be less than or equal to the threshold plus the upper bound\\)\\. A null value indicates positive infinity\\. \nThe upper bound must be greater than the lower bound\\. \n*Required*: Conditional \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ScalingAdjustment": "The amount by which to scale, based on the specified adjustment type\\. A positive value adds to the current capacity while a negative number removes from the current capacity\\. \nThe amount by which to scale\\. The adjustment is based on the value that you specified in the `AdjustmentType` property \\(either an absolute number or a percentage\\)\\. A positive value adds to the current capacity and a negative number subtracts from the current capacity\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AutoScaling::ScalingPolicy TargetTrackingConfiguration": { "CustomizedMetricSpecification": "A customized metric\\. You must specify either a predefined metric or a customized metric\\. \n*Required*: Conditional \n*Type*: [CustomizedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-customizedmetricspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DisableScaleIn": "Indicates whether scaling in by the target tracking scaling policy is disabled\\. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group\\. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PredefinedMetricSpecification": "A predefined metric\\. You must specify either a predefined metric or a customized metric\\. \n*Required*: Conditional \n*Type*: [PredefinedMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predefinedmetricspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TargetValue": "The target value for the metric\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TargetValue": "The target value for the metric\\. \nSome metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue\\. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one\\-minute interval\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AutoScaling::ScheduledAction": { "AutoScalingGroupName": "The name of the Auto Scaling group\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DesiredCapacity": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain\\. It can scale beyond this capacity if you add more scaling conditions\\. \nYou must specify at least one of the following properties: `MaxSize`, `MinSize`, or `DesiredCapacity`\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DesiredCapacity": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain\\. It can scale beyond this capacity if you add more scaling conditions\\. \nYou must specify at least one of the following properties: `MaxSize`, `MinSize`, or `DesiredCapacity`\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EndTime": "The date and time for the recurring schedule to end, in UTC\\. For example, `\"2021-06-01T00:00:00Z\"`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaxSize": "The maximum size of the Auto Scaling group\\. \nYou must specify at least one of the following properties: `MaxSize`, `MinSize`, or `DesiredCapacity`\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MinSize": "The minimum size of the Auto Scaling group\\. \nYou must specify at least one of the following properties: `MaxSize`, `MinSize`, or `DesiredCapacity`\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Recurrence": "The recurring schedule for this action\\. This format consists of five fields separated by white spaces: \\[Minute\\] \\[Hour\\] \\[Day\\_of\\_Month\\] \\[Month\\_of\\_Year\\] \\[Day\\_of\\_Week\\]\\. For more information about this format, see [Crontab](http://crontab.org)\\. \nWhen `StartTime` and `EndTime` are specified with `Recurrence`, they form the boundaries of when the recurring action starts and stops\\. \nCron expressions use Universal Coordinated Time \\(UTC\\) by default\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StartTime": "The date and time for this action to start, in YYYY\\-MM\\-DDThh:mm:ssZ format in UTC/GMT only\\. For example, `\"2021-06-01T00:00:00Z\"`\\. \nIf you specify `Recurrence` and `StartTime`, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimeZone": "Specifies the time zone for a cron expression\\. If a time zone is not provided, UTC is used by default\\. \nValid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database \\(such as `Etc/GMT+9` or `Pacific/Tahiti`\\)\\. For more information, see [https://en\\.wikipedia\\.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "MaxSize": "The maximum size of the Auto Scaling group\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MinSize": "The minimum size of the Auto Scaling group\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Recurrence": "The recurring schedule for this action\\. This format consists of five fields separated by white spaces: \\[Minute\\] \\[Hour\\] \\[Day\\_of\\_Month\\] \\[Month\\_of\\_Year\\] \\[Day\\_of\\_Week\\]\\. The value must be in quotes \\(for example, `\"30 0 1 1,6,12 *\"`\\)\\. For more information about this format, see [Crontab](http://crontab.org)\\. \nWhen `StartTime` and `EndTime` are specified with `Recurrence`, they form the boundaries of when the recurring action starts and stops\\. \nCron expressions use Universal Coordinated Time \\(UTC\\) by default\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartTime": "The date and time for this action to start, in YYYY\\-MM\\-DDThh:mm:ssZ format in UTC/GMT only and in quotes \\(for example, `\"2021-06-01T00:00:00Z\"`\\)\\. \nIf you specify `Recurrence` and `StartTime`, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TimeZone": "Specifies the time zone for a cron expression\\. If a time zone is not provided, UTC is used by default\\. \nValid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database \\(such as `Etc/GMT+9` or `Pacific/Tahiti`\\)\\. For more information, see [https://en\\.wikipedia\\.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AutoScaling::WarmPool": { - "AutoScalingGroupName": "The name of the Auto Scaling group\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AutoScalingGroupName": "The name of the Auto Scaling group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InstanceReusePolicy": "Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in\\. The default is to terminate instances in the Auto Scaling group when the group scales in\\. \n*Required*: No \n*Type*: [InstanceReusePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-warmpool-instancereusepolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxGroupPreparedCapacity": "Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except `Terminated` for the Auto Scaling group\\. This is an optional property\\. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity\\. \nIf a value for `MaxGroupPreparedCapacity` is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity\\. If you specify a value for `MaxGroupPreparedCapacity`, Amazon EC2 Auto Scaling uses the difference between the `MaxGroupPreparedCapacity` and the desired capacity instead\\. \nThe size of the warm pool is dynamic\\. Only when `MaxGroupPreparedCapacity` and `MinSize` are set to the same value does the warm pool have an absolute size\\.\nIf the desired capacity of the Auto Scaling group is higher than the `MaxGroupPreparedCapacity`, the capacity of the warm pool is 0, unless you specify a value for `MinSize`\\. To remove a value that you previously set, include the property but specify \\-1 for the value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `-1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MinSize": "Specifies the minimum number of instances to maintain in the warm pool\\. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes\\. Defaults to 0 if not specified\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3123,11 +3446,11 @@ "Unit": "The unit of the metric\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AutoScalingPlans::ScalingPlan CustomizedScalingMetricSpecification": { - "Dimensions": "The dimensions of the metric\\. \nConditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification\\. \n*Required*: No \n*Type*: List of [MetricDimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MetricName": "The name of the metric\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Dimensions": "The dimensions of the metric\\. \nConditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy\\. \n*Required*: No \n*Type*: List of [MetricDimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MetricName": "The name of the metric\\. To get the exact metric name, namespace, and dimensions, inspect the [Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Namespace": "The namespace of the metric\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Statistic": "The statistic of the metric\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Average | Maximum | Minimum | SampleCount | Sum` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Unit": "The unit of the metric\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Unit": "The unit of the metric\\. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::AutoScalingPlans::ScalingPlan MetricDimension": { "Name": "The name of the dimension\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3191,7 +3514,7 @@ "RecoveryPointTags": "To help organize your resources, you can assign your own metadata to the resources that you create\\. Each tag is a key\\-value pair\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RuleName": "A display name for a backup rule\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ScheduleExpression": "A CRON expression specifying when AWS Backup initiates a backup job\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StartWindowMinutes": "An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartWindowMinutes": "An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully\\. \nIf this value is included, it must be at least 60 minutes to avoid errors\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TargetBackupVault": "The name of a logical container where backups are stored\\. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created\\. They consist of letters, numbers, and hyphens\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Backup::BackupPlan CopyActionResourceType": { @@ -3207,18 +3530,28 @@ "BackupSelection": "Specifies the body of a request to assign a set of resources to a backup plan\\. \nIt includes an array of resources, an optional array of patterns to exclude resources, an optional role to provide access to the AWS service the resource belongs to, and an optional array of tags used to identify a set of resources\\. \n*Required*: Yes \n*Type*: [BackupSelectionResourceType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Backup::BackupSelection BackupSelectionResourceType": { - "Conditions": "A list of conditions that you define to assign resources to your backup plans using tags\\. For example, `\"StringEquals\": {\"Department\": \"accounting\"`\\. Condition operators are case sensitive\\. \n`Conditions` differs from `ListOfTags` as follows: \n+ When you specify more than one condition, you only assign the resources that match ALL conditions \\(using AND logic\\)\\.\n+ `Conditions` supports `StringEquals`, `StringLike`, `StringNotEquals`, and `StringNotLike`\\. `ListOfTags` only supports `StringEquals`\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Conditions": "A list of conditions that you define to assign resources to your backup plans using tags\\. For example, `\"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\", \"ConditionValue\": \"true\" },`\\. Condition operators are case sensitive\\. \n`Conditions` differs from `ListOfTags` as follows: \n+ When you specify more than one condition, you only assign the resources that match ALL conditions \\(using AND logic\\)\\.\n+ `Conditions` supports `StringEquals`, `StringLike`, `StringNotEquals`, and `StringNotLike`\\. `ListOfTags` only supports `StringEquals`\\.\n*Required*: No \n*Type*: [Conditions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "IamRoleArn": "The ARN of the IAM role that AWS Backup uses to authenticate when backing up the target resource; for example, `arn:aws:iam::123456789012:role/S3Access`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ListOfTags": "An array of conditions used to specify a set of resources to assign to a backup plan; for example, `\"STRINGEQUALS\": {\"Department\":\"accounting\"`\\. \n*Required*: No \n*Type*: List of [ConditionResourceType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ListOfTags": "A list of conditions that you define to assign resources to your backup plans using tags\\. For example, `\"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\", \"ConditionValue\": \"true\" },`\\. Condition operators are case sensitive\\. \n`ListOfTags` differs from `Conditions` as follows: \n+ When you specify more than one condition, you assign all resources that match AT LEAST ONE condition \\(using OR logic\\)\\.\n+ `ListOfTags` only supports `StringEquals`\\. `Conditions` supports `StringEquals`, `StringLike`, `StringNotEquals`, and `StringNotLike`\\. \n*Required*: No \n*Type*: List of [ConditionResourceType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "NotResources": "A list of Amazon Resource Names \\(ARNs\\) to exclude from a backup plan\\. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards\\. \nIf you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Resources": "An array of strings that contain Amazon Resource Names \\(ARNs\\) of resources to assign to a backup plan\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SelectionName": "The display name of a resource selection document\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::Backup::BackupSelection ConditionParameter": { + "ConditionKey": "The key in a key\\-value pair\\. For example, in the tag `Department: Accounting`, `Department` is the key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ConditionValue": "The value in a key\\-value pair\\. For example, in the tag `Department: Accounting`, `Accounting` is the value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::Backup::BackupSelection ConditionResourceType": { "ConditionKey": "The key in a key\\-value pair\\. For example, in `\"Department\": \"accounting\"`, `\"Department\"` is the key\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ConditionType": "An operation, such as `STRINGEQUALS`, that is applied to a key\\-value pair used to filter resources in a selection\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ConditionValue": "The value in a key\\-value pair\\. For example, in `\"Department\": \"accounting\"`, `\"accounting\"` is the value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::Backup::BackupSelection Conditions": { + "StringEquals": "Filters the values of your tagged resources for only those resources that you tagged with the same value\\. Also called \"exact matching\\.\" \n*Required*: No \n*Type*: List of [ConditionParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StringLike": "Filters the values of your tagged resources for matching tag values with the use of a wildcard character \\(\\*\\) anywhere in the string\\. For example, \"prod\\*\" or \"\\*rod\\*\" matches the tag value \"production\"\\. \n*Required*: No \n*Type*: List of [ConditionParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StringNotEquals": "Filters the values of your tagged resources for only those resources that you tagged that do not have the same value\\. Also called \"negated matching\\.\" \n*Required*: No \n*Type*: List of [ConditionParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StringNotLike": "Filters the values of your tagged resources for non\\-matching tag values with the use of a wildcard character \\(\\*\\) anywhere in the string\\. \n*Required*: No \n*Type*: List of [ConditionParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::Backup::BackupVault": { "AccessPolicy": "A resource\\-based policy that is used to manage access permissions on the target backup vault\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BackupVaultName": "The name of a logical container where backups are stored\\. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created\\. They consist of lowercase letters, numbers, and hyphens\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9\\-\\_]{2,50}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -3228,9 +3561,9 @@ "Notifications": "The SNS event notifications for the specified backup vault\\. \n*Required*: No \n*Type*: [NotificationObjectType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-notificationobjecttype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Backup::BackupVault LockConfigurationType": { - "ChangeableForDays": "The AWS Backup Vault Lock configuration that specifies the number of days before the lock date\\. For example, setting `ChangeableForDays` to 30 on Jan\\. 1, 2022 at 8pm UTC will set the lock date to Jan\\. 31, 2022 at 8pm UTC\\. \nAWS Backup enforces a 72\\-hour cooling\\-off period before Vault Lock takes effect and becomes immutable\\. Therefore, you must set `ChangeableForDays` to 3 or greater\\. \nBefore the lock date, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration`\\. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted\\. \nIf this parameter is not specified, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration` at any time\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaxRetentionDays": "The AWS Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points\\. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years \\(1460 days\\)\\. \nIf this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault\\. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period\\. \nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period\\. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault\\. Recovery points already saved in the vault prior to Vault Lock are not affected\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MinRetentionDays": "The AWS Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points\\. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years \\(2555 days\\)\\. \nIf this parameter is not specified, Vault Lock will not enforce a minimum retention period\\. \nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period\\. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault\\. Recovery points already saved in the vault prior to Vault Lock are not affected\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ChangeableForDays": "The AWS Backup Vault Lock configuration that specifies the number of days before the lock date\\. For example, setting `ChangeableForDays` to 30 on Jan\\. 1, 2022 at 8pm UTC will set the lock date to Jan\\. 31, 2022 at 8pm UTC\\. \nAWS Backup enforces a 72\\-hour cooling\\-off period before Vault Lock takes effect and becomes immutable\\. Therefore, you must set `ChangeableForDays` to 3 or greater\\. \nBefore the lock date, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration`\\. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted\\. \nIf this parameter is not specified, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration` at any time\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxRetentionDays": "The AWS Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points\\. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years \\(1460 days\\)\\. \nIf this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault\\. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period\\. \nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period\\. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault\\. Recovery points already saved in the vault prior to Vault Lock are not affected\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MinRetentionDays": "The AWS Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points\\. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years \\(2555 days\\)\\. \nIf this parameter is not specified, Vault Lock will not enforce a minimum retention period\\. \nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period\\. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault\\. Recovery points already saved in the vault prior to Vault Lock are not affected\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Backup::BackupVault NotificationObjectType": { "BackupVaultEvents": "An array of events that indicate the status of jobs to back up resources to the backup vault\\. For valid events, see [ BackupVaultEvents](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_PutBackupVaultNotifications.html#API_PutBackupVaultNotifications_RequestSyntax) in the *AWS Backup API Guide*\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3246,17 +3579,34 @@ "ParameterName": "The name of a parameter, for example, `BackupPlanFrequency`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ParameterValue": "The value of parameter, for example, `hourly`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Backup::Framework ControlScope": { + "ComplianceResourceIds": "The ID of the only AWS resource that you want your control scope to contain\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ComplianceResourceTypes": "Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The tag key\\-value pair applied to those AWS resources that you want to trigger an evaluation for a rule\\. A maximum of one key\\-value pair can be provided\\. The tag value is optional, but it cannot be an empty string\\. The structure to assign a tag is: `[{\"Key\":\"string\",\"Value\":\"string\"}]`\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Backup::Framework FrameworkControl": { "ControlInputParameters": "A list of `ParameterName` and `ParameterValue` pairs\\. \n*Required*: No \n*Type*: List of [ControlInputParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlinputparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ControlName": "The name of a control\\. This name is between 1 and 256 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ControlScope": "The scope of a control\\. The control scope defines what the control will evaluate\\. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans\\. For more information, see `ControlScope`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ControlScope": "The scope of a control\\. The control scope defines what the control will evaluate\\. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans\\. For more information, see [`ControlScope`\\.](aws-backup/latest/devguide/API_ControlScope.html) \n*Required*: No \n*Type*: [ControlScope](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlscope.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Backup::ReportPlan": { - "ReportDeliveryChannel": "Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReportDeliveryChannel": "Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports\\. \n*Required*: Yes \n*Type*: [ReportDeliveryChannel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportdeliverychannel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ReportPlanDescription": "An optional description of the report plan with a maximum 1,024 characters\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ReportPlanName": "The unique name of the report plan\\. This name is between 1 and 256 characters starting with a letter, and consisting of letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), and underscores \\(\\_\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z][_a-zA-Z0-9]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ReportPlanTags": "A list of tags to tag your report plan\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ReportSetting": "Identifies the report template for the report\\. Reports are built using a report template\\. The report templates are: \n `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT` \nIf the report template is `RESOURCE_COMPLIANCE_REPORT` or `CONTROL_COMPLIANCE_REPORT`, this API resource also describes the report coverage by AWS Regions and frameworks\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ReportSetting": "Identifies the report template for the report\\. Reports are built using a report template\\. The report templates are: \n `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT` \nIf the report template is `RESOURCE_COMPLIANCE_REPORT` or `CONTROL_COMPLIANCE_REPORT`, this API resource also describes the report coverage by AWS Regions and frameworks\\. \n*Required*: Yes \n*Type*: [ReportSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Backup::ReportPlan ReportDeliveryChannel": { + "Formats": "A list of the format of your reports: `CSV`, `JSON`, or both\\. If not specified, the default format is `CSV`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3BucketName": "The unique name of the S3 bucket that receives your reports\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3KeyPrefix": "The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3\\. The prefix is this part of the following path: s3://your\\-bucket\\-name/`prefix`/Backup/us\\-west\\-2/year/month/day/report\\-name\\. If not specified, there is no prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Backup::ReportPlan ReportSetting": { + "Accounts": "These are the accounts to be included in the report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FrameworkArns": "The Amazon Resource Names \\(ARNs\\) of the frameworks a report covers\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OrganizationUnits": "These are the Organizational Units to be included in the report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Regions": "These are the Regions to be included in the report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReportTemplate": "Identifies the report template for the report\\. Reports are built using a report template\\. The report templates are: \n `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Batch::ComputeEnvironment": { "ComputeEnvironmentName": "The name for your compute environment\\. It can be up to 128 characters long\\. It can contain uppercase and lowercase letters, numbers, hyphens \\(\\-\\), and underscores \\(\\_\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -3264,7 +3614,7 @@ "EksConfiguration": "The details for the Amazon EKS cluster that supports the compute environment\\. \n*Required*: No \n*Type*: [EksConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-eksconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ReplaceComputeEnvironment": "Specifies whether the compute environment is 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`, do not change any other properties 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*\\. \nThe properties that can't be changed without replacing the compute environment are in the [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html) property type: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-allocationstrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-allocationstrategy), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-bidpercentage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-bidpercentage), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2configuration), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancerole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancerole), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancetypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancetypes), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-launchtemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-launchtemplate), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-maxvcpus](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-maxvcpus), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-minvcpus](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-minvcpus), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-placementgroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-placementgroup), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-securitygroupids](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-securitygroupids), [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-subnets), [Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-tags), [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-type), and [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-updatetolatestimageversion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-updatetolatestimageversion)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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*\\. \nIf 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\\.\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/`, 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*\\. \nDepending 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\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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\\. \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\\. \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\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \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\\. \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\\. \nCompute environments in a `DISABLED` state may continue to incur billing charges\\. To prevent additional charges, turn off and then delete the compute environment\\. For more information, see [State](https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state) in the * AWS Batch User Guide*\\.\nWhen an instance is idle, the instance scales down to the `minvCpus` value\\. However, the instance size doesn't change\\. For example, consider a `c5.8xlarge` instance with a `minvCpus` value of `4` and a `desiredvCpus` value of `36`\\. This instance doesn't scale down to a `c5.large` instance\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags applied to the compute environment\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Type": "The type of the compute environment: `MANAGED` or `UNMANAGED`\\. For more information, see [Compute Environments](https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html) in the * AWS Batch User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `MANAGED | UNMANAGED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "UnmanagedvCpus": "The maximum number of vCPUs for an unmanaged compute environment\\. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers\\. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved\\. \nThis parameter is only supported when the `type` parameter is set to `UNMANAGED`\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3273,7 +3623,7 @@ "AWS::Batch::ComputeEnvironment ComputeResources": { "AllocationStrategy": "The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated\\. This might be because of availability of the instance type in the Region or [Amazon EC2 service limits](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html)\\. For more information, see [Allocation strategies](https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html) in the * AWS Batch User Guide*\\. \nWhen updating a compute environment, changing the allocation strategy requires an infrastructure update of the compute environment\\. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the * AWS Batch User Guide*\\. `BEST_FIT` is not supported when updating a compute environment\\. \nThis parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be specified\\. \nBEST\\_FIT \\(default\\) \nAWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest\\-cost instance type\\. If additional instances of the selected instance type aren't available, AWS Batch waits for the additional instances to be available\\. If there aren't enough instances available, or if the user is reaching [Amazon EC2 service limits](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) then additional jobs aren't run until the currently running jobs have completed\\. This allocation strategy keeps costs lower but can limit scaling\\. If you are using Spot Fleets with `BEST_FIT` then the Spot Fleet IAM role must be specified\\. \nBEST\\_FIT\\_PROGRESSIVE \n AWS Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU\\. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types\\. \nSPOT\\_CAPACITY\\_OPTIMIZED \n AWS Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted\\. This allocation strategy is only available for Spot Instance compute resources\\.\nWith both `BEST_FIT_PROGRESSIVE` and `SPOT_CAPACITY_OPTIMIZED` allocation strategies using On\\-Demand or Spot Instances, and the `BEST_FIT` strategy using Spot Instances, AWS Batch might need to go above `maxvCpus` to meet your capacity requirements\\. In this event, AWS Batch never exceeds `maxvCpus` by more than a single instance\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `BEST_FIT_PROGRESSIVE | SPOT_CAPACITY_OPTIMIZED` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "BidPercentage": "The maximum percentage that a Spot Instance price can be when compared with the On\\-Demand price for that instance type before instances are launched\\. For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On\\-Demand price for that Amazon EC2 instance\\. You always pay the lowest \\(market\\) price and never more than your maximum percentage\\. For most use cases, we recommend leaving this field empty\\. \nWhen updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment\\. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the * AWS Batch User Guide*\\. \nThis parameter isn't applicable to jobs that are running on Fargate resources\\. Don't specify it\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", - "DesiredvCpus": "The desired number of Amazon EC2 vCPUS in the compute environment\\. AWS Batch modifies this value between the minimum and maximum values based on job queue demand\\. \nThis parameter isn't applicable to jobs that are running on Fargate resources\\. Don't specify it\\.\n AWS Batch doesn't support changing the desired number of vCPUs of an existing compute environment\\. Don't specify this parameter for compute environments using Amazon EKS clusters\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DesiredvCpus": "The desired number of Amazon EC2 vCPUS in the compute environment\\. AWS Batch modifies this value between the minimum and maximum values based on job queue demand\\. \nThis parameter isn't applicable to jobs that are running on Fargate resources\\. Don't specify it\\.\n AWS Batch doesn't support changing the desired number of vCPUs of an existing compute environment\\. Don't specify this parameter for compute environments using Amazon EKS clusters\\.\nWhen you update the `desiredvCpus` setting, the value must be between the `minvCpus` and `maxvCpus` values\\. \nAdditionally, the updated `desiredvCpus` value must be greater than or equal to the current `desiredvCpus` value\\. For more information, see [test](https://docs.aws.amazon.com/batch/latest/userguide/error-desired-vcpus-update.html) in the * AWS Batch User Guide*\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Ec2Configuration": "Provides information used to select Amazon Machine Images \\(AMIs\\) for EC2 instances in the compute environment\\. If `Ec2Configuration` isn't specified, the default is `ECS_AL2`\\. \nWhen updating a compute environment, changing this setting requires an infrastructure update of the compute environment\\. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the * AWS Batch User Guide*\\. To remove the EC2 configuration and any custom AMI ID specified in `imageIdOverride`, set this value to an empty string\\. \nOne or two values can be provided\\. \nThis parameter isn't applicable to jobs that are running on Fargate resources\\. Don't specify it\\.\n*Required*: No \n*Type*: List of [Ec2ConfigurationObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-ec2configurationobject.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "Ec2KeyPair": "The Amazon EC2 key pair that's used for instances launched in the compute environment\\. You can use this key pair to log in to your instances with SSH\\. To remove the Amazon EC2 key pair, set this value to an empty string\\. \nWhen updating a compute environment, changing the EC2 key pair requires an infrastructure update of the compute environment\\. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the * AWS Batch User Guide*\\. \nThis parameter isn't applicable to jobs that are running on Fargate resources\\. Don't specify it\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "ImageId": "The Amazon Machine Image \\(AMI\\) ID used for instances launched in the compute environment\\. This parameter is overridden by the `imageIdOverride` member of the `Ec2Configuration` structure\\. To remove the custom AMI ID and use the default AMI ID, set this value to an empty string\\. \nWhen updating a compute environment, changing the AMI ID requires an infrastructure update of the compute environment\\. For more information, see [Updating compute environments](https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html) in the * AWS Batch User Guide*\\. \nThis parameter isn't applicable to jobs that are running on Fargate resources\\. Don't specify it\\.\nThe AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment\\. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances\\. Amazon ECS vends both x86 and ARM versions of the Amazon ECS\\-optimized Amazon Linux 2 AMI\\. For more information, see [Amazon ECS\\-optimized Amazon Linux 2 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux-variants.html) in the *Amazon Elastic Container Service Developer Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", @@ -3519,9 +3869,10 @@ "AWS::BillingConductor::BillingGroup": { "AccountGrouping": "The set of accounts that will be under the billing group\\. The set of accounts resemble the linked accounts in a consolidated family\\. \n*Required*: Yes \n*Type*: [AccountGrouping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-billinggroup-accountgrouping.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ComputationPreference": "The preferences and settings that will be used to compute the AWS charges for a billing group\\. \n*Required*: Yes \n*Type*: [ComputationPreference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-billinggroup-computationpreference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "The billing group description\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the billing group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The billing group's name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PrimaryAccountId": "The account ID that serves as the main account in a billing group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "PrimaryAccountId": "The account ID that serves as the main account in a billing group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::BillingConductor::BillingGroup AccountGrouping": { "LinkedAccountIds": "The account IDs that make up the billing group\\. Account IDs must be a part of the consolidated billing family, and not associated with another billing group\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -3538,7 +3889,7 @@ "Tags": "A map that contains tag keys and tag values that are attached to a custom line item\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::BillingConductor::CustomLineItem BillingPeriodRange": { - "ExclusiveEndBillingPeriod": "The inclusive end billing period that defines a billing period range where a custom line is applied\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ExclusiveEndBillingPeriod": "The exclusive end billing period that defines a billing period range where a custom line is applied\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InclusiveStartBillingPeriod": "The inclusive start billing period that defines a billing period range where a custom line is applied\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::BillingConductor::CustomLineItem CustomLineItemChargeDetails": { @@ -3560,23 +3911,38 @@ "Tags": "A map that contains tag keys and tag values that are attached to a pricing plan\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::BillingConductor::PricingRule": { + "BillingEntity": "The seller of services provided by AWS, their affiliates, or third\\-party providers selling services via AWS Marketplace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "The pricing rule description\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ModifierPercentage": "A percentage modifier applied on the public pricing rates\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ModifierPercentage": "A percentage modifier applied on the public pricing rates\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of a pricing rule\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Operation": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Scope": "The scope of pricing rule that indicates if it is globally applicable, or if it is service\\-specific\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Service": "If the `Scope` attribute is `SERVICE`, this attribute indicates which service the `PricingRule` is applicable for\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "A map that contains tag keys and tag values that are attached to a pricing rule\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Type": "The type of pricing rule\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Tiering": "The set of tiering configurations for the pricing rule\\. \n*Required*: No \n*Type*: [Tiering](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-pricingrule-tiering.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of pricing rule\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UsageType": "Usage Type is the unit that each service uses to measure the usage of a specific type of resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::BillingConductor::PricingRule FreeTier": { + "Activated": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::BillingConductor::PricingRule Tiering": { + "FreeTier": "Property description not available\\. \n*Required*: No \n*Type*: [FreeTier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-pricingrule-freetier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Budgets::Budget": { "Budget": "The budget object that you want to create\\. \n*Required*: Yes \n*Type*: [BudgetData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-budgetdata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NotificationsWithSubscribers": "A notification that you want to associate with a budget\\. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers\\. If you include notifications and subscribers in your `CreateBudget` call, AWS creates the notifications and subscribers for you\\. \n*Required*: No \n*Type*: List of [NotificationWithSubscribers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-notificationwithsubscribers.html) \n*Maximum*: `10` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::Budgets::Budget AutoAdjustData": { + "AutoAdjustType": "The string that defines whether your budget auto\\-adjusts based on historical or forecasted data\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FORECAST | HISTORICAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HistoricalOptions": "The parameters that define or describe the historical data that your auto\\-adjusting budget is based on\\. \n*Required*: No \n*Type*: [HistoricalOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-historicaloptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Budgets::Budget BudgetData": { + "AutoAdjustData": "Property description not available\\. \n*Required*: No \n*Type*: [AutoAdjustData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-autoadjustdata.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "BudgetLimit": "The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget\\. \n `BudgetLimit` is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets\\. RI and Savings Plans utilization or coverage budgets default to `100`\\. This is the only valid value for RI or Savings Plans utilization or coverage budgets\\. You can't use `BudgetLimit` with `PlannedBudgetLimits` for `CreateBudget` and `UpdateBudget` actions\\. \n*Required*: No \n*Type*: [Spend](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-spend.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BudgetName": "The name of a budget\\. The value must be unique within an account\\. `BudgetName` can't include `:` and `\\` characters\\. If you don't include value for `BudgetName` in the template, Billing and Cost Management assigns your budget a randomly generated name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "BudgetType": "Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `COST | RI_COVERAGE | RI_UTILIZATION | SAVINGS_PLANS_COVERAGE | SAVINGS_PLANS_UTILIZATION | USAGE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CostFilters": "The cost filters, such as `Region`, `Service`, `member account`, `Tag`, or `Cost Category`, that are applied to a budget\\. \n AWS Budgets supports the following services as a `Service` filter for RI budgets: \n+ Amazon EC2\n+ Amazon Redshift\n+ Amazon Relational Database Service\n+ Amazon ElastiCache\n+ Amazon OpenSearch Service \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CostFilters": "The cost filters, such as `Region`, `Service`, `member account`, `Tag`, or `Cost Category`, that are applied to a budget\\. \n AWS Budgets supports the following services as a `Service` filter for RI budgets: \n+ Amazon EC2\n+ Amazon Redshift\n+ Amazon Relational Database Service\n+ Amazon ElastiCache\n+ Amazon OpenSearch Service\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CostTypes": "The types of costs that are included in this `COST` budget\\. \n `USAGE`, `RI_UTILIZATION`, `RI_COVERAGE`, `SAVINGS_PLANS_UTILIZATION`, and `SAVINGS_PLANS_COVERAGE` budgets do not have `CostTypes`\\. \n*Required*: No \n*Type*: [CostTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-costtypes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PlannedBudgetLimits": "A map containing multiple `BudgetLimit`, including current or future limits\\. \n `PlannedBudgetLimits` is available for cost or usage budget and supports both monthly and quarterly `TimeUnit`\\. \nFor monthly budgets, provide 12 months of `PlannedBudgetLimits` values\\. This must start from the current month and include the next 11 months\\. The `key` is the start of the month, `UTC` in epoch seconds\\. \nFor quarterly budgets, provide four quarters of `PlannedBudgetLimits` value entries in standard calendar quarter increments\\. This must start from the current quarter and include the next three quarters\\. The `key` is the start of the quarter, `UTC` in epoch seconds\\. \nIf the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the `PlannedBudgetLimits` values only for the remaining periods\\. \nIf the budget begins at a date in the future, provide `PlannedBudgetLimits` values from the start date of the budget\\. \nAfter all of the `BudgetLimit` values in `PlannedBudgetLimits` are used, the budget continues to use the last limit as the `BudgetLimit`\\. At that point, the planned budget provides the same experience as a fixed budget\\. \n `DescribeBudget` and `DescribeBudgets` response along with `PlannedBudgetLimits` also contain `BudgetLimit` representing the current month or quarter limit present in `PlannedBudgetLimits`\\. This only applies to budgets that are created with `PlannedBudgetLimits`\\. Budgets that are created without `PlannedBudgetLimits` only contain `BudgetLimit`\\. They don't contain `PlannedBudgetLimits`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TimePeriod": "The period of time that is covered by a budget\\. The period has a start date and an end date\\. The start date must come before the end date\\. There are no restrictions on the end date\\. \nThe start date for a budget\\. If you created your budget and didn't specify a start date, the start date defaults to the start of the chosen time period \\(MONTHLY, QUARTERLY, or ANNUALLY\\)\\. For example, if you create your budget on January 24, 2019, choose `MONTHLY`, and don't set a start date, the start date defaults to `01/01/19 00:00 UTC`\\. The defaults are the same for the AWS Billing and Cost Management console and the API\\. \nYou can change your start date with the `UpdateBudget` operation\\. \nAfter the end date, AWS deletes the budget and all associated notifications and subscribers\\. \n*Required*: No \n*Type*: [TimePeriod](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-timeperiod.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3595,6 +3961,9 @@ "UseAmortized": "Specifies whether a budget uses the amortized rate\\. \nThe default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UseBlended": "Specifies whether a budget uses a blended rate\\. \nThe default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Budgets::Budget HistoricalOptions": { + "BudgetAdjustmentPeriod": "The number of budget periods included in the moving\\-average calculation that determines your auto\\-adjusted budget amount\\. The maximum value depends on the `TimeUnit` granularity of the budget: \n+ For the `DAILY` granularity, the maximum value is `60`\\.\n+ For the `MONTHLY` granularity, the maximum value is `12`\\.\n+ For the `QUARTERLY` granularity, the maximum value is `4`\\.\n+ For the `ANNUALLY` granularity, the maximum value is `1`\\.\n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `60` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Budgets::Budget Notification": { "ComparisonOperator": "The comparison that's used for this notification\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `EQUAL_TO | GREATER_THAN | LESS_THAN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NotificationType": "Specifies whether the notification is for how much you have spent \\(`ACTUAL`\\) or for how much that you're forecasted to spend \\(`FORECASTED`\\)\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ACTUAL | FORECASTED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3659,14 +4028,25 @@ "MonitorDimension": "The dimensions to evaluate\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `SERVICE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "MonitorName": "The name of the monitor\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Pattern*: `[\\S\\s]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MonitorSpecification": "The array of `MonitorSpecification` in JSON array format\\. For instance, you can use `MonitorSpecification` to specify a tag, Cost Category, or linked account for your custom anomaly monitor\\. For further information, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalymonitor.html#aws-resource-ce-anomalymonitor--examples) section of this page\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MonitorType": "The possible type values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CUSTOM | DIMENSIONAL` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "MonitorType": "The possible type values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CUSTOM | DIMENSIONAL` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ResourceTags": "Property description not available\\. \n*Required*: No \n*Type*: List of [ResourceTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalymonitor-resourcetag.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::CE::AnomalyMonitor ResourceTag": { + "Key": "The key that's associated with the tag\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Value": "The value that's associated with the tag\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CE::AnomalySubscription": { - "Frequency": "The frequency that anomaly reports are sent over email\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAILY | IMMEDIATE | WEEKLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Frequency": "The frequency that anomaly notifications are sent\\. Notifications are sent either over email \\(for DAILY and WEEKLY frequencies\\) or SNS \\(for IMMEDIATE frequency\\)\\. For more information, see [Creating an Amazon SNS topic for anomaly notifications](https://docs.aws.amazon.com/cost-management/latest/userguide/ad-SNS.html)\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAILY | IMMEDIATE | WEEKLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MonitorArnList": "A list of cost anomaly monitors\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceTags": "Property description not available\\. \n*Required*: No \n*Type*: List of [ResourceTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalysubscription-resourcetag.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Subscribers": "A list of subscribers to notify\\. \n*Required*: Yes \n*Type*: List of [Subscriber](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalysubscription-subscriber.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SubscriptionName": "The name for the subscription\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Pattern*: `[\\S\\s]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Threshold": "The dollar value that triggers a notification if the threshold is exceeded\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Threshold": "\\(deprecated\\) \nAn absolute dollar value that must be exceeded by the anomaly's total impact \\(see [Impact](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) for more details\\) for an anomaly notification to be generated\\. \nThis field has been deprecated\\. To specify a threshold, use ThresholdExpression\\. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression\\. \nOne of Threshold or ThresholdExpression is required for `AWS::CE::AnomalySubscription`\\. You cannot specify both\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ThresholdExpression": "An [Expression](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) object in JSON string format used to specify the anomalies that you want to generate alerts for\\. This supports dimensions and nested expressions\\. The supported dimensions are `ANOMALY_TOTAL_IMPACT_ABSOLUTE` and `ANOMALY_TOTAL_IMPACT_PERCENTAGE`, corresponding to an anomaly\u2019s TotalImpact and TotalImpactPercentage, respectively \\(see [Impact](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) for more details\\)\\. The supported nested expression types are `AND` and `OR`\\. The match option `GREATER_THAN_OR_EQUAL` is required\\. Values must be numbers between 0 and 10,000,000,000 in string format\\. \nOne of Threshold or ThresholdExpression is required for `AWS::CE::AnomalySubscription`\\. You cannot specify both\\. \nFor further information, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalysubscription.html#aws-resource-ce-anomalysubscription--examples) section of this page\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CE::AnomalySubscription ResourceTag": { + "Key": "The key that's associated with the tag\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Value": "The value that's associated with the tag\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CE::AnomalySubscription Subscriber": { "Address": "The email address or SNS Topic Amazon Resource Name \\(ARN\\), depending on the `Type`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `302` \n*Pattern*: `(^[a-zA-Z0-9.!#$%&'*+=?^_\u2018{|}~-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$)|(^arn:(aws[a-zA-Z-]*):sns:[a-zA-Z0-9-]+:[0-9]{12}:[a-zA-Z0-9_-]+(\\.fifo)?$)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3681,14 +4061,14 @@ "SplitChargeRules": "The split charge rules that are used to allocate your charges between your Cost Category values\\. \n*Required*: No \n*Type*: String \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CUR::ReportDefinition": { - "AdditionalArtifacts": "A list of manifests that you want Amazon Web Services to create for this report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AdditionalSchemaElements": "A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AdditionalArtifacts": "A list of manifests that you want AWS to create for this report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdditionalSchemaElements": "A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "BillingViewArn": "The Amazon Resource Name \\(ARN\\) of the billing view\\. You can get this value by using the billing view service public APIs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Compression": "The compression format that Amazon Web Services uses for the report\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Format": "The format that Amazon Web Services saves the report in\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RefreshClosedReports": "Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months\\. These charges can include refunds, credits, or support fees\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RefreshClosedReports": "Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months\\. These charges can include refunds, credits, or support fees\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ReportName": "The name of the report that you want to create\\. The name must be unique, is case sensitive, and can't include spaces\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ReportVersioning": "Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CREATE_NEW_REPORT | OVERWRITE_REPORT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ReportVersioning": "Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CREATE_NEW_REPORT | OVERWRITE_REPORT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "S3Bucket": "The S3 bucket where Amazon Web Services delivers the report\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3Prefix": "The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report\\. Your prefix can't include spaces\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3Region": "The Region of the S3 bucket that Amazon Web Services delivers the report into\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3719,8 +4099,8 @@ "OrderBy": "The order in which this column's data is stored: \n+ `ASC` \\(default\\) \\- The column's data is stored in ascending order\\.\n+ `DESC` \\- The column's data is stored in descending order\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Cassandra::Table Column": { - "ColumnName": "The name of the column\\. For more information, see [Identifiers](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.elements.identifier) in the *Amazon Keyspaces Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ColumnType": "The data type of the column\\. For more information, see [Data types](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) in the *Amazon Keyspaces Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ColumnName": "The name of the column\\. For more information, see [Identifiers](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.elements.identifier) in the *Amazon Keyspaces Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "ColumnType": "The data type of the column\\. For more information, see [Data types](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) in the *Amazon Keyspaces Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)" }, "AWS::Cassandra::Table EncryptionSpecification": { "EncryptionType": "The encryption at rest options for the table\\. \n+ **AWS owned key** \\(default\\) \\- `AWS_OWNED_KMS_KEY`\n+ **Customer managed key** \\- `CUSTOMER_MANAGED_KMS_KEY`\n**Important** \nIf you choose `CUSTOMER_MANAGED_KMS_KEY`, a `kms_key_identifier` in the format of a key ARN is required\\. \nValid values: `CUSTOMER_MANAGED_KMS_KEY` \\| `AWS_OWNED_KMS_KEY`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3737,7 +4117,7 @@ "DaysBeforeExpiry": "This option specifies the number of days prior to certificate expiration when ACM starts generating `EventBridge` events\\. ACM sends one event per day per certificate until the certificate expires\\. By default, accounts receive events starting 45 days before certificate expiration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CertificateManager::Certificate": { - "CertificateAuthorityArn": "The Amazon Resource Name \\(ARN\\) of the private certificate authority \\(CA\\) that will be used to issue the certificate\\. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate\\. For more information about private CAs, see the [AWS Certificate Manager Private Certificate Authority \\(PCA\\)](https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaWelcome.html) user guide\\. The ARN must have the following form: \n `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012` \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CertificateAuthorityArn": "The Amazon Resource Name \\(ARN\\) of the private certificate authority \\(CA\\) that will be used to issue the certificate\\. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate\\. For more information about private CAs, see the [AWS Private Certificate Authority](https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html) user guide\\. The ARN must have the following form: \n `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012` \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:acm-pca:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "CertificateTransparencyLoggingPreference": "You can opt out of certificate transparency logging by specifying the `DISABLED` option\\. Opt in by specifying `ENABLED`\\. \nIf you do not specify a certificate transparency logging preference on a new CloudFormation template, or if you remove the logging preference from an existing template, this is the same as explicitly enabling the preference\\. \nChanging the certificate transparency logging preference will update the existing resource by calling `UpdateCertificateOptions` on the certificate\\. This action will not create a new resource\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DomainName": "The fully qualified domain name \\(FQDN\\), such as www\\.example\\.com, with which you want to secure an ACM certificate\\. Use an asterisk \\(\\*\\) to create a wildcard certificate that protects several sites in the same domain\\. For example, `*.example.com` protects `www.example.com`, `site.example.com`, and `images.example.com.` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `253` \n*Pattern*: `^(\\*\\.)?(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DomainValidationOptions": "Domain information that domain name registrars use to verify your identity\\. \nIn order for a AWS::CertificateManager::Certificate to be provisioned and validated in CloudFormation automatically, the `DomainName` property needs to be identical to one of the `DomainName` property supplied in DomainValidationOptions, if the ValidationMethod is \\*\\*DNS\\*\\*\\. Failing to keep them like\\-for\\-like will result in failure to create the domain validation records in Route53\\.\n*Required*: No \n*Type*: List of [DomainValidationOption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html) \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -3752,8 +4132,8 @@ }, "AWS::Chatbot::SlackChannelConfiguration": { "ConfigurationName": "The name of the configuration\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "GuardrailPolicies": "The list of IAM policy ARNs that are applied as channel guardrails\\. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set\\. Currently, only 1 IAM policy is supported\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IamRoleArn": "The ARN of the IAM role that defines the permissions for AWS Chatbot\\. \nThis is a user\\-definworked role that AWS Chatbot will assume\\. This is not the service\\-linked role\\. For more information, see [IAM Policies for AWS Chatbot](https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "GuardrailPolicies": "The list of IAM policy ARNs that are applied as channel guardrails\\. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IamRoleArn": "The ARN of the IAM role that defines the permissions for AWS Chatbot\\. \nThis is a user\\-defined role that AWS Chatbot will assume\\. This is not the service\\-linked role\\. For more information, see [IAM Policies for AWS Chatbot](https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LoggingLevel": "Specifies the logging level for this configuration\\. This property affects the log entries pushed to Amazon CloudWatch Logs\\. \nLogging levels include `ERROR`, `INFO`, or `NONE`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SlackChannelId": "The ID of the Slack channel\\. \nTo get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link\\. The channel ID is the 9\\-character string at the end of the URL\\. For example, `ABCBBLZZZ`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SlackWorkspaceId": "The ID of the Slack workspace authorized with AWS Chatbot\\. \nTo get the workspace ID, you must perform the initial authorization flow with Slack in the AWS Chatbot console\\. Then you can copy and paste the workspace ID from the console\\. For more details, see steps 1\\-4 in [Setting Up AWS Chatbot with Slack](https://docs.aws.amazon.com/chatbot/latest/adminguide/setting-up.html#Setup_intro) in the *AWS Chatbot User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -3761,7 +4141,7 @@ "UserRoleRequired": "Enables use of a user role requirement in your chat configuration\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cloud9::EnvironmentEC2": { - "AutomaticStopTimeMinutes": "The number of minutes until the running instance is shut down after the environment was last used\\. \n*Required*: No \n*Type*: Integer \n*Maximum*: `20160` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AutomaticStopTimeMinutes": "The number of minutes until the running instance is shut down after the environment was last used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `20160` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ConnectionType": "The connection type used for connecting to an Amazon EC2 environment\\. Valid values are `CONNECT_SSH` \\(default\\) and `CONNECT_SSM` \\(connected through AWS Systems Manager\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CONNECT_SSH | CONNECT_SSM` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "The description of the environment to create\\. \n*Required*: No \n*Type*: String \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ImageId": "The identifier for the Amazon Machine Image \\(AMI\\) that's used to create the EC2 instance\\. To choose an AMI for the instance, you must specify a valid AMI alias or a valid AWS Systems Manager path\\. \nThe default AMI is used if the parameter isn't explicitly assigned a value in the request\\. \n**AMI aliases ** \n+ **Amazon Linux \\(default\\): `amazonlinux-1-x86_64`** \n+ Amazon Linux 2: `amazonlinux-2-x86_64`\n+ Ubuntu 18\\.04: `ubuntu-18.04-x86_64`\n**SSM paths** \n+ **Amazon Linux \\(default\\): `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64`**\n+ Amazon Linux 2: `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64`\n+ Ubuntu 18\\.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64`\n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -3787,7 +4167,7 @@ "AWS::CloudFormation::HookTypeConfig": { "Configuration": "Specifies the activated hook type configuration, in this AWS account and AWS Region\\. \nYou must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConfigurationAlias": "Specifies the activated hook type configuration, in this AWS account and AWS Region\\. \nDefaults to `default` alias\\. Hook types currently support default configuration alias\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "TypeArn": "The Amazon Resource Number \\(ARN\\) for the hook to set `Configuration` for\\. \nYou must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TypeArn": "The Amazon Resource Number \\(ARN\\) for the hook to set `Configuration` for\\. \nYou must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TypeName": "The unique name for your hook\\. Specifies a three\\-part namespace for your hook, with a recommended pattern of `Organization::Service::Hook`\\. \nYou must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration`\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `196` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFormation::HookVersion": { @@ -3843,7 +4223,7 @@ "TypeName": "The name of the resource being registered\\. \nWe recommend that resource names adhere to the following pattern: *company\\_or\\_organization*::*service*::*type*\\. \nThe following organization namespaces are reserved and can't be used in your resource names: \n+ `Alexa`\n+ `AMZN`\n+ `Amazon`\n+ `AWS`\n+ `Custom`\n+ `Dev`\n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `204` \n*Pattern*: `[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CloudFormation::ResourceVersion LoggingConfig": { - "LogGroupName": "The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "LogGroupName": "The Amazon CloudWatch logs group to which CloudFormation sends error logging information when invoking the type's handlers\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "LogRoleArn": "The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `arn:.+:iam::[0-9]{12}:role/.+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CloudFormation::Stack": { @@ -3860,7 +4240,7 @@ "Capabilities": "The capabilities that are allowed in the stack set\\. Some stack set templates might include resources that can affect permissions in your AWS account\u2014for example, by creating new AWS Identity and Access Management \\(IAM\\) users\\. For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description of the stack set\\. \n*Minimum*: `1` \n*Maximum*: `1024` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExecutionRoleName": "The name of the IAM execution role to use to create the stack set\\. If you don't specify an execution role, AWS CloudFormation uses the `AWSCloudFormationStackSetExecutionRole` role for the stack set operation\\. \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[a-zA-Z_0-9+=,.@-]+` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ManagedExecution": "Describes whether StackSets performs non\\-conflicting operations concurrently and queues conflicting operations\\. \nWhen active, StackSets performs non\\-conflicting operations concurrently and queues conflicting operations\\. After conflicting operations finish, StackSets starts queued operations in request order\\. \nIf there are already running or queued operations, StackSets queues all incoming operations even if they are non\\-conflicting\\. \nYou can't modify your stack set's execution configuration while there are running or queued operations for that stack set\\.\nWhen inactive \\(default\\), StackSets performs one operation at a time in request order\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ManagedExecution": "Describes whether StackSets performs non\\-conflicting operations concurrently and queues conflicting operations\\. \nWhen active, StackSets performs non\\-conflicting operations concurrently and queues conflicting operations\\. After conflicting operations finish, StackSets starts queued operations in request order\\. \nIf there are already running or queued operations, StackSets queues all incoming operations even if they are non\\-conflicting\\. \nYou can't modify your stack set's execution configuration while there are running or queued operations for that stack set\\.\nWhen inactive \\(default\\), StackSets performs one operation at a time in request order\\. \n*Required*: No \n*Type*: [ManagedExecution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-managedexecution.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OperationPreferences": "The user\\-specified preferences for how AWS CloudFormation performs a stack set operation\\. \n*Required*: No \n*Type*: [OperationPreferences](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Parameters": "The input parameters for the stack set template\\. \n*Required*: No \n*Type*: List of [Parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-parameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PermissionModel": "Describes how the IAM roles required for stack set operations are created\\. \n+ With `SELF_MANAGED` permissions, you must create the administrator and execution roles required to deploy to target accounts\\. For more information, see [Grant Self\\-Managed Stack Set Permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html)\\.\n+ With `SERVICE_MANAGED` permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations\\. For more information, see [Grant Service\\-Managed Stack Set Permissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html)\\.\n*Allowed Values*: `SERVICE_MANAGED` \\| `SELF_MANAGED` \nThe `PermissionModel` property is required\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -3875,9 +4255,13 @@ "RetainStacksOnAccountRemoval": "If set to `true`, stack resources are retained when an account is removed from a target organization or OU\\. If set to `false`, stack resources are deleted\\. Specify only if `Enabled` is set to `True`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFormation::StackSet DeploymentTargets": { + "AccountFilterType": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Accounts": "The names of one or more AWS accounts for which you want to deploy stack set updates\\. \n*Pattern*: `^[0-9]{12}$` \n*Required*: Conditional \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OrganizationalUnitIds": "The organization root ID or organizational unit \\(OU\\) IDs to which StackSets deploys\\. \n*Pattern*: `^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$` \n*Required*: Conditional \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::CloudFormation::StackSet ManagedExecution": { + "Active": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::CloudFormation::StackSet OperationPreferences": { "FailureToleranceCount": "The number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region\\. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions\\. \nConditional: You must specify either `FailureToleranceCount` or `FailureTolerancePercentage` \\(but not both\\)\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FailureTolerancePercentage": "The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region\\. If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in any subsequent Regions\\. \nWhen calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds *down* to the next whole number\\. \nConditional: You must specify either `FailureToleranceCount` or `FailureTolerancePercentage`, but not both\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3921,7 +4305,7 @@ }, "AWS::CloudFront::CachePolicy CachePolicyConfig": { "Comment": "A comment to describe the cache policy\\. The comment cannot be longer than 128 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DefaultTTL": "The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated\\. CloudFront uses this value as the object\u2019s time to live \\(TTL\\) only when the origin does *not* send `Cache-Control` or `Expires` headers with the object\\. For more information, see [Managing How Long Content Stays in an Edge Cache \\(Expiration\\)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\. \nThe default value for this field is 86400 seconds \\(one day\\)\\. If the value of `MinTTL` is more than 86400 seconds, then the default value for this field is the same as the value of `MinTTL`\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefaultTTL": "The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated\\. CloudFront uses this value as the object's time to live \\(TTL\\) only when the origin does *not* send `Cache-Control` or `Expires` headers with the object\\. For more information, see [Managing How Long Content Stays in an Edge Cache \\(Expiration\\)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\. \nThe default value for this field is 86400 seconds \\(one day\\)\\. If the value of `MinTTL` is more than 86400 seconds, then the default value for this field is the same as the value of `MinTTL`\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxTTL": "The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated\\. CloudFront uses this value only when the origin sends `Cache-Control` or `Expires` headers with the object\\. For more information, see [Managing How Long Content Stays in an Edge Cache \\(Expiration\\)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\. \nThe default value for this field is 31536000 seconds \\(one year\\)\\. If the value of `MinTTL` or `DefaultTTL` is more than 31536000 seconds, then the default value for this field is the same as the value of `DefaultTTL`\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MinTTL": "The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated\\. For more information, see [Managing How Long Content Stays in an Edge Cache \\(Expiration\\)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A unique name to identify the cache policy\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3937,8 +4321,8 @@ }, "AWS::CloudFront::CachePolicy ParametersInCacheKeyAndForwardedToOrigin": { "CookiesConfig": "An object that determines whether any cookies in viewer requests \\(and if so, which cookies\\) are included in the cache key and automatically included in requests that CloudFront sends to the origin\\. \n*Required*: Yes \n*Type*: [CookiesConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-cookiesconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EnableAcceptEncodingBrotli": "A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin\\. \nThis field is related to the `EnableAcceptEncodingGzip` field\\. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following: \n+ Normalizes the value of the viewer\u2019s `Accept-Encoding` header\n+ Includes the normalized header in the cache key\n+ Includes the normalized header in the request to the origin, if a request is necessary\nFor more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*\\. \nIf you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy\\. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect\\. \nIf both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request\\. By default, it\u2019s not included in the cache key and it\u2019s not included in origin requests\\. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EnableAcceptEncodingGzip": "A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin\\. \nThis field is related to the `EnableAcceptEncodingBrotli` field\\. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following: \n+ Normalizes the value of the viewer\u2019s `Accept-Encoding` header\n+ Includes the normalized header in the cache key\n+ Includes the normalized header in the request to the origin, if a request is necessary\nFor more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*\\. \nIf you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy\\. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect\\. \nIf both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request\\. By default, it\u2019s not included in the cache key and it\u2019s not included in origin requests\\. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableAcceptEncodingBrotli": "A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin\\. \nThis field is related to the `EnableAcceptEncodingGzip` field\\. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following: \n+ Normalizes the value of the viewer's `Accept-Encoding` header\n+ Includes the normalized header in the cache key\n+ Includes the normalized header in the request to the origin, if a request is necessary\nFor more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*\\. \nIf you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy\\. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect\\. \nIf both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request\\. By default, it's not included in the cache key and it's not included in origin requests\\. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableAcceptEncodingGzip": "A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin\\. \nThis field is related to the `EnableAcceptEncodingBrotli` field\\. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following: \n+ Normalizes the value of the viewer's `Accept-Encoding` header\n+ Includes the normalized header in the cache key\n+ Includes the normalized header in the request to the origin, if a request is necessary\nFor more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*\\. \nIf you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy\\. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect\\. \nIf both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request\\. By default, it's not included in the cache key and it's not included in origin requests\\. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HeadersConfig": "An object that determines whether any HTTP headers \\(and if so, which headers\\) are included in the cache key and automatically included in requests that CloudFront sends to the origin\\. \n*Required*: Yes \n*Type*: [HeadersConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-headersconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "QueryStringsConfig": "An object that determines whether any URL query strings in viewer requests \\(and if so, which query strings\\) are included in the cache key and automatically included in requests that CloudFront sends to the origin\\. \n*Required*: Yes \n*Type*: [QueryStringsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-cachepolicy-querystringsconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -3952,14 +4336,39 @@ "AWS::CloudFront::CloudFrontOriginAccessIdentity CloudFrontOriginAccessIdentityConfig": { "Comment": "A comment to describe the origin access identity\\. The comment cannot be longer than 128 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::CloudFront::ContinuousDeploymentPolicy": { + "ContinuousDeploymentPolicyConfig": "Contains the configuration for a continuous deployment policy\\. \n*Required*: Yes \n*Type*: [ContinuousDeploymentPolicyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudFront::ContinuousDeploymentPolicy ContinuousDeploymentPolicyConfig": { + "Enabled": "A Boolean that indicates whether this continuous deployment policy is enabled \\(in effect\\)\\. When this value is `true`, this policy is enabled and in effect\\. When this value is `false`, this policy is not enabled and has no effect\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StagingDistributionDnsNames": "The CloudFront domain name of the staging distribution\\. For example: `d111111abcdef8.cloudfront.net`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TrafficConfig": "Contains the parameters for routing production traffic from your primary to staging distributions\\. \n*Required*: No \n*Type*: [TrafficConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudFront::ContinuousDeploymentPolicy SessionStickinessConfig": { + "IdleTTL": "The amount of time after which you want sessions to cease if no requests are received\\. Allowed values are 300\u20133600 seconds \\(5\u201360 minutes\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumTTL": "The maximum amount of time to consider requests from the viewer as being part of the same session\\. Allowed values are 300\u20133600 seconds \\(5\u201360 minutes\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudFront::ContinuousDeploymentPolicy SingleHeaderConfig": { + "Header": "The request header name that you want CloudFront to send to your staging distribution\\. The header must contain the prefix `aws-cf-cd-`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The request header value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudFront::ContinuousDeploymentPolicy SingleWeightConfig": { + "SessionStickinessConfig": "Session stickiness provides the ability to define multiple requests from a single viewer as a single session\\. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution\\. Define the session duration using TTL values\\. \n*Required*: No \n*Type*: [SessionStickinessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Weight": "The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and \\.15\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudFront::ContinuousDeploymentPolicy TrafficConfig": { + "SingleHeaderConfig": "Determines which HTTP requests are sent to the staging distribution\\. \n*Required*: No \n*Type*: [SingleHeaderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SingleWeightConfig": "Contains the percentage of traffic to send to the staging distribution\\. \n*Required*: No \n*Type*: [SingleWeightConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleweightconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of traffic configuration\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SingleHeader | SingleWeight` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::CloudFront::Distribution": { - "DistributionConfig": "The current configuration information for the distribution\\. Send a `GET` request to the `/CloudFront API version/distribution ID/config` resource\\. \n*Required*: Yes \n*Type*: [DistributionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DistributionConfig": "The distribution's configuration\\. \n*Required*: Yes \n*Type*: [DistributionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A complex type that contains zero or more `Tag` elements\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution CacheBehavior": { "AllowedMethods": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin\\. There are three choices: \n+ CloudFront forwards only `GET` and `HEAD` requests\\.\n+ CloudFront forwards only `GET`, `HEAD`, and `OPTIONS` requests\\.\n+ CloudFront forwards `GET, HEAD, OPTIONS, PUT, PATCH, POST`, and `DELETE` requests\\.\nIf you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to\\. For example, you might not want users to have permissions to delete objects from your origin\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CachePolicyId": "The unique identifier of the cache policy that is attached to this cache behavior\\. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*\\. \nA `CacheBehavior` must include either a `CachePolicyId` or `ForwardedValues`\\. We recommend that you use a `CachePolicyId`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CachedMethods": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods\\. There are two choices: \n+ CloudFront caches responses to `GET` and `HEAD` requests\\.\n+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` requests\\.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward Access\\-Control\\-Request\\-Method, Access\\-Control\\-Request\\-Headers, and Origin headers for the responses to be cached correctly\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CachedMethods": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods\\. There are two choices: \n+ CloudFront caches responses to `GET` and `HEAD` requests\\.\n+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` requests\\.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward Access\\-Control\\-Request\\-Method, Access\\-Control\\-Request\\-Headers, and Origin headers for the responses to be cached correctly\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Compress": "Whether you want CloudFront to automatically compress certain files for this cache behavior\\. If so, specify true; if not, specify false\\. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DefaultTTL": "This field is deprecated\\. We recommend that you use the `DefaultTTL` field in a cache policy instead of this field\\. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*\\. \nThe default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated\\. The value that you specify applies only when your origin does not add HTTP headers such as `Cache-Control max-age`, `Cache-Control s-maxage`, and `Expires` to objects\\. For more information, see [Managing How Long Content Stays in an Edge Cache \\(Expiration\\)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FieldLevelEncryptionId": "The value of `ID` for the field\\-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3972,11 +4381,11 @@ "PathPattern": "The pattern \\(for example, `images/*.jpg`\\) that specifies which requests to apply the behavior to\\. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution\\. \nYou can optionally include a slash \\(`/`\\) at the beginning of the path pattern\\. For example, `/images/*.jpg`\\. CloudFront behavior is the same with or without the leading `/`\\.\nThe path pattern for the default cache behavior is `*` and cannot be changed\\. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior\\. \nFor more information, see [Path Pattern](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) in the * Amazon CloudFront Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RealtimeLogConfigArn": "The Amazon Resource Name \\(ARN\\) of the real\\-time log configuration that is attached to this cache behavior\\. For more information, see [Real\\-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResponseHeadersPolicyId": "The identifier for a response headers policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SmoothStreaming": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior\\. If so, specify `true`; if not, specify `false`\\. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SmoothStreaming": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior\\. If so, specify `true`; if not, specify `false`\\. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TargetOriginId": "The value of `ID` for the origin that you want CloudFront to route requests to when they match this cache behavior\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TrustedKeyGroups": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TrustedSigners": "We recommend using `TrustedKeyGroups` instead of `TrustedSigners`\\.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer\u2019s AWS account\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ViewerProtocolPolicy": "The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`\\. You can specify the following options: \n+ `allow-all`: Viewers can use HTTP or HTTPS\\.\n+ `redirect-to-https`: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 \\(Moved Permanently\\) to the viewer along with the HTTPS URL\\. The viewer then resubmits the request using the new URL\\. \n+ `https-only`: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 \\(Forbidden\\)\\. \nFor more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*\\. \nThe only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object\\. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects\u2019 cache because cached objects are protocol agnostic\\. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously\\. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `allow-all | https-only | redirect-to-https` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TrustedSigners": "We recommend using `TrustedKeyGroups` instead of `TrustedSigners`\\.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS account\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ViewerProtocolPolicy": "The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`\\. You can specify the following options: \n+ `allow-all`: Viewers can use HTTP or HTTPS\\.\n+ `redirect-to-https`: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 \\(Moved Permanently\\) to the viewer along with the HTTPS URL\\. The viewer then resubmits the request using the new URL\\.\n+ `https-only`: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 \\(Forbidden\\)\\.\nFor more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*\\. \nThe only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object\\. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic\\. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously\\. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `allow-all | https-only | redirect-to-https` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution Cookies": { "Forward": "This field is deprecated\\. We recommend that you use a cache policy or an origin request policy instead of this field\\. \nIf you want to include cookies in the cache key, use a cache policy\\. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*\\. \nIf you want to send cookies to the origin but not include them in the cache key, use origin request policy\\. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*\\. \nSpecifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the `WhitelistedNames` complex type\\. \nAmazon S3 doesn't process cookies\\. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the `Forward` element\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `all | none | whitelist` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -3986,20 +4395,20 @@ "ErrorCachingMinTTL": "The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in `ErrorCode`\\. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available\\. \nFor more information, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ErrorCode": "The HTTP status code for which you want to specify a custom error page and/or a caching duration\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResponseCode": "The HTTP status code that you want CloudFront to return to the viewer along with the custom error page\\. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: \n+ Some Internet devices \\(some firewalls and corporate proxies, for example\\) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer\\. If you substitute `200`, the response typically won't be intercepted\\.\n+ If you don't care about distinguishing among different client errors or server errors, you can specify `400` or `500` as the `ResponseCode` for all 4xx or 5xx errors\\.\n+ You might want to return a `200` status code \\(OK\\) and static website so your customers don't know that your website is down\\.\nIf you specify a value for `ResponseCode`, you must also specify a value for `ResponsePagePath`\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResponsePagePath": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by `ErrorCode`, for example, `/4xx-errors/403-forbidden.html`\\. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: \n+ The value of `PathPattern` matches the path to your custom error messages\\. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named `/4xx-errors`\\. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, `/4xx-errors/*`\\. \n+ The value of `TargetOriginId` specifies the value of the `ID` element for the origin that contains your custom error pages\\.\nIf you specify a value for `ResponsePagePath`, you must also specify a value for `ResponseCode`\\. \nWe recommend that you store custom error pages in an Amazon S3 bucket\\. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ResponsePagePath": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by `ErrorCode`, for example, `/4xx-errors/403-forbidden.html`\\. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: \n+ The value of `PathPattern` matches the path to your custom error messages\\. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named `/4xx-errors`\\. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, `/4xx-errors/*`\\.\n+ The value of `TargetOriginId` specifies the value of the `ID` element for the origin that contains your custom error pages\\.\nIf you specify a value for `ResponsePagePath`, you must also specify a value for `ResponseCode`\\. \nWe recommend that you store custom error pages in an Amazon S3 bucket\\. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution CustomOriginConfig": { "HTTPPort": "The HTTP port that CloudFront uses to connect to the origin\\. Specify the HTTP port that the origin listens on\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HTTPSPort": "The HTTPS port that CloudFront uses to connect to the origin\\. Specify the HTTPS port that the origin listens on\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OriginKeepaliveTimeout": "Specifies how long, in seconds, CloudFront persists its connection to the origin\\. The minimum timeout is 1 second, the maximum is 60 seconds, and the default \\(if you don\u2019t specify otherwise\\) is 5 seconds\\. \nFor more information, see [Origin Keep\\-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OriginKeepaliveTimeout": "Specifies how long, in seconds, CloudFront persists its connection to the origin\\. The minimum timeout is 1 second, the maximum is 60 seconds, and the default \\(if you don't specify otherwise\\) is 5 seconds\\. \nFor more information, see [Origin Keep\\-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OriginProtocolPolicy": "Specifies the protocol \\(HTTP or HTTPS\\) that CloudFront uses to connect to the origin\\. Valid values are: \n+ `http-only` \u2013 CloudFront always uses HTTP to connect to the origin\\.\n+ `match-viewer` \u2013 CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront\\.\n+ `https-only` \u2013 CloudFront always uses HTTPS to connect to the origin\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `http-only | https-only | match-viewer` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OriginReadTimeout": "Specifies how long, in seconds, CloudFront waits for a response from the origin\\. This is also known as the *origin response timeout*\\. The minimum timeout is 1 second, the maximum is 60 seconds, and the default \\(if you don\u2019t specify otherwise\\) is 30 seconds\\. \nFor more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OriginReadTimeout": "Specifies how long, in seconds, CloudFront waits for a response from the origin\\. This is also known as the *origin response timeout*\\. The minimum timeout is 1 second, the maximum is 60 seconds, and the default \\(if you don't specify otherwise\\) is 30 seconds\\. \nFor more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OriginSSLProtocols": "Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS\\. Valid values include `SSLv3`, `TLSv1`, `TLSv1.1`, and `TLSv1.2`\\. \nFor more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution DefaultCacheBehavior": { "AllowedMethods": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin\\. There are three choices: \n+ CloudFront forwards only `GET` and `HEAD` requests\\.\n+ CloudFront forwards only `GET`, `HEAD`, and `OPTIONS` requests\\.\n+ CloudFront forwards `GET, HEAD, OPTIONS, PUT, PATCH, POST`, and `DELETE` requests\\.\nIf you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to\\. For example, you might not want users to have permissions to delete objects from your origin\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CachePolicyId": "The unique identifier of the cache policy that is attached to the default cache behavior\\. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*\\. \nA `DefaultCacheBehavior` must include either a `CachePolicyId` or `ForwardedValues`\\. We recommend that you use a `CachePolicyId`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CachedMethods": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods\\. There are two choices: \n+ CloudFront caches responses to `GET` and `HEAD` requests\\.\n+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` requests\\.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward Access\\-Control\\-Request\\-Method, Access\\-Control\\-Request\\-Headers, and Origin headers for the responses to be cached correctly\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CachedMethods": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods\\. There are two choices: \n+ CloudFront caches responses to `GET` and `HEAD` requests\\.\n+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` requests\\.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward Access\\-Control\\-Request\\-Method, Access\\-Control\\-Request\\-Headers, and Origin headers for the responses to be cached correctly\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Compress": "Whether you want CloudFront to automatically compress certain files for this cache behavior\\. If so, specify `true`; if not, specify `false`\\. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DefaultTTL": "This field is deprecated\\. We recommend that you use the `DefaultTTL` field in a cache policy instead of this field\\. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*\\. \nThe default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated\\. The value that you specify applies only when your origin does not add HTTP headers such as `Cache-Control max-age`, `Cache-Control s-maxage`, and `Expires` to objects\\. For more information, see [Managing How Long Content Stays in an Edge Cache \\(Expiration\\)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FieldLevelEncryptionId": "The value of `ID` for the field\\-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -4011,32 +4420,34 @@ "OriginRequestPolicyId": "The unique identifier of the origin request policy that is attached to the default cache behavior\\. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RealtimeLogConfigArn": "The Amazon Resource Name \\(ARN\\) of the real\\-time log configuration that is attached to this cache behavior\\. For more information, see [Real\\-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResponseHeadersPolicyId": "The identifier for a response headers policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SmoothStreaming": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior\\. If so, specify `true`; if not, specify `false`\\. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SmoothStreaming": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior\\. If so, specify `true`; if not, specify `false`\\. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TargetOriginId": "The value of `ID` for the origin that you want CloudFront to route requests to when they use the default cache behavior\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TrustedKeyGroups": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TrustedSigners": "We recommend using `TrustedKeyGroups` instead of `TrustedSigners`\\.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer\u2019s AWS account\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ViewerProtocolPolicy": "The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`\\. You can specify the following options: \n+ `allow-all`: Viewers can use HTTP or HTTPS\\.\n+ `redirect-to-https`: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 \\(Moved Permanently\\) to the viewer along with the HTTPS URL\\. The viewer then resubmits the request using the new URL\\.\n+ `https-only`: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 \\(Forbidden\\)\\.\nFor more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*\\. \nThe only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object\\. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects\u2019 cache because cached objects are protocol agnostic\\. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously\\. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `allow-all | https-only | redirect-to-https` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TrustedSigners": "We recommend using `TrustedKeyGroups` instead of `TrustedSigners`\\.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS account\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ViewerProtocolPolicy": "The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`\\. You can specify the following options: \n+ `allow-all`: Viewers can use HTTP or HTTPS\\.\n+ `redirect-to-https`: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 \\(Moved Permanently\\) to the viewer along with the HTTPS URL\\. The viewer then resubmits the request using the new URL\\.\n+ `https-only`: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 \\(Forbidden\\)\\.\nFor more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*\\. \nThe only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object\\. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic\\. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously\\. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `allow-all | https-only | redirect-to-https` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution DistributionConfig": { "Aliases": "A complex type that contains information about CNAMEs \\(alternate domain names\\), if any, for this distribution\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CNAMEs": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CacheBehaviors": "A complex type that contains zero or more `CacheBehavior` elements\\. \n*Required*: No \n*Type*: List of [CacheBehavior](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Comment": "An optional comment to describe the distribution\\. The comment cannot be longer than 128 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CNAMEs": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CacheBehaviors": "A complex type that contains zero or more `CacheBehavior` elements\\. \n*Required*: No \n*Type*: List of [CacheBehavior](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Comment": "A comment to describe the distribution\\. The comment cannot be longer than 128 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContinuousDeploymentPolicyId": "The identifier of a continuous deployment policy\\. For more information, see `CreateContinuousDeploymentPolicy`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomErrorResponses": "A complex type that controls the following: \n+ Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer\\.\n+ How long CloudFront caches HTTP status codes in the 4xx and 5xx range\\.\nFor more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of [CustomErrorResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customerrorresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CustomOrigin": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [LegacyCustomOrigin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacycustomorigin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DefaultCacheBehavior": "A complex type that describes the default cache behavior if you don't specify a `CacheBehavior` element or if files don't match any of the values of `PathPattern` in `CacheBehavior` elements\\. You must create exactly one default cache behavior\\. \n*Required*: No \n*Type*: [DefaultCacheBehavior](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DefaultRootObject": "The object that you want CloudFront to request from your origin \\(for example, `index.html`\\) when a viewer requests the root URL for your distribution \\(`http://www.example.com`\\) instead of an object in your distribution \\(`http://www.example.com/product-description.html`\\)\\. Specifying a default root object avoids exposing the contents of your distribution\\. \nSpecify only the object name, for example, `index.html`\\. Don't add a `/` before the object name\\. \nIf you don't want to specify a default root object when you create a distribution, include an empty `DefaultRootObject` element\\. \nTo delete the default root object from an existing distribution, update the distribution configuration and include an empty `DefaultRootObject` element\\. \nTo replace the default root object, update the distribution configuration and specify the new object\\. \nFor more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomOrigin": "Property description not available\\. \n*Required*: No \n*Type*: [LegacyCustomOrigin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacycustomorigin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefaultCacheBehavior": "A complex type that describes the default cache behavior if you don't specify a `CacheBehavior` element or if files don't match any of the values of `PathPattern` in `CacheBehavior` elements\\. You must create exactly one default cache behavior\\. \n*Required*: Yes \n*Type*: [DefaultCacheBehavior](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefaultRootObject": "The object that you want CloudFront to request from your origin \\(for example, `index.html`\\) when a viewer requests the root URL for your distribution \\(`https://www.example.com`\\) instead of an object in your distribution \\(`https://www.example.com/product-description.html`\\)\\. Specifying a default root object avoids exposing the contents of your distribution\\. \nSpecify only the object name, for example, `index.html`\\. Don't add a `/` before the object name\\. \nIf you don't want to specify a default root object when you create a distribution, include an empty `DefaultRootObject` element\\. \nTo delete the default root object from an existing distribution, update the distribution configuration and include an empty `DefaultRootObject` element\\. \nTo replace the default root object, update the distribution configuration and specify the new object\\. \nFor more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "From this field, you can enable or disable the selected distribution\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "HttpVersion": "\\(Optional\\) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront\\. The default value for new web distributions is `http1.1`\\. \nFor viewers and CloudFront to use HTTP/2, viewers must support TLS 1\\.2 or later, and must support server name identification \\(SNI\\)\\. \nIn general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency\\. You can improve performance by optimizing for HTTP/2\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `http1.1 | http2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IPV6Enabled": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify `true`\\. If you specify `false`, CloudFront responds to IPv6 DNS requests with the DNS response code `NOERROR` and with no IP addresses\\. This allows viewers to submit a second request, for an IPv4 address for your distribution\\. \nIn general, you should enable IPv6 if you have users on IPv6 networks who want to access your content\\. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the `IpAddress` parameter to restrict the IP addresses that can access your content, don't enable IPv6\\. If you want to restrict access to some content by IP address and not restrict access to other content \\(or restrict access but not by IP address\\), you can create two distributions\\. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*\\. \nIf you're using an Amazon Route\u00a053 AWS Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: \n+ You enable IPv6 for the distribution\n+ You're using alternate domain names in the URLs for your objects\nFor more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the * Amazon Route\u00a053 AWS Integration Developer Guide*\\. \nIf you created a CNAME resource record set, either with Amazon Route\u00a053 AWS Integration or with another DNS service, you don't need to make any changes\\. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HttpVersion": "\\(Optional\\) Specify the maximum HTTP version\\(s\\) that you want viewers to use to communicate with CloudFront\\. The default value for new distributions is `http1.1`\\. \nFor viewers and CloudFront to use HTTP/2, viewers must support TLSv1\\.2 or later, and must support Server Name Indication \\(SNI\\)\\. \nFor viewers and CloudFront to use HTTP/3, viewers must support TLSv1\\.3 and Server Name Indication \\(SNI\\)\\. CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection\\. For more information about connection migration, see [Connection Migration](https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000\\. For more information about supported TLSv1\\.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `http1.1 | http2 | http2and3 | http3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IPV6Enabled": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify `true`\\. If you specify `false`, CloudFront responds to IPv6 DNS requests with the DNS response code `NOERROR` and with no IP addresses\\. This allows viewers to submit a second request, for an IPv4 address for your distribution\\. \nIn general, you should enable IPv6 if you have users on IPv6 networks who want to access your content\\. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the `IpAddress` parameter to restrict the IP addresses that can access your content, don't enable IPv6\\. If you want to restrict access to some content by IP address and not restrict access to other content \\(or restrict access but not by IP address\\), you can create two distributions\\. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*\\. \nIf you're using an Amazon Route\u00a053 AWS Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: \n+ You enable IPv6 for the distribution\n+ You're using alternate domain names in the URLs for your objects\nFor more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the * Amazon Route\u00a053 AWS Integration Developer Guide*\\. \nIf you created a CNAME resource record set, either with Amazon Route\u00a053 AWS Integration or with another DNS service, you don't need to make any changes\\. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Logging": "A complex type that controls whether access logs are written for the distribution\\. \nFor more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: [Logging](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-logging.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OriginGroups": "A complex type that contains information about origin groups for this distribution\\. \n*Required*: No \n*Type*: [OriginGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origingroups.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Origins": "A complex type that contains information about origins for this distribution\\. \n*Required*: No \n*Type*: List of [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Origins": "A complex type that contains information about origins for this distribution\\. \n*Required*: No \n*Type*: List of [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PriceClass": "The price class that corresponds with the maximum price that you want to pay for CloudFront service\\. If you specify `PriceClass_All`, CloudFront responds to requests for your objects from all CloudFront edge locations\\. \nIf you specify a price class other than `PriceClass_All`, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class\\. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance\\. \nFor more information about price classes, see [Choosing the Price Class for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*\\. For information about CloudFront pricing, including how price classes \\(such as Price Class 100\\) map to CloudFront regions, see [Amazon CloudFront Pricing](http://aws.amazon.com/cloudfront/pricing/)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PriceClass_100 | PriceClass_200 | PriceClass_All` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Restrictions": "A complex type that identifies ways in which you want to restrict distribution of your content\\. \n*Required*: No \n*Type*: [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-restrictions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3Origin": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [LegacyS3Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacys3origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ViewerCertificate": "A complex type that determines the distribution\u2019s SSL/TLS configuration for communicating with viewers\\. \n*Required*: No \n*Type*: [ViewerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "WebACLId": "A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution\\. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example `arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a`\\. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example `473e64fd-f30b-4765-81a0-62ad96dd167a`\\. \n AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content\\. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code \\(Forbidden\\)\\. You can also configure CloudFront to return a custom error page when a request is blocked\\. For more information about AWS WAF, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "S3Origin": "Property description not available\\. \n*Required*: No \n*Type*: [LegacyS3Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacys3origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Staging": "A Boolean that indicates whether this is a staging distribution\\. When this value is `true`, this is a staging distribution\\. When this value is `false`, this is not a staging distribution\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ViewerCertificate": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers\\. \n*Required*: No \n*Type*: [ViewerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WebACLId": "A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution\\. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example `arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a`\\. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example `473e64fd-f30b-4765-81a0-62ad96dd167a`\\. \n AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content\\. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code \\(Forbidden\\)\\. You can also configure CloudFront to return a custom error page when a request is blocked\\. For more information about AWS WAF, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution ForwardedValues": { "Cookies": "This field is deprecated\\. We recommend that you use a cache policy or an origin request policy instead of this field\\. \nIf you want to include cookies in the cache key, use a cache policy\\. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*\\. \nIf you want to send cookies to the origin but not include them in the cache key, use an origin request policy\\. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*\\. \nA complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones\\. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: [Cookies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cookies.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -4053,20 +4464,20 @@ "RestrictionType": "The method that you want to use to restrict distribution of your content by country: \n+ `none`: No geo restriction is enabled, meaning access to content is not restricted by client geo location\\.\n+ `blacklist`: The `Location` elements specify the countries in which you don't want CloudFront to distribute your content\\.\n+ `whitelist`: The `Location` elements specify the countries in which you want CloudFront to distribute your content\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `blacklist | none | whitelist` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution LambdaFunctionAssociation": { - "EventType": "Specifies the event type that triggers a Lambda@Edge function invocation\\. You can specify the following values: \n+ `viewer-request`: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache\\. \n+ `origin-request`: The function executes only when CloudFront sends a request to your origin\\. When the requested object is in the edge cache, the function doesn't execute\\.\n+ `origin-response`: The function executes after CloudFront receives a response from the origin and before it caches the object in the response\\. When the requested object is in the edge cache, the function doesn't execute\\.\n+ `viewer-response`: The function executes before CloudFront returns the requested object to the viewer\\. The function executes regardless of whether the object was already in the edge cache\\.", + "EventType": "Specifies the event type that triggers a Lambda@Edge function invocation\\. You can specify the following values: \n+ `viewer-request`: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache\\.\n+ `origin-request`: The function executes only when CloudFront sends a request to your origin\\. When the requested object is in the edge cache, the function doesn't execute\\.\n+ `origin-response`: The function executes after CloudFront receives a response from the origin and before it caches the object in the response\\. When the requested object is in the edge cache, the function doesn't execute\\.\n+ `viewer-response`: The function executes before CloudFront returns the requested object to the viewer\\. The function executes regardless of whether the object was already in the edge cache\\.", "IncludeBody": "A flag that allows a Lambda@Edge function to have read access to the body content\\. For more information, see [Accessing the Request Body by Choosing the Include Body Option](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) in the Amazon CloudFront Developer Guide\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LambdaFunctionARN": "The ARN of the Lambda@Edge function\\. You must specify the ARN of a function version; you can't specify an alias or $LATEST\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution LegacyCustomOrigin": { - "DNSName": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "HTTPPort": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "HTTPSPort": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OriginProtocolPolicy": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OriginSSLProtocols": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DNSName": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HTTPPort": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HTTPSPort": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OriginProtocolPolicy": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OriginSSLProtocols": "Property description not available\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution LegacyS3Origin": { - "DNSName": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OriginAccessIdentity": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DNSName": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OriginAccessIdentity": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution Logging": { "Bucket": "The Amazon S3 bucket to store the access logs in, for example, `myawslogbucket.s3.amazonaws.com`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -4074,11 +4485,12 @@ "Prefix": "An optional string that you want CloudFront to prefix to the access log `filenames` for this distribution, for example, `myprefix/`\\. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty `Prefix` element in the `Logging` element\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution Origin": { - "ConnectionAttempts": "The number of times that CloudFront attempts to connect to the origin\\. The minimum number is 1, the maximum is 3, and the default \\(if you don\u2019t specify otherwise\\) is 3\\. \nFor a custom origin \\(including an Amazon S3 bucket that\u2019s configured with static website hosting\\), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout)\\. \nFor more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ConnectionTimeout": "The number of seconds that CloudFront waits when trying to establish a connection to the origin\\. The minimum timeout is 1 second, the maximum is 10 seconds, and the default \\(if you don\u2019t specify otherwise\\) is 10 seconds\\. \nFor more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectionAttempts": "The number of times that CloudFront attempts to connect to the origin\\. The minimum number is 1, the maximum is 3, and the default \\(if you don't specify otherwise\\) is 3\\. \nFor a custom origin \\(including an Amazon S3 bucket that's configured with static website hosting\\), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout)\\. \nFor more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectionTimeout": "The number of seconds that CloudFront waits when trying to establish a connection to the origin\\. The minimum timeout is 1 second, the maximum is 10 seconds, and the default \\(if you don't specify otherwise\\) is 10 seconds\\. \nFor more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomOriginConfig": "Use this type to specify an origin that is not an Amazon S3 bucket, with one exception\\. If the Amazon S3 bucket is configured with static website hosting, use this type\\. If the Amazon S3 bucket is not configured with static website hosting, use the `S3OriginConfig` type instead\\. \n*Required*: Conditional \n*Type*: [CustomOriginConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-customoriginconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DomainName": "The domain name for the origin\\. \nFor more information, see [Origin Domain Name](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Id": "A unique identifier for the origin\\. This value must be unique within the distribution\\. \nUse this value to specify the `TargetOriginId` in a `CacheBehavior` or `DefaultCacheBehavior`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OriginAccessControlId": "The unique identifier of an origin access control for this origin\\. \nFor more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OriginCustomHeaders": "A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin\\. \nFor more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of [OriginCustomHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origincustomheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OriginPath": "An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin\\. \nFor more information, see [Origin Path](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OriginShield": "CloudFront Origin Shield\\. Using Origin Shield can help reduce the load on your origin\\. \nFor more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: [OriginShield](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-originshield.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -4108,14 +4520,14 @@ "Quantity": "The number of origin groups\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution OriginShield": { - "Enabled": "A flag that specifies whether Origin Shield is enabled\\. \nWhen it\u2019s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin\\. When it\u2019s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Enabled": "A flag that specifies whether Origin Shield is enabled\\. \nWhen it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin\\. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OriginShieldRegion": "The AWS Region for Origin Shield\\. \nSpecify the AWS Region that has the lowest latency to your origin\\. To specify a region, use the region code, not the region name\\. For example, specify the US East \\(Ohio\\) region as `us-east-2`\\. \nWhen you enable CloudFront Origin Shield, you must specify the AWS Region for Origin Shield\\. For the list of AWS Regions that you can specify, and for help choosing the best Region for your origin, see [Choosing the AWS Region for Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Pattern*: `[a-z]{2}-[a-z]+-\\d` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution Restrictions": { "GeoRestriction": "A complex type that controls the countries in which your content is distributed\\. CloudFront determines the location of your users using `MaxMind` GeoIP databases\\. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template\\. \n*Required*: Yes \n*Type*: [GeoRestriction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-georestriction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution S3OriginConfig": { - "OriginAccessIdentity": "The CloudFront origin access identity to associate with the origin\\. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront\\. The format of the value is: \norigin\\-access\\-identity/cloudfront/*ID\\-of\\-origin\\-access\\-identity* \nwhere ` ID-of-origin-access-identity ` is the value that CloudFront returned in the `ID` element when you created the origin access identity\\. \nIf you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty `OriginAccessIdentity` element\\. \nIf you want to use origin access control rather than origin access identity, specify an empty String for the `OriginAccessIdentity` element\\. \nTo delete the origin access identity from an existing distribution, update the distribution configuration and include an empty `OriginAccessIdentity` element\\. \nTo replace the origin access identity, update the distribution configuration and specify the new origin access identity\\. \nFor more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "OriginAccessIdentity": "The CloudFront origin access identity to associate with the origin\\. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront\\. The format of the value is: \norigin\\-access\\-identity/cloudfront/*ID\\-of\\-origin\\-access\\-identity* \nwhere ` ID-of-origin-access-identity ` is the value that CloudFront returned in the `ID` element when you created the origin access identity\\. \nIf you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty `OriginAccessIdentity` element\\. \nTo delete the origin access identity from an existing distribution, update the distribution configuration and include an empty `OriginAccessIdentity` element\\. \nTo replace the origin access identity, update the distribution configuration and specify the new origin access identity\\. \nFor more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Distribution StatusCodes": { "Items": "The items \\(status codes\\) for an origin group\\. \n*Required*: Yes \n*Type*: List of Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -4125,18 +4537,19 @@ "AcmCertificateArn": "In CloudFormation, this field name is `AcmCertificateArn`\\. Note the different capitalization\\.\nIf the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\) and the SSL/TLS certificate is stored in [AWS Certificate Manager \\(ACM\\)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), provide the Amazon Resource Name \\(ARN\\) of the ACM certificate\\. CloudFront only supports ACM certificates in the US East \\(N\\. Virginia\\) Region \\(`us-east-1`\\)\\. \nIf you specify an ACM certificate ARN, you must also specify values for `MinimumProtocolVersion` and `SSLSupportMethod`\\. \\(In CloudFormation, the field name is `SslSupportMethod`\\. Note the different capitalization\\.\\) \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CloudFrontDefaultCertificate": "If the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net`, set this field to `true`\\. \nIf the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\), set this field to `false` and specify values for the following fields: \n+ `ACMCertificateArn` or `IAMCertificateId` \\(specify a value for one, not both\\)", "IamCertificateId": "In CloudFormation, this field name is `IamCertificateId`\\. Note the different capitalization\\.\nIf the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\) and the SSL/TLS certificate is stored in [AWS Identity and Access Management \\(IAM\\)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), provide the ID of the IAM certificate\\. \nIf you specify an IAM certificate ID, you must also specify values for `MinimumProtocolVersion` and `SSLSupportMethod`\\. \\(In CloudFormation, the field name is `SslSupportMethod`\\. Note the different capitalization\\.\\) \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MinimumProtocolVersion": "If the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\), specify the security policy that you want CloudFront to use for HTTPS connections with viewers\\. The security policy determines two settings: \n+ The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers\\.\n+ The ciphers that CloudFront can use to encrypt the content that it returns to viewers\\.\nFor more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*\\. \nOn the CloudFront console, this setting is called **Security Policy**\\.\nWhen you\u2019re using SNI only \\(you set `SSLSupportMethod` to `sni-only`\\), you must specify `TLSv1` or higher\\. \\(In CloudFormation, the field name is `SslSupportMethod`\\. Note the different capitalization\\.\\) \nIf the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net` \\(you set `CloudFrontDefaultCertificate` to `true`\\), CloudFront automatically sets the security policy to `TLSv1` regardless of the value that you set here\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `SSLv3 | TLSv1 | TLSv1.1_2016 | TLSv1.2_2018 | TLSv1.2_2019 | TLSv1.2_2021 | TLSv1_2016` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SslSupportMethod": "In CloudFormation, this field name is `SslSupportMethod`\\. Note the different capitalization\\.\nIf the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\), specify which viewers the distribution accepts HTTPS connections from\\. \n+ `sni-only` \u2013 The distribution accepts HTTPS connections from only viewers that support [server name indication \\(SNI\\)](https://en.wikipedia.org/wiki/Server_Name_Indication)\\. This is recommended\\. Most browsers and clients support SNI\\.\n+ `vip` \u2013 The distribution accepts HTTPS connections from all viewers including those that don\u2019t support SNI\\. This is not recommended, and results in additional monthly charges from CloudFront\\.\n+ `static-ip` \\- Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team\\. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [AWS Support Center](https://console.aws.amazon.com/support/home)\\.\nIf the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net`, don\u2019t set a value for this field\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `sni-only | static-ip | vip` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "MinimumProtocolVersion": "If the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\), specify the security policy that you want CloudFront to use for HTTPS connections with viewers\\. The security policy determines two settings: \n+ The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers\\.\n+ The ciphers that CloudFront can use to encrypt the content that it returns to viewers\\.\nFor more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*\\. \nOn the CloudFront console, this setting is called **Security Policy**\\.\nWhen you're using SNI only \\(you set `SSLSupportMethod` to `sni-only`\\), you must specify `TLSv1` or higher\\. \\(In CloudFormation, the field name is `SslSupportMethod`\\. Note the different capitalization\\.\\) \nIf the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net` \\(you set `CloudFrontDefaultCertificate` to `true`\\), CloudFront automatically sets the security policy to `TLSv1` regardless of the value that you set here\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `SSLv3 | TLSv1 | TLSv1.1_2016 | TLSv1.2_2018 | TLSv1.2_2019 | TLSv1.2_2021 | TLSv1_2016` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SslSupportMethod": "In CloudFormation, this field name is `SslSupportMethod`\\. Note the different capitalization\\.\nIf the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\), specify which viewers the distribution accepts HTTPS connections from\\. \n+ `sni-only` \u2013 The distribution accepts HTTPS connections from only viewers that support [server name indication \\(SNI\\)](https://en.wikipedia.org/wiki/Server_Name_Indication)\\. This is recommended\\. Most browsers and clients support SNI\\.\n+ `vip` \u2013 The distribution accepts HTTPS connections from all viewers including those that don't support SNI\\. This is not recommended, and results in additional monthly charges from CloudFront\\.\n+ `static-ip` \\- Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team\\. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [AWS Support Center](https://console.aws.amazon.com/support/home)\\.\nIf the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net`, don't set a value for this field\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `sni-only | static-ip | vip` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Function": { "AutoPublish": "A flag that determines whether to automatically publish the function to the `LIVE` stage when it\u2019s created\\. To automatically publish to the `LIVE` stage, set this property to `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FunctionCode": "The function code\\. For more information about writing a CloudFront function, see [Writing function code for CloudFront Functions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FunctionConfig": "Contains configuration information about a CloudFront function\\. \n*Required*: Yes \n*Type*: [FunctionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-function-functionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "A name to identify the function\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9-_]{1,64}$`" + "FunctionMetadata": "Contains metadata about a CloudFront function\\. \n*Required*: No \n*Type*: [FunctionMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-function-functionmetadata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "A name to identify the function\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9-_]{1,64}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Function FunctionConfig": { "Comment": "A comment to describe the function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Runtime": "The function\u2019s runtime environment\\. The only valid value is `cloudfront-js-1.0`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `cloudfront-js-1.0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Runtime": "The function's runtime environment\\. The only valid value is `cloudfront-js-1.0`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `cloudfront-js-1.0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::Function FunctionMetadata": { "FunctionARN": "The Amazon Resource Name \\(ARN\\) of the function\\. The ARN uniquely identifies the function\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -4149,6 +4562,26 @@ "Items": "A list of the identifiers of the public keys in the key group\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A name to identify the key group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::CloudFront::MonitoringSubscription": { + "DistributionId": "The ID of the distribution that you are enabling metrics for\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MonitoringSubscription": "A subscription configuration for additional CloudWatch metrics\\. \n*Required*: Yes \n*Type*: [MonitoringSubscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-monitoringsubscription-monitoringsubscription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudFront::MonitoringSubscription MonitoringSubscription": { + "RealtimeMetricsSubscriptionConfig": "A subscription configuration for additional CloudWatch metrics\\. \n*Required*: No \n*Type*: [RealtimeMetricsSubscriptionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudFront::MonitoringSubscription RealtimeMetricsSubscriptionConfig": { + "RealtimeMetricsSubscriptionStatus": "A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Disabled | Enabled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudFront::OriginAccessControl": { + "OriginAccessControlConfig": "The origin access control\\. \n*Required*: Yes \n*Type*: [OriginAccessControlConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudFront::OriginAccessControl OriginAccessControlConfig": { + "Description": "A description of the origin access control\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "A name to identify the origin access control\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OriginAccessControlOriginType": "The type of origin that this origin access control is for\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `mediastore | s3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SigningBehavior": "Specifies which requests CloudFront signs \\(adds authentication information to\\)\\. Specify `always` for the most common use case\\. For more information, see [origin access control advanced settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings) in the *Amazon CloudFront Developer Guide*\\. \nThis field can have one of the following values: \n+ `always` \u2013 CloudFront signs all origin requests, overwriting the `Authorization` header from the viewer request if one exists\\.\n+ `never` \u2013 CloudFront doesn't sign any origin requests\\. This value turns off origin access control for all origins in all distributions that use this origin access control\\.\n+ `no-override` \u2013 If the viewer request doesn't contain the `Authorization` header, then CloudFront signs the origin request\\. If the viewer request contains the `Authorization` header, then CloudFront doesn't sign the origin request and instead passes along the `Authorization` header from the viewer request\\. **WARNING: To pass along the `Authorization` header from the viewer request, you *must* add the `Authorization` header to a [cache policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html) for all cache behaviors that use origins associated with this origin access control\\.** \n*Required*: Yes \n*Type*: String \n*Allowed values*: `always | never | no-override` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SigningProtocol": "The signing protocol of the origin access control, which determines how CloudFront signs \\(authenticates\\) requests\\. The only valid value is `sigv4`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `sigv4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::CloudFront::OriginRequestPolicy": { "OriginRequestPolicyConfig": "The origin request policy configuration\\. \n*Required*: Yes \n*Type*: [OriginRequestPolicyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originrequestpolicy-originrequestpolicyconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -4175,7 +4608,7 @@ "PublicKeyConfig": "Configuration information about a public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field\\-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html)\\. \n*Required*: Yes \n*Type*: [PublicKeyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-publickey-publickeyconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::PublicKey PublicKeyConfig": { - "CallerReference": "A string included in the request to help make sure that the request can\u2019t be replayed\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CallerReference": "A string included in the request to help make sure that the request can't be replayed\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Comment": "A comment to describe the public key\\. The comment cannot be longer than 128 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EncodedKey": "The public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html), or with [field\\-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A name to help identify the public key\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -4195,7 +4628,7 @@ "StreamArn": "The Amazon Resource Name \\(ARN\\) of the Kinesis data stream where you are sending real\\-time log data\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::ResponseHeadersPolicy": { - "ResponseHeadersPolicyConfig": "A response headers policy configuration\\. \nA response headers policy contains information about a set of HTTP response headers and their values\\. CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match a cache behavior that\u2019s associated with the policy\\. \n*Required*: Yes \n*Type*: [ResponseHeadersPolicyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ResponseHeadersPolicyConfig": "A response headers policy configuration\\. \n*Required*: Yes \n*Type*: [ResponseHeadersPolicyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::ResponseHeadersPolicy AccessControlAllowHeaders": { "Items": "The list of HTTP header names\\. You can specify `*` to allow all headers\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -4234,27 +4667,39 @@ "Items": "The list of HTTP response headers and their values\\. \n*Required*: Yes \n*Type*: List of [CustomHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-customheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::ResponseHeadersPolicy FrameOptions": { - "FrameOption": "The value of the `X-Frame-Options` HTTP response header\\. Valid values are `DENY` and `SAMEORIGIN`\\. \nFor more information about these values, see [X\\-Frame\\-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DENY | SAMEORIGIN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FrameOption": "The value of the `X-Frame-Options` HTTP response header\\. Valid values are `DENY` and `SAMEORIGIN`\\. \nFor more information about these values, see [X\\-Frame\\-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DENY | SAMEORIGIN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Override": "A Boolean that determines whether CloudFront overrides the `X-Frame-Options` HTTP response header received from the origin with the one specified in this response headers policy\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::ResponseHeadersPolicy ReferrerPolicy": { "Override": "A Boolean that determines whether CloudFront overrides the `Referrer-Policy` HTTP response header received from the origin with the one specified in this response headers policy\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ReferrerPolicy": "The value of the `Referrer-Policy` HTTP response header\\. Valid values are: \n+ `no-referrer` \n+ `no-referrer-when-downgrade` \n+ `origin` \n+ `origin-when-cross-origin` \n+ `same-origin` \n+ `strict-origin` \n+ `strict-origin-when-cross-origin` \n+ `unsafe-url` \nFor more information about these values, see [Referrer\\-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs\\. \n*Required*: Yes \n*Type*: [String](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-cloudfront-responseheaderspolicy-referrerpolicy.html#aws-properties-cloudfront-responseheaderspolicy-referrerpolicy) \n*Allowed values*: `no-referrer | no-referrer-when-downgrade | origin | origin-when-cross-origin | same-origin | strict-origin | strict-origin-when-cross-origin | unsafe-url` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::CloudFront::ResponseHeadersPolicy RemoveHeader": { + "Header": "The HTTP header name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudFront::ResponseHeadersPolicy RemoveHeadersConfig": { + "Items": "The list of HTTP header names\\. \n*Required*: Yes \n*Type*: List of [RemoveHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-removeheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::CloudFront::ResponseHeadersPolicy ResponseHeadersPolicyConfig": { "Comment": "A comment to describe the response headers policy\\. \nThe comment cannot be longer than 128 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CorsConfig": "A configuration for a set of HTTP response headers that are used for cross\\-origin resource sharing \\(CORS\\)\\. \n*Required*: No \n*Type*: [CorsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-corsconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomHeadersConfig": "A configuration for a set of custom HTTP response headers\\. \n*Required*: No \n*Type*: [CustomHeadersConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-customheadersconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A name to identify the response headers policy\\. \nThe name must be unique for response headers policies in this AWS account\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecurityHeadersConfig": "A configuration for a set of security\\-related HTTP response headers\\. \n*Required*: No \n*Type*: [SecurityHeadersConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "RemoveHeadersConfig": "A configuration for a set of HTTP headers to remove from the HTTP response\\. \n*Required*: No \n*Type*: [RemoveHeadersConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-removeheadersconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecurityHeadersConfig": "A configuration for a set of security\\-related HTTP response headers\\. \n*Required*: No \n*Type*: [SecurityHeadersConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-securityheadersconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerTimingHeadersConfig": "A configuration for enabling the `Server-Timing` header in HTTP responses sent from CloudFront\\. \n*Required*: No \n*Type*: [ServerTimingHeadersConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::ResponseHeadersPolicy SecurityHeadersConfig": { "ContentSecurityPolicy": "The policy directives and their values that CloudFront includes as values for the `Content-Security-Policy` HTTP response header\\. \nFor more information about the `Content-Security-Policy` HTTP response header, see [Content\\-Security\\-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [ContentSecurityPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-contentsecuritypolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ContentTypeOptions": "Determines whether CloudFront includes the `X-Content-Type-Options` HTTP response header with its value set to `nosniff`\\. \nFor more information about the `X-Content-Type-Options` HTTP response header, see [X\\-Content\\-Type\\-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [ContentTypeOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-contenttypeoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FrameOptions": "Determines whether CloudFront includes the `X-Frame-Options` HTTP response header and the header\u2019s value\\. \nFor more information about the `X-Frame-Options` HTTP response header, see [X\\-Frame\\-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [FrameOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-frameoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ReferrerPolicy": "Determines whether CloudFront includes the `Referrer-Policy` HTTP response header and the header\u2019s value\\. \nFor more information about the `Referrer-Policy` HTTP response header, see [Referrer\\-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [ReferrerPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-referrerpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StrictTransportSecurity": "Determines whether CloudFront includes the `Strict-Transport-Security` HTTP response header and the header\u2019s value\\. \nFor more information about the `Strict-Transport-Security` HTTP response header, see [Strict\\-Transport\\-Security](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [StrictTransportSecurity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "XSSProtection": "Determines whether CloudFront includes the `X-XSS-Protection` HTTP response header and the header\u2019s value\\. \nFor more information about the `X-XSS-Protection` HTTP response header, see [X\\-XSS\\-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [XSSProtection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-xssprotection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "FrameOptions": "Determines whether CloudFront includes the `X-Frame-Options` HTTP response header and the header's value\\. \nFor more information about the `X-Frame-Options` HTTP response header, see [X\\-Frame\\-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [FrameOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-frameoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReferrerPolicy": "Determines whether CloudFront includes the `Referrer-Policy` HTTP response header and the header's value\\. \nFor more information about the `Referrer-Policy` HTTP response header, see [Referrer\\-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [ReferrerPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-referrerpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StrictTransportSecurity": "Determines whether CloudFront includes the `Strict-Transport-Security` HTTP response header and the header's value\\. \nFor more information about the `Strict-Transport-Security` HTTP response header, see [Strict\\-Transport\\-Security](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [StrictTransportSecurity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "XSSProtection": "Determines whether CloudFront includes the `X-XSS-Protection` HTTP response header and the header's value\\. \nFor more information about the `X-XSS-Protection` HTTP response header, see [X\\-XSS\\-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [XSSProtection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-xssprotection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudFront::ResponseHeadersPolicy ServerTimingHeadersConfig": { + "Enabled": "A Boolean that determines whether CloudFront adds the `Server-Timing` header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SamplingRate": "A number 0\u2013100 \\(inclusive\\) that specifies the percentage of responses that you want CloudFront to add the `Server-Timing` header to\\. When you set the sampling rate to 100, CloudFront adds the `Server-Timing` header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to\\. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior\\. You can set the sampling rate to any number 0\u2013100 with up to four decimal places\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::ResponseHeadersPolicy StrictTransportSecurity": { "AccessControlMaxAgeSec": "A number that CloudFront uses as the value for the `max-age` directive in the `Strict-Transport-Security` HTTP response header\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -4274,36 +4719,78 @@ }, "AWS::CloudFront::StreamingDistribution Logging": { "Bucket": "The Amazon S3 bucket to store the access logs in, for example, `myawslogbucket.s3.amazonaws.com`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Enabled": "Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket\\. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify `false` for `Enabled`, and specify `empty Bucket` and `Prefix` elements\\. If you specify `false` for `Enabled` but you specify values for `Bucket` and `Prefix`, the values are automatically deleted\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Enabled": "Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket\\. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify `false` for `Enabled`, and specify `empty Bucket` and `Prefix` elements\\. If you specify `false` for `Enabled` but you specify values for `Bucket` and `Prefix`, the values are automatically deleted\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Prefix": "An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, `myprefix/`\\. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty `Prefix` element in the `Logging` element\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::StreamingDistribution S3Origin": { - "DomainName": "The DNS name of the Amazon S3 origin\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DomainName": "The DNS name of the Amazon S3 origin\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OriginAccessIdentity": "The CloudFront origin access identity to associate with the distribution\\. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront\\. \nIf you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty `OriginAccessIdentity` element\\. \nTo delete the origin access identity from an existing distribution, update the distribution configuration and include an empty `OriginAccessIdentity` element\\. \nTo replace the origin access identity, update the distribution configuration and specify the new origin access identity\\. \nFor more information, see [Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the * Amazon CloudFront Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::StreamingDistribution StreamingDistributionConfig": { - "Aliases": "A complex type that contains information about CNAMEs \\(alternate domain names\\), if any, for this streaming distribution\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Comment": "Any comments you want to include about the streaming distribution\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Aliases": "A complex type that contains information about CNAMEs \\(alternate domain names\\), if any, for this streaming distribution\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Comment": "Any comments you want to include about the streaming distribution\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "Whether the streaming distribution is enabled to accept user requests for content\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Logging": "A complex type that controls whether access logs are written for the streaming distribution\\. \n*Required*: No \n*Type*: [Logging](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PriceClass": "A complex type that contains information about price class for this streaming distribution\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PriceClass_100 | PriceClass_200 | PriceClass_All` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3Origin": "A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution\\. \n*Required*: Yes \n*Type*: [S3Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TrustedSigners": "A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content\\. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element\\. For more information, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: Yes \n*Type*: [TrustedSigners](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Logging": "A complex type that controls whether access logs are written for the streaming distribution\\. \n*Required*: No \n*Type*: [Logging](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PriceClass": "A complex type that contains information about price class for this streaming distribution\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PriceClass_100 | PriceClass_200 | PriceClass_All` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3Origin": "A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution\\. \n*Required*: Yes \n*Type*: [S3Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TrustedSigners": "A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content\\. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element\\. For more information, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: Yes \n*Type*: [TrustedSigners](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudFront::StreamingDistribution TrustedSigners": { "AwsAccountNumbers": "An AWS account number that contains active CloudFront key pairs that CloudFront can use to verify the signatures of signed URLs and signed cookies\\. If the AWS account that owns the key pairs is the same account that owns the CloudFront distribution, the value of this field is `self`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "This field is `true` if any of the AWS accounts have public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies\\. If not, this field is `false`\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::CloudTrail::Channel": { + "Channel": "Contains information about a returned CloudTrail channel\\. \n*Required*: No \n*Type*: [String](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-channel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Destinations": "One or more event data stores to which events arriving through a channel will be logged\\. \n*Required*: No \n*Type*: List of [Destination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the channel\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9._\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Source": "The name of the partner or external event source\\. You cannot change this name after you create the channel\\. A maximum of one channel is allowed per source\\. \n A source can be either `Custom` for all valid non\\-AWS events, or the name of a partner event source\\. For information about the source names for available partners, see [Additional information about integration partners](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-integration.html#cloudtrail-lake-partner-information) in the CloudTrail User Guide\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "A list of tags\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudTrail::Channel Channel": { + "ChannelArn": "The Amazon Resource Name \\(ARN\\) of a channel\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._/\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the CloudTrail channel\\. For service\\-linked channels, the name is `aws-service-channel/service-name/custom-suffix` where `service-name` represents the name of the AWS service that created the channel and `custom-suffix` represents the suffix created by the AWS service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9._\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudTrail::Channel Destination": { + "Location": "For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel\\. For service\\-linked channels, the location is the name of the AWS service\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `1024` \n*Pattern*: `^[a-zA-Z0-9._/\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of destination for events arriving from a channel\\. For channels used for a CloudTrail Lake integration, the value is `EventDataStore`\\. For service\\-linked channels, the value is `AWS_SERVICE`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AWS_SERVICE | EVENT_DATA_STORE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudTrail::EventDataStore": { + "AdvancedEventSelectors": "The advanced event selectors to use to select the events for the data store\\. You can configure up to five advanced event selectors for each event data store\\. \n For more information about how to use advanced event selectors to log CloudTrail events, see [Log events by using advanced event selectors](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced) in the CloudTrail User Guide\\. \nFor more information about how to use advanced event selectors to include AWS Config configuration items in your event data store, see [Create an event data store for AWS Config configuration items](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-eds-config) in the CloudTrail User Guide\\. \nFor more information about how to use advanced event selectors to include non\\-AWS events in your event data store, see [Create an integration to log events from outside AWS](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-integration) in the CloudTrail User Guide\\. \n*Required*: No \n*Type*: List of [AdvancedEventSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsKeyId": "Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail\\. The value can be an alias name prefixed by `alias/`, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier\\. \nDisabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key\\. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed\\. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store\\.\nCloudTrail also supports AWS KMS multi\\-Region keys\\. For more information about multi\\-Region keys, see [Using multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the * AWS Key Management Service Developer Guide*\\. \nExamples: \n+ `alias/MyAliasName` \n+ `arn:aws:kms:us-east-2:123456789012:alias/MyAliasName` \n+ `arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012` \n+ `12345678-1234-1234-1234-123456789012` \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `350` \n*Pattern*: `^[a-zA-Z0-9._/\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MultiRegionEnabled": "Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the event data store\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9._\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OrganizationEnabled": "Specifies whether an event data store collects events logged for an organization in AWS Organizations\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RetentionPeriod": "The retention period of the event data store, in days\\. You can set a retention period of up to 2557 days, the equivalent of seven years\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `7` \n*Maximum*: `2557` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "A list of tags\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TerminationProtectionEnabled": "Specifies whether termination protection is enabled for the event data store\\. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudTrail::EventDataStore AdvancedEventSelector": { + "FieldSelectors": "Contains all selector statements in an advanced event selector\\. \n*Required*: Yes \n*Type*: List of [AdvancedFieldSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\"\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1000` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudTrail::EventDataStore AdvancedFieldSelector": { + "EndsWith": "An operator that includes events that match the last few characters of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Equals": "An operator that includes events that match the exact value of the event record field specified as the value of `Field`\\. This is the only valid operator that you can use with the `readOnly`, `eventCategory`, and `resources.type` fields\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Field": "A field in a CloudTrail event record on which to filter events to be logged\\. For event data stores for AWS Config configuration items, Audit Manager evidence, or non\\-AWS events, the field is used only for selecting events as filtering is not supported\\. \n For CloudTrail event records, supported fields include `readOnly`, `eventCategory`, `eventSource` \\(for management events\\), `eventName`, `resources.type`, and `resources.ARN`\\. \n For event data stores for AWS Config configuration items, Audit Manager evidence, or non\\-AWS events, the only supported field is `eventCategory`\\. \n+ ** `readOnly` ** \\- Optional\\. Can be set to `Equals` a value of `true` or `false`\\. If you do not add this field, CloudTrail logs both `read` and `write` events\\. A value of `true` logs only `read` events\\. A value of `false` logs only `write` events\\.\n+ ** `eventSource` ** \\- For filtering management events only\\. This can be set only to `NotEquals` `kms.amazonaws.com`\\.\n+ ** `eventName` ** \\- Can use any operator\\. You can use it to \ufb01lter in or \ufb01lter out any data event logged to CloudTrail, such as `PutBucket` or `GetSnapshotBlock`\\. You can have multiple values for this \ufb01eld, separated by commas\\.\n+ ** `eventCategory` ** \\- This is required and must be set to `Equals`\\. \n + For CloudTrail event records, the value must be `Management` or `Data`\\. \n + For AWS Config configuration items, the value must be `ConfigurationItem`\\. \n + For Audit Manager evidence, the value must be `Evidence`\\. \n + For non\\-AWS events, the value must be `ActivityAuditLog`\\. \n+ ** `resources.type` ** \\- This \ufb01eld is required for CloudTrail data events\\. `resources.type` can only use the `Equals` operator, and the value can be one of the following:\n + `AWS::DynamoDB::Table` \n + `AWS::Lambda::Function` \n + `AWS::S3::Object` \n + `AWS::CloudTrail::Channel` \n + `AWS::Cognito::IdentityPool` \n + `AWS::DynamoDB::Stream` \n + `AWS::EC2::Snapshot` \n + `AWS::FinSpace::Environment` \n + `AWS::Glue::Table` \n + `AWS::KendraRanking::ExecutionPlan` \n + `AWS::ManagedBlockchain::Node` \n + `AWS::SageMaker::ExperimentTrialComponent` \n + `AWS::SageMaker::FeatureGroup` \n + `AWS::S3::AccessPoint` \n + `AWS::S3ObjectLambda::AccessPoint` \n + `AWS::S3Outposts::Object`", + "NotEndsWith": "An operator that excludes events that match the last few characters of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NotEquals": "An operator that excludes events that match the exact value of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NotStartsWith": "An operator that excludes events that match the first few characters of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartsWith": "An operator that includes events that match the first few characters of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudTrail::ResourcePolicy": { + "ResourceArn": "The Amazon Resource Name \\(ARN\\) of the CloudTrail channel attached to the resource\\-based policy\\. The following is the format of a resource ARN: `arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._/\\-:]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ResourcePolicy": "A JSON\\-formatted string for an AWS resource\\-based policy\\. \nThe following are requirements for the resource policy: \n+ Contains only one action: cloudtrail\\-data:PutAuditEvents \n+ Contains at least one statement\\. The policy can have a maximum of 20 statements\\. \n+ Each statement contains at least one principal\\. A statement can have a maximum of 50 principals\\. \n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::CloudTrail::Trail": { - "CloudWatchLogsLogGroupArn": "Specifies a log group name using an Amazon Resource Name \\(ARN\\), a unique identifier that represents the log group to which CloudTrail logs are delivered\\. Not required unless you specify `CloudWatchLogsRoleArn`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CloudWatchLogsRoleArn": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CloudWatchLogsLogGroupArn": "Specifies a log group name using an Amazon Resource Name \\(ARN\\), a unique identifier that represents the log group to which CloudTrail logs are delivered\\. You must use a log group that exists in your account\\. \nNot required unless you specify `CloudWatchLogsRoleArn`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CloudWatchLogsRoleArn": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group\\. You must use a role that exists in your account\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnableLogFileValidation": "Specifies whether log file validation is enabled\\. The default is false\\. \nWhen you disable log file integrity validation, the chain of digest files is broken after one hour\\. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled\\. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re\\-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10\\. The same applies whenever you stop CloudTrail logging or delete a trail\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EventSelectors": "Use event selectors to further specify the management and data event settings for your trail\\. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events\\. When an event occurs in your account, CloudTrail evaluates the event selector for all trails\\. For each trail, if the event matches any event selector, the trail processes and logs the event\\. If the event doesn't match any event selector, the trail doesn't log the event\\. \nYou can configure up to five event selectors for a trail\\. \nYou cannot apply both event selectors and advanced event selectors to a trail\\. \n*Required*: No \n*Type*: List of [EventSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventSelectors": "Use event selectors to further specify the management and data event settings for your trail\\. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events\\. When an event occurs in your account, CloudTrail evaluates the event selector for all trails\\. For each trail, if the event matches any event selector, the trail processes and logs the event\\. If the event doesn't match any event selector, the trail doesn't log the event\\. \nYou can configure up to five event selectors for a trail\\. \n*Required*: No \n*Type*: List of [EventSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeGlobalServiceEvents": "Specifies whether the trail is publishing events from global services such as IAM to the log files\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InsightSelectors": "Specifies whether a trail has insight types specified in an `InsightSelector` list\\. \n*Required*: No \n*Type*: List of [InsightSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-insightselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InsightSelectors": "A JSON string that contains the insight types you want to log on a trail\\. `ApiCallRateInsight` and `ApiErrorRateInsight` are valid insight types\\. \n*Required*: No \n*Type*: List of [InsightSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-insightselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IsLogging": "Whether the CloudTrail trail is currently logging AWS API calls\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IsMultiRegionTrail": "Specifies whether the trail applies only to the current region or to all regions\\. The default is false\\. If the trail exists only in the current region and this value is set to true, shadow trails \\(replications of the trail\\) will be created in the other regions\\. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted\\. As a best practice, consider using trails that log events in all regions\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IsOrganizationTrail": "Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account\\. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the management account for an organization in AWS Organizations\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsOrganizationTrail": "Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account\\. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the management account or delegated administrator account for an organization in AWS Organizations\\. If the trail is not an organization trail and this is set to `true`, the trail will be created in all AWS accounts that belong to the organization\\. If the trail is an organization trail and this is set to `false`, the trail will remain in the current AWS account but be deleted from all member accounts in the organization\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KMSKeyId": "Specifies the AWS KMS key ID to use to encrypt the logs delivered by CloudTrail\\. The value can be an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier\\. \nCloudTrail also supports AWS KMS multi\\-Region keys\\. For more information about multi\\-Region keys, see [Using multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the * AWS Key Management Service Developer Guide*\\. \nExamples: \n+ alias/MyAliasName\n+ arn:aws:kms:us\\-east\\-2:123456789012:alias/MyAliasName\n+ arn:aws:kms:us\\-east\\-2:123456789012:key/12345678\\-1234\\-1234\\-1234\\-123456789012\n+ 12345678\\-1234\\-1234\\-1234\\-123456789012\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3BucketName": "Specifies the name of the Amazon S3 bucket designated for publishing log files\\. See [Amazon S3 Bucket Naming Requirements](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3KeyPrefix": "Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery\\. For more information, see [Finding Your CloudTrail Log Files](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html)\\. The maximum length is 200 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -4312,13 +4799,13 @@ "TrailName": "Specifies the name of the trail\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), periods \\(\\.\\), underscores \\(\\_\\), or dashes \\(\\-\\)\n+ Start with a letter or number, and end with a letter or number\n+ Be between 3 and 128 characters\n+ Have no adjacent periods, underscores or dashes\\. Names like `my-_namespace` and `my--namespace` are not valid\\.\n+ Not be in IP address format \\(for example, 192\\.168\\.5\\.4\\)\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CloudTrail::Trail DataResource": { - "Type": "The resource type in which you want to log data events\\. You can specify the following *basic* event selector resource types: \n+ `AWS::S3::Object` \n+ `AWS::Lambda::Function` \n+ `AWS::DynamoDB::Table` \nThe following resource types are also availble through *advanced* event selectors\\. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors\\. For more information, see [AdvancedFieldSelector:Field](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedFieldSelector.html#awscloudtrail-Type-AdvancedFieldSelector-Field)\\. \n+ `AWS::S3Outposts::Object` \n+ `AWS::ManagedBlockchain::Node` \n+ `AWS::S3ObjectLambda::AccessPoint` \n+ `AWS::EC2::Snapshot` \n+ `AWS::S3::AccessPoint` \n+ `AWS::DynamoDB::Stream` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Values": "An array of Amazon Resource Name \\(ARN\\) strings or partial ARN strings for the specified objects\\. \n+ To log data events for all objects in all S3 buckets in your AWS account, specify the prefix as `arn:aws:s3:::`\\.\n**Note** \nThis also enables logging of data event activity performed by any user or role in your AWS account, even if that activity is performed on a bucket that belongs to another AWS account\\.\n+ To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as `arn:aws:s3:::bucket-1/`\\. The trail logs data events for all objects in this S3 bucket\\.\n+ To log data events for specific objects, specify the S3 bucket and object prefix such as `arn:aws:s3:::bucket-1/example-images`\\. The trail logs data events for objects in this S3 bucket that match the prefix\\.\n+ To log data events for all Lambda functions in your AWS account, specify the prefix as `arn:aws:lambda`\\.\n**Note** \nThis also enables logging of `Invoke` activity performed by any user or role in your AWS account, even if that activity is performed on a function that belongs to another AWS account\\. \n+ To log data events for a specific Lambda function, specify the function ARN\\.\n**Note** \nLambda function ARNs are exact\\. For example, if you specify a function ARN *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld*, data events will only be logged for *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld*\\. They will not be logged for *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld2*\\.\n+ To log data events for all DynamoDB tables in your AWS account, specify the prefix as `arn:aws:dynamodb`\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Type": "The resource type in which you want to log data events\\. You can specify the following *basic* event selector resource types: \n+ `AWS::S3::Object` \n+ `AWS::Lambda::Function` \n+ `AWS::DynamoDB::Table` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Values": "An array of Amazon Resource Name \\(ARN\\) strings or partial ARN strings for the specified objects\\. \n+ To log data events for all objects in all S3 buckets in your AWS account, specify the prefix as `arn:aws:s3`\\.\n**Note** \nThis also enables logging of data event activity performed by any user or role in your AWS account, even if that activity is performed on a bucket that belongs to another AWS account\\.\n+ To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as `arn:aws:s3:::bucket-1/`\\. The trail logs data events for all objects in this S3 bucket\\. \n+ To log data events for specific objects, specify the S3 bucket and object prefix such as `arn:aws:s3:::bucket-1/example-images`\\. The trail logs data events for objects in this S3 bucket that match the prefix\\.\n+ To log data events for all Lambda functions in your AWS account, specify the prefix as `arn:aws:lambda`\\.\n**Note** \nThis also enables logging of `Invoke` activity performed by any user or role in your AWS account, even if that activity is performed on a function that belongs to another AWS account\\. \n+ To log data events for a specific Lambda function, specify the function ARN\\.\n**Note** \nLambda function ARNs are exact\\. For example, if you specify a function ARN *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld*, data events will only be logged for *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld*\\. They will not be logged for *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld2*\\.\n+ To log data events for all DynamoDB tables in your AWS account, specify the prefix as `arn:aws:dynamodb`\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudTrail::Trail EventSelector": { - "DataResources": "CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions\\. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail\\. This limit does not apply if you configure resource logging for all data events\\. \nFor more information, see [Data Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-data-events) and [Limits in AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) in the *AWS CloudTrail User Guide*\\. \n*Required*: Conditional \n*Type*: List of [DataResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataResources": "In AWS CloudFormation, CloudTrail supports data event logging for Amazon S3 objects, Amazon DynamoDB tables, and AWS Lambda functions\\. Currently, advanced event selectors for data events are not supported in AWS CloudFormation templates\\. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail\\. This limit does not apply if you configure resource logging for all data events\\. \nFor more information, see [Logging data events for trails](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) and [Limits in AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) in the *AWS CloudTrail User Guide*\\. \n*Required*: Conditional \n*Type*: List of [DataResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExcludeManagementEventSources": "An optional list of service event sources from which you do not want management events to be logged on your trail\\. In this release, the list can be empty \\(disables the filter\\), or it can filter out AWS Key Management Service or Amazon RDS Data API events by containing `kms.amazonaws.com` or `rdsdata.amazonaws.com`\\. By default, `ExcludeManagementEventSources` is empty, and AWS KMS and Amazon RDS Data API events are logged to your trail\\. You can exclude management event sources only in regions that support the event source\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IncludeManagementEvents": "Specify if you want your event selector to include management events for your trail\\. \n For more information, see [Management Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-management-events) in the * AWS CloudTrail User Guide*\\. \nBy default, the value is `true`\\. \nThe first copy of management events is free\\. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region\\. For more information about CloudTrail pricing, see [AWS CloudTrail Pricing](http://aws.amazon.com/cloudtrail/pricing/)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeManagementEvents": "Specify if you want your event selector to include management events for your trail\\. \n For more information, see [Management Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) in the * AWS CloudTrail User Guide*\\. \nBy default, the value is `true`\\. \nThe first copy of management events is free\\. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region\\. For more information about CloudTrail pricing, see [AWS CloudTrail Pricing](http://aws.amazon.com/cloudtrail/pricing/)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ReadWriteType": "Specify if you want your trail to log read\\-only events, write\\-only events, or all\\. For example, the EC2 `GetConsoleOutput` is a read\\-only API operation and `RunInstances` is a write\\-only API operation\\. \n By default, the value is `All`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `All | ReadOnly | WriteOnly` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudTrail::Trail InsightSelector": { @@ -4331,10 +4818,10 @@ "AlarmName": "The name of the alarm\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ComparisonOperator": "The arithmetic operation to use when comparing the specified statistic and threshold\\. The specified statistic value is used as the first operand\\. \nYou can specify the following values: `GreaterThanThreshold`, `GreaterThanOrEqualToThreshold`, `LessThanThreshold`, or `LessThanOrEqualToThreshold`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `GreaterThanOrEqualToThreshold | GreaterThanThreshold | GreaterThanUpperThreshold | LessThanLowerOrGreaterThanUpperThreshold | LessThanLowerThreshold | LessThanOrEqualToThreshold | LessThanThreshold` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DatapointsToAlarm": "The number of datapoints that must be breaching to trigger the alarm\\. This is used only if you are setting an \"M out of N\" alarm\\. In that case, this value is the M, and the value that you set for `EvaluationPeriods` is the N value\\. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *Amazon CloudWatch User Guide*\\. \nIf you omit this parameter, CloudWatch uses the same value here that you set for `EvaluationPeriods`, and the alarm goes to alarm state if that many consecutive periods are breaching\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Dimensions": "The dimensions for the metric associated with the alarm\\. For an alarm based on a math expression, you can't specify `Dimensions`\\. Instead, you use `Metrics`\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Dimensions": "The dimensions for the metric associated with the alarm\\. For an alarm based on a math expression, you can't specify `Dimensions`\\. Instead, you use `Metrics`\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html) \n*Maximum*: `30` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EvaluateLowSampleCountPercentile": "Used only for alarms based on percentiles\\. If `ignore`, the alarm state does not change during periods with too few data points to be statistically significant\\. If `evaluate` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EvaluationPeriods": "The number of periods over which data is compared to the specified threshold\\. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number\\. If you are setting an \"M out of N\" alarm, this value is the N, and `DatapointsToAlarm` is the M\\. \nFor more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *Amazon CloudWatch User Guide*\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ExtendedStatistic": "The percentile statistic for the metric associated with the alarm\\. Specify a value between p0\\.0 and p100\\. \nFor an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both\\. \nFor an alarm based on a math expression, you can't specify `ExtendedStatistic`\\. Instead, you use `Metrics`\\. \n*Required*: No \n*Type*: String \n*Pattern*: `p(\\d{1,2}(\\.\\d{0,2})?|100)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExtendedStatistic": "The percentile statistic for the metric associated with the alarm\\. Specify a value between p0\\.0 and p100\\. \nFor an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both\\. \nFor an alarm based on a math expression, you can't specify `ExtendedStatistic`\\. Instead, you use `Metrics`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InsufficientDataActions": "The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state\\. Each action is specified as an Amazon Resource Name \\(ARN\\)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MetricName": "The name of the metric associated with the alarm\\. This is required for an alarm based on a metric\\. For an alarm based on a math expression, you use `Metrics` instead and you can't specify `MetricName`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Metrics": "An array that enables you to create an alarm based on the result of a metric math expression\\. Each item in the array either retrieves a metric or performs a math expression\\. \nIf you specify the `Metrics` parameter, you cannot specify `MetricName`, `Dimensions`, `Period`, `Namespace`, `Statistic`, `ExtendedStatistic`, or `Unit`\\. \n*Required*: No \n*Type*: List of [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -4349,16 +4836,16 @@ }, "AWS::CloudWatch::Alarm Dimension": { "Name": "The name of the dimension, from 1\u2013255 characters in length\\. This dimension name must have been included when the metric was published\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Value": "The value for the dimension, from 1\u2013255 characters in length\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Value": "The value for the dimension, from 1\u2013255 characters in length\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudWatch::Alarm Metric": { - "Dimensions": "The metric dimensions that you want to be used for the metric that the alarm will watch\\.\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Dimensions": "The metric dimensions that you want to be used for the metric that the alarm will watch\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html) \n*Maximum*: `30` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MetricName": "The name of the metric that you want the alarm to watch\\. This is a required field\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Namespace": "The namespace of the metric that the alarm will watch\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[^:].*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudWatch::Alarm MetricDataQuery": { "AccountId": "The ID of the account where the metrics are located, if this is a cross\\-account alarm\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Expression": "The math expression to be performed on the returned data, if this object is performing a math expression\\. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions\\. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*\\. \nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Expression": "The math expression to be performed on the returned data, if this object is performing a math expression\\. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions\\. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*\\. \nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Id": "A short name used to tie this object to the results in the response\\. This name must be unique within a single call to `GetMetricData`\\. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression\\. The valid characters are letters, numbers, and underscore\\. The first character must be a lowercase letter\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Label": "A human\\-readable label for this metric or expression\\. This is especially useful if this is an expression, so that you know what the value represents\\. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown\\. If `Label` is omitted, CloudWatch generates a default\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MetricStat": "The metric to be returned, along with statistics, period, and units\\. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data\\. \nWithin one MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -4386,24 +4873,24 @@ }, "AWS::CloudWatch::AnomalyDetector Dimension": { "Name": "The name of the dimension\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Value": "The value of the dimension\\. Dimension values must contain only ASCII characters and must include at least one non\\-whitespace character\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Value": "The value of the dimension\\. Dimension values must contain only ASCII characters and must include at least one non\\-whitespace character\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CloudWatch::AnomalyDetector Metric": { - "Dimensions": "The dimensions for the metric\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html) \n*Maximum*: `10` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Dimensions": "The dimensions for the metric\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html) \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "MetricName": "The name of the metric\\. This is a required field\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Namespace": "The namespace of the metric\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[^:].*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CloudWatch::AnomalyDetector MetricDataQuery": { - "AccountId": "The ID of the account where the metrics are located, if this is a cross\\-account alarm\\. \nUse this field only for `PutMetricAlarm` operations\\. It is not used in `GetMetricData` operations\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Expression": "This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data\\. For more information about Metrics Insights queries, see [Metrics Insights query components and syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage) in the *Amazon CloudWatch User Guide*\\. \nA math expression can use the `Id` of the other metrics or queries to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions\\. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*\\. \nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AccountId": "The ID of the account where the metrics are located\\. \nIf you are performing a `GetMetricData` operation in a monitoring account, use this to specify which account to retrieve this metric from\\. \nIf you are performing a `PutMetricAlarm` operation, use this to specify which account contains the metric that the alarm is watching\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Expression": "This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data\\. For more information about Metrics Insights queries, see [Metrics Insights query components and syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage) in the *Amazon CloudWatch User Guide*\\. \nA math expression can use the `Id` of the other metrics or queries to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions\\. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*\\. \nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Id": "A short name used to tie this object to the results in the response\\. This name must be unique within a single call to `GetMetricData`\\. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression\\. The valid characters are letters, numbers, and underscore\\. The first character must be a lowercase letter\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Label": "A human\\-readable label for this metric or expression\\. This is especially useful if this is an expression, so that you know what the value represents\\. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown\\. If Label is omitted, CloudWatch generates a default\\. \nYou can put dynamic expressions into a label, so that it is more descriptive\\. For more information, see [Using Dynamic Labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MetricStat": "The metric to be returned, along with statistics, period, and units\\. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data\\. \nWithin one MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricstat.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Period": "The granularity, in seconds, of the returned data points\\. For metrics with regular resolution, a period can be as short as one minute \\(60 seconds\\) and must be a multiple of 60\\. For high\\-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60\\. High\\-resolution metrics are those metrics stored by a `PutMetricData` operation that includes a `StorageResolution of 1 second`\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ReturnData": "When used in `GetMetricData`, this option indicates whether to return the timestamps and raw data values of this metric\\. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify `False`\\. If you omit this, the default of `True` is used\\. \nWhen used in `PutMetricAlarm`, specify `True` for the one expression result to use as the alarm\\. For all other metrics and expressions in the same `PutMetricAlarm` operation, specify `ReturnData` as False\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ReturnData": "When used in `GetMetricData`, this option indicates whether to return the timestamps and raw data values of this metric\\. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify `false`\\. If you omit this, the default of `true` is used\\. \nWhen used in `PutMetricAlarm`, specify `true` for the one expression result to use as the alarm\\. For all other metrics and expressions in the same `PutMetricAlarm` operation, specify `ReturnData` as False\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudWatch::AnomalyDetector MetricMathAnomalyDetector": { - "MetricDataQueries": "An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression\\. Each item in `MetricDataQueries` gets a metric or performs a math expression\\. One item in `MetricDataQueries` is the expression that provides the time series that the anomaly detector uses as input\\. Designate the expression by setting `ReturnData` to `True` for this object in the array\\. For all other expressions and metrics, set `ReturnData` to `False`\\. The designated expression must return a single time series\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataqueries.html) of [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "MetricDataQueries": "An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression\\. Each item in `MetricDataQueries` gets a metric or performs a math expression\\. One item in `MetricDataQueries` is the expression that provides the time series that the anomaly detector uses as input\\. Designate the expression by setting `ReturnData` to `true` for this object in the array\\. For all other expressions and metrics, set `ReturnData` to `false`\\. The designated expression must return a single time series\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataqueries.html) of [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CloudWatch::AnomalyDetector MetricStat": { "Metric": "The metric to return, including the metric name, namespace, and dimensions\\. \n*Required*: Yes \n*Type*: [Metric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metric.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -4416,16 +4903,19 @@ "StartTime": "The start time of the range to exclude\\. The format is `yyyy-MM-dd'T'HH:mm:ss`\\. For example, `2019-07-01T23:59:59`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudWatch::AnomalyDetector SingleMetricAnomalyDetector": { - "Dimensions": "The metric dimensions to create the anomaly detection model for\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html) \n*Maximum*: `10` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Dimensions": "The metric dimensions to create the anomaly detection model for\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html) \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "MetricName": "The name of the metric to create the anomaly detection model for\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Namespace": "The namespace of the metric to create the anomaly detection model for\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[^:].*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Stat": "The statistic to use for the metric and anomaly detection model\\. \n*Required*: No \n*Type*: String \n*Maximum*: `50` \n*Pattern*: `(SampleCount|Average|Sum|Minimum|Maximum|IQM|(p|tc|tm|ts|wm)(\\d{1,2}(\\.\\d{0,10})?|100)|[ou]\\d+(\\.\\d*)?)(_E|_L|_H)?|(TM|TC|TS|WM)\\(((((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%)?:((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%|((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%:(((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%)?)\\)|(TM|TC|TS|WM|PR)\\(((\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)):((\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)))?|((\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)))?:(\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)))\\)` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CloudWatch::CompositeAlarm": { "ActionsEnabled": "Indicates whether actions should be executed during any changes to the alarm state of the composite alarm\\. The default is TRUE\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ActionsSuppressor": "Actions will be suppressed if the suppressor alarm is in the `ALARM` state\\. `ActionsSuppressor` can be an AlarmName or an Amazon Resource Name \\(ARN\\) from an existing alarm\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ActionsSuppressorExtensionPeriod": "The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the `ALARM` state\\. After this time, the composite alarm performs its actions\\. \n `ExtensionPeriod` is required only when `ActionsSuppressor` is specified\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ActionsSuppressorWaitPeriod": "The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the `ALARM` state\\. After this time, the composite alarm performs its actions\\. \n `WaitPeriod` is required only when `ActionsSuppressor` is specified\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AlarmActions": "The actions to execute when this alarm transitions to the ALARM state from any other state\\. Each action is specified as an Amazon Resource Name \\(ARN\\)\\. For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AlarmDescription": "The description for the composite alarm\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AlarmName": "The name for the composite alarm\\. This name must be unique within your AWS account\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AlarmName": "The name for the composite alarm\\. This name must be unique within your AWS account\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "AlarmRule": "An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state\\. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT\\_DATA state\\. You can use operators \\(AND, OR and NOT\\) to combine multiple functions in a single expression\\. You can use parenthesis to logically group the functions in your expression\\. \nYou can use either alarm names or ARNs to reference the other alarms that are to be evaluated\\. \nFunctions can include the following: \n+ ALARM\\(\"alarm\\-name or alarm\\-ARN\"\\) is TRUE if the named alarm is in ALARM state\\. \n+ OK\\(\"alarm\\-name or alarm\\-ARN\"\\) is TRUE if the named alarm is in OK state\\. \n+ INSUFFICIENT\\_DATA\\(\"alarm\\-name or alarm\\-ARN\"\\) is TRUE if the named alarm is in INSUFFICIENT\\_DATA state\\. \n+ TRUE always evaluates to TRUE\\.\n+ FALSE always evaluates to FALSE\\.\n TRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm actions\\. \nFor more information about `AlarmRule` syntax, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InsufficientDataActions": "The actions to execute when this alarm transitions to the INSUFFICIENT\\_DATA state from any other state\\. Each action is specified as an Amazon Resource Name \\(ARN\\)\\. For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OKActions": "The actions to execute when this alarm transitions to the OK state from any other state\\. Each action is specified as an Amazon Resource Name \\(ARN\\)\\. For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -4444,14 +4934,24 @@ "ExcludeFilters": "If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here\\. You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream\\. \nWhen you modify the `IncludeFilters` or `ExcludeFilters` of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update\\. \n*Required*: No \n*Type*: List of [MetricStreamFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamfilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FirehoseArn": "The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream\\. This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeFilters": "If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here\\. You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream\\. \nWhen you modify the `IncludeFilters` or `ExcludeFilters` of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update\\. \n*Required*: No \n*Type*: List of [MetricStreamFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamfilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeLinkedAccountsMetrics": "If you are creating a metric stream in a monitoring account, specify `true` to include metrics from source accounts that are linked to this monitoring account, in the metric stream\\. The default is `false`\\. \nFor more information about linking accounts, see [CloudWatch cross\\-account observability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "If you are creating a new metric stream, this is the name for the new stream\\. The name must be different than the names of other metric streams in this account and Region\\. \nIf you are updating a metric stream, specify the name of that stream here\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "OutputFormat": "The output format for the stream\\. Valid values are `json` and `opentelemetry0.7` For more information about metric stream output formats, see [ Metric streams output formats](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html)\\. \nThis parameter is required\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources\\. This IAM role must already exist and must be in the same account as the metric stream\\. This IAM role must include the `firehose:PutRecord` and `firehose:PutRecordBatch` permissions\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StatisticsConfigurations": "By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed\\. You can use this parameter to have the metric stream also send additional statistics in the stream\\. This array can have up to 100 members\\. \nFor each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics\\. The additional statistics that you can stream depend on the stream's `OutputFormat`\\. If the `OutputFormat` is `json`, you can stream any additional statistic that is supported by CloudWatch, listed in [CloudWatch statistics definitions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html)\\. If the `OutputFormat` is `opentelemetry0`\\.7, you can stream percentile statistics *\\(p??\\)*\\. \n*Required*: No \n*Type*: List of [MetricStreamStatisticsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs to apply to the metric stream\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CloudWatch::MetricStream MetricStreamFilter": { "Namespace": "The name of the metric namespace in the filter\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::CloudWatch::MetricStream MetricStreamStatisticsConfiguration": { + "AdditionalStatistics": "The additional statistics to stream for the metrics listed in `IncludeMetrics`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeMetrics": "An array that defines the metrics that are to have additional statistics streamed\\. \n*Required*: Yes \n*Type*: List of [MetricStreamStatisticsMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CloudWatch::MetricStream MetricStreamStatisticsMetric": { + "MetricName": "The name of the metric\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Namespace": "The namespace of the metric\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::CodeArtifact::Domain": { "DomainName": "A string that specifies the name of the requested domain\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `2` \n*Maximum*: `50` \n*Pattern*: `[a-z][a-z0-9\\-]{0,48}[a-z0-9]` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EncryptionKey": "The key used to encrypt the domain\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Pattern*: `\\S+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -4462,7 +4962,7 @@ "Description": "A text description of the repository\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Pattern*: `\\P{C}*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DomainName": "The name of the domain that contains the repository\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `2` \n*Maximum*: `50` \n*Pattern*: `[a-z][a-z0-9\\-]{0,48}[a-z0-9]` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DomainOwner": "The 12\\-digit account number of the AWS account that owns the domain that contains the repository\\. It does not include dashes or spaces\\. \n*Required*: No \n*Type*: String \n*Minimum*: `12` \n*Maximum*: `12` \n*Pattern*: `[0-9]{12}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ExternalConnections": "An array of external connections associated with the repository. Currently only one external connection is allowed per repository.\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExternalConnections": "An array of external connections associated with the repository\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PermissionsPolicyDocument": "The document that defines the resource policy that is set on a repository\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RepositoryName": "The name of an upstream repository\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `2` \n*Maximum*: `100` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "A list of tags to be applied to the repository\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -4663,21 +5163,21 @@ "TrafficRoutingConfig": "The configuration that specifies how the deployment traffic is routed\\. \n*Required*: No \n*Type*: [TrafficRoutingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-trafficroutingconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CodeDeploy::DeploymentConfig MinimumHealthyHosts": { - "Type": "The minimum healthy instance type: \n+ HOST\\_COUNT: The minimum number of healthy instance as an absolute value\\.\n+ FLEET\\_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment\\.\nIn an example of nine instance, if a HOST\\_COUNT of six is specified, deploy to up to three instances at a time\\. The deployment is successful if six or more instances are deployed to successfully\\. Otherwise, the deployment fails\\. If a FLEET\\_PERCENT of 40 is specified, deploy to up to five instance at a time\\. The deployment is successful if four or more instance are deployed to successfully\\. Otherwise, the deployment fails\\. \nIn a call to `GetDeploymentConfig`, CodeDeployDefault\\.OneAtATime returns a minimum healthy instance type of MOST\\_CONCURRENCY and a value of 1\\. This means a deployment to only one instance at a time\\. \\(You cannot set the type to MOST\\_CONCURRENCY, only to HOST\\_COUNT or FLEET\\_PERCENT\\.\\) In addition, with CodeDeployDefault\\.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment\\. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful\\.\nFor more information, see [AWS CodeDeploy Instance Health](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html) in the *AWS CodeDeploy User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FLEET_PERCENT | HOST_COUNT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Value": "The minimum healthy instance value\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Type": "The minimum healthy instance type: \n+ HOST\\_COUNT: The minimum number of healthy instance as an absolute value\\.\n+ FLEET\\_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment\\.\nIn an example of nine instance, if a HOST\\_COUNT of six is specified, deploy to up to three instances at a time\\. The deployment is successful if six or more instances are deployed to successfully\\. Otherwise, the deployment fails\\. If a FLEET\\_PERCENT of 40 is specified, deploy to up to five instance at a time\\. The deployment is successful if four or more instance are deployed to successfully\\. Otherwise, the deployment fails\\. \nIn a call to `GetDeploymentConfig`, CodeDeployDefault\\.OneAtATime returns a minimum healthy instance type of MOST\\_CONCURRENCY and a value of 1\\. This means a deployment to only one instance at a time\\. \\(You cannot set the type to MOST\\_CONCURRENCY, only to HOST\\_COUNT or FLEET\\_PERCENT\\.\\) In addition, with CodeDeployDefault\\.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment\\. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful\\.\nFor more information, see [AWS CodeDeploy Instance Health](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html) in the *AWS CodeDeploy User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FLEET_PERCENT | HOST_COUNT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Value": "The minimum healthy instance value\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CodeDeploy::DeploymentConfig TimeBasedCanary": { - "CanaryInterval": "The number of minutes between the first and second traffic shifts of a `TimeBasedCanary` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CanaryPercentage": "The percentage of traffic to shift in the first increment of a `TimeBasedCanary` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CanaryInterval": "The number of minutes between the first and second traffic shifts of a `TimeBasedCanary` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CanaryPercentage": "The percentage of traffic to shift in the first increment of a `TimeBasedCanary` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CodeDeploy::DeploymentConfig TimeBasedLinear": { - "LinearInterval": "The number of minutes between each incremental traffic shift of a `TimeBasedLinear` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LinearPercentage": "The percentage of traffic that is shifted at the start of each increment of a `TimeBasedLinear` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "LinearInterval": "The number of minutes between each incremental traffic shift of a `TimeBasedLinear` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "LinearPercentage": "The percentage of traffic that is shifted at the start of each increment of a `TimeBasedLinear` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CodeDeploy::DeploymentConfig TrafficRoutingConfig": { - "TimeBasedCanary": "A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments\\. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file\\. \n*Required*: No \n*Type*: [TimeBasedCanary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedcanary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimeBasedLinear": "A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment\\. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file\\. \n*Required*: No \n*Type*: [TimeBasedLinear](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedlinear.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Type": "The type of traffic shifting \\(`TimeBasedCanary` or `TimeBasedLinear`\\) used by a deployment configuration\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AllAtOnce | TimeBasedCanary | TimeBasedLinear` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TimeBasedCanary": "A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments\\. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file\\. \n*Required*: No \n*Type*: [TimeBasedCanary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedcanary.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TimeBasedLinear": "A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment\\. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file\\. \n*Required*: No \n*Type*: [TimeBasedLinear](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedlinear.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Type": "The type of traffic shifting \\(`TimeBasedCanary` or `TimeBasedLinear`\\) used by a deployment configuration\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AllAtOnce | TimeBasedCanary | TimeBasedLinear` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CodeDeploy::DeploymentGroup": { "AlarmConfiguration": "Information about the Amazon CloudWatch alarms that are associated with the deployment group\\. \n*Required*: No \n*Type*: [AlarmConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarmconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -4695,14 +5195,16 @@ "LoadBalancerInfo": "Information about the load balancer to use in a deployment\\. For more information, see [ Integrating CodeDeploy with Elastic Load Balancing](https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-elastic-load-balancing.html) in the *AWS CodeDeploy User Guide*\\. \n*Required*: No \n*Type*: [LoadBalancerInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-loadbalancerinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OnPremisesInstanceTagFilters": "The on\\-premises instance tags already applied to on\\-premises instances that you want to include in the deployment group\\. CodeDeploy includes all on\\-premises instances identified by any of the tags you specify in this deployment group\\. To register on\\-premises instances with CodeDeploy, see [Working with On\\-Premises Instances for CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-on-premises.html) in the *AWS CodeDeploy User Guide*\\. Duplicates are not allowed\\. \n You can specify `OnPremisesInstanceTagFilters` or `OnPremisesInstanceTagSet`, but not both\\. \n*Required*: No \n*Type*: List of [TagFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-tagfilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OnPremisesTagSet": "Information about groups of tags applied to on\\-premises instances\\. The deployment group includes only on\\-premises instances identified by all the tag groups\\. \n You can specify `OnPremisesInstanceTagFilters` or `OnPremisesInstanceTagSet`, but not both\\. \n*Required*: No \n*Type*: [OnPremisesTagSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagset.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OutdatedInstancesStrategy": "Indicates what happens when new Amazon EC2 instances are launched mid\\-deployment and do not receive the deployed application revision\\. \nIf this option is set to `UPDATE` or is unspecified, CodeDeploy initiates one or more 'auto\\-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances\\. \nIf this option is set to `IGNORE`, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances\\. This may result in instances having different revisions\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IGNORE | UPDATE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceRoleArn": "A service role Amazon Resource Name \\(ARN\\) that grants CodeDeploy permission to make calls to AWS services on your behalf\\. For more information, see [Create a Service Role for AWS CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-service-role.html) in the *AWS CodeDeploy User Guide*\\. \n In some cases, you might need to add a dependency on the service role's policy\\. For more information, see IAM role policy in [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html)\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them\\. Each tag consists of a key and an optional value, both of which you define\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TriggerConfigurations": "Information about triggers associated with the deployment group\\. Duplicates are not allowed \n*Required*: No \n*Type*: List of [TriggerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-triggerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CodeDeploy::DeploymentGroup Alarm": { "Name": "The name of the alarm\\. Maximum length is 255 characters\\. Each alarm name can be used only once in a list of alarms\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CodeDeploy::DeploymentGroup AlarmConfiguration": { - "Alarms": "A list of alarms configured for the deployment group\\. A maximum of 10 alarms can be added to a deployment group\\. \n*Required*: No \n*Type*: List of [Alarm](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Alarms": "A list of alarms configured for the deployment or deployment group\\. A maximum of 10 alarms can be added\\. \n*Required*: No \n*Type*: List of [Alarm](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "Indicates whether the alarm configuration is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IgnorePollAlarmFailure": "Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch\\. The default value is `false`\\. \n+ `true`: The deployment proceeds even if alarm status information can't be retrieved from CloudWatch\\.\n+ `false`: The deployment stops if alarm status information can't be retrieved from CloudWatch\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -4759,7 +5261,8 @@ }, "AWS::CodeDeploy::DeploymentGroup LoadBalancerInfo": { "ElbInfoList": "An array that contains information about the load balancer to use for load balancing in a deployment\\. In Elastic Load Balancing, load balancers are used with Classic Load Balancers\\. \n Adding more than one load balancer to the array is not supported\\. \n*Required*: No \n*Type*: List of [ELBInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-elbinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TargetGroupInfoList": "An array that contains information about the target group to use for load balancing in a deployment\\. In Elastic Load Balancing, target groups are used with Application Load Balancers\\. \n Adding more than one target group to the array is not supported\\. \n*Required*: Conditional \n*Type*: List of [TargetGroupInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgroupinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TargetGroupInfoList": "An array that contains information about the target group to use for load balancing in a deployment\\. In Elastic Load Balancing, target groups are used with Application Load Balancers\\. \n Adding more than one target group to the array is not supported\\. \n*Required*: Conditional \n*Type*: List of [TargetGroupInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgroupinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetGroupPairInfoList": "The target group pair information\\. This is an array of `TargeGroupPairInfo` objects with a maximum size of one\\. \n*Required*: No \n*Type*: List of [TargetGroupPairInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CodeDeploy::DeploymentGroup OnPremisesTagSet": { "OnPremisesTagSetList": "A list that contains other lists of on\\-premises instance tag groups\\. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list\\. \nDuplicates are not allowed\\. \n*Required*: No \n*Type*: List of [OnPremisesTagSetListObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-onpremisestagsetlistobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -4787,18 +5290,29 @@ "AWS::CodeDeploy::DeploymentGroup TargetGroupInfo": { "Name": "For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment registered with\\. For in\\-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re\\-registered with after the deployment completes\\. No duplicates allowed\\. \nAWS CloudFormation supports blue/green deployments on AWS Lambda compute platforms only\\.\nThis value cannot exceed 32 characters, so you should use the `Name` property of the target group, or the `TargetGroupName` attribute with the `Fn::GetAtt` intrinsic function, as shown in the following example\\. Don't use the group's Amazon Resource Name \\(ARN\\) or `TargetGroupFullName` attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::CodeDeploy::DeploymentGroup TargetGroupPairInfo": { + "ProdTrafficRoute": "The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete\\. \n*Required*: No \n*Type*: [TrafficRoute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-trafficroute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetGroups": "One pair of target groups\\. One is associated with the original task set\\. The second is associated with the task set that serves traffic after the deployment is complete\\. \n*Required*: No \n*Type*: List of [TargetGroupInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgroupinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TestTrafficRoute": "An optional path used by a load balancer to route test traffic after an Amazon ECS deployment\\. Validation can occur while test traffic is served during a deployment\\. \n*Required*: No \n*Type*: [TrafficRoute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-trafficroute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::CodeDeploy::DeploymentGroup TrafficRoute": { + "ListenerArns": "The Amazon Resource Name \\(ARN\\) of one listener\\. The listener identifies the route between a target group and a load balancer\\. This is an array of strings with a maximum size of one\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::CodeDeploy::DeploymentGroup TriggerConfig": { "TriggerEvents": "The event type or types that trigger notifications\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TriggerName": "The name of the notification trigger\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TriggerTargetArn": "The Amazon Resource Name \\(ARN\\) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CodeGuruProfiler::ProfilingGroup": { - "AgentPermissions": "The agent permissions attached to this profiling group\\. This action group grants `ConfigureAgent` and `PostAgentProfile` permissions to perform actions required by the profiling agent\\. The Json consists of key `Principals`\\. \n*Principals*: A list of string ARNs for the roles and users you want to grant access to the profiling group\\. Wildcards are not supported in the ARNs\\. You are allowed to provide up to 50 ARNs\\. An empty list is not permitted\\. This is a required key\\. \nFor more information, see [Resource\\-based policies in CodeGuru Profiler](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html) in the *Amazon CodeGuru Profiler user guide*, [ConfigureAgent](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html), and [PostAgentProfile](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AgentPermissions": "The agent permissions attached to this profiling group\\. This action group grants `ConfigureAgent` and `PostAgentProfile` permissions to perform actions required by the profiling agent\\. The Json consists of key `Principals`\\. \n*Principals*: A list of string ARNs for the roles and users you want to grant access to the profiling group\\. Wildcards are not supported in the ARNs\\. You are allowed to provide up to 50 ARNs\\. An empty list is not permitted\\. This is a required key\\. \nFor more information, see [Resource\\-based policies in CodeGuru Profiler](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html) in the *Amazon CodeGuru Profiler user guide*, [ConfigureAgent](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html), and [PostAgentProfile](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html)\\. \n*Required*: No \n*Type*: [AgentPermissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeguruprofiler-profilinggroup-agentpermissions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AnomalyDetectionNotificationConfiguration": "Adds anomaly notifications for a profiling group\\. \n*Required*: No \n*Type*: List of [Channel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeguruprofiler-profilinggroup-channel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ComputePlatform": "The compute platform of the profiling group\\. Use `AWSLambda` if your application runs on AWS Lambda\\. Use `Default` if your application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on\\-premises server, or a different platform\\. If not specified, `Default` is used\\. This property is immutable\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ProfilingGroupName": "The name of the profiling group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "A list of tags to add to the created profiling group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::CodeGuruProfiler::ProfilingGroup AgentPermissions": { + "Principals": "Property description not available\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::CodeGuruProfiler::ProfilingGroup Channel": { "channelId": "The channel ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "channelUri": "The channel URI\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -4822,23 +5336,23 @@ "Version": "The version identifier of the custom action\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `9` \n*Pattern*: `[0-9A-Za-z_-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CodePipeline::CustomActionType ArtifactDetails": { - "MaximumCount": "The maximum number of artifacts allowed for the action type\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MinimumCount": "The minimum number of artifacts allowed for the action type\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "MaximumCount": "The maximum number of artifacts allowed for the action type\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MinimumCount": "The minimum number of artifacts allowed for the action type\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CodePipeline::CustomActionType ConfigurationProperties": { - "Description": "The description of the action configuration property that is displayed to users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `160` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Key": "Whether the configuration property is a key\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the action configuration property\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Queryable": "Indicates that the property is used with `PollForJobs`\\. When creating a custom action, an action can have up to one queryable property\\. If it has one, that property must be both required and not secret\\. \nIf you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions\\. The value must be less than or equal to twenty \\(20\\) characters\\. The value can contain only alphanumeric characters, underscores, and hyphens\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Required": "Whether the configuration property is a required value\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Secret": "Whether the configuration property is secret\\. Secrets are hidden from all calls except for `GetJobDetails`, `GetThirdPartyJobDetails`, `PollForJobs`, and `PollForThirdPartyJobs`\\. \nWhen updating a pipeline, passing \\* \\* \\* \\* \\* without changing any other values of the action preserves the previous value of the secret\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Type": "The type of the configuration property\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Boolean | Number | String` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Description": "The description of the action configuration property that is displayed to users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `160` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Key": "Whether the configuration property is a key\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the action configuration property\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Queryable": "Indicates that the property is used with `PollForJobs`\\. When creating a custom action, an action can have up to one queryable property\\. If it has one, that property must be both required and not secret\\. \nIf you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions\\. The value must be less than or equal to twenty \\(20\\) characters\\. The value can contain only alphanumeric characters, underscores, and hyphens\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Required": "Whether the configuration property is a required value\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Secret": "Whether the configuration property is secret\\. Secrets are hidden from all calls except for `GetJobDetails`, `GetThirdPartyJobDetails`, `PollForJobs`, and `PollForThirdPartyJobs`\\. \nWhen updating a pipeline, passing \\* \\* \\* \\* \\* without changing any other values of the action preserves the previous value of the secret\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Type": "The type of the configuration property\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Boolean | Number | String` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CodePipeline::CustomActionType Settings": { - "EntityUrlTemplate": "The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group\\. This link is provided as part of the action display in the pipeline\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ExecutionUrlTemplate": "The URL returned to the CodePipeline console that contains a link to the top\\-level landing page for the external system, such as the console page for CodeDeploy\\. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RevisionUrlTemplate": "The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ThirdPartyConfigurationUrl": "The URL of a sign\\-up page where users can sign up for an external service and perform initial configuration of the action provided by that service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "EntityUrlTemplate": "The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group\\. This link is provided as part of the action display in the pipeline\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ExecutionUrlTemplate": "The URL returned to the CodePipeline console that contains a link to the top\\-level landing page for the external system, such as the console page for CodeDeploy\\. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RevisionUrlTemplate": "The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ThirdPartyConfigurationUrl": "The URL of a sign\\-up page where users can sign up for an external service and perform initial configuration of the action provided by that service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CodePipeline::Pipeline": { "ArtifactStore": "The S3 bucket where artifacts for the pipeline are stored\\. \nYou must include either `artifactStore` or `artifactStores` in your pipeline, but you cannot use both\\. If you create a cross\\-region action in your pipeline, you must use `artifactStores`\\.\n*Required*: Conditional \n*Type*: [ArtifactStore](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-artifactstore.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -4853,10 +5367,10 @@ "AWS::CodePipeline::Pipeline ActionDeclaration": { "ActionTypeId": "Specifies the action type and the provider of the action\\. \n*Required*: Yes \n*Type*: [ActionTypeId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-actiontypeid.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Configuration": "The action's configuration\\. These are key\\-value pairs that specify input values for an action\\. For more information, see [Action Structure Requirements in CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements)\\. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see [Configuration Properties Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-action-reference.html) in the * AWS CloudFormation User Guide*\\. For template snippets with examples, see [Using Parameter Override Functions with CodePipeline Pipelines](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/continuous-delivery-codepipeline-parameter-override-functions.html) in the * AWS CloudFormation User Guide*\\. \nThe values can be represented in either JSON or YAML format\\. For example, the JSON configuration item format is as follows: \n *JSON:* \n `\"Configuration\" : { Key : Value },` \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InputArtifacts": "The name or ID of the artifact consumed by the action, such as a test or build artifact\\. \nFor a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource\\. For more information, see the [CodeBuild action reference page](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeBuild.html) in the *AWS CodePipeline User Guide*\\.\n*Required*: No \n*Type*: List of [InputArtifact](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InputArtifacts": "The name or ID of the artifact consumed by the action, such as a test or build artifact\\. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of input artifacts\\. To refer to the action configuration specification by action provider, see the [Action structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) in the *AWS CodePipeline User Guide*\\. \nFor a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource\\. For more information, see the [CodeBuild action reference page](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeBuild.html) in the *AWS CodePipeline User Guide*\\.\n*Required*: No \n*Type*: List of [InputArtifact](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The action declaration's name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[A-Za-z0-9.@\\-_]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Namespace": "The variable namespace associated with the action\\. All variables produced as output by this action fall under this namespace\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[A-Za-z0-9@\\-_]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OutputArtifacts": "The name or ID of the result of the action declaration, such as a test or build artifact\\. \n*Required*: No \n*Type*: List of [OutputArtifact](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OutputArtifacts": "The name or ID of the result of the action declaration, such as a test or build artifact\\. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of output artifacts\\. To refer to the action configuration specification by action provider, see the [Action structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) in the *AWS CodePipeline User Guide*\\. \n*Required*: No \n*Type*: List of [OutputArtifact](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Region": "The action declaration's AWS Region, such as us\\-east\\-1\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `30` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The ARN of the IAM service role that performs the declared action\\. This is assumed through the roleArn for the pipeline\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RunOrder": "The order in which actions are run\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `999` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -4881,11 +5395,11 @@ "Type": "Reserved for future use\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Schedule` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CodePipeline::Pipeline EncryptionKey": { - "Id": "The ID used to identify the key\\. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN\\. \nAliases are recognized only in the account that created the AWS KMS key\\. For cross\\-account actions, you can only use the key ID or key ARN to identify the key\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Id": "The ID used to identify the key\\. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN\\. \nAliases are recognized only in the account that created the AWS KMS key\\. For cross\\-account actions, you can only use the key ID or key ARN to identify the key\\. Cross\\-account actions involve using the role from the other account \\(AccountB\\), so specifying the key ID will use the key from the other account \\(AccountB\\)\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Type": "The type of encryption key, such as an AWS KMS key\\. When creating or updating a pipeline, the value must be set to 'KMS'\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CodePipeline::Pipeline InputArtifact": { - "Name": "The name of the artifact to be worked on \\(for example, \"My App\"\\)\\. \nThe input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact\\. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z0-9_\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "The name of the artifact to be worked on \\(for example, \"My App\"\\)\\. \nArtifacts are the files that are worked on by actions in the pipeline\\. See the action configuration for each action for details about artifact parameters\\. For example, the S3 source action input artifact is a file name \\(or file path\\), and the files are generally provided as a ZIP file\\. Example artifact name: SampleApp\\_Windows\\.zip \nThe input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact\\. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z0-9_\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CodePipeline::Pipeline OutputArtifact": { "Name": "The name of the output of an artifact, such as \"My App\"\\. \nThe output artifact name must exactly match the input artifact declared for a downstream action\\. However, the downstream action's input artifact does not have to be the next action in strict sequence from the action that provided the output artifact\\. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions\\. \nOutput artifact names must be unique within a pipeline\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z0-9_\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -4919,7 +5433,7 @@ }, "AWS::CodeStar::GitHubRepository": { "Code": "Information about code to be committed to a repository after it is created in an AWS CloudFormation stack\\. \n*Required*: No \n*Type*: [Code](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-code.html) \n*Update requires*: Updates are not supported\\.", - "ConnectionArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectionArn": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnableIssues": "Indicates whether to enable issues for the GitHub repository\\. You can use GitHub issues to track information and bugs for your repository\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: Updates are not supported\\.", "IsPrivate": "Indicates whether the GitHub repository is a private repository\\. If so, you choose who can see and commit to this repository\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: Updates are not supported\\.", "RepositoryAccessToken": "The GitHub user's personal access token for the GitHub repository\\. \n*Required*: No \n*Type*: String \n*Update requires*: Updates are not supported\\.", @@ -4942,16 +5456,16 @@ "Tags": "Specifies the tags applied to the resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CodeStarNotifications::NotificationRule": { - "CreatedBy": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CreatedBy": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DetailType": "The level of detail to include in the notifications for this resource\\. `BASIC` will include only the contents of the event as it would appear in Amazon CloudWatch\\. `FULL` will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BASIC | FULL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EventTypeId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EventTypeIds": "A list of event types associated with this notification rule\\. For a complete list of event types and IDs, see [Notification concepts](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api) in the *Developer Tools Console User Guide*\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventTypeId": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventTypeIds": "A list of event types associated with this notification rule\\. For a complete list of event types and IDs, see [Notification concepts](https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api) in the *Developer Tools Console User Guide*\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name for the notification rule\\. Notification rule names must be unique in your AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[A-Za-z0-9\\-_ ]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Resource": "The Amazon Resource Name \\(ARN\\) of the resource to associate with the notification rule\\. Supported resources include pipelines in AWS CodePipeline, repositories in AWS CodeCommit, and build projects in AWS CodeBuild\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^arn:aws[^:\\s]*:[^:\\s]*:[^:\\s]*:[0-9]{12}:[^\\s]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Status": "The status of the notification rule\\. The default value is `ENABLED`\\. If the status is set to `DISABLED`, notifications aren't sent for the notification rule\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "A list of tags to apply to this notification rule\\. Key names cannot start with \"`aws`\"\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "TargetAddress": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Targets": "A list of Amazon Resource Names \\(ARNs\\) of AWS Chatbot topics and AWS Chatbot clients to associate with the notification rule\\. \n*Required*: Yes \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestarnotifications-notificationrule-target.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Tags": "A list of tags to apply to this notification rule\\. Key names cannot start with \"`aws`\"\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetAddress": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Targets": "A list of Amazon Resource Names \\(ARNs\\) of Amazon Simple Notification Service topics and AWS Chatbot clients to associate with the notification rule\\. \n*Required*: Yes \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestarnotifications-notificationrule-target.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CodeStarNotifications::NotificationRule Target": { "TargetAddress": "The Amazon Resource Name \\(ARN\\) of the AWS Chatbot topic or AWS Chatbot client\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `320` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5009,18 +5523,20 @@ "AdminCreateUserConfig": "The configuration for creating a new user profile\\. \n*Required*: No \n*Type*: [AdminCreateUserConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AliasAttributes": "Attributes supported as an alias for this user pool\\. Possible values: **phone\\_number**, **email**, or **preferred\\_username**\\. \nThis user pool property cannot be updated\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AutoVerifiedAttributes": "The attributes to be auto\\-verified\\. Possible values: **email**, **phone\\_number**\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeviceConfiguration": "The device configuration\\. \n*Required*: No \n*Type*: [DeviceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EmailConfiguration": "The email configuration\\. \n*Required*: No \n*Type*: [EmailConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EmailVerificationMessage": "A string representing the email verification message\\. EmailVerificationMessage is allowed only if [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EmailVerificationSubject": "A string representing the email verification subject\\. EmailVerificationSubject is allowed only if [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeletionProtection": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeviceConfiguration": "The device\\-remembering configuration for a user pool\\. A null value indicates that you have deactivated device remembering in your user pool\\. \nWhen you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device\\-remembering feature\\.\n*Required*: No \n*Type*: [DeviceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EmailConfiguration": "The email configuration of your user pool\\. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool\\. \n*Required*: No \n*Type*: [EmailConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EmailVerificationMessage": "This parameter is no longer used\\. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EmailVerificationSubject": "This parameter is no longer used\\. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnabledMfas": "Enables MFA on a specified user pool\\. To disable all MFAs after it has been enabled, set MfaConfiguration to \u201cOFF\u201d and remove EnabledMfas\\. MFAs can only be all disabled if MfaConfiguration is OFF\\. Once SMS\\_MFA is enabled, SMS\\_MFA can only be disabled by setting MfaConfiguration to \u201cOFF\u201d\\. Can be one of the following values: \n+ `SMS_MFA` \\- Enables SMS MFA for the user pool\\. SMS\\_MFA can only be enabled if SMS configuration is provided\\.\n+ `SOFTWARE_TOKEN_MFA` \\- Enables software token MFA for the user pool\\.\nAllowed values: `SMS_MFA` \\| `SOFTWARE_TOKEN_MFA` \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LambdaConfig": "The Lambda trigger configuration information for the new user pool\\. \nIn a push model, event sources \\(such as Amazon S3 and custom applications\\) need permission to invoke a function\\. So you must make an extra call to add permission for these event sources to invoke your Lambda function\\. \n \nFor more information on using the Lambda API to add permission, see[ AddPermission ](https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html)\\. \nFor adding permission using the AWS CLI, see[ add\\-permission ](https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html)\\.\n*Required*: No \n*Type*: [LambdaConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MfaConfiguration": "The multi\\-factor \\(MFA\\) configuration\\. Valid values include: \n+ `OFF` MFA won't be used for any users\\.\n+ `ON` MFA is required for all users to sign in\\.\n+ `OPTIONAL` MFA will be required only for individual users who have an MFA factor activated\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `OFF | ON | OPTIONAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MfaConfiguration": "The multi\\-factor authentication \\(MFA\\) configuration\\. Valid values include: \n+ `OFF` MFA won't be used for any users\\.\n+ `ON` MFA is required for all users to sign in\\.\n+ `OPTIONAL` MFA will be required only for individual users who have an MFA factor activated\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `OFF | ON | OPTIONAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Policies": "The policy associated with a user pool\\. \n*Required*: No \n*Type*: [Policies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-policies.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Schema": "", + "Schema": "The schema attributes for the new user pool\\. These attributes can be standard or custom attributes\\. \n During a user pool update, you can add new schema attributes but you cannot modify or delete an existing schema attribute\\.\n*Required*: No \n*Type*: List of [SchemaAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SmsAuthenticationMessage": "A string representing the SMS authentication message\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `140` \n*Pattern*: `.*\\{####\\}.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SmsConfiguration": "The SMS configuration\\. \n*Required*: No \n*Type*: [SmsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SmsVerificationMessage": "A string representing the SMS verification message\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `140` \n*Pattern*: `.*\\{####\\}.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SmsConfiguration": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service\\. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management \\(IAM\\) role in your AWS account\\. \n*Required*: No \n*Type*: [SmsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SmsVerificationMessage": "This parameter is no longer used\\. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `140` \n*Pattern*: `.*\\{####\\}.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UserAttributeUpdateSettings": "The settings for updates to user attributes\\. These settings include the property `AttributesRequireVerificationBeforeUpdate`, a user\\-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes\\. For more information, see [ Verifying updates to email addresses and phone numbers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates)\\. \n*Required*: No \n*Type*: [UserAttributeUpdateSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userattributeupdatesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserPoolAddOns": "Enables advanced security risk detection\\. Set the key `AdvancedSecurityMode` to the value \"AUDIT\"\\. \n*Required*: No \n*Type*: [UserPoolAddOns](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userpooladdons.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserPoolName": "A string used to name the user pool\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\w\\s+=,.@-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserPoolTags": "The tag keys and values to assign to the user pool\\. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5034,7 +5550,7 @@ "AWS::Cognito::UserPool AdminCreateUserConfig": { "AllowAdminCreateUserOnly": "Set to `True` if only the administrator is allowed to create user profiles\\. Set to `False` if users can sign themselves up via an app\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InviteMessageTemplate": "The message template to be used for the welcome message to new users\\. \nSee also [Customizing User Invitation Messages](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization)\\. \n*Required*: No \n*Type*: [InviteMessageTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-invitemessagetemplate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UnusedAccountValidityDays": "The user account expiration limit, in days, after which the account is no longer usable\\. To reset the account after that time limit, you must call `AdminCreateUser` again, specifying `\"RESEND\"` for the `MessageAction` parameter\\. The default value for this parameter is 7\\. \nIf you set a value for `TemporaryPasswordValidityDays` in `PasswordPolicy`, that value will be used, and `UnusedAccountValidityDays` will be no longer be an available parameter for that user pool\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `365` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "UnusedAccountValidityDays": "The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable\\. To reset the account after that time limit, you must call `AdminCreateUser` again, specifying `\"RESEND\"` for the `MessageAction` parameter\\. The default value for this parameter is 7\\. \nIf you set a value for `TemporaryPasswordValidityDays` in `PasswordPolicy`, that value will be used, and `UnusedAccountValidityDays` will be no longer be an available parameter for that user pool\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `365` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cognito::UserPool CustomEmailSender": { "LambdaArn": "The Amazon Resource Name \\(ARN\\) of the AWS Lambda function that Amazon Cognito triggers to send email notifications to users\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5045,15 +5561,15 @@ "LambdaVersion": "The Lambda version represents the signature of the \"request\" attribute in the \"event\" information Amazon Cognito passes to your custom SMS sender Lambda function\\. The only supported value is `V1_0`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cognito::UserPool DeviceConfiguration": { - "ChallengeRequiredOnNewDevice": "When true, device authentication can replace SMS and time\\-based one\\-time password \\(TOTP\\) factors for multi\\-factor authentication \\(MFA\\)\\. \nUsers that sign in with devices that have not been confirmed or remembered will still have to provide a second factor, whether or not ChallengeRequiredOnNewDevice is true, when your user pool requires MFA\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeviceOnlyRememberedOnUserPrompt": "When true, users can opt in to remembering their device\\. Your app code must use callback functions to return the user's choice\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ChallengeRequiredOnNewDevice": "When true, a remembered device can sign in with device authentication instead of SMS and time\\-based one\\-time password \\(TOTP\\) factors for multi\\-factor authentication \\(MFA\\)\\. \nWhether or not `ChallengeRequiredOnNewDevice` is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeviceOnlyRememberedOnUserPrompt": "When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a [ ConfirmDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) API request\\. In your app, create a prompt for your user to choose whether they want to remember their device\\. Return the user's choice in an [ UpdateDeviceStatus](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) API request\\. \nWhen `DeviceOnlyRememberedOnUserPrompt` is `false`, Amazon Cognito immediately remembers devices that you register in a `ConfirmDevice` API request\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cognito::UserPool EmailConfiguration": { "ConfigurationSet": "The set of configuration rules that can be applied to emails sent using Amazon SES\\. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email\\. Once applied, all of the rules in that configuration set are applied to the email\\. Configuration sets can be used to apply the following types of rules to emails: \n+ Event publishing \u2013 Amazon SES can track the number of send, delivery, open, click, bounce, and complaint events for each email sent\\. Use event publishing to send information about these events to other AWS services such as SNS and CloudWatch\\.\n+ IP pool management \u2013 When leasing dedicated IP addresses with Amazon SES, you can create groups of IP addresses, called dedicated IP pools\\. You can then associate the dedicated IP pools with configuration sets\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9_-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EmailSendingAccount": "Specifies whether Amazon Cognito emails your users by using its built\\-in email functionality or your Amazon Simple Email Service email configuration\\. Specify one of the following values: \nCOGNITO\\_DEFAULT \nWhen Amazon Cognito emails your users, it uses its built\\-in email functionality\\. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool\\. For typical production environments, the default email limit is less than the required delivery volume\\. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration\\. \nTo look up the email delivery limit for the default option, see [Limits in ](https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html) in the * Developer Guide*\\. \nThe default FROM address is `no-reply@verificationemail.com`\\. To customize the FROM address, provide the Amazon Resource Name \\(ARN\\) of an Amazon SES verified email address for the `SourceArn` parameter\\. \n If EmailSendingAccount is COGNITO\\_DEFAULT, you can't use the following parameters: \n+ EmailVerificationMessage\n+ EmailVerificationSubject\n+ InviteMessageTemplate\\.EmailMessage\n+ InviteMessageTemplate\\.EmailSubject\n+ VerificationMessageTemplate\\.EmailMessage\n+ VerificationMessageTemplate\\.EmailMessageByLink\n+ VerificationMessageTemplate\\.EmailSubject,\n+ VerificationMessageTemplate\\.EmailSubjectByLink\nDEVELOPER EmailSendingAccount is required\\. \nDEVELOPER \nWhen Amazon Cognito emails your users, it uses your Amazon SES configuration\\. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address\\. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account\\. \nIf you use this option, you must provide the ARN of an Amazon SES verified email address for the `SourceArn` parameter\\. \nBefore Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf\\. When you update your user pool with this option, Amazon Cognito creates a *service\\-linked role*, which is a type of role, in your AWS account\\. This role contains the permissions that allow to access Amazon SES and send email messages with your address\\. For more information about the service\\-linked role that Amazon Cognito creates, see [Using Service\\-Linked Roles for Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html) in the *Amazon Cognito Developer Guide*\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `COGNITO_DEFAULT | DEVELOPER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EmailSendingAccount": "Specifies whether Amazon Cognito uses its built\\-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration\\. Specify one of the following values: \nCOGNITO\\_DEFAULT \nWhen Amazon Cognito emails your users, it uses its built\\-in email functionality\\. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool\\. For typical production environments, the default email limit is less than the required delivery volume\\. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration\\. \nTo look up the email delivery limit for the default option, see [Limits](https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html) in the *Amazon Cognito Developer Guide*\\. \nThe default FROM address is `no-reply@verificationemail.com`\\. To customize the FROM address, provide the Amazon Resource Name \\(ARN\\) of an Amazon SES verified email address for the `SourceArn` parameter\\. \nDEVELOPER \nWhen Amazon Cognito emails your users, it uses your Amazon SES configuration\\. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address\\. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account\\. \nIf you use this option, provide the ARN of an Amazon SES verified email address for the `SourceArn` parameter\\. \nBefore Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf\\. When you update your user pool with this option, Amazon Cognito creates a *service\\-linked role*, which is a type of role in your AWS account\\. This role contains the permissions that allow you to access Amazon SES and send email messages from your email address\\. For more information about the service\\-linked role that Amazon Cognito creates, see [Using Service\\-Linked Roles for Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html) in the *Amazon Cognito Developer Guide*\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `COGNITO_DEFAULT | DEVELOPER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "From": "Identifies either the sender's email address or the sender's name with their email address\\. For example, `testuser@example.com` or `Test User `\\. This address appears before the body of the email\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ReplyToEmailAddress": "The destination to which the receiver of the email should reply\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+@[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SourceArn": "The ARN of a verified email address in Amazon SES\\. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the `EmailSendingAccount` parameter: \n+ If you specify `COGNITO_DEFAULT`, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built\\-in email account\\.\n+ If you specify `DEVELOPER`, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf\\.\n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SourceArn": "The ARN of a verified email address in Amazon SES\\. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the `EmailSendingAccount` parameter: \n+ If you specify `COGNITO_DEFAULT`, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built\\-in email account\\.\n+ If you specify `DEVELOPER`, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf\\.\nThe Region value of the `SourceArn` parameter must indicate a supported AWS Region of your user pool\\. Typically, the Region in the `SourceArn` and the user pool Region are the same\\. For more information, see [Amazon SES email configuration regions](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html#user-pool-email-developer-region-mapping) in the [Amazon Cognito Developer Guide](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cognito::UserPool InviteMessageTemplate": { "EmailMessage": "The message template for email messages\\. EmailMessage is allowed only if [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5085,7 +5601,7 @@ "RequireNumbers": "In the password policy that you have set, refers to whether you have required users to use at least one number in their password\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RequireSymbols": "In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RequireUppercase": "In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TemporaryPasswordValidityDays": "The number of days a temporary password is valid in the password policy\\. If the user doesn't sign in during this time, an administrator must reset their password\\. \nWhen you set `TemporaryPasswordValidityDays` for a user pool, you can no longer set the deprecated `UnusedAccountValidityDays` value for that user pool\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `365` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TemporaryPasswordValidityDays": "The number of days a temporary password is valid in the password policy\\. If the user doesn't sign in during this time, an administrator must reset their password\\. \nWhen you set `TemporaryPasswordValidityDays` for a user pool, you can no longer set a value for the legacy `UnusedAccountValidityDays` parameter in that user pool\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `365` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cognito::UserPool Policies": { "PasswordPolicy": "The password policy\\. \n*Required*: No \n*Type*: [PasswordPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -5097,7 +5613,7 @@ "AWS::Cognito::UserPool SchemaAttribute": { "AttributeDataType": "The attribute data type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Boolean | DateTime | Number | String` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DeveloperOnlyAttribute": "We recommend that you use [WriteAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes) in the user pool client to control how attributes can be mutated for new use cases instead of using `DeveloperOnlyAttribute`\\.\nSpecifies whether the attribute type is developer only\\. This attribute can only be modified by an administrator\\. Users will not be able to modify this attribute using their access token\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Mutable": "Specifies whether the value of the attribute can be changed\\. \nFor any user pool attribute that is mapped to an identity provider attribute, you must set this parameter to `true`\\. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider\\. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute\\. For more information, see [Specifying Identity Provider Attribute Mappings for Your User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Mutable": "Specifies whether the value of the attribute can be changed\\. \nFor any user pool attribute that is mapped to an IdP attribute, you must set this parameter to `true`\\. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP\\. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute\\. For more information, see [Specifying Identity Provider Attribute Mappings for Your User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A schema attribute of the name type\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `20` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NumberAttributeConstraints": "Specifies the constraints for an attribute of the number type\\. \n*Required*: No \n*Type*: [NumberAttributeConstraints](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-numberattributeconstraints.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Required": "Specifies whether a user pool attribute is required\\. If the attribute is required and the user doesn't provide a value, registration or sign\\-in will fail\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5106,59 +5622,64 @@ "AWS::Cognito::UserPool SmsConfiguration": { "ExternalId": "The external ID is a value\\. We recommend you use `ExternalId`to add security to your IAM role, which is used to call Amazon SNS to send SMS messages for your user pool\\. If you provide an `ExternalId`, the Cognito User Pool uses it when attempting to assume your IAM role\\. You can also set your roles trust policy to require the `ExternalID`\\. If you use the Cognito Management Console to create a role for SMS MFA, Cognito creates a role with the required permissions and a trust policy that uses `ExternalId`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SnsCallerArn": "The Amazon Resource Name \\(ARN\\) of the Amazon SNS caller\\. This is the ARN of the IAM role in your AWS account that Amazon Cognito will use to send SMS messages\\. SMS messages are subject to a [spending limit](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SnsRegion": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SnsRegion": "The AWS Region to use with Amazon SNS integration\\. You can choose the same Region as your user pool, or a supported **Legacy Amazon SNS alternate Region**\\. \n Amazon Cognito resources in the Asia Pacific \\(Seoul\\) AWS Region must use your Amazon SNS configuration in the Asia Pacific \\(Tokyo\\) Region\\. For more information, see [SMS message settings for Amazon Cognito user pools](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `5` \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cognito::UserPool StringAttributeConstraints": { "MaxLength": "The maximum length\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MinLength": "The minimum length\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Cognito::UserPool UserAttributeUpdateSettings": { + "AttributesRequireVerificationBeforeUpdate": "Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute\\. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address\\. Amazon Cognito doesn\u2019t change the value of the attribute until your user responds to the verification message and confirms the new value\\. \nYou can verify an updated email address or phone number with a [VerifyUserAttribute](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html) API request\\. You can also call the [AdminUpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html) API and set `email_verified` or `phone_number_verified` to true\\. \nWhen `AttributesRequireVerificationBeforeUpdate` is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them\\. In a user pool where `AttributesRequireVerificationBeforeUpdate` is false, API operations that change attribute values can immediately update a user\u2019s `email` or `phone_number` attribute\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Cognito::UserPool UserPoolAddOns": { "AdvancedSecurityMode": "The advanced security mode\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AUDIT | ENFORCED | OFF` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cognito::UserPool UsernameConfiguration": { - "CaseSensitive": "Specifies whether username case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs\\. \nValid values include: \n+ ** `True` **: Enables case sensitivity for all username input\\. When this option is set to `True`, users must sign in using the exact capitalization of their given username, such as \u201cUserName\u201d\\. This is the default value\\.\n+ ** `False` **: Enables case insensitivity for all username input\\. For example, when this option is set to `False`, users can sign in using either \"username\" or \"Username\"\\. This option also enables both `preferred_username` and `email` alias to be case insensitive, in addition to the `username` attribute\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CaseSensitive": "Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs\\. For most use cases, set case sensitivity to `False` \\(case insensitive\\) as a best practice\\. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name\\. \nValid values include: \nTrue \nEnables case sensitivity for all username input\\. When this option is set to `True`, users must sign in using the exact capitalization of their given username, such as \u201cUserName\u201d\\. This is the default value\\. \nFalse \nEnables case insensitivity for all username input\\. For example, when this option is set to `False`, users can sign in using `username`, `USERNAME`, or `UserName`\\. This option also enables both `preferred_username` and `email` alias to be case insensitive, in addition to the `username` attribute\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cognito::UserPool VerificationMessageTemplate": { "DefaultEmailOption": "The default email option\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CONFIRM_WITH_CODE | CONFIRM_WITH_LINK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EmailMessage": "The email message template\\. EmailMessage is allowed only if [ EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EmailMessageByLink": "The email message template for sending a confirmation link to the user\\. EmailMessageByLink is allowed only if [ EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{##[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*##\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EmailSubject": "The subject line for the email message template\\. EmailSubject is allowed only if [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EmailSubjectByLink": "The subject line for the email message template for sending a confirmation link to the user\\. EmailSubjectByLink is allowed only [ EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SmsMessage": "The SMS message template\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `140` \n*Pattern*: `.*\\{####\\}.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{##[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*##\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SmsMessage": "The template for SMS messages that Amazon Cognito sends to your users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `140` \n*Pattern*: `.*\\{####\\}.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cognito::UserPoolClient": { - "AccessTokenValidity": "The time limit, after which the access token is no longer valid and cannot be used\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AllowedOAuthFlows": "The allowed OAuth flows\\. \nSet to `code` to initiate a code grant flow, which provides an authorization code as the response\\. This code can be exchanged for access tokens with the token endpoint\\. \nSet to `implicit` to specify that the client should get the access token \\(and, optionally, ID token, based on scopes\\) directly\\. \nSet to `client_credentials` to specify that the client should get the access token \\(and, optionally, ID token, based on scopes\\) from the token endpoint using a combination of client and client\\_secret\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AccessTokenValidity": "The access token time limit\\. After this limit expires, your user can't use their access token\\. To specify the time unit for `AccessTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request\\. \nFor example, when you set `AccessTokenValidity` to `10` and `TokenValidityUnits` to `hours`, your user can authorize access with their access token for 10 hours\\. \nThe default time unit for `AccessTokenValidity` in an API request is hours\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AllowedOAuthFlows": "The allowed OAuth flows\\. \ncode \nUse a code grant flow, which provides an authorization code as the response\\. This code can be exchanged for access tokens with the `/oauth2/token` endpoint\\. \nimplicit \nIssue the access token \\(and, optionally, ID token, based on scopes\\) directly to your user\\. \nclient\\_credentials \nIssue the access token from the `/oauth2/token` endpoint directly to a non\\-person user using a combination of the client ID and client secret\\.\n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AllowedOAuthFlowsUserPoolClient": "Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AllowedOAuthScopes": "The allowed OAuth scopes\\. Possible values provided by OAuth are: `phone`, `email`, `openid`, and `profile`\\. Possible values provided by AWS are: `aws.cognito.signin.user.admin`\\. Custom scopes created in Resource Servers are also supported\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AnalyticsConfiguration": "The Amazon Pinpoint analytics configuration for collecting metrics for this user pool\\. \nIn AWS Regions where isn't available, User Pools only supports sending events to Amazon Pinpoint projects in AWS Region us\\-east\\-1\\. In Regions where is available, User Pools will support sending events to Amazon Pinpoint projects within that same Region\\. \n*Required*: No \n*Type*: [AnalyticsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CallbackURLs": "A list of allowed redirect \\(callback\\) URLs for the identity providers\\. \nA redirect URI must: \n+ Be an absolute URI\\.\n+ Be registered with the authorization server\\.\n+ Not include a fragment component\\.\nSee [OAuth 2\\.0 \\- Redirection Endpoint](https://tools.ietf.org/html/rfc6749#section-3.1.2)\\. \nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only\\. \nApp callback URLs such as myapp://example are also supported\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AllowedOAuthScopes": "The allowed OAuth scopes\\. Possible values provided by OAuth are `phone`, `email`, `openid`, and `profile`\\. Possible values provided by AWS are `aws.cognito.signin.user.admin`\\. Custom scopes created in Resource Servers are also supported\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AnalyticsConfiguration": "The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign\\. \nIn AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us\\-east\\-1\\. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region\\.\n*Required*: No \n*Type*: [AnalyticsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthSessionValidity": "Amazon Cognito creates a session token for each API request in an authentication flow\\. `AuthSessionValidity` is the duration, in minutes, of that session token\\. Your user pool native user must respond to each authentication challenge before the session expires\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `3` \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CallbackURLs": "A list of allowed redirect \\(callback\\) URLs for the IdPs\\. \nA redirect URI must: \n+ Be an absolute URI\\.\n+ Be registered with the authorization server\\.\n+ Not include a fragment component\\.\nSee [OAuth 2\\.0 \\- Redirection Endpoint](https://tools.ietf.org/html/rfc6749#section-3.1.2)\\. \nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only\\. \nApp callback URLs such as myapp://example are also supported\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClientName": "The client name for the user pool client you would like to create\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\w\\s+=,.@-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DefaultRedirectURI": "The default redirect URI\\. Must be in the `CallbackURLs` list\\. \nA redirect URI must: \n+ Be an absolute URI\\.\n+ Be registered with the authorization server\\.\n+ Not include a fragment component\\.\nSee [OAuth 2\\.0 \\- Redirection Endpoint](https://tools.ietf.org/html/rfc6749#section-3.1.2)\\. \nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only\\. \nApp callback URLs such as myapp://example are also supported\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnablePropagateAdditionalUserContextData": "Activates the propagation of additional user context data\\. For more information about propagation of user context data, see [ Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html)\\. If you don\u2019t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security\\. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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)\\. \nIf you don't include this parameter, token revocation is automatically activated for the new user pool client\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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\\. Note that values with `ALLOW_` prefix must be used only along with the `ALLOW_` prefix\\. \nValid values include: \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*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExplicitAuthFlows": "The authentication flows that you want your user pool client to support\\. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password \\(SRP\\), a user name and password, or a custom authentication process that you define with Lambda functions\\. \nIf you don't specify a value for `ExplicitAuthFlows`, your user client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`, and `ALLOW_CUSTOM_AUTH`\\.\nValid values include: \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, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password \\(SRP\\) protocol to securely transmit the password\\.\n+ `ALLOW_CUSTOM_AUTH`: Enable 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\\.\nIn some environments, you will see the values `ADMIN_NO_SRP_AUTH`, `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`\\. You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_`, like `ALLOW_USER_SRP_AUTH`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GenerateSecret": "Boolean to specify whether you want to generate a secret for the user pool client being created\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "IdTokenValidity": "The time limit, after which the ID token is no longer valid and cannot be used\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LogoutURLs": "A list of allowed logout URLs for the identity providers\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IdTokenValidity": "The ID token time limit\\. After this limit expires, your user can't use their ID token\\. To specify the time unit for `IdTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request\\. \nFor example, when you set `IdTokenValidity` as `10` and `TokenValidityUnits` as `hours`, your user can authenticate their session with their ID token for 10 hours\\. \nThe default time unit for `AccessTokenValidity` in an API request is hours\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LogoutURLs": "A list of allowed logout URLs for the IdPs\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PreventUserExistenceErrors": "Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool\\. When set to `ENABLED` and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination\\. When set to `LEGACY`, those APIs will return a `UserNotFoundException` exception if the user does not exist in the user pool\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ENABLED | LEGACY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ReadAttributes": "The read attributes\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RefreshTokenValidity": "The time limit, in days, after which the refresh token is no longer valid and can't be used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `315360000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SupportedIdentityProviders": "A list of provider names for the identity providers that are supported on this client\\. The following are supported: `COGNITO`, `Facebook`, `SignInWithApple`, `Google` and `LoginWithAmazon`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TokenValidityUnits": "The units in which the validity times are represented in\\. Default for RefreshToken is days, and default for ID and access tokens are hours\\. \n*Required*: No \n*Type*: [TokenValidityUnits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RefreshTokenValidity": "The refresh token time limit\\. After this limit expires, your user can't use their refresh token\\. To specify the time unit for `RefreshTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request\\. \nFor example, when you set `RefreshTokenValidity` as `10` and `TokenValidityUnits` as `days`, your user can refresh their session and retrieve new access and ID tokens for 10 days\\. \nThe default time unit for `RefreshTokenValidity` in an API request is days\\. You can't set `RefreshTokenValidity` to 0\\. If you do, Amazon Cognito overrides the value with the default value of 30 days\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SupportedIdentityProviders": "A list of provider names for the identity providers \\(IdPs\\) that are supported on this client\\. The following are supported: `COGNITO`, `Facebook`, `Google`, `SignInWithApple`, and `LoginWithAmazon`\\. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TokenValidityUnits": "The units in which the validity times are represented\\. The default unit for RefreshToken is days, and default for ID and access tokens are hours\\. \n*Required*: No \n*Type*: [TokenValidityUnits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserPoolId": "The user pool ID for the user pool where you want to create a user pool client\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `55` \n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "WriteAttributes": "The user pool attributes that the app client can write to\\. \nIf your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes\\. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider\\. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute\\. For more information, see [Specifying Identity Provider Attribute Mappings for Your User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "WriteAttributes": "The user pool attributes that the app client can write to\\. \nIf your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes\\. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP\\. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute\\. For more information, see [Specifying IdP Attribute Mappings for Your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cognito::UserPoolClient AnalyticsConfiguration": { "ApplicationArn": "The Amazon Resource Name \\(ARN\\) of an Amazon Pinpoint project\\. You can use the Amazon Pinpoint project for integration with the chosen user pool client\\. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ApplicationId": "The application ID for an Amazon Pinpoint application\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[0-9a-fA-F]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExternalId": "The external ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The ARN of an AWS Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UserDataShared": "If `UserDataShared` is `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "UserDataShared": "If `UserDataShared` is `true`, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cognito::UserPoolClient TokenValidityUnits": { - "AccessToken": "A time unit in \u201cseconds\u201d, \u201cminutes\u201d, \u201chours\u201d or \u201cdays\u201d for the value in AccessTokenValidity, defaults to hours\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IdToken": "A time unit in \u201cseconds\u201d, \u201cminutes\u201d, \u201chours\u201d or \u201cdays\u201d for the value in IdTokenValidity, defaults to hours\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RefreshToken": "A time unit in \u201cseconds\u201d, \u201cminutes\u201d, \u201chours\u201d or \u201cdays\u201d for the value in RefreshTokenValidity, defaults to days\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AccessToken": "A time unit of `seconds`, `minutes`, `hours`, or `days` for the value that you set in the `AccessTokenValidity` parameter\\. The default `AccessTokenValidity` time unit is hours\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `days | hours | minutes | seconds` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IdToken": "A time unit of `seconds`, `minutes`, `hours`, or `days` for the value that you set in the `IdTokenValidity` parameter\\. The default `IdTokenValidity` time unit is hours\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `days | hours | minutes | seconds` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RefreshToken": "A time unit of `seconds`, `minutes`, `hours`, or `days` for the value that you set in the `RefreshTokenValidity` parameter\\. The default `RefreshTokenValidity` time unit is days\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `days | hours | minutes | seconds` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cognito::UserPoolDomain": { "CustomDomainConfig": "The configuration for a custom domain that hosts the sign\\-up and sign\\-in pages for your application\\. Use this object to specify an SSL certificate that is managed by ACM\\. \n*Required*: No \n*Type*: [CustomDomainConfigType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpooldomain-customdomainconfigtype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5171,16 +5692,16 @@ "AWS::Cognito::UserPoolGroup": { "Description": "A string containing the description of the group\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GroupName": "The name of the group\\. Must be unique\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Precedence": "A non\\-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool\\. Zero is the highest precedence value\\. Groups with lower `Precedence` values take precedence over groups with higher ornull `Precedence` values\\. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims\\. \nTwo groups can have the same `Precedence` value\\. If this happens, neither group takes precedence over the other\\. If two groups with the same `Precedence` have the same role ARN, that role is used in the `cognito:preferred_role` claim in tokens for users in each group\\. If the two groups have different role ARNs, the `cognito:preferred_role` claim isn't set in users' tokens\\. \nThe default `Precedence` value is null\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Precedence": "A non\\-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool\\. Zero is the highest precedence value\\. Groups with lower `Precedence` values take precedence over groups with higher or null `Precedence` values\\. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims\\. \nTwo groups can have the same `Precedence` value\\. If this happens, neither group takes precedence over the other\\. If two groups with the same `Precedence` have the same role ARN, that role is used in the `cognito:preferred_role` claim in tokens for users in each group\\. If the two groups have different role ARNs, the `cognito:preferred_role` claim isn't set in users' tokens\\. \nThe default `Precedence` value is null\\. The maximum `Precedence` value is `2^31-1`\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The role Amazon Resource Name \\(ARN\\) for the group\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserPoolId": "The user pool ID for the user pool\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `55` \n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Cognito::UserPoolIdentityProvider": { - "AttributeMapping": "A mapping of identity provider attributes to standard and custom user pool attributes\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IdpIdentifiers": "A list of identity provider identifiers\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ProviderDetails": "The identity provider details\\. The following list describes the provider detail keys for each identity provider type\\. \n+ For Google and Login with Amazon:\n + client\\_id\n + client\\_secret\n + authorize\\_scopes\n+ For Facebook:\n + client\\_id\n + client\\_secret\n + authorize\\_scopes\n + api\\_version\n+ For Sign in with Apple:\n + client\\_id\n + team\\_id\n + key\\_id\n + private\\_key\n + authorize\\_scopes\n+ For OpenID Connect \\(OIDC\\) providers:\n + client\\_id\n + client\\_secret\n + attributes\\_request\\_method\n + oidc\\_issuer\n + authorize\\_scopes\n + authorize\\_url *if not available from discovery URL specified by oidc\\_issuer key* \n + token\\_url *if not available from discovery URL specified by oidc\\_issuer key* \n + attributes\\_url *if not available from discovery URL specified by oidc\\_issuer key* \n + jwks\\_uri *if not available from discovery URL specified by oidc\\_issuer key* \n + attributes\\_url\\_add\\_attributes *a read\\-only property that is set automatically* \n+ For SAML providers:\n + MetadataFile OR MetadataURL\n + IDPSignout \\(optional\\)\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ProviderName": "The identity provider name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Pattern*: `[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ProviderType": "The identity provider type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Facebook | Google | LoginWithAmazon | OIDC | SAML | SignInWithApple` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AttributeMapping": "A mapping of IdP attributes to standard and custom user pool attributes\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IdpIdentifiers": "A list of IdP identifiers\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProviderDetails": "The IdP details\\. The following list describes the provider detail keys for each IdP type\\. \n+ For Google and Login with Amazon:\n + client\\_id\n + client\\_secret\n + authorize\\_scopes\n+ For Facebook:\n + client\\_id\n + client\\_secret\n + authorize\\_scopes\n + api\\_version\n+ For Sign in with Apple:\n + client\\_id\n + team\\_id\n + key\\_id\n + private\\_key\n + authorize\\_scopes\n+ For OpenID Connect \\(OIDC\\) providers:\n + client\\_id\n + client\\_secret\n + attributes\\_request\\_method\n + oidc\\_issuer\n + authorize\\_scopes\n + The following keys are only present if Amazon Cognito didn't discover them at the `oidc_issuer` URL\\.\n + authorize\\_url \n + token\\_url \n + attributes\\_url \n + jwks\\_uri \n + Amazon Cognito sets the value of the following keys automatically\\. They are read\\-only\\.\n + attributes\\_url\\_add\\_attributes \n+ For SAML providers:\n + MetadataFile or MetadataURL\n + IDPSignout *optional* \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProviderName": "The IdP name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `32` \n*Pattern*: `[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ProviderType": "The IdP type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Facebook | Google | LoginWithAmazon | OIDC | SAML | SignInWithApple` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "UserPoolId": "The user pool ID\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `55` \n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Cognito::UserPoolResourceServer": { @@ -5201,7 +5722,7 @@ "UserPoolId": "The user pool ID\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `55` \n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Cognito::UserPoolRiskConfigurationAttachment AccountTakeoverActionType": { - "EventAction": "The event action\\. \n+ `BLOCK` Choosing this action will block the request\\.\n+ `MFA_IF_CONFIGURED` Present an MFA challenge if user has configured it, else allow the request\\.\n+ `MFA_REQUIRED` Present an MFA challenge if user has configured it, else block the request\\.\n+ `NO_ACTION` Allow the user to sign in\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `BLOCK | MFA_IF_CONFIGURED | MFA_REQUIRED | NO_ACTION` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventAction": "The action to take in response to the account takeover action\\. Valid values are as follows: \n+ `BLOCK` Choosing this action will block the request\\.\n+ `MFA_IF_CONFIGURED` Present an MFA challenge if user has configured it, else allow the request\\.\n+ `MFA_REQUIRED` Present an MFA challenge if user has configured it, else block the request\\.\n+ `NO_ACTION` Allow the user to sign in\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `BLOCK | MFA_IF_CONFIGURED | MFA_REQUIRED | NO_ACTION` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Notify": "Flag specifying whether to send a notification\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Cognito::UserPoolRiskConfigurationAttachment AccountTakeoverActionsType": { @@ -5272,7 +5793,12 @@ "InputParameters": "A string, in JSON format, that is passed to the AWS Config rule Lambda function\\. \n*Required*: No \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaximumExecutionFrequency": "The maximum frequency with which AWS Config runs evaluations for a rule\\. You can specify a value for `MaximumExecutionFrequency` when: \n+ You are using an AWS managed rule that is triggered at a periodic frequency\\.\n+ Your custom rule is triggered when AWS Config delivers the configuration snapshot\\. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/config/latest/APIReference/API_ConfigSnapshotDeliveryProperties.html)\\.\nBy default, rules with a periodic trigger are evaluated every 24 hours\\. To change the frequency, specify a valid value for the `MaximumExecutionFrequency` parameter\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `One_Hour | Six_Hours | Three_Hours | Twelve_Hours | TwentyFour_Hours` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Scope": "Defines which resources can trigger an evaluation for the rule\\. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value\\. Specify a scope to constrain the resources that can trigger an evaluation for the rule\\. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes\\. \nThe scope can be empty\\. \n*Required*: No \n*Type*: [Scope](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Source": "Provides the rule owner \\(AWS or customer\\), the rule identifier, and the notifications that cause the function to evaluate your AWS resources\\. \n*Required*: Yes \n*Type*: [Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Source": "Provides the rule owner \\(` AWS ` for managed rules, `CUSTOM_POLICY` for Custom Policy rules, and `CUSTOM_LAMBDA` for Custom Lambda rules\\), the rule identifier, and the notifications that cause the function to evaluate your AWS resources\\. \n*Required*: Yes \n*Type*: [Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Config::ConfigRule CustomPolicyDetails": { + "EnableDebugLogDelivery": "The boolean expression for enabling debug logging for your AWS Config Custom Policy rule\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PolicyRuntime": "The runtime system for your AWS Config Custom Policy rule\\. Guard is a policy\\-as\\-code language that allows you to write policies that are enforced by AWS Config Custom Policy rules\\. For more information about Guard, see the [Guard GitHub Repository](https://github.com/aws-cloudformation/cloudformation-guard)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `guard\\-2\\.x\\.x` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PolicyText": "The policy definition containing the logic for your AWS Config Custom Policy rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Config::ConfigRule Scope": { "ComplianceResourceId": "The ID of the only AWS resource that you want to trigger an evaluation for the rule\\. If you specify a resource ID, you must specify one resource type for `ComplianceResourceTypes`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `768` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5281,9 +5807,10 @@ "TagValue": "The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule\\. If you specify a value for `TagValue`, you must also specify a value for `TagKey`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Config::ConfigRule Source": { - "Owner": "Indicates whether AWS or the customer owns and manages the AWS Config rule\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AWS | CUSTOM_LAMBDA` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SourceDetails": "Provides the source and type of the event that causes AWS Config to evaluate your AWS resources\\. \n*Required*: No \n*Type*: List of [SourceDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source-sourcedetails.html) \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SourceIdentifier": "For AWS Config managed rules, a predefined identifier from a list\\. For example, `IAM_PASSWORD_POLICY` is a managed rule\\. To reference a managed rule, see [Using AWS Config managed rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html)\\. \nFor custom rules, the identifier is the Amazon Resource Name \\(ARN\\) of the rule's AWS Lambda function, such as `arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CustomPolicyDetails": "Provides the runtime system, policy definition, and whether debug logging is enabled\\. Required when owner is set to `CUSTOM_POLICY`\\. \n*Required*: No \n*Type*: [CustomPolicyDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-custompolicydetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Owner": "Indicates whether AWS or the customer owns and manages the AWS Config rule\\. \n AWS Config Managed Rules are predefined rules owned by AWS\\. For more information, see [AWS Config Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) in the * AWS Config developer guide*\\. \n AWS Config Custom Rules are rules that you can develop either with Guard \\(`CUSTOM_POLICY`\\) or AWS Lambda \\(`CUSTOM_LAMBDA`\\)\\. For more information, see [AWS Config Custom Rules ](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html) in the * AWS Config developer guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AWS | CUSTOM_LAMBDA | CUSTOM_POLICY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceDetails": "Provides the source and the message types that cause AWS Config to evaluate your AWS resources against a rule\\. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic\\. \nIf the owner is set to `CUSTOM_POLICY`, the only acceptable values for the AWS Config rule trigger message type are `ConfigurationItemChangeNotification` and `OversizedConfigurationItemChangeNotification`\\. \n*Required*: No \n*Type*: List of [SourceDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source-sourcedetails.html) \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceIdentifier": "For AWS Config Managed rules, a predefined identifier from a list\\. For example, `IAM_PASSWORD_POLICY` is a managed rule\\. To reference a managed rule, see [List of AWS Config Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html)\\. \nFor AWS Config Custom Lambda rules, the identifier is the Amazon Resource Name \\(ARN\\) of the rule's AWS Lambda function, such as `arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name`\\. \nFor AWS Config Custom Policy rules, this field will be ignored\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Config::ConfigRule SourceDetail": { "EventSource": "The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `aws.config` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5322,46 +5849,51 @@ "DeliveryS3Bucket": "The name of the Amazon S3 bucket where AWS Config stores conformance pack templates\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DeliveryS3KeyPrefix": "The prefix for the Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TemplateBody": "A string containing full conformance pack template body\\. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes\\. \nYou can only use a YAML template with two resource types: config rule \\(`AWS::Config::ConfigRule`\\) and a remediation action \\(`AWS::Config::RemediationConfiguration`\\)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TemplateS3Uri": "Location of file containing the template body \\(s3://bucketname/prefix\\)\\. The uri must point to the conformance pack template \\(max size: 300 KB\\) that is located in an Amazon S3 bucket\\. \nYou must have access to read Amazon S3 bucket\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TemplateS3Uri": "Location of file containing the template body \\(s3://bucketname/prefix\\)\\. The uri must point to the conformance pack template \\(max size: 300 KB\\) that is located in an Amazon S3 bucket\\. \nYou must have access to read Amazon S3 bucket\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TemplateSSMDocumentDetails": "Property description not available\\. \n*Required*: No \n*Type*: [TemplateSSMDocumentDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Config::ConformancePack ConformancePackInputParameter": { "ParameterName": "One part of a key\\-value pair\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ParameterValue": "Another part of the key\\-value pair\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Config::ConformancePack TemplateSSMDocumentDetails": { + "DocumentName": "The name or Amazon Resource Name \\(ARN\\) of the SSM document to use to create a conformance pack\\. If you use the document name, AWS Config checks only your account and AWS Region for the SSM document\\. If you want to use an SSM document from another Region or account, you must provide the ARN\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,200}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DocumentVersion": "The version of the SSM document to use to create a conformance pack\\. By default, AWS Config uses the latest version\\. \nThis field is optional\\.\n*Required*: No \n*Type*: String \n*Pattern*: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Config::DeliveryChannel": { "ConfigSnapshotDeliveryProperties": "The options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket\\. \n*Required*: No \n*Type*: [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-deliverychannel-configsnapshotdeliveryproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A name for the delivery channel\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the delivery channel name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nUpdates are not supported\\. To change the name, you must run two separate updates\\. In the first update, delete this resource, and then recreate it with a new name in the second update\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "S3BucketName": "The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files\\. \nIf you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config\\. For more information, see [Permissions for the Amazon S3 Bucket](https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html) in the AWS Config Developer Guide\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3KeyPrefix": "The prefix for the specified Amazon S3 bucket\\. Do not include 'AWSLogs/' in your value as it is prepended automatically\\. Ex: BucketName/S3KeyPrefix/AWSLogs/sourceAccountID/Config/Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3BucketName": "The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files\\. \nIf you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config\\. For more information, see [Permissions for the Amazon S3 Bucket](https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html) in the * AWS Config Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3KeyPrefix": "The prefix for the specified Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3KmsKeyArn": "The Amazon Resource Name \\(ARN\\) of the AWS Key Management Service \\(AWS KMS \\) AWS KMS key \\(KMS key\\) used to encrypt objects delivered by AWS Config\\. Must belong to the same Region as the destination S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SnsTopicARN": "The Amazon Resource Name \\(ARN\\) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes\\. \nIf you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config\\. For more information, see [Permissions for the Amazon SNS Topic](https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html) in the AWS Config Developer Guide\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SnsTopicARN": "The Amazon Resource Name \\(ARN\\) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes\\. \nIf you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config\\. For more information, see [Permissions for the Amazon SNS Topic](https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html) in the * AWS Config Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Config::DeliveryChannel ConfigSnapshotDeliveryProperties": { "DeliveryFrequency": "The frequency with which AWS Config delivers configuration snapshots\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `One_Hour | Six_Hours | Three_Hours | Twelve_Hours | TwentyFour_Hours` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Config::OrganizationConfigRule": { - "ExcludedAccounts": "A comma\\-separated list of accounts excluded from organization config rule\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OrganizationConfigRuleName": "The name that you assign to organization config rule\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "OrganizationCustomCodeRuleMetadata": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [OrganizationCustomCodeRuleMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomcoderulemetadata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExcludedAccounts": "A comma\\-separated list of accounts excluded from organization AWS Config rule\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OrganizationConfigRuleName": "The name that you assign to organization AWS Config rule\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "OrganizationCustomPolicyRuleMetadata": "An object that specifies metadata for your organization's AWS Config Custom Policy rule\\. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of AWS resource, and organization trigger types that initiate AWS Config to evaluate AWS resources against a rule\\. \n*Required*: No \n*Type*: [OrganizationCustomPolicyRuleMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OrganizationCustomRuleMetadata": "An `OrganizationCustomRuleMetadata` object\\. \n*Required*: No \n*Type*: [OrganizationCustomRuleMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OrganizationManagedRuleMetadata": "An `OrganizationManagedRuleMetadata` object\\. \n*Required*: No \n*Type*: [OrganizationManagedRuleMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, - "AWS::Config::OrganizationConfigRule OrganizationCustomCodeRuleMetadata": { - "CodeText": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DebugLogDeliveryAccounts": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InputParameters": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaximumExecutionFrequency": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OrganizationConfigRuleTriggerTypes": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResourceIdScope": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResourceTypesScope": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Runtime": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TagKeyScope": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TagValueScope": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AWS::Config::OrganizationConfigRule OrganizationCustomPolicyRuleMetadata": { + "DebugLogDeliveryAccounts": "A list of accounts that you can enable debug logging for your organization AWS Config Custom Policy rule\\. List is null when debug logging is enabled for all accounts\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description that you provide for your organization AWS Config Custom Policy rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InputParameters": "A string, in JSON format, that is passed to your organization AWS Config Custom Policy rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumExecutionFrequency": "The maximum frequency with which AWS Config runs evaluations for a rule\\. Your AWS Config Custom Policy rule is triggered when AWS Config delivers the configuration snapshot\\. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-configsnapshotdeliveryproperties)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `One_Hour | Six_Hours | Three_Hours | Twelve_Hours | TwentyFour_Hours` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OrganizationConfigRuleTriggerTypes": "The type of notification that initiates AWS Config to run an evaluation for a rule\\. For AWS Config Custom Policy rules, AWS Config supports change\\-initiated notification types: \n+ `ConfigurationItemChangeNotification` \\- Initiates an evaluation when AWS Config delivers a configuration item as a result of a resource change\\.\n+ `OversizedConfigurationItemChangeNotification` \\- Initiates an evaluation when AWS Config delivers an oversized configuration item\\. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PolicyText": "The policy definition containing the logic for your organization AWS Config Custom Policy rule\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceIdScope": "The ID of the AWS resource that was evaluated\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `768` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceTypesScope": "The type of the AWS resource that was evaluated\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Runtime": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TagKeyScope": "One part of a key\\-value pair that make up a tag\\. A key is a general label that acts like a category for more specific tag values\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TagValueScope": "The optional part of a key\\-value pair that make up a tag\\. A value acts as a descriptor within a tag category \\(key\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Config::OrganizationConfigRule OrganizationCustomRuleMetadata": { - "Description": "The description that you provide for organization config rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InputParameters": "A string, in JSON format, that is passed to organization config rule Lambda function\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description that you provide for your organization AWS Config rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InputParameters": "A string, in JSON format, that is passed to your organization AWS Config rule Lambda function\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LambdaFunctionArn": "The lambda function ARN\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaximumExecutionFrequency": "The maximum frequency with which AWS Config runs evaluations for a rule\\. Your custom rule is triggered when AWS Config delivers the configuration snapshot\\. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-configsnapshotdeliveryproperties)\\. \nBy default, rules with a periodic trigger are evaluated every 24 hours\\. To change the frequency, specify a valid value for the `MaximumExecutionFrequency` parameter\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `One_Hour | Six_Hours | Three_Hours | Twelve_Hours | TwentyFour_Hours` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OrganizationConfigRuleTriggerTypes": "The type of notification that triggers AWS Config to run an evaluation for a rule\\. You can specify the following notification types: \n+ `ConfigurationItemChangeNotification` \\- Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change\\.\n+ `OversizedConfigurationItemChangeNotification` \\- Triggers an evaluation when AWS Config delivers an oversized configuration item\\. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS\\.\n+ `ScheduledNotification` \\- Triggers a periodic evaluation at the frequency specified for `MaximumExecutionFrequency`\\.\n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5371,9 +5903,9 @@ "TagValueScope": "The optional part of a key\\-value pair that make up a tag\\. A value acts as a descriptor within a tag category \\(key\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Config::OrganizationConfigRule OrganizationManagedRuleMetadata": { - "Description": "The description that you provide for organization config rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InputParameters": "A string, in JSON format, that is passed to organization config rule Lambda function\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaximumExecutionFrequency": "The maximum frequency with which AWS Config runs evaluations for a rule\\. You are using an AWS Config managed rule that is triggered at a periodic frequency\\. \nBy default, rules with a periodic trigger are evaluated every 24 hours\\. To change the frequency, specify a valid value for the `MaximumExecutionFrequency` parameter\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `One_Hour | Six_Hours | Three_Hours | Twelve_Hours | TwentyFour_Hours` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description that you provide for your organization AWS Config rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InputParameters": "A string, in JSON format, that is passed to your organization AWS Config rule Lambda function\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumExecutionFrequency": "The maximum frequency with which AWS Config runs evaluations for a rule\\. This is for an AWS Config managed rule that is triggered at a periodic frequency\\. \nBy default, rules with a periodic trigger are evaluated every 24 hours\\. To change the frequency, specify a valid value for the `MaximumExecutionFrequency` parameter\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `One_Hour | Six_Hours | Three_Hours | Twelve_Hours | TwentyFour_Hours` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResourceIdScope": "The ID of the AWS resource that was evaluated\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `768` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResourceTypesScope": "The type of the AWS resource that was evaluated\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RuleIdentifier": "For organization config managed rules, a predefined identifier from a list\\. For example, `IAM_PASSWORD_POLICY` is a managed rule\\. To reference a managed rule, see [Using AWS Config managed rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5398,7 +5930,7 @@ "ConfigRuleName": "The name of the AWS Config rule\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ExecutionControls": "An ExecutionControls object\\. \n*Required*: No \n*Type*: [ExecutionControls](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-remediationconfiguration-executioncontrols.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaximumAutomaticAttempts": "The maximum number of failed attempts for auto\\-remediation\\. If you do not select a number, the default is 5\\. \nFor example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, AWS Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Parameters": "An object of the RemediationParameterValue\\. \nThe type is a map of strings to RemediationParameterValue\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Parameters": "An object of the RemediationParameterValue\\. For more information, see [RemediationParameterValue](https://docs.aws.amazon.com/config/latest/APIReference/API_RemediationParameterValue.html)\\. \nThe type is a map of strings to RemediationParameterValue\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResourceType": "The type of a resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RetryAttemptSeconds": "Maximum time in seconds that AWS Config runs auto\\-remediation\\. If you do not select a number, the default is 60 seconds\\. \nFor example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, AWS Config will run auto\\-remediations 5 times within 50 seconds before throwing an exception\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TargetId": "Target ID is the name of the public document\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5428,21 +5960,25 @@ "QueryName": "The name of the query\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9-_]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Connect::ApprovedOrigin": { + "InstanceId": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Minimum*: `1` \n*Maximum*: `100` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Origin": "Domain name to be added to the allow\\-list of the instance\\. \n*Maximum*: `267` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::Connect::ContactFlow": { - "Content": "The content of the contact flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "The description of the contact flow\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Content": "The content of the flow\\. \nFor more information, see [Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html) in the *Amazon Connect Administrator Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the flow\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InstanceArn": "The Amazon Resource Name \\(ARN\\) of the Amazon Connect instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the contact flow\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "State": "The state of the contact flow\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | ARCHIVED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the flow\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "State": "The state of the flow\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | ARCHIVED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Type": "The type of the contact flow\\. For descriptions of the available types, see [Choose a Contact Flow Type](https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) in the *Amazon Connect Administrator Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AGENT_HOLD | AGENT_TRANSFER | AGENT_WHISPER | CONTACT_FLOW | CUSTOMER_HOLD | CUSTOMER_QUEUE | CUSTOMER_WHISPER | OUTBOUND_WHISPER | QUEUE_TRANSFER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Type": "The type of the flow\\. For descriptions of the available types, see [Choose a flow type](https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) in the *Amazon Connect Administrator Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AGENT_HOLD | AGENT_TRANSFER | AGENT_WHISPER | CONTACT_FLOW | CUSTOMER_HOLD | CUSTOMER_QUEUE | CUSTOMER_WHISPER | OUTBOUND_WHISPER | QUEUE_TRANSFER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Connect::ContactFlowModule": { - "Content": "The content of the contact flow module\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "The description of the contact flow module\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Content": "The content of the flow module\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the flow module\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InstanceArn": "The Amazon Resource Name \\(ARN\\) of the Amazon Connect instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the contact flow module\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `127` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "State": "The state of the contact flow module\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | ARCHIVED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the flow module\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `127` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "State": "The state of the flow module\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | ARCHIVED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Connect::HoursOfOperation": { @@ -5450,7 +5986,7 @@ "Description": "The description for the hours of operation\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `250` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InstanceArn": "The Amazon Resource Name \\(ARN\\) for the instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name for the hours of operation\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `127` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "The tags used to organize, track, or control access for this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TimeZone": "The time zone for the hours of operation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Connect::HoursOfOperation HoursOfOperationConfig": { @@ -5462,18 +5998,75 @@ "Hours": "The hours\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `23` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Minutes": "The minutes\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `59` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Connect::Instance": { + "Attributes": "A toggle for an individual feature at the instance level\\. \n*Required*: Yes \n*Type*: [Attributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instance-attributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DirectoryId": "The identifier for the directory\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IdentityManagementType": "The identity management type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONNECT_MANAGED | EXISTING_DIRECTORY | SAML` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InstanceAlias": "The alias of instance\\. `InstanceAlias` is only required when `IdentityManagementType` is `CONNECT_MANAGED` or `SAML`\\. `InstanceAlias` is not required when `IdentityManagementType` is `EXISTING_DIRECTORY`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `62` \n*Pattern*: `^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Connect::Instance Attributes": { + "AutoResolveBestVoices": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContactLens": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContactflowLogs": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EarlyMedia": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InboundCalls": "*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OutboundCalls": "*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseCustomTTSVoices": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::InstanceStorageConfig": { + "InstanceArn": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "KinesisFirehoseConfig": "The configuration of the Kinesis Firehose delivery stream\\. \n*Required*: No \n*Type*: [KinesisFirehoseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisfirehoseconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KinesisStreamConfig": "The configuration of the Kinesis data stream\\. \n*Required*: No \n*Type*: [KinesisStreamConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisstreamconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KinesisVideoStreamConfig": "The configuration of the Kinesis video stream\\. \n*Required*: No \n*Type*: [KinesisVideoStreamConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisvideostreamconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceType": "A valid resource type\\. Following are the valid resource types: `CHAT_TRANSCRIPTS` \\| `CALL_RECORDINGS` \\| `SCHEDULED_REPORTS` \\| `MEDIA_STREAMS` \\| `CONTACT_TRACE_RECORDS` \\| `AGENT_EVENTS` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "S3Config": "The S3 bucket configuration\\. \n*Required*: No \n*Type*: [S3Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-s3config.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StorageType": "A valid storage type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KINESIS_FIREHOSE | KINESIS_STREAM | KINESIS_VIDEO_STREAM | S3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::InstanceStorageConfig EncryptionConfig": { + "EncryptionType": "The type of encryption\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KeyId": "The full ARN of the encryption key\\. \nBe sure to provide the full ARN of the encryption key, not just the ID\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::InstanceStorageConfig KinesisFirehoseConfig": { + "FirehoseArn": "The Amazon Resource Name \\(ARN\\) of the delivery stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::InstanceStorageConfig KinesisStreamConfig": { + "StreamArn": "The Amazon Resource Name \\(ARN\\) of the data stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::InstanceStorageConfig KinesisVideoStreamConfig": { + "EncryptionConfig": "The encryption configuration\\. \n*Required*: No \n*Type*: [EncryptionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-encryptionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Prefix": "The prefix of the video stream\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RetentionPeriodHours": "The number of hours data is retained in the stream\\. Kinesis Video Streams retains the data in a data store that is associated with the stream\\. \nThe default value is 0, indicating that the stream does not persist data\\. \n*Required*: Yes \n*Type*: Double \n*Minimum*: `0` \n*Maximum*: `87600` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::InstanceStorageConfig S3Config": { + "BucketName": "The S3 bucket name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BucketPrefix": "The S3 bucket prefix\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EncryptionConfig": "The Amazon S3 encryption configuration\\. \n*Required*: No \n*Type*: [EncryptionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-encryptionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::IntegrationAssociation": { + "InstanceId": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Minimum*: `1` \n*Maximum*: `100` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IntegrationArn": "ARN of the integration being associated with the instance\\. \n*Minimum*: `1` \n*Maximum*: `140` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IntegrationType": "Specifies the integration type to be associated with the instance\\. \n*Allowed Values*: `LEX_BOT` \\| `LAMBDA_FUNCTION` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Connect::PhoneNumber": { + "CountryCode": "The ISO country code\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AD | AE | AF | AG | AI | AL | AM | AN | AO | AQ | AR | AS | AT | AU | AW | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BR | BS | BT | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GG | GH | GI | GL | GM | GN | GQ | GR | GT | GU | GW | GY | HK | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | ST | SV | SX | SY | SZ | TC | TD | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Description": "The description of the phone number\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `^[\\W\\S_]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Prefix": "The prefix of the phone number\\. If provided, it must contain `+` as part of the country code\\. \n*Pattern*: `^\\\\+[0-9]{1,15}` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetArn": "The Amazon Resource Name \\(ARN\\) for Amazon Connect instances or traffic distribution group that phone numbers are claimed to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of phone number\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DID | TOLL_FREE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::Connect::QuickConnect": { "Description": "The description of the quick connect\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `250` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InstanceArn": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the quick connect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `127` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "QuickConnectConfig": "Contains information about the quick connect\\. \n*Required*: Yes \n*Type*: [QuickConnectConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-quickconnectconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "The tags used to organize, track, or control access for this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Tags": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Connect::QuickConnect PhoneNumberQuickConnectConfig": { - "PhoneNumber": "The phone number in E\\.164 format\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "PhoneNumber": "The phone number in E\\.164 format\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\\\+[1-9]\\\\d{1,14}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Connect::QuickConnect QueueQuickConnectConfig": { - "ContactFlowArn": "The Amazon Resource Name \\(ARN\\) of the contact flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContactFlowArn": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "QueueArn": "The Amazon Resource Name \\(ARN\\) of the queue\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Connect::QuickConnect QuickConnectConfig": { @@ -5483,9 +6076,95 @@ "UserConfig": "The user configuration\\. This is required only if QuickConnectType is USER\\. \n*Required*: No \n*Type*: [UserQuickConnectConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-userquickconnectconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Connect::QuickConnect UserQuickConnectConfig": { - "ContactFlowArn": "The Amazon Resource Name \\(ARN\\) of the contact flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContactFlowArn": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserArn": "The Amazon Resource Name \\(ARN\\) of the user\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Connect::Rule": { + "Actions": "A list of actions to be run when the rule is triggered\\. \n*Required*: Yes \n*Type*: [Actions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-actions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Function": "The conditions of the rule\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InstanceArn": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the rule\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PublishStatus": "The publish status of the rule\\. \n*Allowed values*: `DRAFT` \\| `PUBLISHED` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TriggerEventSource": "The event source to trigger the rule\\. \n*Required*: Yes \n*Type*: [RuleTriggerEventSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-ruletriggereventsource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Connect::Rule Actions": { + "AssignContactCategoryActions": "Information about the contact category action\\. The syntax can be empty, for example, `{}`\\. \n*Required*: No \n*Type*: List of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventBridgeActions": "Information about the EventBridge action\\. \n*Required*: No \n*Type*: List of [EventBridgeAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-eventbridgeaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SendNotificationActions": "Information about the send notification action\\. \n*Required*: No \n*Type*: List of [SendNotificationAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-sendnotificationaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TaskActions": "Information about the task action\\. This field is required if `TriggerEventSource` is one of the following values: `OnZendeskTicketCreate` \\| `OnZendeskTicketStatusUpdate` \\| `OnSalesforceCaseCreate` \n*Required*: No \n*Type*: List of [TaskAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-taskaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::Rule EventBridgeAction": { + "Name": "The name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::Rule NotificationRecipientType": { + "UserArns": "The Amazon Resource Name \\(ARN\\) of the user account\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UserTags": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. Amazon Connect users with the specified tags will be notified\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::Rule Reference": { + "Type": "The type of the reference\\. `DATE` must be of type Epoch timestamp\\. \n*Allowed values*: `URL` \\| `ATTACHMENT` \\| `NUMBER` \\| `STRING` \\| `DATE` \\| `EMAIL` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "A valid value for the reference\\. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel \\(CCP\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::Rule RuleTriggerEventSource": { + "EventSourceName": "The name of the event source\\. \n*Allowed values*: `OnPostCallAnalysisAvailable` \\| `OnRealTimeCallAnalysisAvailable` \\| `OnPostChatAnalysisAvailable` \\| `OnZendeskTicketCreate` \\| `OnZendeskTicketStatusUpdate` \\| `OnSalesforceCaseCreate` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IntegrationAssociationArn": "The Amazon Resource Name \\(ARN\\) for the integration association\\. `IntegrationAssociationArn` is required if `TriggerEventSource` is one of the following values: `OnZendeskTicketCreate` \\| `OnZendeskTicketStatusUpdate` \\| `OnSalesforceCaseCreate` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Connect::Rule SendNotificationAction": { + "Content": "Notification content\\. Supports variable injection\\. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContentType": "Content type format\\. \n*Allowed value*: `PLAIN_TEXT` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeliveryMethod": "Notification delivery method\\. \n*Allowed value*: `EMAIL` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Recipient": "Notification recipient\\. \n*Required*: Yes \n*Type*: [NotificationRecipientType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-notificationrecipienttype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Subject": "The subject of the email if the delivery method is `EMAIL`\\. Supports variable injection\\. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::Rule TaskAction": { + "ContactFlowArn": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description\\. Supports variable injection\\. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name\\. Supports variable injection\\. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "References": "Information about the reference when the `referenceType` is `URL`\\. Otherwise, null\\. `URL` is the only accepted type\\. \\(Supports variable injection in the `Value` field\\.\\) \n*Required*: No \n*Type*: Map of [Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-reference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::SecurityKey": { + "InstanceId": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Minimum*: `1` \n*Maximum*: `100` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Key": "A valid security key in PEM format\\. \n*Minimum*: `1` \n*Maximum*: `1024` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Connect::TaskTemplate": { + "ClientToken": "A unique, case\\-sensitive identifier that you provide to ensure the idempotency of the request\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Constraints": "Constraints that are applicable to the fields listed\\. \nThe values can be represented in either JSON or YAML format\\. For an example of the JSON configuration, see *Examples* at the bottom of this page\\. \n*Required*: No \n*Type*: [Constraints](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-constraints.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContactFlowArn": "The Amazon Resource Name \\(ARN\\) of the flow that runs by default when a task is created by referencing this template\\. `ContactFlowArn` is not required when there is a field with `fieldType` = `QUICK_CONNECT`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Defaults": "The default values for fields when a task is created by referencing this template\\. \n*Required*: No \n*Type*: List of [DefaultFieldValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-defaultfieldvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the task template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Fields": "Fields that are part of the template\\. A template requires at least one field that has type `Name`\\. \n*Required*: No \n*Type*: List of [Field](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-field.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InstanceArn": "The Amazon Resource Name \\(ARN\\) of the Amazon Connect instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the task template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "The status of the task template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The tags used to organize, track, or control access for this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::TaskTemplate Constraints": { + "InvisibleFields": "Property description not available\\. \n*Required*: No \n*Type*: List of [InvisibleFieldInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-invisiblefieldinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReadOnlyFields": "Property description not available\\. \n*Required*: No \n*Type*: List of [ReadOnlyFieldInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-readonlyfieldinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RequiredFields": "Property description not available\\. \n*Required*: No \n*Type*: List of [RequiredFieldInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-requiredfieldinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::TaskTemplate DefaultFieldValue": { + "DefaultValue": "Default value for the field\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Id": "Identifier of a field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::TaskTemplate Field": { + "Description": "The description of the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Id": "The unique identifier for the field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SingleSelectOptions": "A list of options for a single select field\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "Indicates the type of field\\. Following are the valid field types: `NAME` `DESCRIPTION` \\| `SCHEDULED_TIME` \\| `QUICK_CONNECT` \\| `URL` \\| `NUMBER` \\| `TEXT` \\| `TEXT_AREA` \\| `DATE_TIME` \\| `BOOLEAN` \\| `SINGLE_SELECT` \\| `EMAIL` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::TaskTemplate FieldIdentifier": { + "Name": "The name of the task template field\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::TaskTemplate InvisibleFieldInfo": { + "Id": "Identifier of the invisible field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::TaskTemplate ReadOnlyFieldInfo": { + "Id": "Identifier of the read\\-only field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Connect::TaskTemplate RequiredFieldInfo": { + "Id": "The unique identifier for the field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Connect::User": { "DirectoryUserId": "The identifier of the user account in the directory used for identity management\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HierarchyGroupArn": "The Amazon Resource Name \\(ARN\\) of the user's hierarchy group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5501,12 +6180,14 @@ "AWS::Connect::User UserIdentityInfo": { "Email": "The email address\\. If you are using SAML for identity management and include this parameter, an error is returned\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FirstName": "The first name\\. This is required if you are using Amazon Connect or SAML for identity management\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LastName": "The last name\\. This is required if you are using Amazon Connect or SAML for identity management\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "LastName": "The last name\\. This is required if you are using Amazon Connect or SAML for identity management\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Mobile": "The user's mobile number\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\\\+[1-9]\\\\d{1,14}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecondaryEmail": "The user's secondary email address\\. If you provide a secondary email, the user receives email notifications \\-\\- other than password reset notifications \\-\\- to this email address instead of to their primary email address\\. \n*Pattern*: `(?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Connect::User UserPhoneConfig": { - "AfterContactWorkTimeLimit": "The After Call Work \\(ACW\\) timeout setting, in seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AfterContactWorkTimeLimit": "The After Call Work \\(ACW\\) timeout setting, in seconds\\. \nWhen returned by a `SearchUsers` call, `AfterContactWorkTimeLimit` is returned in milliseconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AutoAccept": "The Auto accept setting\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeskPhoneNumber": "The phone number for the user's desk phone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeskPhoneNumber": "The phone number for the user's desk phone\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\\\+[1-9]\\\\d{1,14}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PhoneType": "The phone type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DESK_PHONE | SOFT_PHONE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Connect::UserHierarchyGroup": { @@ -5514,6 +6195,36 @@ "Name": "The name of the user hierarchy group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ParentGroupArn": "The Amazon Resource Name \\(ARN\\) of the parent group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::ConnectCampaigns::Campaign": { + "ConnectInstanceArn": "The Amazon Resource Name \\(ARN\\) of the Amazon Connect instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DialerConfig": "Contains information about the dialer configuration\\. \n*Required*: Yes \n*Type*: [DialerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-dialerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the campaign\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OutboundCallConfig": "Contains information about the outbound call configuration\\. \n*Required*: Yes \n*Type*: [OutboundCallConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-outboundcallconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ConnectCampaigns::Campaign AnswerMachineDetectionConfig": { + "EnableAnswerMachineDetection": "Whether answering machine detection is enabled\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ConnectCampaigns::Campaign DialerConfig": { + "PredictiveDialerConfig": "The configuration of the predictive dialer\\. \n*Required*: No \n*Type*: [PredictiveDialerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-predictivedialerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProgressiveDialerConfig": "The configuration of the progressive dialer\\. \n*Required*: No \n*Type*: [ProgressiveDialerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-progressivedialerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ConnectCampaigns::Campaign OutboundCallConfig": { + "AnswerMachineDetectionConfig": "Whether answering machine detection has been enabled\\. \n*Required*: No \n*Type*: [AnswerMachineDetectionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-answermachinedetectionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectContactFlowArn": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectQueueArn": "The Amazon Resource Name \\(ARN\\) of the queue\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectSourcePhoneNumber": "The phone number associated with the outbound call\\. This is the caller ID that is displayed to customers when an agent calls them\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ConnectCampaigns::Campaign PredictiveDialerConfig": { + "BandwidthAllocation": "Bandwidth allocation for the predictive dialer\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ConnectCampaigns::Campaign ProgressiveDialerConfig": { + "BandwidthAllocation": "Bandwidth allocation for the progressive dialer\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ControlTower::EnabledControl": { + "ControlIdentifier": "The ARN of the control\\. Only **Strongly recommended** and **Elective** controls are permitted, with the exception of the **Region deny** guardrail\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TargetIdentifier": "The ARN of the organizational unit\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::CustomerProfiles::Domain": { "DeadLetterQueueUrl": "The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications\\. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DefaultEncryptionKey": "The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified\\. It is used to encrypt all data before it is placed in permanent or semi\\-permanent storage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5523,91 +6234,91 @@ }, "AWS::CustomerProfiles::Integration": { "DomainName": "The unique name of the domain\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "FlowDefinition": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [FlowDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FlowDefinition": "The configuration that controls how Customer Profiles retrieves data from the source\\. \n*Required*: No \n*Type*: [FlowDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ObjectTypeName": "The name of the profile object type mapping to use\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ObjectTypeNames": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [ObjectTypeMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ObjectTypeNames": "The object type mapping\\. \n*Required*: No \n*Type*: List of [ObjectTypeMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags used to organize, track, or control access for this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Uri": "The URI of the S3 bucket or any other type of data source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::CustomerProfiles::Integration ConnectorOperator": { - "Marketo": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Salesforce": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServiceNow": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Zendesk": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Marketo": "The operation to be performed on the provided Marketo source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | DIVISION | GREATER_THAN | LESS_THAN | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3": "The operation to be performed on the provided Amazon S3 source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Salesforce": "The operation to be performed on the provided Salesforce source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServiceNow": "The operation to be performed on the provided ServiceNow source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Zendesk": "The operation to be performed on the provided Zendesk source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | DIVISION | GREATER_THAN | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration FlowDefinition": { - "Description": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FlowName": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KmsArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SourceFlowConfig": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [SourceFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tasks": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: List of [Task](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TriggerConfig": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [TriggerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Description": "A description of the flow you want to create\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `[\\w!@#\\-.?,\\s]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FlowName": "The specified name of the flow\\. Use underscores \\(\\_\\) or hyphens \\(\\-\\) only\\. Spaces are not allowed\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9][\\w!@#.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsArn": "The Amazon Resource Name \\(ARN\\) of the AWS Key Management Service \\(KMS\\) key you provide for encryption\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:aws:kms:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceFlowConfig": "The configuration that controls how Customer Profiles retrieves data from the source\\. \n*Required*: Yes \n*Type*: [SourceFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tasks": "A list of tasks that Customer Profiles performs while transferring the data in the flow run\\. \n*Required*: Yes \n*Type*: List of [Task](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TriggerConfig": "The trigger settings that determine how and when the flow runs\\. \n*Required*: Yes \n*Type*: [TriggerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration IncrementalPullConfig": { - "DatetimeTypeFieldName": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DatetimeTypeFieldName": "A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration MarketoSourceProperties": { - "Object": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Object": "The object specified in the Marketo flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration ObjectTypeMapping": { - "Key": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Value": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Key": "The key\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration S3SourceProperties": { - "BucketName": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "BucketPrefix": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "BucketName": "The Amazon S3 bucket name where the source files are stored\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BucketPrefix": "The object key for the Amazon S3 bucket in which the source files are stored\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration SalesforceSourceProperties": { - "EnableDynamicFieldUpdate": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IncludeDeletedRecords": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Object": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "EnableDynamicFieldUpdate": "The flag that enables dynamic fetching of new \\(recently added\\) fields in the Salesforce objects while running a flow\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeDeletedRecords": "Indicates whether Amazon AppFlow includes deleted files in the flow run\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Object": "The object specified in the Salesforce flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration ScheduledTriggerProperties": { - "DataPullMode": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FirstExecutionFrom": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ScheduleEndTime": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ScheduleExpression": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ScheduleOffset": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ScheduleStartTime": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Timezone": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DataPullMode": "Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Complete | Incremental` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FirstExecutionFrom": "Specifies the date range for the records to import from the connector in the first flow run\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ScheduleEndTime": "Specifies the scheduled end time for a scheduled\\-trigger flow\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ScheduleExpression": "The scheduling expression that determines the rate at which the schedule will run, for example rate \\(5 minutes\\)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ScheduleOffset": "Specifies the optional offset that is added to the time interval for a schedule\\-triggered flow\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ScheduleStartTime": "Specifies the scheduled start time for a scheduled\\-trigger flow\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Timezone": "Specifies the time zone used when referring to the date and time of a scheduled\\-triggered flow, such as America/New\\_York\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration ServiceNowSourceProperties": { - "Object": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Object": "The object specified in the ServiceNow flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration SourceConnectorProperties": { - "Marketo": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [MarketoSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-marketosourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [S3SourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Salesforce": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SalesforceSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServiceNow": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ServiceNowSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-servicenowsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Zendesk": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ZendeskSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-zendesksourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Marketo": "The properties that are applied when Marketo is being used as a source\\. \n*Required*: No \n*Type*: [MarketoSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-marketosourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3": "The properties that are applied when Amazon S3 is being used as the flow source\\. \n*Required*: No \n*Type*: [S3SourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Salesforce": "The properties that are applied when Salesforce is being used as a source\\. \n*Required*: No \n*Type*: [SalesforceSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServiceNow": "The properties that are applied when ServiceNow is being used as a source\\. \n*Required*: No \n*Type*: [ServiceNowSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-servicenowsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Zendesk": "The properties that are applied when using Zendesk as a flow source\\. \n*Required*: No \n*Type*: [ZendeskSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-zendesksourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration SourceFlowConfig": { - "ConnectorProfileName": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ConnectorType": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IncrementalPullConfig": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [IncrementalPullConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-incrementalpullconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SourceConnectorProperties": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [SourceConnectorProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ConnectorProfileName": "The name of the Amazon AppFlow connector profile\\. This name must be unique for each connector profile in the AWS account\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[\\w/!@#+=.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectorType": "The type of connector, such as Salesforce, Marketo, and so on\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Marketo | S3 | Salesforce | Servicenow | Zendesk` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncrementalPullConfig": "Defines the configuration for a scheduled incremental data pull\\. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull\\. \n*Required*: No \n*Type*: [IncrementalPullConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-incrementalpullconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceConnectorProperties": "Specifies the information that is required to query a particular source connector\\. \n*Required*: Yes \n*Type*: [SourceConnectorProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration Task": { - "ConnectorOperator": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ConnectorOperator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DestinationField": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SourceFields": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TaskProperties": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [TaskPropertiesMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TaskType": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ConnectorOperator": "The operation to be performed on the provided source fields\\. \n*Required*: No \n*Type*: [ConnectorOperator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DestinationField": "A field in a destination connector, or a field value against which Amazon AppFlow validates a source field\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceFields": "The source fields to which a particular task is applied\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TaskProperties": "A map used to store task\\-related information\\. The service looks for particular information based on the TaskType\\. \n*Required*: No \n*Type*: List of [TaskPropertiesMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TaskType": "Specifies the particular task implementation that Amazon AppFlow performs\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Arithmetic | Filter | Map | Mask | Merge | Truncate | Validate` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration TaskPropertiesMap": { - "OperatorPropertyKey": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Property": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "OperatorPropertyKey": "The task property key\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Property": "The task property value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration TriggerConfig": { - "TriggerProperties": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [TriggerProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TriggerType": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TriggerProperties": "Specifies the configuration details of a schedule\\-triggered flow that you define\\. Currently, these settings only apply to the Scheduled trigger type\\. \n*Required*: No \n*Type*: [TriggerProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TriggerType": "Specifies the type of flow trigger\\. It can be OnDemand, Scheduled, or Event\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Event | OnDemand | Scheduled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration TriggerProperties": { - "Scheduled": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ScheduledTriggerProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Scheduled": "Specifies the configuration details of a schedule\\-triggered flow that you define\\. \n*Required*: No \n*Type*: [ScheduledTriggerProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::Integration ZendeskSourceProperties": { - "Object": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Object": "The object specified in the Zendesk flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::CustomerProfiles::ObjectType": { "AllowProfileCreation": "Indicates whether a profile should be created when data is received if one doesn\u2019t exist for an object of this type\\. The default is `FALSE`\\. If the AllowProfileCreation flag is set to `FALSE`, then the service tries to fetch a standard profile and associate this object with the profile\\. If it is set to `TRUE`, and if no match is found, then the service creates a new standard profile\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5678,34 +6389,40 @@ "CrossRegionCopy": "The rule for copying shared snapshots across Regions\\. \n*Required*: Yes \n*Type*: List of [CrossRegionCopyAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyaction.html) \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A descriptive name for the action\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `120` \n*Pattern*: `[0-9A-Za-z _-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::DLM::LifecyclePolicy ArchiveRetainRule": { + "RetentionArchiveTier": "Information about retention period in the Amazon EBS Snapshots Archive\\. For more information, see [Archive Amazon EBS snapshots](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/snapshot-archive.html)\\. \n*Required*: Yes \n*Type*: [RetentionArchiveTier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retentionarchivetier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::DLM::LifecyclePolicy ArchiveRule": { + "RetainRule": "Information about the retention period for the snapshot archiving rule\\. \n*Required*: Yes \n*Type*: [ArchiveRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-archiveretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::DLM::LifecyclePolicy CreateRule": { "CronExpression": "The schedule, as a Cron expression\\. The schedule interval must be between 1 hour and 1 year\\. For more information, see [Cron expressions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) in the *Amazon CloudWatch User Guide*\\. \n*Required*: No \n*Type*: String \n*Minimum*: `17` \n*Maximum*: `106` \n*Pattern*: `cron\\([^\\n]{11,100}\\)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Interval": "The interval between snapshots\\. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IntervalUnit": "The interval unit\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HOURS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Location": "Specifies the destination for snapshots created by the policy\\. To create snapshots in the same Region as the source resource, specify `CLOUD`\\. To create snapshots on the same Outpost as the source resource, specify `OUTPOST_LOCAL`\\. If you omit this parameter, `CLOUD` is used by default\\. \nIf the policy targets resources in an AWS Region, then you must create snapshots in the same Region as the source resource\\. \nIf the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CLOUD | OUTPOST_LOCAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Times": "The time, in UTC, to start the operation\\. The supported format is hh:mm\\. \nThe operation occurs within a one\\-hour window following the specified time\\. If you do not specify a time, Amazon DLM selects a time within the next 24 hours\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Location": "**\\[Snapshot policies only\\]** Specifies the destination for snapshots created by the policy\\. To create snapshots in the same Region as the source resource, specify `CLOUD`\\. To create snapshots on the same Outpost as the source resource, specify `OUTPOST_LOCAL`\\. If you omit this parameter, `CLOUD` is used by default\\. \nIf the policy targets resources in an AWS Region, then you must create snapshots in the same Region as the source resource\\. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CLOUD | OUTPOST_LOCAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Times": "The time, in UTC, to start the operation\\. The supported format is hh:mm\\. \nThe operation occurs within a one\\-hour window following the specified time\\. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DLM::LifecyclePolicy CrossRegionCopyAction": { "EncryptionConfiguration": "The encryption settings for the copied snapshot\\. \n*Required*: Yes \n*Type*: [EncryptionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-encryptionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RetainRule": "Specifies the retention rule for cross\\-Region snapshot copies\\. \n*Required*: No \n*Type*: [CrossRegionCopyRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RetainRule": "Specifies a retention rule for cross\\-Region snapshot copies created by snapshot or event\\-based policies, or cross\\-Region AMI copies created by AMI policies\\. After the retention period expires, the cross\\-Region copy is deleted\\. \n*Required*: No \n*Type*: [CrossRegionCopyRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Target": "The target Region\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `2048` \n*Pattern*: `^[\\w:\\-\\/\\*]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DLM::LifecyclePolicy CrossRegionCopyDeprecateRule": { "Interval": "The period after which to deprecate the cross\\-Region AMI copies\\. The period must be less than or equal to the cross\\-Region AMI copy retention period, and it can't be greater than 10 years\\. This is equivalent to 120 months, 520 weeks, or 3650 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IntervalUnit": "The unit of time in which to measure the **Interval**\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "IntervalUnit": "The unit of time in which to measure the **Interval**\\. For example, to deprecate a cross\\-Region AMI copy after 3 months, specify `Interval=3` and `IntervalUnit=MONTHS`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DLM::LifecyclePolicy CrossRegionCopyRetainRule": { - "Interval": "The amount of time to retain each snapshot\\. The maximum is 100 years\\. This is equivalent to 1200 months, 5200 weeks, or 36500 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IntervalUnit": "The unit of time for time\\-based retention\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Interval": "The amount of time to retain a cross\\-Region snapshot or AMI copy\\. The maximum is 100 years\\. This is equivalent to 1200 months, 5200 weeks, or 36500 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IntervalUnit": "The unit of time for time\\-based retention\\. For example, to retain a cross\\-Region copy for 3 months, specify `Interval=3` and `IntervalUnit=MONTHS`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DLM::LifecyclePolicy CrossRegionCopyRule": { "CmkArn": "The Amazon Resource Name \\(ARN\\) of the AWS KMS key to use for EBS encryption\\. If this parameter is not specified, the default KMS key for the account is used\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `2048` \n*Pattern*: `arn:aws(-[a-z]{1,3}){0,2}:kms:([a-z]+-){2,3}\\d:\\d+:key/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CopyTags": "Indicates whether to copy all user\\-defined tags from the source snapshot to the cross\\-Region snapshot copy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeprecateRule": "The AMI deprecation rule for cross\\-Region AMI copies created by the rule\\. \n*Required*: No \n*Type*: [CrossRegionCopyDeprecateRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopydeprecaterule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CopyTags": "Indicates whether to copy all user\\-defined tags from the source snapshot or AMI to the cross\\-Region copy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeprecateRule": "**\\[AMI policies only\\]** The AMI deprecation rule for cross\\-Region AMI copies created by the rule\\. \n*Required*: No \n*Type*: [CrossRegionCopyDeprecateRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopydeprecaterule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Encrypted": "To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter\\. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RetainRule": "The retention rule that indicates how long snapshot copies are to be retained in the destination Region\\. \n*Required*: No \n*Type*: [CrossRegionCopyRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RetainRule": "The retention rule that indicates how long the cross\\-Region snapshot or AMI copies are to be retained in the destination Region\\. \n*Required*: No \n*Type*: [CrossRegionCopyRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Target": "The target Region or the Amazon Resource Name \\(ARN\\) of the target Outpost for the snapshot copies\\. \nUse this parameter instead of **TargetRegion**\\. Do not specify both\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `2048` \n*Pattern*: `^[\\w:\\-\\/\\*]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TargetRegion": "Avoid using this parameter when creating new policies\\. Instead, use **Target** to specify a target Region or a target Outpost for snapshot copies\\. \nFor policies created before the **Target** parameter was introduced, this parameter indicates the target Region for snapshot copies\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `16` \n*Pattern*: `([a-z]+-){2,3}\\d` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TargetRegion": "Avoid using this parameter when creating new policies\\. Instead, use **Target** to specify a target Region or a target Outpost for snapshot copies\\. \nFor policies created before the **Target** parameter was introduced, this parameter indicates the target Region for snapshot copies\\.\n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `16` \n*Pattern*: `([a-z]+-){2,3}\\d` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DLM::LifecyclePolicy DeprecateRule": { "Count": "If the schedule has a count\\-based retention rule, this parameter specifies the number of oldest AMIs to deprecate\\. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5732,35 +6449,42 @@ "IntervalUnit": "The unit of time for enabling fast snapshot restore\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DLM::LifecyclePolicy Parameters": { - "ExcludeBootVolume": "\\[EBS Snapshot Management \u2013 Instance policies only\\] Indicates whether to exclude the root volume from snapshots created using [CreateSnapshots](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSnapshots.html)\\. The default is false\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "NoReboot": "Applies to AMI lifecycle policies only\\. Indicates whether targeted instances are rebooted when the lifecycle policy runs\\. `true` indicates that targeted instances are not rebooted when the policy runs\\. `false` indicates that target instances are rebooted when the policy runs\\. The default is `true` \\(instances are not rebooted\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ExcludeBootVolume": "**\\[Snapshot policies that target instances only\\]** Indicates whether to exclude the root volume from multi\\-volume snapshot sets\\. The default is `false`\\. If you specify `true`, then the root volumes attached to targeted instances will be excluded from the multi\\-volume snapshot sets created by the policy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExcludeDataVolumeTags": "**\\[Snapshot policies that target instances only\\]** The tags used to identify data \\(non\\-root\\) volumes to exclude from multi\\-volume snapshot sets\\. \nIf you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi\\-volume snapshot sets created by the policy\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NoReboot": "**\\[AMI policies only\\]** Indicates whether targeted instances are rebooted when the lifecycle policy runs\\. `true` indicates that targeted instances are not rebooted when the policy runs\\. `false` indicates that target instances are rebooted when the policy runs\\. The default is `true` \\(instances are not rebooted\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DLM::LifecyclePolicy PolicyDetails": { - "Actions": "The actions to be performed when the event\\-based policy is triggered\\. You can specify only one action per policy\\. \nThis parameter is required for event\\-based policies only\\. If you are creating a snapshot or AMI policy, omit this parameter\\. \n*Required*: No \n*Type*: List of [Action](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-action.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EventSource": "The event that triggers the event\\-based policy\\. \nThis parameter is required for event\\-based policies only\\. If you are creating a snapshot or AMI policy, omit this parameter\\. \n*Required*: No \n*Type*: [EventSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventsource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Parameters": "A set of optional parameters for snapshot and AMI lifecycle policies\\. \nThis parameter is required for snapshot and AMI policies only\\. If you are creating an event\\-based policy, omit this parameter\\. \nIf you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require\\. You can't omit this parameter or set its values to null\\.\n*Required*: No \n*Type*: [Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PolicyType": "The valid target resource types and actions a policy can manage\\. Specify `EBS_SNAPSHOT_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots\\. Specify `IMAGE_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of EBS\\-backed AMIs\\. Specify `EVENT_BASED_POLICY ` to create an event\\-based policy that performs specific actions when a defined event occurs in your AWS account\\. \nThe default is `EBS_SNAPSHOT_MANAGEMENT`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EBS_SNAPSHOT_MANAGEMENT | EVENT_BASED_POLICY | IMAGE_MANAGEMENT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResourceLocations": "The location of the resources to backup\\. If the source resources are located in an AWS Region, specify `CLOUD`\\. If the source resources are located on an Outpost in your account, specify `OUTPOST`\\. \nIf you specify `OUTPOST`, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResourceTypes": "The target resource type for snapshot and AMI lifecycle policies\\. Use `VOLUME `to create snapshots of individual volumes or use `INSTANCE` to create multi\\-volume snapshots from the volumes for an instance\\. \nThis parameter is required for snapshot and AMI policies only\\. If you are creating an event\\-based policy, omit this parameter\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Schedules": "The schedules of policy\\-defined actions for snapshot and AMI lifecycle policies\\. A policy can have up to four schedules\u2014one mandatory schedule and up to three optional schedules\\. \nThis parameter is required for snapshot and AMI policies only\\. If you are creating an event\\-based policy, omit this parameter\\. \n*Required*: No \n*Type*: List of [Schedule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html) \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TargetTags": "The single tag that identifies targeted resources for this policy\\. \nThis parameter is required for snapshot and AMI policies only\\. If you are creating an event\\-based policy, omit this parameter\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Actions": "**\\[Event\\-based policies only\\]** The actions to be performed when the event\\-based policy is activated\\. You can specify only one action per policy\\. \n*Required*: No \n*Type*: List of [Action](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-action.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventSource": "**\\[Event\\-based policies only\\]** The event that activates the event\\-based policy\\. \n*Required*: No \n*Type*: [EventSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventsource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Parameters": "**\\[Snapshot and AMI policies only\\]** A set of optional parameters for snapshot and AMI lifecycle policies\\. \nIf you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require\\. You can't omit this parameter or set its values to null\\.\n*Required*: No \n*Type*: [Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PolicyType": "**\\[All policy types\\]** The valid target resource types and actions a policy can manage\\. Specify `EBS_SNAPSHOT_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots\\. Specify `IMAGE_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of EBS\\-backed AMIs\\. Specify `EVENT_BASED_POLICY ` to create an event\\-based policy that performs specific actions when a defined event occurs in your AWS account\\. \nThe default is `EBS_SNAPSHOT_MANAGEMENT`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EBS_SNAPSHOT_MANAGEMENT | EVENT_BASED_POLICY | IMAGE_MANAGEMENT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceLocations": "**\\[Snapshot and AMI policies only\\]** The location of the resources to backup\\. If the source resources are located in an AWS Region, specify `CLOUD`\\. If the source resources are located on an Outpost in your account, specify `OUTPOST`\\. \nIf you specify `OUTPOST`, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceTypes": "**\\[Snapshot policies only\\]** The target resource type for snapshot and AMI lifecycle policies\\. Use `VOLUME `to create snapshots of individual volumes or use `INSTANCE` to create multi\\-volume snapshots from the volumes for an instance\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Schedules": "**\\[Snapshot and AMI policies only\\]** The schedules of policy\\-defined actions for snapshot and AMI lifecycle policies\\. A policy can have up to four schedules\u2014one mandatory schedule and up to three optional schedules\\. \n*Required*: No \n*Type*: List of [Schedule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html) \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetTags": "**\\[Snapshot and AMI policies only\\]** The single tag that identifies targeted resources for this policy\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DLM::LifecyclePolicy RetainRule": { - "Count": "The number of snapshots to retain for each volume, up to a maximum of 1000\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Interval": "The amount of time to retain each snapshot\\. The maximum is 100 years\\. This is equivalent to 1200 months, 5200 weeks, or 36500 days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IntervalUnit": "The unit of time for time\\-based retention\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Count": "The number of snapshots to retain for each volume, up to a maximum of 1000\\. For example if you want to retain a maximum of three snapshots, specify `3`\\. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an [ArchiveRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-archiverule)\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Interval": "The amount of time to retain each snapshot\\. The maximum is 100 years\\. This is equivalent to 1200 months, 5200 weeks, or 36500 days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IntervalUnit": "The unit of time for time\\-based retention\\. For example, to retain snapshots for 3 months, specify `Interval=3` and `IntervalUnit=MONTHS`\\. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an [ArchiveRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-archiverule)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::DLM::LifecyclePolicy RetentionArchiveTier": { + "Count": "The maximum number of snapshots to retain in the archive storage tier for each volume\\. The count must ensure that each snapshot remains in the archive tier for at least 90 days\\. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Interval": "Specifies the period of time to retain snapshots in the archive tier\\. After this period expires, the snapshot is permanently deleted\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IntervalUnit": "The unit of time in which to measure the **Interval**\\. For example, to retain a snapshots in the archive tier for 6 months, specify `Interval=6` and `IntervalUnit=MONTHS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DLM::LifecyclePolicy Schedule": { + "ArchiveRule": "**\\[Snapshot policies that target volumes only\\]** The snapshot archiving rule for the schedule\\. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met\\. Snapshots are then retained in the archive tier for the archive retention period that you specify\\. \nFor more information about using snapshot archiving, see [Considerations for snapshot lifecycle policies](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive)\\. \n*Required*: No \n*Type*: [ArchiveRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-archiverule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CopyTags": "Copy all user\\-defined tags on a source volume to snapshots of the volume created by this policy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CreateRule": "The creation rule\\. \n*Required*: No \n*Type*: [CreateRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-createrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CrossRegionCopyRules": "The rule for cross\\-Region snapshot copies\\. \nYou can only specify cross\\-Region copy rules for policies that create snapshots in a Region\\. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost\\. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts\\. \n*Required*: No \n*Type*: List of [CrossRegionCopyRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html) \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeprecateRule": "The AMI deprecation rule for the schedule\\. \n*Required*: No \n*Type*: [DeprecateRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FastRestoreRule": "The rule for enabling fast snapshot restore\\. \n*Required*: No \n*Type*: [FastRestoreRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CrossRegionCopyRules": "Specifies a rule for copying snapshots or AMIs across regions\\. \nYou can't specify cross\\-Region copy rules for policies that create snapshots on an Outpost\\. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts\\.\n*Required*: No \n*Type*: List of [CrossRegionCopyRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html) \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeprecateRule": "**\\[AMI policies only\\]** The AMI deprecation rule for the schedule\\. \n*Required*: No \n*Type*: [DeprecateRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FastRestoreRule": "**\\[Snapshot policies only\\]** The rule for enabling fast snapshot restore\\. \n*Required*: No \n*Type*: [FastRestoreRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the schedule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `120` \n*Pattern*: `[0-9A-Za-z _-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RetainRule": "The retention rule\\. \n*Required*: No \n*Type*: [RetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ShareRules": "The rule for sharing snapshots with other AWS accounts\\. \n*Required*: No \n*Type*: List of [ShareRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RetainRule": "The retention rule for snapshots or AMIs created by the policy\\. \n*Required*: No \n*Type*: [RetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ShareRules": "**\\[Snapshot policies only\\]** The rule for sharing snapshots with other AWS accounts\\. \n*Required*: No \n*Type*: List of [ShareRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TagsToAdd": "The tags to apply to policy\\-created resources\\. These user\\-defined tags are in addition to the AWS\\-added lifecycle tags\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `45` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VariableTags": "A collection of key/value pairs with values determined dynamically when the policy is executed\\. Keys may be any valid Amazon EC2 tag key\\. Values must be in one of the two following formats: `$(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/instance-id.html)` or `$(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/timestamp.html)`\\. Variable tags are only valid for EBS Snapshot Management \u2013 Instance policies\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `45` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "VariableTags": "**\\[AMI policies and snapshot policies that target instances only\\]** A collection of key/value pairs with values determined dynamically when the policy is executed\\. Keys may be any valid Amazon EC2 tag key\\. Values must be in one of the two following formats: `$(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/instance-id.html)` or `$(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/timestamp.html)`\\. Variable tags are only valid for EBS Snapshot Management \u2013 Instance policies\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `45` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DLM::LifecyclePolicy ShareRule": { "TargetAccounts": "The IDs of the AWS accounts with which to share the snapshots\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5769,53 +6493,56 @@ }, "AWS::DMS::Certificate": { "CertificateIdentifier": "A customer\\-assigned name for the certificate\\. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens\\. They can't end with a hyphen or contain two consecutive hyphens\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "CertificatePem": "The contents of the \\.pem X\\.509 certificate file for the certificate\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "CertificateWallet": "The location of the imported Oracle Wallet certificate for use with SSL\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "CertificatePem": "The contents of a `.pem` file, which contains an X\\.509 certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CertificateWallet": "The location of an imported Oracle Wallet certificate for use with SSL\\. An example is: `filebase64(\"${path.root}/rds-ca-2019-root.sso\")` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::DMS::Endpoint": { "CertificateArn": "The Amazon Resource Name \\(ARN\\) for the certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DatabaseName": "The name of the endpoint database\\. For a MySQL source or target endpoint, do not specify DatabaseName\\. To migrate to a specific database, use this setting and `targetDbType`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DocDbSettings": "Settings in JSON format for the source DocumentDB endpoint\\. For more information about the available settings, see the configuration properties section in [ Using DocumentDB as a Target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [DocDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DynamoDbSettings": "Settings in JSON format for the target Amazon DynamoDB endpoint\\. For information about other available settings, see [Using Object Mapping to Migrate Data to DynamoDB](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [DynamoDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ElasticsearchSettings": "Settings in JSON format for the target OpenSearch endpoint\\. For more information about the available settings, see [Extra Connection Attributes When Using OpenSearch as a Target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) in the * AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [ElasticsearchSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DatabaseName": "The name of the endpoint database\\. For a MySQL source or target endpoint, don't specify `DatabaseName`\\. To migrate to a specific database, use this setting and `targetDbType`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DocDbSettings": "Settings in JSON format for the source and target DocumentDB endpoint\\. For more information about other available settings, see [ Using extra connections attributes with Amazon DocumentDB as a source](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html#CHAP_Source.DocumentDB.ECAs) and [ Using Amazon DocumentDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DocumentDB.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [DocDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DynamoDbSettings": "Settings in JSON format for the target Amazon DynamoDB endpoint\\. For information about other available settings, see [ Using object mapping to migrate data to DynamoDB](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [DynamoDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ElasticsearchSettings": "Settings in JSON format for the target OpenSearch endpoint\\. For more information about the available settings, see [ Extra connection attributes when using OpenSearch as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [ElasticsearchSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EndpointIdentifier": "The database endpoint identifier\\. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens\\. They can't end with a hyphen, or contain two consecutive hyphens\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EndpointType": "The type of endpoint\\. Valid values are `source` and `target`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `source | target` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EngineName": "The type of engine for the endpoint\\. Valid values, depending on the `EndpointType` value, include `\"mysql\"`, `\"oracle\"`, `\"postgres\"`, `\"mariadb\"`, `\"aurora\"`, `\"aurora-postgresql\"`, `\"opensearch\"`, `\"redshift\"`, `\"s3\"`, `\"db2\"`, `\"azuredb\"`, `\"sybase\"`, `\"dynamodb\"`, `\"mongodb\"`, `\"kinesis\"`, `\"kafka\"`, `\"elasticsearch\"`, `\"docdb\"`, `\"sqlserver\"`, and `\"neptune\"`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ExtraConnectionAttributes": "Additional attributes associated with the connection\\. Each attribute is specified as a name\\-value pair associated by an equal sign \\(=\\)\\. Multiple attributes are separated by a semicolon \\(;\\) with no additional white space\\. For information on the attributes available for connecting your source or target endpoint, see [Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "GcpMySQLSettings": "Settings in JSON format for the source GCP MySQL endpoint\\. \n*Required*: No \n*Type*: [GcpMySQLSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IbmDb2Settings": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [IbmDb2Settings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KafkaSettings": "Settings in JSON format for the target Apache Kafka endpoint\\. For more information about the available settings, see [Using object mapping to migrate data to a Kafka topic](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [KafkaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KinesisSettings": "Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams\\. For more information about the available settings, see [Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [KinesisSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KmsKeyId": "An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint\\. \nIf you don't specify a value for the `KmsKeyId` parameter, then AWS DMS uses your default encryption key\\. \n AWS KMS creates the default encryption key for your AWS account\\. Your AWS account has a different default encryption key for each AWS Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MicrosoftSqlServerSettings": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [MicrosoftSqlServerSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MongoDbSettings": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [MongoDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MySqlSettings": "Settings in JSON format for the source and target MySQL endpoint\\. For information about other available settings, see [Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) and [Extra connection attributes when using a MySQL\\-compatible database as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [MySqlSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "NeptuneSettings": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [NeptuneSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OracleSettings": "Settings in JSON format for the source and target Oracle endpoint\\. For information about other available settings, see [Extra connection attributes when using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) and [ Extra connection attributes when using Oracle as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [OracleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EngineName": "The type of engine for the endpoint, depending on the `EndpointType` value\\. \n*Valid values*: `mysql` \\| `oracle` \\| `postgres` \\| `mariadb` \\| `aurora` \\| `aurora-postgresql` \\| `opensearch` \\| `redshift` \\| `s3` \\| `db2` \\| `azuredb` \\| `sybase` \\| `dynamodb` \\| `mongodb` \\| `kinesis` \\| `kafka` \\| `elasticsearch` \\| `docdb` \\| `sqlserver` \\| `neptune` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExtraConnectionAttributes": "Additional attributes associated with the connection\\. Each attribute is specified as a name\\-value pair associated by an equal sign \\(=\\)\\. Multiple attributes are separated by a semicolon \\(;\\) with no additional white space\\. For information on the attributes available for connecting your source or target endpoint, see [ Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "GcpMySQLSettings": "Settings in JSON format for the source GCP MySQL endpoint\\. These settings are much the same as the settings for any MySQL\\-compatible endpoint\\. For more information, see [ Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [GcpMySQLSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IbmDb2Settings": "Settings in JSON format for the source IBM Db2 LUW endpoint\\. For information about other available settings, see [ Extra connection attributes when using Db2 LUW as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [IbmDb2Settings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KafkaSettings": "Settings in JSON format for the target Apache Kafka endpoint\\. For more information about other available settings, see [ Using object mapping to migrate data to a Kafka topic](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [KafkaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KinesisSettings": "Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams\\. For more information about other available settings, see [ Using object mapping to migrate data to a Kinesis data stream](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [KinesisSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsKeyId": "An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint\\. \nIf you don't specify a value for the `KmsKeyId` parameter, AWS DMS uses your default encryption key\\. \nAWS KMS creates the default encryption key for your AWS account\\. Your AWS account has a different default encryption key for each AWS Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MicrosoftSqlServerSettings": "Settings in JSON format for the source and target Microsoft SQL Server endpoint\\. For information about other available settings, see [ Extra connection attributes when using SQL Server as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib) and [ Extra connection attributes when using SQL Server as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [MicrosoftSqlServerSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MongoDbSettings": "Settings in JSON format for the source MongoDB endpoint\\. For more information about the available settings, see [ Using MongoDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [MongoDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MySqlSettings": "Settings in JSON format for the source and target MySQL endpoint\\. For information about other available settings, see [ Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) and [ Extra connection attributes when using a MySQL\\-compatible database as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [MySqlSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NeptuneSettings": "Settings in JSON format for the target Amazon Neptune endpoint\\. For more information about the available settings, see [ Specifying endpoint settings for Amazon Neptune as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [NeptuneSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OracleSettings": "Settings in JSON format for the source and target Oracle endpoint\\. For information about other available settings, see [ Extra connection attributes when using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) and [ Extra connection attributes when using Oracle as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [OracleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Password": "The password to be used to log in to the endpoint database\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Port": "The port used by the endpoint database\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PostgreSqlSettings": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [PostgreSqlSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RedisSettings": "Settings in JSON format for the target Redis endpoint\\. \n*Required*: No \n*Type*: [RedisSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RedshiftSettings": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [RedshiftSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResourceIdentifier": "A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "S3Settings": "Settings in JSON format for the target Amazon S3 endpoint\\. For more information about the available settings, see [Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [S3Settings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PostgreSqlSettings": "Settings in JSON format for the source and target PostgreSQL endpoint\\. \nFor information about other available settings, see [ Extra connection attributes when using PostgreSQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) and [ Extra connection attributes when using PostgreSQL as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [PostgreSqlSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RedisSettings": "Settings in JSON format for the target Redis endpoint\\. For information about other available settings, see [ Specifying endpoint settings for Redis as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redis.html#CHAP_Target.Redis.EndpointSettings) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [RedisSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RedshiftSettings": "Settings in JSON format for the Amazon Redshift endpoint\\. \nFor more information about other available settings, see [ Extra connection attributes when using Amazon Redshift as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redshift.html#CHAP_Target.Redshift.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [RedshiftSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceIdentifier": "A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. \nFor example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "S3Settings": "Settings in JSON format for the source and target Amazon S3 endpoint\\. For more information about other available settings, see [ Extra connection attributes when using Amazon S3 as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.S3.html#CHAP_Source.S3.Configuring) and [ Extra connection attributes when using Amazon S3 as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) in the*AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [S3Settings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServerName": "The name of the server where the endpoint database resides\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SslMode": "The Secure Sockets Layer \\(SSL\\) mode to use for the SSL connection\\. The default is `none`\\. \nWhen `engine_name` is set to S3, then the only allowed value is `none`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `none | require | verify-ca | verify-full` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SybaseSettings": "Settings in JSON format for the source and target SAP ASE endpoint\\. For information about other available settings, see [Extra connection attributes when using SAP ASE as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) and [Extra connection attributes when using SAP ASE as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [SybaseSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "One or more tags to be assigned to the endpoint\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SslMode": "The Secure Sockets Layer \\(SSL\\) mode to use for the SSL connection\\. The default is `none`\\. \nWhen `engine_name` is set to S3, the only allowed value is `none`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `none | require | verify-ca | verify-full` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SybaseSettings": "Settings in JSON format for the source and target SAP ASE endpoint\\. For information about other available settings, see [ Extra connection attributes when using SAP ASE as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) and [ Extra connection attributes when using SAP ASE as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [SybaseSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "One or more tags to be assigned to the endpoint\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Username": "The user name to be used to log in to the endpoint database\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint DocDbSettings": { - "SecretsManagerAccessRoleArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerSecretId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DocsToInvestigate": "Indicates the number of documents to preview to determine the document organization\\. Use this setting when `NestingLevel` is set to `\"one\"`\\. \nMust be a positive value greater than `0`\\. Default value is `1000`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExtractDocId": "Specifies the document ID\\. Use this setting when `NestingLevel` is set to `\"none\"`\\. \nDefault value is `\"false\"`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NestingLevel": "Specifies either document or table mode\\. \nDefault value is `\"none\"`\\. Specify `\"none\"` to use document mode\\. Specify `\"one\"` to use table mode\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `none | one` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerAccessRoleArn": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the DocumentDB endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerSecretId": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the DocumentDB endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint DynamoDbSettings": { "ServiceAccessRoleArn": "The Amazon Resource Name \\(ARN\\) used by the service to access the IAM role\\. The role must allow the `iam:PassRole` action\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint ElasticsearchSettings": { - "EndpointUri": "The endpoint for the OpenSearch cluster\\. AWS DMS uses HTTPS if a transport protocol \\(http/https\\) is not specified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EndpointUri": "The endpoint for the OpenSearch cluster\\. AWS DMS uses HTTPS if a transport protocol \\(either HTTP or HTTPS\\) isn't specified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ErrorRetryDuration": "The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FullLoadErrorPercentage": "The maximum percentage of records that can fail to be written before a full load operation stops\\. \nTo avoid early failure, this counter is only effective after 1000 records are transferred\\. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window\\. If transfer of all records fail in the last 10 minutes, the full load operation stops\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FullLoadErrorPercentage": "The maximum percentage of records that can fail to be written before a full load operation stops\\. \nTo avoid early failure, this counter is only effective after 1,000 records are transferred\\. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window\\. If transfer of all records fail in the last 10 minutes, the full load operation stops\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceAccessRoleArn": "The Amazon Resource Name \\(ARN\\) used by the service to access the IAM role\\. The role must allow the `iam:PassRole` action\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint GcpMySQLSettings": { @@ -5826,86 +6553,149 @@ "MaxFileSize": "Specifies the maximum size \\(in KB\\) of any \\.csv file used to transfer data to a MySQL\\-compatible database\\. \nExample: `maxFileSize=512` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ParallelLoadThreads": "Improves performance when loading data into the MySQL\\-compatible target database\\. Specifies how many threads to use to load the data into the MySQL\\-compatible target database\\. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread\\. The default is one\\. \nExample: `parallelLoadThreads=1` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Password": "Endpoint connection password\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Port": "*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerAccessRoleArn": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret.` The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the AWS Database Migration Service User Guide\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerSecretId": "The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Port": "The port used by the endpoint database\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerAccessRoleArn": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret.` The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerSecretId": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServerName": "Endpoint TCP port\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServerTimezone": "Specifies the time zone for the source MySQL database\\. \nExample: `serverTimezone=US/Pacific;` \nNote: Do not enclose time zones in single quotes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerTimezone": "Specifies the time zone for the source MySQL database\\. Don't enclose time zones in single quotation marks\\. \nExample: `serverTimezone=US/Pacific;` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Username": "Endpoint connection user name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint IbmDb2Settings": { - "SecretsManagerAccessRoleArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerSecretId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CurrentLsn": "For ongoing replication \\(CDC\\), use CurrentLSN to specify a log sequence number \\(LSN\\) where you want the replication to start\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxKBytesPerRead": "Maximum number of bytes per read, as a NUMBER value\\. The default is 64 KB\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerAccessRoleArn": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerSecretId": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the IBMDB2 endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SetDataCaptureChanges": "Enables ongoing replication \\(CDC\\) as a BOOLEAN value\\. The default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint KafkaSettings": { - "Broker": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Broker": "A comma\\-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance\\. Specify each broker location in the form `broker-hostname-or-ip:port`\\. For example, `\"ec2-12-345-678-901.compute-1.amazonaws.com:2345\"`\\. For more information and examples of specifying a list of broker locations, see [ Using Apache Kafka as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeControlDetails": "Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeNullAndEmpty": "Include NULL and empty columns for records migrated to the endpoint\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludePartitionValue": "Shows the partition value within the Kafka message output unless the partition type is `schema-table-type`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeTableAlterOperations": "Includes any data definition language \\(DDL\\) operations that change the table in the control data, such as `rename-table`, `drop-table`, `add-column`, `drop-column`, and `rename-column`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeTransactionDetails": "Provides detailed transaction information from the source database\\. This information includes a commit timestamp, a log position, and values for `transaction_id`, previous `transaction_id`, and `transaction_record_id` \\(the record offset within a transaction\\)\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MessageFormat": "The output format for the records created on the endpoint\\. The message format is `JSON` \\(default\\) or `JSON_UNFORMATTED` \\(a single line with no tab\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `json | json-unformatted` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MessageMaxBytes": "The maximum size in bytes for records created on the endpoint The default is 1,000,000\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NoHexPrefix": "Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format\\. For example, by default, AWS DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target\\. Use the `NoHexPrefix` endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PartitionIncludeSchemaTable": "Prefixes schema and table names to partition values, when the partition type is `primary-key-type`\\. Doing this increases data distribution among Kafka partitions\\. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key\\. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SaslPassword": "The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL\\-SSL authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SaslUserName": "The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL\\-SSL authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SaslPassword": "The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL\\-SSL authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SaslUserName": "The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL\\-SSL authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityProtocol": "Set secure connection to a Kafka target endpoint using Transport Layer Security \\(TLS\\)\\. Options include `ssl-encryption`, `ssl-authentication`, and `sasl-ssl`\\. `sasl-ssl` requires `SaslUsername` and `SaslPassword`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `plaintext | sasl-ssl | ssl-authentication | ssl-encryption` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SslCaCertificateArn": "The Amazon Resource Name \\(ARN\\) for the private certificate authority \\(CA\\) cert that AWS DMS uses to securely connect to your Kafka target endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SslClientCertificateArn": "The Amazon Resource Name \\(ARN\\) of the client certificate used to securely connect to a Kafka target endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SslClientKeyArn": "The Amazon Resource Name \\(ARN\\) for the client private key used to securely connect to a Kafka target endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SslClientKeyPassword": "The password for the client private key used to securely connect to a Kafka target endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Topic": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Topic": "The topic to which you migrate the data\\. If you don't specify a topic, AWS DMS specifies `\"kafka-default-topic\"` as the migration topic\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint KinesisSettings": { "IncludeControlDetails": "Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeNullAndEmpty": "Include NULL and empty columns for records migrated to the endpoint\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludePartitionValue": "Shows the partition value within the Kinesis message output, unless the partition type is `schema-table-type`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeTableAlterOperations": "Includes any data definition language \\(DDL\\) operations that change the table in the control data, such as `rename-table`, `drop-table`, `add-column`, `drop-column`, and `rename-column`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeTransactionDetails": "Provides detailed transaction information from the source database\\. This information includes a commit timestamp, a log position, and values for `transaction_id`, previous `transaction_id`, and `transaction_record_id` \\(the record offset within a transaction\\)\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MessageFormat": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `json | json-unformatted` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MessageFormat": "The output format for the records created on the endpoint\\. The message format is `JSON` \\(default\\) or `JSON_UNFORMATTED` \\(a single line with no tab\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `json | json-unformatted` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NoHexPrefix": "Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format\\. For example, by default, AWS DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target\\. Use the `NoHexPrefix` endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PartitionIncludeSchemaTable": "Prefixes schema and table names to partition values, when the partition type is `primary-key-type`\\. Doing this increases data distribution among Kinesis shards\\. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key\\. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServiceAccessRoleArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StreamArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ServiceAccessRoleArn": "The Amazon Resource Name \\(ARN\\) for the IAM role that AWS DMS uses to write to the Kinesis data stream\\. The role must allow the `iam:PassRole` action\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StreamArn": "The Amazon Resource Name \\(ARN\\) for the Amazon Kinesis Data Streams endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint MicrosoftSqlServerSettings": { - "SecretsManagerAccessRoleArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerSecretId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "BcpPacketSize": "The maximum size of the packets \\(in bytes\\) used to transfer data using BCP\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ControlTablesFileGroup": "Specifies a file group for the AWS DMS internal tables\\. When the replication task starts, all the internal AWS DMS control tables \\(awsdms\\_ apply\\_exception, awsdms\\_apply, awsdms\\_changes\\) are created for the specified file group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "QuerySingleAlwaysOnNode": "Cleans and recreates table metadata information on the replication instance when a mismatch occurs\\. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReadBackupOnly": "When this attribute is set to `Y`, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication\\. Setting this parameter to `Y` enables you to control active transaction log file growth during full load and ongoing replication tasks\\. However, it can add some source latency to ongoing replication\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SafeguardPolicy": "Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods\\. \n *Start transactions in the database:* This is the default method\\. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database\\. As long as such a transaction is open, changes that appear after the transaction started aren't truncated\\. If you need Microsoft Replication to be enabled in your database, then you must choose this method\\. \n *Exclusively use sp\\_repldone within a single task*: When this method is used, AWS DMS reads the changes and then uses sp\\_repldone to mark the TLOG transactions as ready for truncation\\. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running\\. Also, when using this method, only one AWS DMS task can access the database at any given time\\. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerAccessRoleArn": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerSecretId": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MicrosoftSQLServer endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseBcpFullLoad": "Use this to attribute to transfer data for full\\-load operations using BCP\\. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseThirdPartyBackupDevice": "When this attribute is set to `Y`, DMS processes third\\-party transaction log backups if they are created in native format\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint MongoDbSettings": { - "AuthMechanism": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `default | mongodb_cr | scram_sha_1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AuthSource": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AuthType": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `no | password` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DatabaseName": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DocsToInvestigate": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ExtractDocId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "NestingLevel": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `none | one` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Password": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Port": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerAccessRoleArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerSecretId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServerName": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Username": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AuthMechanism": "The authentication mechanism you use to access the MongoDB source endpoint\\. \nFor the default value, in MongoDB version 2\\.x, `\"default\"` is `\"mongodb_cr\"`\\. For MongoDB version 3\\.x or later, `\"default\"` is `\"scram_sha_1\"`\\. This setting isn't used when `AuthType` is set to `\"no\"`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `default | mongodb_cr | scram_sha_1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthSource": "The MongoDB database name\\. This setting isn't used when `AuthType` is set to `\"no\"`\\. \nThe default is `\"admin\"`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthType": "The authentication type you use to access the MongoDB source endpoint\\. \nWhen set to `\"no\"`, user name and password parameters are not used and can be empty\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `no | password` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DatabaseName": "The database name on the MongoDB source endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DocsToInvestigate": "Indicates the number of documents to preview to determine the document organization\\. Use this setting when `NestingLevel` is set to `\"one\"`\\. \nMust be a positive value greater than `0`\\. Default value is `1000`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExtractDocId": "Specifies the document ID\\. Use this setting when `NestingLevel` is set to `\"none\"`\\. \nDefault value is `\"false\"`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NestingLevel": "Specifies either document or table mode\\. \nDefault value is `\"none\"`\\. Specify `\"none\"` to use document mode\\. Specify `\"one\"` to use table mode\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `none | one` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Password": "The password for the user account you use to access the MongoDB source endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Port": "The port value for the MongoDB source endpoint\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerAccessRoleArn": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerSecretId": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MongoDB endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerName": "The name of the server on the MongoDB source endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Username": "The user name you use to access the MongoDB source endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint MySqlSettings": { - "SecretsManagerAccessRoleArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerSecretId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AfterConnectScript": "Specifies a script to run immediately after AWS DMS connects to the endpoint\\. The migration task continues running regardless if the SQL statement succeeds or fails\\. \nFor this parameter, provide the code of the script itself, not the name of a file containing the script\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CleanSourceMetadataOnMismatch": "Cleans and recreates table metadata information on the replication instance when a mismatch occurs\\. For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventsPollInterval": "Specifies how often to check the binary log for new changes/events when the database is idle\\. The default is five seconds\\. \nExample: `eventsPollInterval=5;` \nIn the example, AWS DMS checks for changes in the binary logs every five seconds\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxFileSize": "Specifies the maximum size \\(in KB\\) of any \\.csv file used to transfer data to a MySQL\\-compatible database\\. \nExample: `maxFileSize=512` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ParallelLoadThreads": "Improves performance when loading data into the MySQL\\-compatible target database\\. Specifies how many threads to use to load the data into the MySQL\\-compatible target database\\. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread\\. The default is one\\. \nExample: `parallelLoadThreads=1` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerAccessRoleArn": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerSecretId": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerTimezone": "Specifies the time zone for the source MySQL database\\. \nExample: `serverTimezone=US/Pacific;` \nNote: Do not enclose time zones in single quotes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetDbType": "Specifies where to migrate source tables on the target, either to a single database or multiple databases\\. If you specify `SPECIFIC_DATABASE`, specify the database name using the `DatabaseName` parameter of the `Endpoint` object\\. \nExample: `targetDbType=MULTIPLE_DATABASES` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint NeptuneSettings": { "ErrorRetryDuration": "The number of milliseconds for AWS DMS to wait to retry a bulk\\-load of migrated graph data to the Neptune target database before raising an error\\. The default is 250\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IamAuthEnabled": "If you want AWS Identity and Access Management \\(IAM\\) authorization enabled for this endpoint, set this parameter to `true`\\. Then attach the appropriate IAM policy document to your service role specified by `ServiceAccessRoleArn`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IamAuthEnabled": "If you want IAM authorization enabled for this endpoint, set this parameter to `true`\\. Then attach the appropriate IAM policy document to your service role specified by `ServiceAccessRoleArn`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxFileSize": "The maximum size in kilobytes of migrated graph data stored in a \\.csv file before AWS DMS bulk\\-loads the data to the Neptune target database\\. The default is 1,048,576 KB\\. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxRetryCount": "The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error\\. The default is 5\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3BucketFolder": "A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by `S3BucketName` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3BucketName": "The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in \\.csv files before bulk\\-loading it to the Neptune target database\\. AWS DMS maps the SQL source data to graph data before storing it in these \\.csv files\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServiceAccessRoleArn": "The Amazon Resource Name \\(ARN\\) of the service role that you created for the Neptune target endpoint\\. The role must allow the `iam:PassRole` action\\. For more information, see [Creating an IAM Service Role for Accessing Amazon Neptune as a Target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole) in the * AWS Database Migration Service User Guide\\. * \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ServiceAccessRoleArn": "The Amazon Resource Name \\(ARN\\) of the service role that you created for the Neptune target endpoint\\. The role must allow the `iam:PassRole` action\\. \nFor more information, see [ Creating an IAM Service Role for Accessing Amazon Neptune as a Target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint OracleSettings": { - "SecretsManagerAccessRoleArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerOracleAsmAccessRoleArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerOracleAsmSecretId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerSecretId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AccessAlternateDirectly": "Set this attribute to `false` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AddSupplementalLogging": "Set this attribute to set up table\\-level supplemental logging for the Oracle database\\. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task\\. \nIf you use this option, you still need to enable database\\-level supplemental logging\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdditionalArchivedLogDestId": "Set this attribute with `ArchivedLogDestId` in a primary/ standby setup\\. This attribute is useful in the case of a switchover\\. In this case, AWS DMS needs to know which destination to get archive redo logs from to read changes\\. This need arises because the previous primary instance is now a standby instance after switchover\\. \nAlthough AWS DMS supports the use of the Oracle `RESETLOGS` option to open the database, never use `RESETLOGS` unless necessary\\. For additional information about `RESETLOGS`, see [RMAN Data Repair Concepts](https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the *Oracle Database Backup and Recovery User's Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AllowSelectNestedTables": "Set this attribute to `true` to enable replication of Oracle tables containing columns that are nested tables or defined types\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ArchivedLogDestId": "Specifies the ID of the destination for the archived redo logs\\. This value should be the same as a number in the dest\\_id column of the v$archived\\_log view\\. If you work with an additional redo log destination, use the `AdditionalArchivedLogDestId` option to specify the additional destination ID\\. Doing this improves performance by ensuring that the correct logs are accessed from the outset\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ArchivedLogsOnly": "When this field is set to `Y`, AWS DMS only accesses the archived redo logs\\. If the archived redo logs are stored on Automatic Storage Management \\(ASM\\) only, the AWS DMS user account needs to be granted ASM privileges\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AsmPassword": "For an Oracle source endpoint, your Oracle Automatic Storage Management \\(ASM\\) password\\. You can set this value from the ` asm_user_password ` value\\. You set this value as part of the comma\\-separated value that you set to the `Password` request parameter when you create the endpoint to access transaction logs using Binary Reader\\. For more information, see [Configuration for change data capture \\(CDC\\) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AsmServer": "For an Oracle source endpoint, your ASM server address\\. You can set this value from the `asm_server` value\\. You set `asm_server` as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM\\. For more information, see [Configuration for change data capture \\(CDC\\) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AsmUser": "For an Oracle source endpoint, your ASM user name\\. You can set this value from the `asm_user` value\\. You set `asm_user` as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM\\. For more information, see [Configuration for change data capture \\(CDC\\) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CharLengthSemantics": "Specifies whether the length of a character column is in bytes or in characters\\. To indicate that the character column length is in characters, set this attribute to `CHAR`\\. Otherwise, the character column length is in bytes\\. \nExample: `charLengthSemantics=CHAR;` \n*Required*: No \n*Type*: String \n*Allowed values*: `byte | char | default` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DirectPathNoLog": "When set to `true`, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DirectPathParallelLoad": "When set to `true`, this attribute specifies a parallel load when `useDirectPathFullLoad` is set to `Y`\\. This attribute also only applies when you use the AWS DMS parallel load feature\\. Note that the target table cannot have any constraints or indexes\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableHomogenousTablespace": "Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExtraArchivedLogDestIds": "Specifies the IDs of one more destinations for one or more archived redo logs\\. These IDs are the values of the `dest_id` column in the `v$archived_log` view\\. Use this setting with the `archivedLogDestId` extra connection attribute in a primary\\-to\\-single setup or a primary\\-to\\-multiple\\-standby setup\\. \nThis setting is useful in a switchover when you use an Oracle Data Guard database as a source\\. In this case, AWS DMS needs information about what destination to get archive redo logs from to read changes\\. AWS DMS needs this because after the switchover the previous primary is a standby instance\\. For example, in a primary\\-to\\-single standby setup you might apply the following settings\\. \n `archivedLogDestId=1; ExtraArchivedLogDestIds=[2]` \nIn a primary\\-to\\-multiple\\-standby setup, you might apply the following settings\\. \n `archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]` \nAlthough AWS DMS supports the use of the Oracle `RESETLOGS` option to open the database, never use `RESETLOGS` unless it's necessary\\. For more information about `RESETLOGS`, see [ RMAN Data Repair Concepts](https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the *Oracle Database Backup and Recovery User's Guide*\\. \n*Required*: No \n*Type*: List of Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailTasksOnLobTruncation": "When set to `true`, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified `LobMaxSize`\\. \nIf a task is set to limited LOB mode and this option is set to `true`, the task fails instead of truncating the LOB data\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NumberDatatypeScale": "Specifies the number scale\\. You can select a scale up to 38, or you can select FLOAT\\. By default, the NUMBER data type is converted to precision 38, scale 10\\. \nExample: `numberDataTypeScale=12` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OraclePathPrefix": "Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This value specifies the default Oracle root used to access the redo logs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ParallelAsmReadThreads": "Set this attribute to change the number of threads that DMS configures to perform a change data capture \\(CDC\\) load using Oracle Automatic Storage Management \\(ASM\\)\\. You can specify an integer value between 2 \\(the default\\) and 8 \\(the maximum\\)\\. Use this attribute together with the `readAheadBlocks` attribute\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReadAheadBlocks": "Set this attribute to change the number of read\\-ahead blocks that DMS configures to perform a change data capture \\(CDC\\) load using Oracle Automatic Storage Management \\(ASM\\)\\. You can specify an integer value between 1000 \\(the default\\) and 200,000 \\(the maximum\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReadTableSpaceName": "When set to `true`, this attribute supports tablespace replication\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReplacePathPrefix": "Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This setting tells DMS instance to replace the default Oracle root with the specified `usePathPrefix` setting to access the redo logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RetryInterval": "Specifies the number of seconds that the system waits before resending a query\\. \nExample: `retryInterval=6;` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerAccessRoleArn": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the Oracle endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerOracleAsmAccessRoleArn": "Required only if your Oracle endpoint uses Advanced Storage Manager \\(ASM\\)\\. The full ARN of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the `SecretsManagerOracleAsmSecret`\\. This `SecretsManagerOracleAsmSecret` has the secret value that allows access to the Oracle ASM of the endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerOracleAsmSecretId`\\. Or you can specify clear\\-text values for `AsmUserName`, `AsmPassword`, and `AsmServerName`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerOracleAsmSecret`, the corresponding `SecretsManagerOracleAsmAccessRoleArn`, and the `SecretsManagerOracleAsmSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerOracleAsmSecretId": "Required only if your Oracle endpoint uses Advanced Storage Manager \\(ASM\\)\\. The full ARN, partial ARN, or display name of the `SecretsManagerOracleAsmSecret` that contains the Oracle ASM connection details for the Oracle endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerSecretId": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the Oracle endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecurityDbEncryption": "For an Oracle source endpoint, the transparent data encryption \\(TDE\\) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader\\. It is also the ` TDE_Password ` part of the comma\\-separated value you set to the `Password` request parameter when you create the endpoint\\. The `SecurityDbEncryptian` setting is related to this `SecurityDbEncryptionName` setting\\. For more information, see [ Supported encryption methods for using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) in the * AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecurityDbEncryptionName": "For an Oracle source endpoint, the name of a key used for the transparent data encryption \\(TDE\\) of the columns and tablespaces in an Oracle source database that is encrypted using TDE\\. The key value is the value of the `SecurityDbEncryption` setting\\. For more information on setting the key name value of `SecurityDbEncryptionName`, see the information and example for setting the `securityDbEncryptionName` extra connection attribute in [ Supported encryption methods for using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) in the * AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SpatialDataOptionToGeoJsonFunctionName": "Use this attribute to convert `SDO_GEOMETRY` to `GEOJSON` format\\. By default, DMS calls the `SDO2GEOJSON` custom function if present and accessible\\. Or you can create your own custom function that mimics the operation of `SDOGEOJSON` and set `SpatialDataOptionToGeoJsonFunctionName` to call it instead\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StandbyDelayTime": "Use this attribute to specify a time in minutes for the delay in standby sync\\. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases\\. \nIn AWS DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes\\. Doing this eliminates the need to connect to an active database that might be in production\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseAlternateFolderForOnline": "Set this attribute to `true` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This tells the DMS instance to use any specified prefix replacement to access all online redo logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseBFile": "Set this attribute to Y to capture change data using the Binary Reader utility\\. Set `UseLogminerReader` to N to set this attribute to Y\\. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes\\. For more information about using this setting with Oracle Automatic Storage Management \\(ASM\\), see [ Using Oracle LogMiner or AWS DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseDirectPathFullLoad": "Set this attribute to Y to have AWS DMS use a direct path full load\\. Specify this value to use the direct path protocol in the Oracle Call Interface \\(OCI\\)\\. By using this OCI protocol, you can bulk\\-load Oracle target tables during a full load\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseLogminerReader": "Set this attribute to Y to capture change data using the Oracle LogMiner utility \\(the default\\)\\. Set this attribute to N if you want to access the redo logs as a binary file\\. When you set `UseLogminerReader` to N, also set `UseBfile` to Y\\. For more information on this setting and using Oracle ASM, see [ Using Oracle LogMiner or AWS DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC) in the * AWS DMS User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UsePathPrefix": "Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This value specifies the path prefix used to replace the default Oracle root to access the redo logs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint PostgreSqlSettings": { - "SecretsManagerAccessRoleArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerSecretId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AfterConnectScript": "For use with change data capture \\(CDC\\) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data\\. \nExample: `afterConnectScript=SET session_replication_role='replica'` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CaptureDdls": "To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts\\. You can later remove these artifacts\\. \nIf this value is set to `N`, you don't have to create tables or triggers on the source database\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DdlArtifactsSchema": "The schema in which the operational DDL database artifacts are created\\. \nExample: `ddlArtifactsSchema=xyzddlschema;` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExecuteTimeout": "Sets the client statement timeout for the PostgreSQL instance, in seconds\\. The default value is 60 seconds\\. \nExample: `executeTimeout=100;` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailTasksOnLobTruncation": "When set to `true`, this value causes a task to fail if the actual size of a LOB column is greater than the specified `LobMaxSize`\\. \nIf task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HeartbeatEnable": "The write\\-ahead log \\(WAL\\) heartbeat feature mimics a dummy transaction\\. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source\\. This heartbeat keeps `restart_lsn` moving and prevents storage full scenarios\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HeartbeatFrequency": "Sets the WAL heartbeat frequency \\(in minutes\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HeartbeatSchema": "Sets the schema in which the heartbeat artifacts are created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxFileSize": "Specifies the maximum size \\(in KB\\) of any \\.csv file used to transfer data to PostgreSQL\\. \nExample: `maxFileSize=512` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PluginName": "Specifies the plugin to use to create a replication slot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerAccessRoleArn": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerSecretId": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the PostgreSQL endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SlotName": "Sets the name of a previously created logical replication slot for a change data capture \\(CDC\\) load of the PostgreSQL source instance\\. \nWhen used with the `CdcStartPosition` request parameter for the AWS DMS API , this attribute also makes it possible to use native CDC start points\\. DMS verifies that the specified logical replication slot exists before starting the CDC load task\\. It also verifies that the task was created with a valid setting of `CdcStartPosition`\\. If the specified slot doesn't exist or the task doesn't have a valid `CdcStartPosition` setting, DMS raises an error\\. \nFor more information about setting the `CdcStartPosition` request parameter, see [Determining a CDC native start point](dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native) in the * AWS Database Migration Service User Guide*\\. For more information about using `CdcStartPosition`, see [CreateReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html), [StartReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html), and [ModifyReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint RedisSettings": { "AuthPassword": "The password provided with the `auth-role` and `auth-token` options of the `AuthType` setting for a Redis target endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -5917,102 +6707,125 @@ "SslSecurityProtocol": "The connection to a Redis target endpoint using Transport Layer Security \\(TLS\\)\\. Valid values include `plaintext` and `ssl-encryption`\\. The default is `ssl-encryption`\\. The `ssl-encryption` option makes an encrypted connection\\. Optionally, you can identify an Amazon Resource Name \\(ARN\\) for an SSL certificate authority \\(CA\\) using the `SslCaCertificateArn `setting\\. If an ARN isn't given for a CA, DMS uses the Amazon root CA\\. \nThe `plaintext` option doesn't provide Transport Layer Security \\(TLS\\) encryption for traffic between endpoint and database\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `plaintext | ssl-encryption` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint RedshiftSettings": { - "SecretsManagerAccessRoleArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerSecretId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AcceptAnyDate": "A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error\\. You can choose `true` or `false` \\(the default\\)\\. \nThis parameter applies only to TIMESTAMP and DATE columns\\. Always use ACCEPTANYDATE with the DATEFORMAT parameter\\. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AfterConnectScript": "Code to run after connecting\\. This parameter should contain the code itself, not the name of a file containing the code\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BucketFolder": "An S3 folder where the comma\\-separated\\-value \\(\\.csv\\) files are stored before being uploaded to the target Redshift cluster\\. \nFor full load mode, AWS DMS converts source records into \\.csv files and loads them to the *BucketFolder/TableID* path\\. AWS DMS uses the Redshift `COPY` command to upload the \\.csv files to the target table\\. The files are deleted once the `COPY` operation has finished\\. For more information, see [COPY](https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) in the *Amazon Redshift Database Developer Guide*\\. \nFor change\\-data\\-capture \\(CDC\\) mode, AWS DMS creates a *NetChanges* table, and loads the \\.csv files to this *BucketFolder/NetChangesTableID* path\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BucketName": "The name of the intermediate S3 bucket used to store \\.csv files before uploading data to Redshift\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CaseSensitiveNames": "If Amazon Redshift is configured to support case sensitive schema names, set `CaseSensitiveNames` to `true`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CompUpdate": "If you set `CompUpdate` to `true` Amazon Redshift applies automatic compression if the table is empty\\. This applies even if the table columns already have encodings other than `RAW`\\. If you set `CompUpdate` to `false`, automatic compression is disabled and existing column encodings aren't changed\\. The default is `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectionTimeout": "A value that sets the amount of time to wait \\(in milliseconds\\) before timing out, beginning from when you initially establish a connection\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DateFormat": "The date format that you are using\\. Valid values are `auto` \\(case\\-sensitive\\), your date format string enclosed in quotes, or NULL\\. If this parameter is left unset \\(NULL\\), it defaults to a format of 'YYYY\\-MM\\-DD'\\. Using `auto` recognizes most strings, even some that aren't supported when you use a date format string\\. \nIf your date and time values use formats different from each other, set this to `auto`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EmptyAsNull": "A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL\\. A value of `true` sets empty CHAR and VARCHAR fields to null\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EncryptionMode": "The type of server\\-side encryption that you want to use for your data\\. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3\\. You can choose either `SSE_S3` \\(the default\\) or `SSE_KMS`\\. \nFor the `ModifyEndpoint` operation, you can change the existing value of the `EncryptionMode` parameter from `SSE_KMS` to `SSE_S3`\\. But you can\u2019t change the existing value from `SSE_S3` to `SSE_KMS`\\.\nTo use `SSE_S3`, create an AWS Identity and Access Management \\(IAM\\) role with a policy that allows `\"arn:aws:s3:::*\"` to use the following actions: `\"s3:PutObject\", \"s3:ListBucket\"` \n*Required*: No \n*Type*: String \n*Allowed values*: `sse-kms | sse-s3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExplicitIds": "This setting is only valid for a full\\-load migration task\\. Set `ExplicitIds` to `true` to have tables with `IDENTITY` columns override their auto\\-generated values with explicit values loaded from the source data files used to populate the tables\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FileTransferUploadStreams": "The number of threads used to upload a single file\\. This parameter accepts a value from 1 through 64\\. It defaults to 10\\. \nThe number of parallel streams used to upload a single \\.csv file to an S3 bucket using S3 Multipart Upload\\. For more information, see [Multipart upload overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html)\\. \n `FileTransferUploadStreams` accepts a value from 1 through 64\\. It defaults to 10\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LoadTimeout": "The amount of time to wait \\(in milliseconds\\) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxFileSize": "The maximum size \\(in KB\\) of any \\.csv file used to load data on an S3 bucket and transfer data to Amazon Redshift\\. It defaults to 1048576KB \\(1 GB\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RemoveQuotes": "A value that specifies to remove surrounding quotation marks from strings in the incoming data\\. All characters within the quotation marks, including delimiters, are retained\\. Choose `true` to remove quotation marks\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReplaceChars": "A value that specifies to replaces the invalid characters specified in `ReplaceInvalidChars`, substituting the specified characters instead\\. The default is `\"?\"`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReplaceInvalidChars": "A list of characters that you want to replace\\. Use with `ReplaceChars`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerAccessRoleArn": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerSecretId": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the Amazon Redshift endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerSideEncryptionKmsKeyId": "The AWS KMS key ID\\. If you are using `SSE_KMS` for the `EncryptionMode`, provide this key ID\\. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServiceAccessRoleArn": "The Amazon Resource Name \\(ARN\\) of the IAM role that has access to the Amazon Redshift service\\. The role must allow the `iam:PassRole` action\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TimeFormat": "The time format that you want to use\\. Valid values are `auto` \\(case\\-sensitive\\), `'timeformat_string'`, `'epochsecs'`, or `'epochmillisecs'`\\. It defaults to 10\\. Using `auto` recognizes most strings, even some that aren't supported when you use a time format string\\. \nIf your date and time values use formats different from each other, set this parameter to `auto`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TrimBlanks": "A value that specifies to remove the trailing white space characters from a VARCHAR string\\. This parameter applies only to columns with a VARCHAR data type\\. Choose `true` to remove unneeded white space\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TruncateColumns": "A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column\\. This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less\\. Choose `true` to truncate data\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WriteBufferSize": "The size \\(in KB\\) of the in\\-memory file write buffer used when generating \\.csv files on the local disk at the DMS replication instance\\. The default value is 1000 \\(buffer size is 1000KB\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint S3Settings": { "AddColumnName": "An optional parameter that, when set to `true` or `y`, you can use to add column name information to the \\.csv output file\\. \nThe default value is `false`\\. Valid values are `true`, `false`, `y`, and `n`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "BucketFolder": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "BucketName": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CannedAclForObjects": "A value that enables AWS DMS to specify a predefined \\(canned\\) access control list for objects created in an Amazon S3 bucket as \\.csv or \\.parquet files\\. For more information about Amazon S3 canned ACLs, see [Canned ACL](http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 Developer Guide\\.* \nThe default value is NONE\\. Valid values include NONE, PRIVATE, PUBLIC\\_READ, PUBLIC\\_READ\\_WRITE, AUTHENTICATED\\_READ, AWS\\_EXEC\\_READ, BUCKET\\_OWNER\\_READ, and BUCKET\\_OWNER\\_FULL\\_CONTROL\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `authenticated-read | aws-exec-read | bucket-owner-full-control | bucket-owner-read | none | private | public-read | public-read-write` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CdcInsertsAndUpdates": "A value that enables a change data capture \\(CDC\\) load to write INSERT and UPDATE operations to \\.csv or \\.parquet \\(columnar storage\\) output files\\. The default setting is `false`, but when `CdcInsertsAndUpdates` is set to `true` or `y`, only INSERTs and UPDATEs from the source database are migrated to the \\.csv or \\.parquet file\\. \nFor \\.csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the `IncludeOpForFullLoad` parameter\\. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to either `I` or `U` to indicate INSERT and UPDATE operations at the source\\. But if `IncludeOpForFullLoad` is set to `false`, CDC records are written without an indication of INSERT or UPDATE operations at the source\\. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the * AWS Database Migration Service User Guide\\.*\\. \n AWS DMS supports the use of the `CdcInsertsAndUpdates` parameter in versions 3\\.3\\.1 and later\\. \n `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint\\. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CdcInsertsOnly": "A value that enables a change data capture \\(CDC\\) load to write only INSERT operations to \\.csv or columnar storage \\(\\.parquet\\) output files\\. By default \\(the `false` setting\\), the first field in a \\.csv or \\.parquet record contains the letter I \\(INSERT\\), U \\(UPDATE\\), or D \\(DELETE\\)\\. These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target\\. \nIf `CdcInsertsOnly` is set to `true` or `y`, only INSERTs from the source database are migrated to the \\.csv or \\.parquet file\\. For \\.csv format only, how these INSERTs are recorded depends on the value of `IncludeOpForFullLoad`\\. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to I to indicate the INSERT operation at the source\\. If `IncludeOpForFullLoad` is set to `false`, every CDC record is written without a first field to indicate the INSERT operation at the source\\. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the * AWS Database Migration Service User Guide\\.*\\. \n AWS DMS supports the interaction described preceding between the `CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in versions 3\\.1\\.4 and later\\. \n `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint\\. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BucketFolder": "An optional parameter to set a folder name in the S3 bucket\\. If provided, tables are created in the path `bucketFolder/schema_name/table_name/`\\. If this parameter isn't specified, the path used is `schema_name/table_name/`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BucketName": "The name of the S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CannedAclForObjects": "A value that enables AWS DMS to specify a predefined \\(canned\\) access control list \\(ACL\\) for objects created in an Amazon S3 bucket as \\.csv or \\.parquet files\\. For more information about Amazon S3 canned ACLs, see [ Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 Developer Guide*\\. \nThe default value is NONE\\. Valid values include NONE, PRIVATE, PUBLIC\\_READ, PUBLIC\\_READ\\_WRITE, AUTHENTICATED\\_READ, AWS\\_EXEC\\_READ, BUCKET\\_OWNER\\_READ, and BUCKET\\_OWNER\\_FULL\\_CONTROL\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `authenticated-read | aws-exec-read | bucket-owner-full-control | bucket-owner-read | none | private | public-read | public-read-write` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CdcInsertsAndUpdates": "A value that enables a change data capture \\(CDC\\) load to write INSERT and UPDATE operations to \\.csv or \\.parquet \\(columnar storage\\) output files\\. The default setting is `false`, but when `CdcInsertsAndUpdates` is set to `true` or `y`, only INSERTs and UPDATEs from the source database are migrated to the \\.csv or \\.parquet file\\. \nFor \\.csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the `IncludeOpForFullLoad` parameter\\. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to either `I` or `U` to indicate INSERT and UPDATE operations at the source\\. But if `IncludeOpForFullLoad` is set to `false`, CDC records are written without an indication of INSERT or UPDATE operations at the source\\. For more information about how these settings work together, see [ Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide*\\. \n AWS DMS supports the use of the `CdcInsertsAndUpdates` parameter in versions 3\\.3\\.1 and later\\. \n `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint\\. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CdcInsertsOnly": "A value that enables a change data capture \\(CDC\\) load to write only INSERT operations to \\.csv or columnar storage \\(\\.parquet\\) output files\\. By default \\(the `false` setting\\), the first field in a \\.csv or \\.parquet record contains the letter I \\(INSERT\\), U \\(UPDATE\\), or D \\(DELETE\\)\\. These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target\\. \nIf `CdcInsertsOnly` is set to `true` or `y`, only INSERTs from the source database are migrated to the \\.csv or \\.parquet file\\. For \\.csv format only, how these INSERTs are recorded depends on the value of `IncludeOpForFullLoad`\\. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to I to indicate the INSERT operation at the source\\. If `IncludeOpForFullLoad` is set to `false`, every CDC record is written without a first field to indicate the INSERT operation at the source\\. For more information about how these settings work together, see [ Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide*\\. \nAWS DMS supports the interaction described preceding between the `CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in versions 3\\.1\\.4 and later\\. \n `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint\\. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CdcMaxBatchInterval": "Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3\\. \nWhen `CdcMaxBatchInterval` and `CdcMinFileSize` are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template\\. \nThe default value is 60 seconds\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CdcMinFileSize": "Minimum file size, defined in megabytes, to reach for a file output to Amazon S3\\. \nWhen `CdcMinFileSize` and `CdcMaxBatchInterval` are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template\\. \nThe default value is 32 MB\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CdcPath": "Specifies the folder path of CDC files\\. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional\\. If `CdcPath` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint\\. For an S3 target if you set [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) to `true`, AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load\\. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) and [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName)\\. \nFor example, if you specify `CdcPath` as `MyChangedData`, and you specify `BucketName` as `MyTargetBucket` but do not specify `BucketFolder`, AWS DMS creates the CDC folder path following: `MyTargetBucket/MyChangedData`\\. \nIf you specify the same `CdcPath`, and you specify `BucketName` as `MyTargetBucket` and `BucketFolder` as `MyTargetData`, AWS DMS creates the CDC folder path following: `MyTargetBucket/MyTargetData/MyChangedData`\\. \nFor more information on CDC including transaction order on an S3 target, see [Capturing data changes \\(CDC\\) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath)\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.2 and later\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CompressionType": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `gzip | none` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CsvDelimiter": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CdcMinFileSize": "Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3\\. \nWhen `CdcMinFileSize` and `CdcMaxBatchInterval` are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template\\. \nThe default value is 32 MB\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CdcPath": "Specifies the folder path of CDC files\\. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional\\. If `CdcPath` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint\\. For an S3 target if you set [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) to `true`, AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load\\. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) and [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName)\\. \nFor example, if you specify `CdcPath` as `MyChangedData`, and you specify `BucketName` as `MyTargetBucket` but do not specify `BucketFolder`, AWS DMS creates the CDC folder path following: `MyTargetBucket/MyChangedData`\\. \nIf you specify the same `CdcPath`, and you specify `BucketName` as `MyTargetBucket` and `BucketFolder` as `MyTargetData`, AWS DMS creates the CDC folder path following: `MyTargetBucket/MyTargetData/MyChangedData`\\. \nFor more information on CDC including transaction order on an S3 target, see [ Capturing data changes \\(CDC\\) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath)\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.2 and later\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CompressionType": "An optional parameter\\. When set to GZIP it enables the service to compress the target files\\. To allow the service to write the target files uncompressed, either set this parameter to NONE \\(the default\\) or don't specify the parameter at all\\. This parameter applies to both \\.csv and \\.parquet file formats\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `gzip | none` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CsvDelimiter": "The delimiter used to separate columns in the \\.csv file for both source and target\\. The default is a comma\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CsvNoSupValue": "This setting only applies if your Amazon S3 output files during a change data capture \\(CDC\\) load are written in \\.csv format\\. If [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-UseCsvNoSupValue) is set to true, specify a string value that you want AWS DMS to use for all columns not included in the supplemental log\\. If you do not specify a string value, AWS DMS uses the null value for these columns regardless of the `UseCsvNoSupValue` setting\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.1 and later\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CsvNullValue": "An optional parameter that specifies how AWS DMS treats null values\\. While handling the null value, you can use this parameter to pass a user\\-defined string as null when writing to the target\\. For example, when target columns are not nullable, you can use this option to differentiate between the empty string value and the null value\\. So, if you set this parameter value to the empty string \\(\"\" or ''\\), AWS DMS treats the empty string as the null value instead of `NULL`\\. \nThe default value is `NULL`\\. Valid values include any valid string\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CsvRowDelimiter": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CsvRowDelimiter": "The delimiter used to separate rows in the \\.csv file for both source and target\\. \nThe default is a carriage return \\(`\\n`\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DataFormat": "The format of the data that you want to use for output\\. You can choose one of the following: \n+ `csv` : This is a row\\-based file format with comma\\-separated values \\(\\.csv\\)\\. \n+ `parquet` : Apache Parquet \\(\\.parquet\\) is a columnar storage file format that features efficient compression and provides faster query response\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `csv | parquet` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DataPageSize": "The size of one data page in bytes\\. This parameter defaults to 1024 \\* 1024 bytes \\(1 MiB\\)\\. This number is used for \\.parquet file format only\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DatePartitionDelimiter": "Specifies a date separating delimiter to use during folder partitioning\\. The default value is `SLASH`\\. Use this parameter when `DatePartitionedEnabled` is set to `true`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DASH | NONE | SLASH | UNDERSCORE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DatePartitionEnabled": "When set to `true`, this parameter partitions S3 bucket folders based on transaction commit dates\\. The default value is `false`\\. For more information about date\\-based folder partitioning, see [Using date\\-based folder partitioning](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DatePartitionEnabled": "When set to `true`, this parameter partitions S3 bucket folders based on transaction commit dates\\. The default value is `false`\\. For more information about date\\-based folder partitioning, see [ Using date\\-based folder partitioning](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DatePartitionSequence": "Identifies the sequence of the date format to use during folder partitioning\\. The default value is `YYYYMMDD`\\. Use this parameter when `DatePartitionedEnabled` is set to `true`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DDMMYYYY | MMYYYYDD | YYYYMM | YYYYMMDD | YYYYMMDDHH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DatePartitionTimezone": "When creating an S3 target endpoint, set `DatePartitionTimezone` to convert the current UTC time into a specified time zone\\. The conversion occurs when a date partition folder is created and a CDC filename is generated\\. The time zone format is Area/Location\\. Use this parameter when `DatePartitionedEnabled` is set to `true`, as shown in the following example\\. \n `s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\", \"DatePartitionDelimiter\": \"SLASH\", \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\": \"dms-nattarat-test\"}'` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DatePartitionTimezone": "When creating an S3 target endpoint, set `DatePartitionTimezone` to convert the current UTC time into a specified time zone\\. The conversion occurs when a date partition folder is created and a change data capture \\(CDC\\) file name is generated\\. The time zone format is Area/Location\\. Use this parameter when `DatePartitionedEnabled` is set to `true`, as shown in the following example\\. \n `s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\", \"DatePartitionDelimiter\": \"SLASH\", \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\": \"dms-nattarat-test\"}'` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DictPageSizeLimit": "The maximum size of an encoded dictionary page of a column\\. If the dictionary page exceeds this, this column is stored using an encoding type of `PLAIN`\\. This parameter defaults to 1024 \\* 1024 bytes \\(1 MiB\\), the maximum size of a dictionary page before it reverts to `PLAIN` encoding\\. This size is used for \\.parquet file format only\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnableStatistics": "A value that enables statistics for Parquet pages and row groups\\. Choose `true` to enable statistics, `false` to disable\\. Statistics include `NULL`, `DISTINCT`, `MAX`, and `MIN` values\\. This parameter defaults to `true`\\. This value is used for \\.parquet file format only\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EncodingType": "The type of encoding you are using: \n+ `RLE_DICTIONARY` uses a combination of bit\\-packing and run\\-length encoding to store repeated values more efficiently\\. This is the default\\.\n+ `PLAIN` doesn't use encoding at all\\. Values are stored as they are\\.\n+ `PLAIN_DICTIONARY` builds a dictionary of the values encountered in a given column\\. The dictionary is stored in a dictionary page for each column chunk\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `plain | plain-dictionary | rle-dictionary` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EncryptionMode": "The type of server\\-side encryption that you want to use for your data\\. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3\\. You can choose either `SSE_S3` \\(the default\\) or `SSE_KMS`\\. \nFor the `ModifyEndpoint` operation, you can change the existing value of the `EncryptionMode` parameter from `SSE_KMS` to `SSE_S3`\\. But you can\u2019t change the existing value from `SSE_S3` to `SSE_KMS`\\.\nTo use `SSE_S3`, you need an AWS Identity and Access Management \\(IAM\\) role with permission to allow `\"arn:aws:s3:::dms-*\"` to use the following actions: \n+ `s3:CreateBucket` \n+ `s3:ListBucket` \n+ `s3:DeleteBucket` \n+ `s3:GetBucketLocation` \n+ `s3:GetObject` \n+ `s3:PutObject` \n+ `s3:DeleteObject` \n+ `s3:GetObjectVersion` \n+ `s3:GetBucketPolicy` \n+ `s3:PutBucketPolicy` \n+ `s3:DeleteBucketPolicy` \n*Required*: No \n*Type*: String \n*Allowed values*: `sse-kms | sse-s3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ExternalTableDefinition": "Not currently supported by AWS CloudFormation\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EncodingType": "The type of encoding that you're using: \n+ `RLE_DICTIONARY` uses a combination of bit\\-packing and run\\-length encoding to store repeated values more efficiently\\. This is the default\\.\n+ `PLAIN` doesn't use encoding at all\\. Values are stored as they are\\.\n+ `PLAIN_DICTIONARY` builds a dictionary of the values encountered in a given column\\. The dictionary is stored in a dictionary page for each column chunk\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `plain | plain-dictionary | rle-dictionary` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EncryptionMode": "The type of server\\-side encryption that you want to use for your data\\. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3\\. You can choose either `SSE_S3` \\(the default\\) or `SSE_KMS`\\. \nFor the `ModifyEndpoint` operation, you can change the existing value of the `EncryptionMode` parameter from `SSE_KMS` to `SSE_S3`\\. But you can\u2019t change the existing value from `SSE_S3` to `SSE_KMS`\\.\nTo use `SSE_S3`, you need an IAM role with permission to allow `\"arn:aws:s3:::dms-*\"` to use the following actions: \n+ `s3:CreateBucket` \n+ `s3:ListBucket` \n+ `s3:DeleteBucket` \n+ `s3:GetBucketLocation` \n+ `s3:GetObject` \n+ `s3:PutObject` \n+ `s3:DeleteObject` \n+ `s3:GetObjectVersion` \n+ `s3:GetBucketPolicy` \n+ `s3:PutBucketPolicy` \n+ `s3:DeleteBucketPolicy` \n*Required*: No \n*Type*: String \n*Allowed values*: `sse-kms | sse-s3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExternalTableDefinition": "The external table definition\\. \nConditional: If `S3` is used as a source then `ExternalTableDefinition` is required\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IgnoreHeaderRows": "When this value is set to 1, AWS DMS ignores the first row header in a \\.csv file\\. A value of 1 turns on the feature; a value of 0 turns off the feature\\. \nThe default is 0\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IncludeOpForFullLoad": "A value that enables a full load to write INSERT operations to the comma\\-separated value \\(\\.csv\\) output files only to indicate how the rows were added to the source database\\. \n AWS DMS supports the `IncludeOpForFullLoad` parameter in versions 3\\.1\\.4 and later\\.\nFor full load, records can only be inserted\\. By default \\(the `false` setting\\), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database\\. If `IncludeOpForFullLoad` is set to `true` or `y`, the INSERT is recorded as an I annotation in the first field of the \\.csv file\\. This allows the format of your target records from a full load to be consistent with the target records from a CDC load\\. \nThis setting works together with the `CdcInsertsOnly` and the `CdcInsertsAndUpdates` parameters for output to \\.csv files only\\. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the * AWS Database Migration Service User Guide\\.*\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeOpForFullLoad": "A value that enables a full load to write INSERT operations to the comma\\-separated value \\(\\.csv\\) output files only to indicate how the rows were added to the source database\\. \n AWS DMS supports the `IncludeOpForFullLoad` parameter in versions 3\\.1\\.4 and later\\.\nFor full load, records can only be inserted\\. By default \\(the `false` setting\\), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database\\. If `IncludeOpForFullLoad` is set to `true` or `y`, the INSERT is recorded as an I annotation in the first field of the \\.csv file\\. This allows the format of your target records from a full load to be consistent with the target records from a CDC load\\. \nThis setting works together with the `CdcInsertsOnly` and the `CdcInsertsAndUpdates` parameters for output to \\.csv files only\\. For more information about how these settings work together, see [ Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxFileSize": "A value that specifies the maximum size \\(in KB\\) of any \\.csv file to be created while migrating to an S3 target during full load\\. \nThe default value is 1,048,576 KB \\(1 GB\\)\\. Valid values include 1 to 1,048,576\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ParquetTimestampInMillisecond": "A value that specifies the precision of any `TIMESTAMP` column values that are written to an Amazon S3 object file in \\.parquet format\\. \n AWS DMS supports the `ParquetTimestampInMillisecond` parameter in versions 3\\.1\\.4 and later\\.\nWhen `ParquetTimestampInMillisecond` is set to `true` or `y`, AWS DMS writes all `TIMESTAMP` columns in a \\.parquet formatted file with millisecond precision\\. Otherwise, DMS writes them with microsecond precision\\. \nCurrently, Amazon Athena and AWS Glue can handle only millisecond precision for `TIMESTAMP` values\\. Set this parameter to `true` for S3 endpoint object files that are \\.parquet formatted only if you plan to query or process the data with Athena or AWS Glue\\. \n AWS DMS writes any `TIMESTAMP` column values written to an S3 file in \\.csv format with microsecond precision\\. \nSetting `ParquetTimestampInMillisecond` has no effect on the string format of the timestamp column value that is inserted by setting the `TimestampColumnName` parameter\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ParquetVersion": "The version of the Apache Parquet format that you want to use: `parquet_1_0` \\(the default\\) or `parquet_2_0`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `parquet-1-0 | parquet-2-0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PreserveTransactions": "If set to `true`, AWS DMS saves the transaction order for a change data capture \\(CDC\\) load on the Amazon S3 target specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath)\\. For more information, see [Capturing data changes \\(CDC\\) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath)\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.2 and later\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PreserveTransactions": "If this setting is set to `true`, AWS DMS saves the transaction order for a change data capture \\(CDC\\) load on the Amazon S3 target specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath)\\. For more information, see [ Capturing data changes \\(CDC\\) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath)\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.2 and later\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Rfc4180": "For an S3 source, when this value is set to `true` or `y`, each leading double quotation mark has to be followed by an ending double quotation mark\\. This formatting complies with RFC 4180\\. When this value is set to `false` or `n`, string literals are copied to the target as is\\. In this case, a delimiter \\(row or column\\) signals the end of the field\\. Thus, you can't use a delimiter as part of the string, because it signals the end of the value\\. \nFor an S3 target, an optional parameter used to set behavior to comply with RFC 4180 for data migrated to Amazon S3 using \\.csv file format only\\. When this value is set to `true` or `y` using Amazon S3 as a target, if the data has quotation marks or newline characters in it, AWS DMS encloses the entire column with an additional pair of double quotation marks \\(\"\\)\\. Every quotation mark within the data is repeated twice\\. \nThe default value is `true`\\. Valid values include `true`, `false`, `y`, and `n`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RowGroupLength": "The number of rows in a row group\\. A smaller row group size provides faster reads\\. But as the number of row groups grows, the slower writes become\\. This parameter defaults to 10,000 rows\\. This number is used for \\.parquet file format only\\. \nIf you choose a value larger than the maximum, `RowGroupLength` is set to the max row group length in bytes \\(64 \\* 1024 \\* 1024\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServerSideEncryptionKmsKeyId": "If you are using `SSE_KMS` for the `EncryptionMode`, provide the AWS KMS key ID\\. The key that you use needs an attached policy that enables AWS Identity and Access Management \\(IAM\\) user permissions and allows use of the key\\. \nHere is a CLI example: `aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value ` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServiceAccessRoleArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimestampColumnName": "A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target\\. \n AWS DMS supports the `TimestampColumnName` parameter in versions 3\\.1\\.4 and later\\.\nDMS includes an additional `STRING` column in the \\.csv or \\.parquet object files of your migrated data when you set `TimestampColumnName` to a nonblank value\\. \nFor a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS\\. \nFor a change data capture \\(CDC\\) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database\\. \nThe string format for this timestamp column value is `yyyy-MM-dd HH:mm:ss.SSSSSS`\\. By default, the precision of this value is in microseconds\\. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database\\. \nWhen the `AddColumnName` parameter is set to `true`, DMS also includes a name for the timestamp column that you set with `TimestampColumnName`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UseCsvNoSupValue": "This setting applies if the S3 output files during a change data capture \\(CDC\\) load are written in \\.csv format\\. If set to `true` for columns not included in the supplemental log, AWS DMS uses the value specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue)\\. If not set or set to `false`, AWS DMS uses the null value for these columns\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.1 and later\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerSideEncryptionKmsKeyId": "If you are using `SSE_KMS` for the `EncryptionMode`, provide the AWS KMS key ID\\. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key\\. \nHere is a CLI example: `aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value ` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServiceAccessRoleArn": "A required parameter that specifies the Amazon Resource Name \\(ARN\\) used by the service to access the IAM role\\. The role must allow the `iam:PassRole` action\\. It enables AWS DMS to read and write objects from an S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TimestampColumnName": "A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target\\. \n AWS DMS supports the `TimestampColumnName` parameter in versions 3\\.1\\.4 and later\\.\nAWS DMS includes an additional `STRING` column in the \\.csv or \\.parquet object files of your migrated data when you set `TimestampColumnName` to a nonblank value\\. \nFor a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS\\. \nFor a change data capture \\(CDC\\) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database\\. \nThe string format for this timestamp column value is `yyyy-MM-dd HH:mm:ss.SSSSSS`\\. By default, the precision of this value is in microseconds\\. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database\\. \nWhen the `AddColumnName` parameter is set to `true`, DMS also includes a name for the timestamp column that you set with `TimestampColumnName`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseCsvNoSupValue": "This setting applies if the S3 output files during a change data capture \\(CDC\\) load are written in \\.csv format\\. If this setting is set to `true` for columns not included in the supplemental log, AWS DMS uses the value specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue)\\. If this setting isn't set or is set to `false`, AWS DMS uses the null value for these columns\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.1 and later\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UseTaskStartTimeForFullLoadTimestamp": "When set to true, this parameter uses the task start time as the timestamp column value instead of the time data is written to target\\. For full load, when `useTaskStartTimeForFullLoadTimestamp` is set to `true`, each row of the timestamp column contains the task start time\\. For CDC loads, each row of the timestamp column contains the transaction commit time\\. \nWhen `useTaskStartTimeForFullLoadTimestamp` is set to `false`, the full load timestamp in the timestamp column increments with the time data arrives at the target\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::Endpoint SybaseSettings": { - "SecretsManagerAccessRoleArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsManagerSecretId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SecretsManagerAccessRoleArn": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the SAP ASE endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsManagerSecretId": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the SAP SAE endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::EventSubscription": { "Enabled": "Indicates whether to activate the subscription\\. If you don't specify this property, AWS CloudFormation activates the subscription\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EventCategories": "A list of event categories for a source type that you want to subscribe to\\. If you don't specify this property, you are notified about all event categories\\. For more information, see [Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS DMS User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SnsTopicArn": "The Amazon Resource Name \\(ARN\\) of the Amazon SNS topic created for event notification\\. The ARN is created by Amazon SNS when you create a topic and subscribe to it\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventCategories": "A list of event categories for a source type that you want to subscribe to\\. If you don't specify this property, you are notified about all event categories\\. For more information, see [ Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS DMS User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SnsTopicArn": "The Amazon Resource Name \\(ARN\\) of the Amazon SNS topic created for event notification\\. The ARN is created by Amazon SNS when you create a topic and subscribe to it\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourceIds": "A list of identifiers for which AWS DMS provides notification events\\. \nIf you don't specify a value, notifications are provided for all sources\\. \nIf you specify multiple values, they must be of the same type\\. For example, if you specify a database instance ID, then all of the other values must be database instance IDs\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SourceType": "The type of AWS DMS resource that generates the events\\. For example, if you want to be notified of events generated by a replication instance, you set this parameter to `replication-instance`\\. If this value isn't specified, all events are returned\\. \nValid values: `replication-instance` \\| `replication-task` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceType": "The type of AWS DMS resource that generates the events\\. For example, if you want to be notified of events generated by a replication instance, you set this parameter to `replication-instance`\\. If this value isn't specified, all events are returned\\. \n*Valid values*: `replication-instance` \\| `replication-task` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SubscriptionName": "The name of the AWS DMS event notification subscription\\. This name must be less than 255 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "One or more tags to be assigned to the event subscription\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Tags": "One or more tags to be assigned to the event subscription\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::ReplicationInstance": { "AllocatedStorage": "The amount of storage \\(in gigabytes\\) to be initially allocated for the replication instance\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AllowMajorVersionUpgrade": "Indicates that major version upgrades are allowed\\. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible\\. \nThis parameter must be set to `true` when specifying a value for the `EngineVersion` parameter that is a different major version than the replication instance's current version\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AutoMinorVersionUpgrade": "A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window\\. This parameter defaults to `true`\\. \nDefault: `true` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AvailabilityZone": "The Availability Zone that the replication instance will be created in\\. \nThe default value is a random, system\\-chosen Availability Zone in the endpoint's , for example: `us-east-1d` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AutoMinorVersionUpgrade": "A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window\\. This parameter defaults to `true`\\. \nDefault: `true` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AvailabilityZone": "The Availability Zone that the replication instance will be created in\\. \nThe default value is a random, system\\-chosen Availability Zone in the endpoint's AWS Region, for example `us-east-1d`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EngineVersion": "The engine version number of the replication instance\\. \nIf an engine version number is not specified when a replication instance is created, the default is the latest engine version available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KmsKeyId": "An AWS KMS key identifier that is used to encrypt the data on the replication instance\\. \nIf you don't specify a value for the `KmsKeyId` parameter, then AWS DMS uses your default encryption key\\. \n AWS KMS creates the default encryption key for your AWS account\\. Your AWS account has a different default encryption key for each AWS Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MultiAZ": "Specifies whether the replication instance is a Multi\\-AZ deployment\\. You can't set the `AvailabilityZone` parameter if the Multi\\-AZ parameter is set to `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \n Format: `ddd:hh24:mi-ddd:hh24:mi` \nDefault: A 30\\-minute window selected at random from an 8\\-hour block of time per AWS Region, occurring on a random day of the week\\. \nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun \nConstraints: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PubliclyAccessible": "Specifies the accessibility options for the replication instance\\. A value of `true` represents an instance with a public IP address\\. A value of `false` represents an instance with a private IP address\\. The default value is `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ReplicationInstanceClass": "The compute and memory capacity of the replication instance as defined for the specified replication instance class\\. For example to specify the instance class dms\\.c4\\.large, set this parameter to `\"dms.c4.large\"`\\. \nFor more information on the settings and capacities for the available replication instance classes, see [ Selecting the right AWS DMS replication instance for your migration](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ReplicationInstanceIdentifier": "The replication instance identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain 1\\-63 alphanumeric characters or hyphens\\.\n+ First character must be a letter\\.\n+ Can't end with a hyphen or contain two consecutive hyphens\\.\nExample: `myrepinstance` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsKeyId": "An AWS KMS key identifier that is used to encrypt the data on the replication instance\\. \nIf you don't specify a value for the `KmsKeyId` parameter, AWS DMS uses your default encryption key\\. \nAWS KMS creates the default encryption key for your AWS account\\. Your AWS account has a different default encryption key for each AWS Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MultiAZ": "Specifies whether the replication instance is a Multi\\-AZ deployment\\. You can't set the `AvailabilityZone` parameter if the Multi\\-AZ parameter is set to `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in UTC\\. \n*Format*: `ddd:hh24:mi-ddd:hh24:mi` \n*Default*: A 30\\-minute window selected at random from an 8\\-hour block of time per AWS Region, occurring on a random day of the week\\. \n*Valid days* \\(`ddd`\\): `Mon` \\| `Tue` \\| `Wed` \\| `Thu` \\| `Fri` \\| `Sat` \\| `Sun` \n*Constraints*: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PubliclyAccessible": "Specifies the accessibility options for the replication instance\\. A value of `true` represents an instance with a public IP address\\. A value of `false` represents an instance with a private IP address\\. The default value is `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ReplicationInstanceClass": "The compute and memory capacity of the replication instance as defined for the specified replication instance class\\. For example, to specify the instance class dms\\.c4\\.large, set this parameter to `\"dms.c4.large\"`\\. For more information on the settings and capacities for the available replication instance classes, see [ Selecting the right AWS DMS replication instance for your migration](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth) in the *AWS Database Migration Service User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReplicationInstanceIdentifier": "The replication instance identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain 1\\-63 alphanumeric characters or hyphens\\.\n+ First character must be a letter\\.\n+ Can't end with a hyphen or contain two consecutive hyphens\\.\nExample: `myrepinstance` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ReplicationSubnetGroupIdentifier": "A subnet group to associate with the replication instance\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ResourceIdentifier": "A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "One or more tags to be assigned to the replication instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "VpcSecurityGroupIds": "Specifies the VPC security group to be used with the replication instance\\. The VPC security group must work with the VPC containing the replication instance\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ResourceIdentifier": "A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "One or more tags to be assigned to the replication instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcSecurityGroupIds": "Specifies the virtual private cloud \\(VPC\\) security group to be used with the replication instance\\. The VPC security group must work with the VPC containing the replication instance\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::ReplicationSubnetGroup": { "ReplicationSubnetGroupDescription": "The description for the subnet group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ReplicationSubnetGroupIdentifier": "The identifier for the replication subnet group\\. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the identifier\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ReplicationSubnetGroupIdentifier": "The identifier for the replication subnet group\\. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the identifier\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SubnetIds": "One or more subnet IDs to be assigned to the subnet group\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "One or more tags to be assigned to the subnet group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Tags": "One or more tags to be assigned to the subnet group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DMS::ReplicationTask": { - "CdcStartPosition": "Indicates when you want a change data capture \\(CDC\\) operation to start\\. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start\\. Specifying both values results in an error\\. \n The value can be in date, checkpoint, or LSN/SCN format\\. \nDate Example: \\-\\-cdc\\-start\\-position \u201c2018\\-03\\-08T12:12:12\u201d \nCheckpoint Example: \\-\\-cdc\\-start\\-position \"checkpoint:V1\\#27\\#mysql\\-bin\\-changelog\\.157832:1975:\\-1:2002:677883278264080:mysql\\-bin\\-changelog\\.157832:1876\\#0\\#0\\#\\*\\#0\\#93\" \nLSN Example: \\-\\-cdc\\-start\\-position \u201cmysql\\-bin\\-changelog\\.000024:373\u201d \nWhen you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint\\. You can verify this by setting the `slotName` extra connection attribute to the name of this logical replication slot\\. For more information, see [Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CdcStartPosition": "Indicates when you want a change data capture \\(CDC\\) operation to start\\. Use either `CdcStartPosition` or `CdcStartTime` to specify when you want a CDC operation to start\\. Specifying both values results in an error\\. \n The value can be in date, checkpoint, log sequence number \\(LSN\\), or system change number \\(SCN\\) format\\. \nHere is a date example: `--cdc-start-position \"2018-03-08T12:12:12\"` \nHere is a checkpoint example: `--cdc-start-position \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"` \nHere is an LSN example: `--cdc-start-position \u201cmysql-bin-changelog.000024:373\u201d` \nWhen you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint\\. You can verify this by setting the `slotName` extra connection attribute to the name of this logical replication slot\\. For more information, see [ Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CdcStartTime": "Indicates the start time for a change data capture \\(CDC\\) operation\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CdcStopPosition": "Indicates when you want a change data capture \\(CDC\\) operation to stop\\. The value can be either server time or commit time\\. \nServer time example: \\-\\-cdc\\-stop\\-position \u201cserver\\_time:2018\\-02\\-09T12:12:12\u201d \nCommit time example: \\-\\-cdc\\-stop\\-position \u201ccommit\\_time: 2018\\-02\\-09T12:12:12 \u201c \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CdcStopPosition": "Indicates when you want a change data capture \\(CDC\\) operation to stop\\. The value can be either server time or commit time\\. \nHere is a server time example: `--cdc-stop-position \"server_time:2018-02-09T12:12:12\"` \nHere is a commit time example: `--cdc-stop-position \"commit_time: 2018-02-09T12:12:12\"` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MigrationType": "The migration type\\. Valid values: `full-load` \\| `cdc` \\| `full-load-and-cdc` \n*Required*: Yes \n*Type*: String \n*Allowed values*: `cdc | full-load | full-load-and-cdc` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ReplicationInstanceArn": "The Amazon Resource Name \\(ARN\\) of a replication instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ReplicationTaskIdentifier": "An identifier for the replication task\\. \nConstraints: \n+ Must contain 1\\-255 alphanumeric characters or hyphens\\.\n+ First character must be a letter\\.\n+ Cannot end with a hyphen or contain two consecutive hyphens\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ReplicationTaskSettings": "Overall settings for the task, in JSON format\\. For more information, see [Specifying Task Settings for AWS Database Migration Service Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResourceIdentifier": "A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ReplicationTaskSettings": "Overall settings for the task, in JSON format\\. For more information, see [ Specifying Task Settings for AWS Database Migration Service Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceIdentifier": "A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. \nFor example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SourceEndpointArn": "An Amazon Resource Name \\(ARN\\) that uniquely identifies the source endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "TableMappings": "The table mappings for the task, in JSON format\\. For more information, see [Using Table Mapping to Specify Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "One or more tags to be assigned to the replication task\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TableMappings": "The table mappings for the task, in JSON format\\. For more information, see [ Using Table Mapping to Specify Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "One or more tags to be assigned to the replication task\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TargetEndpointArn": "An Amazon Resource Name \\(ARN\\) that uniquely identifies the target endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "TaskData": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TaskData": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataBrew::Dataset": { - "Format": "The file format of a dataset that is created from an Amazon S3 file or folder\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CSV | EXCEL | JSON | PARQUET` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Format": "The file format of a dataset that is created from an Amazon S3 file or folder\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CSV | EXCEL | JSON | ORC | PARQUET` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FormatOptions": "A set of options that define how DataBrew interprets the data in the dataset\\. \n*Required*: No \n*Type*: [FormatOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-formatoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Input": "Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3\\. \n*Required*: Yes \n*Type*: [Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The unique name of the dataset\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -6106,7 +6919,7 @@ "MaxCapacity": "The maximum number of nodes that can be consumed when the job processes data\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxRetries": "The maximum number of times to retry the job after a job run fails\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The unique name of the job\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `240` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "OutputLocation": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [OutputLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputlocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OutputLocation": "Property description not available\\. \n*Required*: No \n*Type*: [OutputLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputlocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Outputs": "One or more artifacts that represent output from running the job\\. \n*Required*: No \n*Type*: List of [Output](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ProfileConfiguration": "Configuration for profile jobs\\. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations\\. When configuration is undefined, the profile job will apply default settings to all supported columns\\. \n*Required*: No \n*Type*: [ProfileConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ProjectName": "The name of the project that the job is associated with\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -6170,7 +6983,7 @@ }, "AWS::DataBrew::Job OutputLocation": { "Bucket": "The Amazon S3 bucket name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "BucketOwner": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BucketOwner": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Key": "The unique name of the object in the bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataBrew::Job ProfileConfiguration": { @@ -6192,7 +7005,7 @@ "Location": "Represents an Amazon S3 location \\(bucket name and object key\\) where DataBrew can write output from a job\\. \n*Required*: Yes \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataBrew::Job StatisticOverride": { - "Parameters": "A map that includes overrides of an evaluation\u2019s parameters\\. \n*Required*: Yes \n*Type*: [ParameterMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-parametermap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Parameters": "A map that includes overrides of an evaluation\u2019s parameters\\. \n*Required*: Yes \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Statistic": "The name of an evaluation \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[A-Z\\_]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataBrew::Job StatisticsConfiguration": { @@ -6223,7 +7036,7 @@ }, "AWS::DataBrew::Recipe Action": { "Operation": "The name of a valid DataBrew transformation to be performed on the data\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Parameters": "Contextual parameters for the transformation\\. \n*Required*: No \n*Type*: [ParameterMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-parametermap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Parameters": "Contextual parameters for the transformation\\. \n*Required*: No \n*Type*: [RecipeParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataBrew::Recipe ConditionExpression": { "Condition": "A specific condition to apply to a recipe action\\. For more information, see [Recipe structure](https://docs.aws.amazon.com/databrew/latest/dg/recipe-structure.html) in the *AWS Glue DataBrew Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[A-Z\\_]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -6236,6 +7049,10 @@ "TableName": "The name of a database table in the Data Catalog\\. This table corresponds to a DataBrew dataset\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TempDirectory": "Represents an Amazon location where DataBrew can store intermediate results\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::DataBrew::Recipe Input": { + "DataCatalogInputDefinition": "The AWS Glue Data Catalog parameters for the data\\. \n*Required*: No \n*Type*: [DataCatalogInputDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-datacataloginputdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3InputDefinition": "The Amazon S3 location where the data is stored\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::DataBrew::Recipe RecipeParameters": { "AggregateFunction": "The name of an aggregation function to apply\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Base": "The number of digits used in a counting system\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -6266,7 +7083,7 @@ "HiddenColumns": "A list of columns to hide\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IgnoreCase": "Indicates that lower and upper case letters are treated equally\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeInSplit": "Indicates if this column is participating in a split transform\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Input": "The input location to load the dataset from \\- Amazon S3 or AWS Glue Data Catalog\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Input": "The input location to load the dataset from \\- Amazon S3 or AWS Glue Data Catalog\\. \n*Required*: No \n*Type*: [Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-input.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Interval": "The number of characters to split by\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IsText": "Indicates if the content is text\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "JoinKeys": "The keys or columns involved in a join\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -6380,7 +7197,7 @@ "Value": "The value of a threshold\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataBrew::Schedule": { - "CronExpression": "The dates and times when the job is to run\\. For more information, see [Cron expressions](https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) in the * AWS Glue DataBrew Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CronExpression": "The dates and times when the job is to run\\. For more information, see [Working with cron expressions for recipe jobs](https://docs.aws.amazon.com/databrew/latest/dg/jobs.recipe.html#jobs.cron) in the * AWS Glue DataBrew Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "JobNames": "A list of jobs to be run, according to the schedule\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the schedule\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Metadata tags that have been applied to the schedule\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" @@ -6389,10 +7206,10 @@ "Activate": "Indicates whether to validate and start the pipeline or stop an active pipeline\\. By default, the value is set to `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description of the pipeline\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "The name of the pipeline\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ParameterObjects": "The parameter objects used with the pipeline\\. \n*Required*: Yes \n*Type*: List of [ParameterObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ParameterValues": "The parameter values used with the pipeline\\. \n*Required*: No \n*Type*: List of [ParameterValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalues.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PipelineObjects": "The objects that define the pipeline\\. These objects overwrite the existing pipeline definition\\. Not all objects, fields, and values can be updated\\. For information about restrictions, see [Editing Your Pipeline](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-manage-pipeline-modify-console.html) in the *AWS Data Pipeline Developer Guide*\\. \n*Required*: No \n*Type*: List of [PipelineObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PipelineTags": "A list of arbitrary tags \\(key\\-value pairs\\) to associate with the pipeline, which you can use to control permissions\\. For more information, see [Controlling Access to Pipelines and Resources](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the *AWS Data Pipeline Developer Guide*\\. \n*Required*: No \n*Type*: List of [PipelineTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ParameterObjects": "The parameter objects used with the pipeline\\. \n*Required*: No \n*Type*: List of [ParameterObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ParameterValues": "The parameter values used with the pipeline\\. \n*Required*: No \n*Type*: List of [ParameterValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PipelineObjects": "The objects that define the pipeline\\. These objects overwrite the existing pipeline definition\\. Not all objects, fields, and values can be updated\\. For information about restrictions, see [Editing Your Pipeline](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-manage-pipeline-modify-console.html) in the *AWS Data Pipeline Developer Guide*\\. \n*Required*: No \n*Type*: List of [PipelineObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PipelineTags": "A list of arbitrary tags \\(key\\-value pairs\\) to associate with the pipeline, which you can use to control permissions\\. For more information, see [Controlling Access to Pipelines and Resources](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the *AWS Data Pipeline Developer Guide*\\. \n*Required*: No \n*Type*: List of [PipelineTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetag.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataPipeline::Pipeline Field": { "Key": "Specifies the name of a field for a particular object\\. To view valid values for a particular field, see [Pipeline Object Reference](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-pipeline-objects.html) in the *AWS Data Pipeline Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -6404,7 +7221,7 @@ "StringValue": "The field value, expressed as a String\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `10240` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataPipeline::Pipeline ParameterObject": { - "Attributes": "The attributes of the parameter object\\. \n*Required*: Yes \n*Type*: List of [ParameterAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects-attributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Attributes": "The attributes of the parameter object\\. \n*Required*: Yes \n*Type*: List of [ParameterAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterattribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Id": "The ID of the parameter object\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataPipeline::Pipeline ParameterValue": { @@ -6412,7 +7229,7 @@ "StringValue": "The field value, expressed as a String\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `10240` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataPipeline::Pipeline PipelineObject": { - "Fields": "Key\\-value pairs that define the properties of the object\\. \n*Required*: Yes \n*Type*: List of [Field](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Fields": "Key\\-value pairs that define the properties of the object\\. \n*Required*: Yes \n*Type*: List of [Field](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-field.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Id": "The ID of the object\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the object\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -6421,7 +7238,7 @@ "Value": "The value to associate with the key name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataSync::Agent": { - "ActivationKey": "Your agent activation key\\. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address \\(port 80\\)\\. Alternatively, you can get it from the DataSync console\\. \nThe redirect URL returned in the response provides you the activation key for your agent in the query string parameter `activationKey`\\. It might also include other activation\\-related parameters; however, these are merely defaults\\. The arguments you pass to this API call determine the actual configuration of your agent\\. \nFor more information, see [Creating and activating an agent](https://docs.aws.amazon.com/datasync/latest/userguide/activating-agent.html) in the * AWS DataSync User Guide\\.* \n*Required*: Yes \n*Type*: String \n*Maximum*: `29` \n*Pattern*: `[A-Z0-9]{5}(-[A-Z0-9]{5}){4}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ActivationKey": "Your agent activation key\\. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address \\(port 80\\)\\. Alternatively, you can get it from the DataSync console\\. \nThe redirect URL returned in the response provides you the activation key for your agent in the query string parameter `activationKey`\\. It might also include other activation\\-related parameters; however, these are merely defaults\\. The arguments you pass to this API call determine the actual configuration of your agent\\. \nFor more information, see [Creating and activating an agent](https://docs.aws.amazon.com/datasync/latest/userguide/activating-agent.html) in the * AWS DataSync User Guide\\.* \n*Required*: No \n*Type*: String \n*Maximum*: `29` \n*Pattern*: `[A-Z0-9]{5}(-[A-Z0-9]{5}){4}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "AgentName": "The name you configured for your agent\\. This value is a text reference that is used to identify the agent in the console\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9\\s+=._:@/-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityGroupArns": "The Amazon Resource Names \\(ARNs\\) of the security groups used to protect your data transfer task subnets\\. See [SecurityGroupArns](https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns)\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SubnetArns": "The Amazon Resource Names \\(ARNs\\) of the subnets in which DataSync will create elastic network interfaces for each data transfer task\\. The agent that runs a task must be private\\. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private\\. In this case, DataSync creates four network interfaces for each task in your subnet\\. For a data transfer to work, the agent must be able to route to all these four network interfaces\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -6429,33 +7246,78 @@ "VpcEndpointId": "The ID of the virtual private cloud \\(VPC\\) endpoint that the agent has access to\\. This is the client\\-side VPC endpoint, powered by AWS PrivateLink\\. If you don't have an AWS PrivateLink VPC endpoint, see [AWS PrivateLink and VPC endpoints](https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-services-overview.html) in the *Amazon VPC User Guide*\\. \nFor more information about activating your agent in a private network based on a VPC, see [Using AWS DataSync in a Virtual Private Cloud](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-in-vpc.html) in the *AWS DataSync User Guide\\.* \nA VPC endpoint ID looks like this: `vpce-01234d5aff67890e1`\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^vpce-[0-9a-f]{17}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::DataSync::LocationEFS": { - "Ec2Config": "The subnet and security group that the Amazon EFS file system uses\\. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified\\. \nThe exact relationship between security group M \\(of the mount target\\) and security group S \\(which you provide for DataSync to use at this stage\\) is as follows: \n+ Security group M \\(which you associate with the mount target\\) must allow inbound access for the Transmission Control Protocol \\(TCP\\) on the NFS port \\(2049\\) from security group S\\. You can enable inbound connections either by IP address \\(CIDR range\\) or security group\\. \n+ Security group S \\(provided to DataSync to access EFS\\) should have a rule that enables outbound connections to the NFS port on one of the file system\u2019s mount targets\\. You can enable outbound connections either by IP address \\(CIDR range\\) or security group\\.", - "EfsFilesystemArn": "The Amazon Resource Name \\(ARN\\) for the Amazon EFS file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Subdirectory": "A subdirectory in the location\u2019s path\\. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination\\. By default, AWS DataSync uses the root directory\\. \n `Subdirectory` must be specified with forward slashes\\. For example, `/path/to/folder`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "The key\\-value pair that represents a tag that you want to add to the resource\\. The value can be an empty string\\. This value helps you manage, filter, and search for your resources\\. We recommend that you create a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AccessPointArn": "Specifies the Amazon Resource Name \\(ARN\\) of the access point that DataSync uses to access the Amazon EFS file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Ec2Config": "Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system\\. \n*Required*: Yes \n*Type*: [Ec2Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationefs-ec2config.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EfsFilesystemArn": "Specifies the ARN for the Amazon EFS file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FileSystemAccessRoleArn": "Specifies an AWS Identity and Access Management \\(IAM\\) role that DataSync assumes when mounting the Amazon EFS file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InTransitEncryption": "Specifies whether you want DataSync to use Transport Layer Security \\(TLS\\) 1\\.2 encryption when it copies data to or from the Amazon EFS file system\\. \nIf you specify an access point using `AccessPointArn` or an IAM role using `FileSystemAccessRoleArn`, you must set this parameter to `TLS1_2`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | TLS1_2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Subdirectory": "Specifies a mount path for your Amazon EFS file system\\. This is where DataSync reads or writes data \\(depending on if this is a source or destination location\\)\\. By default, DataSync uses the root directory, but you can also include subdirectories\\. \nYou must specify a value with forward slashes \\(for example, `/path/to/folder`\\)\\.\n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Specifies the key\\-value pair that represents a tag that you want to add to the resource\\. The value can be an empty string\\. This value helps you manage, filter, and search for your resources\\. We recommend that you create a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataSync::LocationEFS Ec2Config": { - "SecurityGroupArns": "The Amazon Resource Names \\(ARNs\\) of the security groups that are configured for the Amazon EC2 resource\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SubnetArn": "The Amazon Resource Name \\(ARN\\) of the subnet that DataSync uses to access the target EFS file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "SecurityGroupArns": "Specifies the Amazon Resource Names \\(ARNs\\) of the security groups associated with an Amazon EFS file system's mount target\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SubnetArn": "Specifies the ARN of a subnet where DataSync creates the [network interfaces](datasync/latest/userguide/datasync-network.html#required-network-interfaces) for managing traffic during your transfer\\. \nThe subnet must be located: \n+ In the same virtual private cloud \\(VPC\\) as the Amazon EFS file system\\.\n+ In the same Availability Zone as at least one mount target for the Amazon EFS file system\\.\nYou don't need to specify a subnet that includes a file system mount target\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::DataSync::LocationFSxLustre": { - "FsxFilesystemArn": "The Amazon Resource Name \\(ARN\\) for the FSx for Lustre file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SecurityGroupArns": "The ARNs of the security groups that are used to configure the FSx for Lustre file system\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Length constraints*: Maximum length of 128\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FsxFilesystemArn": "The Amazon Resource Name \\(ARN\\) for the FSx for Lustre file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SecurityGroupArns": "The ARNs of the security groups that are used to configure the FSx for Lustre file system\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Length constraints*: Maximum length of 128\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Subdirectory": "A subdirectory in the location's path\\. This subdirectory in the FSx for Lustre file system is used to read data from the FSx for Lustre source location or write data to the FSx for Lustre destination\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The key\\-value pair that represents a tag that you want to add to the resource\\. The value can be an empty string\\. This value helps you manage, filter, and search for your resources\\. We recommend that you create a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::DataSync::LocationFSxONTAP": { + "Protocol": "Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system\\. \n*Required*: No \n*Type*: [Protocol](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-protocol.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SecurityGroupArns": "Specifies the Amazon Resource Names \\(ARNs\\) of the security groups that DataSync can use to access your FSx for ONTAP file system\\. You must configure the security groups to allow outbound traffic on the following ports \\(depending on the protocol that you're using\\): \n+ **Network File System \\(NFS\\)**: TCP ports 111, 635, and 2049\n+ **Server Message Block \\(SMB\\)**: TCP port 445\nYour file system's security groups must also allow inbound traffic on the same port\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StorageVirtualMachineArn": "Specifies the ARN of the storage virtual machine \\(SVM\\) in your file system where you want to copy data to or from\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `162` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Subdirectory": "Specifies a path to the file share in the SVM where you'll copy your data\\. \nYou can specify a junction path \\(also known as a mount point\\), qtree path \\(for NFS file shares\\), or share name \\(for SMB file shares\\)\\. For example, your mount path might be `/vol1`, `/vol1/tree1`, or `/share1`\\. \nDon't specify a junction path in the SVM's root volume\\. For more information, see [Managing FSx for ONTAP storage virtual machines](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) in the *Amazon FSx for NetApp ONTAP User Guide*\\.\n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Specifies labels that help you categorize, filter, and search for your AWS resources\\. We recommend creating at least a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::DataSync::LocationFSxONTAP NFS": { + "MountOptions": "Specifies how DataSync can access a location using the NFS protocol\\. \n*Required*: Yes \n*Type*: [NfsMountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfsmountoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::DataSync::LocationFSxONTAP NfsMountOptions": { + "Version": "Specifies the NFS version that you want DataSync to use when mounting your NFS share\\. If the server refuses to use the version specified, the task fails\\. \nYou can specify the following options: \n+ `AUTOMATIC` \\(default\\): DataSync chooses NFS version 4\\.1\\.\n+ `NFS3`: Stateless protocol version that allows for asynchronous writes on the server\\.\n+ `NFSv4_0`: Stateful, firewall\\-friendly protocol version that supports delegations and pseudo file systems\\.\n+ `NFSv4_1`: Stateful protocol version that supports sessions, directory delegations, and parallel data processing\\. NFS version 4\\.1 also includes all features available in version 4\\.0\\.\nDataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::DataSync::LocationFSxONTAP Protocol": { + "NFS": "Specifies the Network File System \\(NFS\\) protocol configuration that DataSync uses to access your FSx for ONTAP file system's storage virtual machine \\(SVM\\)\\. \n*Required*: No \n*Type*: [NFS](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfs.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SMB": "Specifies the Server Message Block \\(SMB\\) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM\\. \n*Required*: No \n*Type*: [SMB](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::DataSync::LocationFSxONTAP SMB": { + "Domain": "Specifies the fully qualified domain name \\(FQDN\\) of the Microsoft Active Directory that your storage virtual machine \\(SVM\\) belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^[A-Za-z0-9]((\\.|-+)?[A-Za-z0-9]){0,252}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MountOptions": "Specifies how DataSync can access a location using the SMB protocol\\. \n*Required*: Yes \n*Type*: [SmbMountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smbmountoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Password": "Specifies the password of a user who has permission to access your SVM\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "User": "Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM\\. \nIf you provide a user in your Active Directory, note the following: \n+ If you're using AWS Directory Service for Microsoft Active Directory, the user must be a member of the AWS Delegated FSx Administrators group\\.\n+ If you're using a self\\-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system\\.\nMake sure that the user has the permissions it needs to copy the data you want: \n+ `SE_TCB_NAME`: Required to set object ownership and file metadata\\. With this privilege, you also can copy NTFS discretionary access lists \\(DACLs\\)\\.\n+ `SE_SECURITY_NAME`: May be needed to copy NTFS system access control lists \\(SACLs\\)\\. This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group\\. If you configure your task to copy SACLs, make sure that the user has the required privileges\\. For information about copying SACLs, see [Ownership and permissions\\-related options](https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions)\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::DataSync::LocationFSxONTAP SmbMountOptions": { + "Version": "By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server\\. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically\\. \nThese are the following options for configuring the SMB version: \n+ `AUTOMATIC` \\(default\\): DataSync and the SMB file server negotiate a protocol version that they mutually support\\. \\(DataSync supports SMB versions 1\\.0 and later\\.\\)" + }, + "AWS::DataSync::LocationFSxOpenZFS": { + "FsxFilesystemArn": "The Amazon Resource Name \\(ARN\\) of the FSx for OpenZFS file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Protocol": "The type of protocol that AWS DataSync uses to access your file system\\. \n*Required*: Yes \n*Type*: [Protocol](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-protocol.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SecurityGroupArns": "The ARNs of the security groups that are used to configure the FSx for OpenZFS file system\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Length constraints*: Maximum length of 128\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Subdirectory": "A subdirectory in the location's path that must begin with `/fsx`\\. DataSync uses this subdirectory to read or write data \\(depending on whether the file system is a source or destination location\\)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,4096}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "The key\\-value pair that represents a tag that you want to add to the resource\\. The value can be an empty string\\. This value helps you manage, filter, and search for your resources\\. We recommend that you create a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::DataSync::LocationFSxOpenZFS MountOptions": { + "Version": "The specific NFS version that you want DataSync to use to mount your NFS share\\. If the server refuses to use the version specified, the sync will fail\\. If you don't specify a version, DataSync defaults to `AUTOMATIC`\\. That is, DataSync automatically selects a version based on negotiation with the NFS server\\. \nYou can specify the following NFS versions: \n+ **[NFSv3](https://tools.ietf.org/html/rfc1813)**: Stateless protocol version that allows for asynchronous writes on the server\\.\n+ **[NFSv4\\.0](https://tools.ietf.org/html/rfc3530)**: Stateful, firewall\\-friendly protocol version that supports delegations and pseudo file systems\\.\n+ **[NFSv4\\.1](https://tools.ietf.org/html/rfc5661)**: Stateful protocol version that supports sessions, directory delegations, and parallel data processing\\. Version 4\\.1 also includes all features available in version 4\\.0\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::DataSync::LocationFSxOpenZFS NFS": { + "MountOptions": "Represents the mount options that are available for DataSync to access an NFS location\\. \n*Required*: Yes \n*Type*: [MountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-mountoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::DataSync::LocationFSxOpenZFS Protocol": { + "NFS": "Represents the Network File System \\(NFS\\) protocol that DataSync uses to access your FSx for OpenZFS file system\\. \n*Required*: No \n*Type*: [NFS](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-nfs.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::DataSync::LocationFSxWindows": { - "Domain": "The name of the Windows domain that the FSx for Windows File Server belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "FsxFilesystemArn": "The Amazon Resource Name \\(ARN\\) for the FSx for Windows File Server file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Password": "The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Domain": "Specifies the name of the Windows domain that the FSx for Windows File Server belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^[A-Za-z0-9]((\\.|-+)?[A-Za-z0-9]){0,252}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FsxFilesystemArn": "Specifies the Amazon Resource Name \\(ARN\\) for the FSx for Windows File Server file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Password": "Specifies the password of the user who has the permissions to access files and folders in the file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SecurityGroupArns": "The Amazon Resource Names \\(ARNs\\) of the security groups that are used to configure the FSx for Windows File Server file system\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Length constraints*: Maximum length of 128\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Subdirectory": "A subdirectory in the location's path\\. This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "The key\\-value pair that represents a tag that you want to add to the resource\\. The value can be an empty string\\. This value helps you manage, filter, and search for your resources\\. We recommend that you create a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Subdirectory": "Specifies a mount path for your file system using forward slashes\\. This is where DataSync reads or writes data \\(depending on if this is a source or destination location\\)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Specifies labels that help you categorize, filter, and search for your AWS resources\\. We recommend creating at least a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "User": "The user who has the permissions to access files and folders in the FSx for Windows File Server file system\\. \nFor information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see [user](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#FSxWuser)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::DataSync::LocationHDFS": { "AgentArns": "The Amazon Resource Names \\(ARNs\\) of the agents that are used to connect to the HDFS cluster\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AuthenticationType": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthenticationType": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BlockSize": "The size of data blocks to write into the HDFS cluster\\. The block size must be a multiple of 512 bytes\\. The default block size is 128 mebibytes \\(MiB\\)\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1048576` \n*Maximum*: `1073741824` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KerberosKeytab": "The Kerberos key table \\(keytab\\) that contains mappings between the defined Kerberos principal and the encrypted keys\\. Provide the base64\\-encoded file text\\. If `KERBEROS` is specified for `AuthType`, this value is required\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KerberosKrb5Conf": "The `krb5.conf` file that contains the Kerberos configuration information\\. You can load the `krb5.conf` by providing a string of the file's contents or an Amazon S3 presigned URL of the file\\. If`KERBEROS` is specified for `AuthType`, this value is required\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -6479,31 +7341,32 @@ "AWS::DataSync::LocationNFS": { "MountOptions": "The NFS mount options that DataSync can use to mount your NFS share\\. \n*Required*: No \n*Type*: [MountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationnfs-mountoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OnPremConfig": "Contains a list of Amazon Resource Names \\(ARNs\\) of agents that are used to connect to an NFS server\\. \nIf you are copying data to or from your AWS Snowcone device, see [NFS Server on AWS Snowcone](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) for more information\\. \n*Required*: Yes \n*Type*: [OnPremConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationnfs-onpremconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServerHostname": "The name of the NFS server\\. This value is the IP address or Domain Name Service \\(DNS\\) name of the NFS server\\. An agent that is installed on\\-premises uses this host name to mount the NFS server in a network\\. \nIf you are copying data to or from your AWS Snowcone device, see [NFS Server on AWS Snowcone](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) for more information\\. \nThis name must either be DNS\\-compliant or must be an IP version 4 \\(IPv4\\) address\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Subdirectory": "The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination\\. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path\\. The path should be such that it can be mounted by other NFS clients in your network\\. \nTo see all the paths exported by your NFS server, run \"`showmount -e nfs-server-name`\" from an NFS client that has access to your server\\. You can specify any directory that appears in the results, and any subdirectory of that directory\\. Ensure that the NFS export is accessible without Kerberos authentication\\. \nTo transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data\\. To ensure this, either configure the NFS export with `no_root_squash,` or ensure that the permissions for all of the files that you want DataSync allow read access for all users\\. Doing either enables the agent to read the files\\. For the agent to access directories, you must additionally enable all execute access\\. \nIf you are copying data to or from your AWS Snowcone device, see [NFS Server on AWS Snowcone](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) for more information\\. \nFor information about NFS export configuration, see [18\\.7\\. The /etc/exports Configuration File](http://web.mit.edu/rhel-doc/5/RHEL-5-manual/Deployment_Guide-en-US/s1-nfs-server-config-exports.html) in the Red Hat Enterprise Linux documentation\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerHostname": "The name of the NFS server\\. This value is the IP address or Domain Name Service \\(DNS\\) name of the NFS server\\. An agent that is installed on\\-premises uses this hostname to mount the NFS server in a network\\. \nIf you are copying data to or from your AWS Snowcone device, see [NFS Server on AWS Snowcone](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) for more information\\. \nThis name must either be DNS\\-compliant or must be an IP version 4 \\(IPv4\\) address\\.\n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Subdirectory": "The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination\\. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path\\. The path should be such that it can be mounted by other NFS clients in your network\\. \nTo see all the paths exported by your NFS server, run \"`showmount -e nfs-server-name`\" from an NFS client that has access to your server\\. You can specify any directory that appears in the results, and any subdirectory of that directory\\. Ensure that the NFS export is accessible without Kerberos authentication\\. \nTo transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data\\. To ensure this, either configure the NFS export with `no_root_squash,` or ensure that the permissions for all of the files that you want DataSync allow read access for all users\\. Doing either enables the agent to read the files\\. For the agent to access directories, you must additionally enable all execute access\\. \nIf you are copying data to or from your AWS Snowcone device, see [NFS Server on AWS Snowcone](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) for more information\\. \nFor information about NFS export configuration, see [18\\.7\\. The /etc/exports Configuration File](http://web.mit.edu/rhel-doc/5/RHEL-5-manual/Deployment_Guide-en-US/s1-nfs-server-config-exports.html) in the Red Hat Enterprise Linux documentation\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The key\\-value pair that represents the tag that you want to add to the location\\. The value can be an empty string\\. We recommend using tags to name your resources\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataSync::LocationNFS MountOptions": { - "Version": "The specific NFS version that you want DataSync to use to mount your NFS share\\. If the server refuses to use the version specified, the sync will fail\\. If you don't specify a version, DataSync defaults to `AUTOMATIC`\\. That is, DataSync automatically selects a version based on negotiation with the NFS server\\. \nYou can specify the following NFS versions: \n+ ** [NFSv3](https://tools.ietf.org/html/rfc1813) ** \\- stateless protocol version that allows for asynchronous writes on the server\\.\n+ ** [NFSv4\\.0](https://tools.ietf.org/html/rfc3530) ** \\- stateful, firewall\\-friendly protocol version that supports delegations and pseudo file systems\\.\n+ ** [NFSv4\\.1](https://tools.ietf.org/html/rfc5661) ** \\- stateful protocol version that supports sessions, directory delegations, and parallel data processing\\. Version 4\\.1 also includes all features available in version 4\\.0\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Version": "Specifies the NFS version that you want DataSync to use when mounting your NFS share\\. If the server refuses to use the version specified, the task fails\\. \nYou can specify the following options: \n+ `AUTOMATIC` \\(default\\): DataSync chooses NFS version 4\\.1\\.\n+ `NFS3`: Stateless protocol version that allows for asynchronous writes on the server\\.\n+ `NFSv4_0`: Stateful, firewall\\-friendly protocol version that supports delegations and pseudo file systems\\.\n+ `NFSv4_1`: Stateful protocol version that supports sessions, directory delegations, and parallel data processing\\. NFS version 4\\.1 also includes all features available in version 4\\.0\\.\nDataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataSync::LocationNFS OnPremConfig": { "AgentArns": "ARNs of the agents to use for an NFS location\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataSync::LocationObjectStorage": { - "AccessKey": "Optional\\. The access key is used if credentials are required to access the self\\-managed object storage server\\. If your object storage requires a user name and password to authenticate, use `AccessKey` and `SecretKey` to provide the user name and password, respectively\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `200` \n*Pattern*: `^.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AgentArns": "The Amazon Resource Name \\(ARN\\) of the agents associated with the self\\-managed object storage server location\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "BucketName": "The bucket on the self\\-managed object storage server that is used to read data from\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SecretKey": "Optional\\. The secret key is used if credentials are required to access the self\\-managed object storage server\\. If your object storage requires a user name and password to authenticate, use `AccessKey` and `SecretKey` to provide the user name and password, respectively\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `200` \n*Pattern*: `^.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServerHostname": "The name of the self\\-managed object storage server\\. This value is the IP address or Domain Name Service \\(DNS\\) name of the object storage server\\. An agent uses this host name to mount the object storage server in a network\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ServerPort": "The port that your self\\-managed object storage server accepts inbound network traffic on\\. The server port is set by default to TCP 80 \\(HTTP\\) or TCP 443 \\(HTTPS\\)\\. You can specify a custom port if your self\\-managed object storage server requires one\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65536` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServerProtocol": "The protocol that the object storage server uses to communicate\\. Valid values are HTTP or HTTPS\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HTTP | HTTPS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Subdirectory": "The subdirectory in the self\\-managed object storage server that is used to read data from\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "The key\\-value pair that represents the tag that you want to add to the location\\. The value can be an empty string\\. We recommend using tags to name your resources\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AccessKey": "Specifies the access key \\(for example, a user name\\) if credentials are required to authenticate with the object storage server\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `200` \n*Pattern*: `^.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AgentArns": "Specifies the Amazon Resource Names \\(ARNs\\) of the DataSync agents that can securely connect with your location\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BucketName": "Specifies the name of the object storage bucket involved in the transfer\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SecretKey": "Specifies the secret key \\(for example, a password\\) if credentials are required to authenticate with the object storage server\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `200` \n*Pattern*: `^.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerCertificate": "Specifies a certificate to authenticate with an object storage system that uses a private or self\\-signed certificate authority \\(CA\\)\\. You must specify a Base64\\-encoded `.pem` file \\(for example, `file:///home/user/.ssh/storage_sys_certificate.pem`\\)\\. The certificate can be up to 32768 bytes \\(before Base64 encoding\\)\\. \nTo use this parameter, configure `ServerProtocol` to `HTTPS`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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 in a network\\. \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ServerPort": "Specifies the port that your object storage server accepts inbound network traffic on \\(for example, port 443\\)\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65536` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerProtocol": "Specifies the protocol that your object storage server uses to communicate\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HTTP | HTTPS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Subdirectory": "Specifies the object prefix for your object storage server\\. If this is a source location, DataSync only copies objects with this prefix\\. If this is a destination location, DataSync writes all objects with this prefix\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Specifies the key\\-value pair that represents a tag that you want to add to the resource\\. Tags can help you manage, filter, and search for your resources\\. We recommend creating a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataSync::LocationS3": { - "S3BucketArn": "The ARN of the Amazon S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `156` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "S3BucketArn": "The ARN of the Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Maximum*: `156` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "S3Config": "The Amazon Resource Name \\(ARN\\) of the AWS Identity and Access Management \\(IAM\\) role that is used to access an Amazon S3 bucket\\. \nFor detailed information about using such a role, see [Creating a Location for Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location) in the *AWS DataSync User Guide*\\. \n*Required*: Yes \n*Type*: [S3Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locations3-s3config.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "S3StorageClass": "The Amazon S3 storage class that you want to store your files in when this location is used as a task destination\\. For buckets in AWS Regions, the storage class defaults to S3 Standard\\. \nFor more information about S3 storage classes, see [Amazon S3 Storage Classes](http://aws.amazon.com/s3/storage-classes/)\\. Some storage classes have behaviors that can affect your S3 storage costs\\. 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)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEEP_ARCHIVE | GLACIER | INTELLIGENT_TIERING | ONEZONE_IA | OUTPOSTS | STANDARD | STANDARD_IA` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "S3StorageClass": "The Amazon S3 storage class that you want to store your files in when this location is used as a task destination\\. For buckets in AWS Regions, the storage class defaults to S3 Standard\\. \nFor more information about S3 storage classes, see [Amazon S3 Storage Classes](http://aws.amazon.com/s3/storage-classes/)\\. Some storage classes have behaviors that can affect your S3 storage costs\\. 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)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEEP_ARCHIVE | GLACIER | GLACIER_INSTANT_RETRIEVAL | INTELLIGENT_TIERING | ONEZONE_IA | OUTPOSTS | STANDARD | STANDARD_IA` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Subdirectory": "A subdirectory in the Amazon S3 bucket\\. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The key\\-value pair that represents the tag that you want to add to the location\\. The value can be an empty string\\. We recommend using tags to name your resources\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -6512,44 +7375,45 @@ }, "AWS::DataSync::LocationSMB": { "AgentArns": "The Amazon Resource Names \\(ARNs\\) of agents to use for a Server Message Block \\(SMB\\) location\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Domain": "The name of the Windows domain that the SMB server belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MountOptions": "The mount options used by DataSync to access the SMB server\\. \n*Required*: No \n*Type*: [MountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-mountoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Password": "The password of the user who can mount the share and has the permissions to access files and folders in the SMB share\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServerHostname": "The name of the SMB server\\. This value is the IP address or Domain Name Service \\(DNS\\) name of the SMB server\\. An agent that is installed on\\-premises uses this hostname to mount the SMB server in a network\\. \nThis name must either be DNS\\-compliant or must be an IP version 4 \\(IPv4\\) address\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Subdirectory": "The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination\\. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path\\. The path should be such that it can be mounted by other SMB clients in your network\\. \n `Subdirectory` must be specified with forward slashes\\. For example, `/path/to/folder`\\.\nTo transfer all the data in the folder you specified, DataSync must have permissions to mount the SMB share, as well as to access all the data in that share\\. To ensure this, either make sure that the user name and password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share\\. Doing either one enables the agent to access the data\\. For the agent to access directories, you must additionally enable all execute access\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "The key\\-value pair that represents the tag that you want to add to the location\\. The value can be an empty string\\. We recommend using tags to name your resources\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Domain": "Specifies the Windows domain name that your SMB file server belongs to\\. \nFor more information, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) for SMB locations\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^[A-Za-z0-9]((\\.|-+)?[A-Za-z0-9]){0,252}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MountOptions": "Specifies the version of the SMB protocol that DataSync uses to access your SMB file server\\. \n*Required*: No \n*Type*: [MountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-mountoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Password": "The password of the user who can mount the share and has the permissions to access files and folders in the SMB share\\. \n*Required*: No \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerHostname": "Specifies the Domain Name Service \\(DNS\\) name or IP address of the SMB file server that your DataSync agent will mount\\. \nYou can't specify an IP version 6 \\(IPv6\\) address\\.\n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Subdirectory": "The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination\\. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path\\. The path should be such that it can be mounted by other SMB clients in your network\\. \n `Subdirectory` must be specified with forward slashes\\. For example, `/path/to/folder`\\.\nTo transfer all the data in the folder you specified, DataSync must have permissions to mount the SMB share, as well as to access all the data in that share\\. To ensure this, either make sure that the user name and password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share\\. Doing either one enables the agent to access the data\\. For the agent to access directories, you must additionally enable all execute access\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Specifies labels that help you categorize, filter, and search for your AWS resources\\. We recommend creating at least a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "User": "The user who can mount the share and has the permissions to access files and folders in the SMB share\\. \nFor information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see [user](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#SMBuser)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataSync::LocationSMB MountOptions": { - "Version": "The specific SMB version that you want DataSync to use to mount your SMB share\\. If you don't specify a version, DataSync defaults to `AUTOMATIC`\\. That is, DataSync automatically selects a version based on negotiation with the SMB server\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | SMB2 | SMB3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Version": "By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server\\. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically\\. \nThese are the following options for configuring the SMB version: \n+ `AUTOMATIC` \\(default\\): DataSync and the SMB file server negotiate a protocol version that they mutually support\\. \\(DataSync supports SMB versions 1\\.0 and later\\.\\)" }, "AWS::DataSync::Task": { "CloudWatchLogGroupArn": "The Amazon Resource Name \\(ARN\\) of the Amazon CloudWatch log group that is used to monitor and log events in the task\\. \nFor more information about how to use CloudWatch Logs with DataSync, see [Monitoring Your Task](https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html#cloudwatchlogs) in the * AWS DataSync User Guide\\.* \nFor more information about these groups, see [Working with Log Groups and Log Streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html) in the *Amazon CloudWatch Logs User Guide*\\. \n*Required*: No \n*Type*: String \n*Maximum*: `562` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\\-0-9]*:[0-9]{12}:log-group:([^:\\*]*)(:\\*)?$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DestinationLocationArn": "The Amazon Resource Name \\(ARN\\) of an AWS storage resource's location\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Excludes": "A list of filter rules that determines which files to exclude from a task\\. The list should contain a single filter string that consists of the patterns to exclude\\. The patterns are delimited by \"\\|\" \\(that is, a pipe\\), for example, `\"/folder1|/folder2\"`\\. \n \n*Required*: No \n*Type*: List of [FilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Includes": "A list of filter rules that determines which files to include when running a task\\. The pattern contains a single filter string that consists of the patterns to include\\. The patterns are delimited by \"\\|\" \\(that is, a pipe\\), for example, `\"/folder1|/folder2\"`\\. \n*Required*: No \n*Type*: List of [FilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Excludes": "Specifies a list of filter rules that exclude specific data during your transfer\\. For more information and examples, see [Filtering data transferred by DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)\\. \n*Required*: No \n*Type*: List of [FilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Includes": "Specifies a list of filter rules that include specific data during your transfer\\. For more information and examples, see [Filtering data transferred by DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)\\. \n*Required*: No \n*Type*: List of [FilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of a task\\. This value is a text reference that is used to identify the task in the console\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9\\s+=._:@/-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Options": "The set of configuration options that control the behavior of a single execution of the task that occurs when you call `StartTaskExecution`\\. You can configure these options to preserve metadata such as user ID \\(UID\\) and group ID \\(GID\\), file permissions, data integrity verification, and so on\\. \nFor each individual task execution, you can override these options by specifying the `OverrideOptions` before starting the task execution\\. For more information, see the [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) operation\\. \n*Required*: No \n*Type*: [Options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Options": "Specifies the configuration options for a task\\. Some options include preserving file or object metadata and verifying data integrity\\. \nYou can also override these options before starting an individual run of a task \\(also known as a *task execution*\\)\\. For more information, see [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html)\\. \n*Required*: No \n*Type*: [Options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Schedule": "Specifies a schedule used to periodically transfer files from a source to a destination location\\. The schedule should be specified in UTC time\\. For more information, see [Scheduling your task](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)\\. \n*Required*: No \n*Type*: [TaskSchedule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourceLocationArn": "The Amazon Resource Name \\(ARN\\) of the source location for the task\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "The key\\-value pair that represents the tag that you want to add to the resource\\. The value can be an empty string\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Tags": "Specifies the tags that you want to apply to the Amazon Resource Name \\(ARN\\) representing the task\\. \n *Tags* are key\\-value pairs that help you manage, filter, and search for your DataSync resources\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataSync::Task FilterRule": { "FilterType": "The type of filter rule to apply\\. AWS DataSync only supports the SIMPLE\\_PATTERN rule type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `SIMPLE_PATTERN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Value": "A single filter string that consists of the patterns to include or exclude\\. The patterns are delimited by \"\\|\" \\(that is, a pipe\\), for example: `/folder1|/folder2` \n \n*Required*: No \n*Type*: String \n*Maximum*: `409600` \n*Pattern*: `^[^\\x00]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Value": "A single filter string that consists of the patterns to include or exclude\\. The patterns are delimited by \"\\|\" \\(that is, a pipe\\), for example: `/folder1|/folder2` \n \n*Required*: No \n*Type*: String \n*Maximum*: `102400` \n*Pattern*: `^[^\\x00]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DataSync::Task Options": { "Atime": "A file metadata value that shows the last time that a file was accessed \\(that is, when the file was read or written to\\)\\. If you set `Atime` to `BEST_EFFORT`, AWS DataSync attempts to preserve the original `Atime` attribute on all source files \\(that is, the version before the PREPARING phase\\)\\. However, `Atime`'s behavior is not fully standard across platforms, so AWS DataSync can only do this on a best\\-effort basis\\. \nDefault value: `BEST_EFFORT` \n`BEST_EFFORT`: Attempt to preserve the per\\-file `Atime` value \\(recommended\\)\\. \n`NONE`: Ignore `Atime`\\. \nIf `Atime` is set to `BEST_EFFORT`, `Mtime` must be set to `PRESERVE`\\. \nIf `Atime` is set to `NONE`, `Mtime` must also be `NONE`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `BEST_EFFORT | NONE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BytesPerSecond": "A value that limits the bandwidth used by AWS DataSync\\. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to `1048576` \\(=1024\\*1024\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Gid": "The group ID \\(GID\\) of the file's owners\\. \nDefault value: `INT_VALUE` \n`INT_VALUE`: Preserve the integer value of the user ID \\(UID\\) and group ID \\(GID\\) \\(recommended\\)\\. \n`NAME`: Currently not supported\\. \n`NONE`: Ignore the UID and GID\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `BOTH | INT_VALUE | NAME | NONE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `BASIC | OFF | TRANSFER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LogLevel": "Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group\\. To specify the log group, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn)\\. \nIf you set `LogLevel` to `OFF`, no logs are published\\. `BASIC` publishes logs on errors for individual files transferred\\. `TRANSFER` publishes logs for every file or object that is transferred and integrity checked\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `BASIC | OFF | TRANSFER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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\\. \nDefault value: `PRESERVE` \n`PRESERVE`: Preserve original `Mtime` \\(recommended\\) \n `NONE`: Ignore `Mtime`\\. \nIf `Mtime` is set to `PRESERVE`, `Atime` must be set to `BEST_EFFORT`\\. \nIf `Mtime` is set to `NONE`, `Atime` must also be set to `NONE`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | PRESERVE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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\\. \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*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS | NEVER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ObjectTags": "Specifies whether object tags are preserved when transferring between object storage systems\\. If you want your DataSync task to ignore object tags, specify the `NONE` value\\. \nDefault Value: `PRESERVE` \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | PRESERVE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OverwriteMode": "Specifies whether data at the destination location should be overwritten or preserved\\. If set to `NEVER`, a destination file for example 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\\. \nSome storage classes have specific behaviors that can affect your Amazon 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)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS | NEVER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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)\\. \nDefault value: `PRESERVE` \n`PRESERVE`: Preserve POSIX\\-style permissions \\(recommended\\)\\. \n`NONE`: Ignore permissions\\. \n AWS DataSync can preserve extant permissions of a source location\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | PRESERVE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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*\\. \nDefault value: `PRESERVE` \n`PRESERVE`: Ignore destination files that aren't present in the source \\(recommended\\)\\. \n`REMOVE`: Delete destination files that aren't present in the source\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PRESERVE | REMOVE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PreserveDevices": "A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and re\\-create the files with that device name and metadata on the destination\\. DataSync does not copy the contents of such devices, only the name and metadata\\. \n AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end\\-of\\-file \\(EOF\\) marker\\.\nDefault value: `NONE` \n`NONE`: Ignore special devices \\(recommended\\)\\. \n`PRESERVE`: Preserve character and block device metadata\\. This option isn't currently supported for Amazon EFS\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | PRESERVE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityDescriptorCopyFlags": "A value that determines which components of the SMB security descriptor are copied from source to destination objects\\. \nThis value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations\\. For more information about how DataSync handles metadata, see [How DataSync Handles Metadata and Special Files](https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html)\\. \nDefault value: `OWNER_DACL` \n `OWNER_DACL`: For each copied object, DataSync copies the following metadata: \n+ Object owner\\.\n+ NTFS discretionary access control lists \\(DACLs\\), which determine whether to grant access to an object\\.\nWhen you use option, DataSync does NOT copy the NTFS system access control lists \\(SACLs\\), which are used by administrators to log attempts to access a secured object\\. \n `OWNER_DACL_SACL`: For each copied object, DataSync copies the following metadata: \n+ Object owner\\.\n+ NTFS discretionary access control lists \\(DACLs\\), which determine whether to grant access to an object\\.\n+ NTFS system access control lists \\(SACLs\\), which are used by administrators to log attempts to access a secured object\\.\nCopying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location\\. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see [user](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#SMBuser)\\. \n`NONE`: None of the SMB security descriptor components are copied\\. Destination objects are owned by the user that was provided for accessing the destination location\\. DACLs and SACLs are set based on the destination server\u2019s configuration\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | OWNER_DACL | OWNER_DACL_SACL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TaskQueueing": "A value that determines whether tasks should be queued before executing the tasks\\. If set to `ENABLED`, the tasks will be queued\\. The default is `ENABLED`\\. \nIf you use the same agent to run multiple tasks, you can enable the tasks to run in series\\. For more information, see [Queueing task executions](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TaskQueueing": "Specifies whether tasks should be queued before executing the tasks\\. The default is `ENABLED`, which means the tasks will be queued\\. \nIf you use the same agent to run multiple tasks, you can enable the tasks to run in series\\. For more information, see [Queueing task executions](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TransferMode": "A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing it to the destination location\\. \n`CHANGED`: DataSync copies only data or metadata that is new or different from the source location to the destination location\\. \n`ALL`: DataSync copies all source location content to the destination, without comparing it to existing content on the destination\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ALL | CHANGED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Uid": "The user ID \\(UID\\) of the file's owner\\. \nDefault value: `INT_VALUE` \n`INT_VALUE`: Preserve the integer value of the UID and group ID \\(GID\\) \\(recommended\\)\\. \n`NAME`: Currently not supported \n`NONE`: Ignore the UID and GID\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `BOTH | INT_VALUE | NAME | NONE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VerifyMode": "A value that determines whether a data integrity verification is performed at the end of a task execution after all data and metadata have been transferred\\. For more information, see [Configure task settings](https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html)\\. \nDefault value: `POINT_IN_TIME_CONSISTENT` \n`ONLY_FILES_TRANSFERRED` \\(recommended\\): Perform verification only on files that were transferred\\. \n`POINT_IN_TIME_CONSISTENT`: Scan the entire source and entire destination at the end of the transfer to verify that the source and destination are fully synchronized\\. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes\\. \n`NONE`: No additional verification is done at the end of the transfer, but all data transmissions are integrity\\-checked with checksum verification during the transfer\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | ONLY_FILES_TRANSFERRED | POINT_IN_TIME_CONSISTENT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -6571,8 +7435,13 @@ "Config": "A `NotificationChannelConfig` object that contains information about configured notification channels\\. \n*Required*: Yes \n*Type*: [NotificationChannelConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationchannelconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::DevOpsGuru::NotificationChannel NotificationChannelConfig": { + "Filters": "The filter configurations for the Amazon SNS notification topic you use with DevOps Guru\\. If you do not provide filter configurations, the default configurations are to receive notifications for all message types of `High` or `Medium` severity\\. \n*Required*: No \n*Type*: [NotificationFilterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationfilterconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Sns": "Information about a notification channel configured in DevOps Guru to send notifications when insights are created\\. \nIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications\\. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account\\. DevOps Guru only supports standard SNS topics\\. For more information, see [Permissions for cross account Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html)\\. \nIf you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications\\. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account\\. For more information, see Permissions for cross account Amazon SNS topics\\. \nIf you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer\\-managed key \\(CMK\\), then you must add permissions to the CMK\\. For more information, see [Permissions for AWS KMS\u2013encrypted Amazon SNS topics](https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html)\\. \n*Required*: No \n*Type*: [SnsChannelConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-snschannelconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::DevOpsGuru::NotificationChannel NotificationFilterConfig": { + "MessageTypes": "The events that you want to receive notifications for\\. For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Severities": "The severity levels that you want to receive notifications for\\. For example, you can choose to receive notifications only for insights with `HIGH` and `MEDIUM` severity levels\\. For more information, see [Understanding insight severities](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::DevOpsGuru::NotificationChannel SnsChannelConfig": { "TopicArn": "The Amazon Resource Name \\(ARN\\) of an Amazon Simple Notification Service topic\\. \n*Required*: No \n*Type*: String \n*Minimum*: `36` \n*Maximum*: `1024` \n*Pattern*: `^arn:aws[a-z0-9-]*:sns:[a-z0-9-]+:\\d{12}:[^:]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -6583,7 +7452,12 @@ "StackNames": "An array of CloudFormation stack names\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DevOpsGuru::ResourceCollection ResourceCollectionFilter": { - "CloudFormation": "Information about AWS CloudFormation stacks\\. You can use up to 500 stacks to specify which AWS resources in your account to analyze\\. For more information, see [Stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the * AWS CloudFormation User Guide*\\. \n*Required*: No \n*Type*: [CloudFormationCollectionFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-cloudformationcollectionfilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CloudFormation": "Information about AWS CloudFormation stacks\\. You can use up to 500 stacks to specify which AWS resources in your account to analyze\\. For more information, see [Stacks](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the * AWS CloudFormation User Guide*\\. \n*Required*: No \n*Type*: [CloudFormationCollectionFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-cloudformationcollectionfilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The AWS tags used to filter the resources in the resource collection\\. \nTags help you identify and organize your AWS resources\\. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related\\. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function\\. For more information about using tags, see the [Tagging best practices](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) whitepaper\\. \nEach AWS tag has two parts\\. \n+ A tag *key* \\(for example, `CostCenter`, `Environment`, `Project`, or `Secret`\\)\\. Tag *keys* are case\\-sensitive\\.\n+ An optional field known as a tag *value* \\(for example, `111122223333`, `Production`, or a team name\\)\\. Omitting the tag *value* is the same as using an empty string\\. Like tag *keys*, tag *values* are case\\-sensitive\\.\nTogether these are known as *key*\\-*value* pairs\\. \nThe string used for a *key* in a tag that you use to define your resource coverage must begin with the prefix `Devops-guru-`\\. The tag *key* might be `DevOps-Guru-deployment-application` or `devops-guru-rds-application`\\. When you create a *key*, the case of characters in the *key* can be whatever you choose\\. After you create a *key*, it is case\\-sensitive\\. For example, DevOps Guru works with a *key* named `devops-guru-rds` and a *key* named `DevOps-Guru-RDS`, and these act as two different *keys*\\. Possible *key*/*value* pairs in your application might be `Devops-Guru-production-application/RDS` or `Devops-Guru-production-application/containers`\\.\n*Required*: No \n*Type*: List of [TagCollection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-tagcollection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::DevOpsGuru::ResourceCollection TagCollection": { + "AppBoundaryKey": "An AWS tag *key* that is used to identify the AWS resources that DevOps Guru analyzes\\. All AWS resources in your account and Region tagged with this *key* make up your DevOps Guru application and analysis boundary\\. \nThe string used for a *key* in a tag that you use to define your resource coverage must begin with the prefix `Devops-guru-`\\. The tag *key* might be `DevOps-Guru-deployment-application` or `devops-guru-rds-application`\\. When you create a *key*, the case of characters in the *key* can be whatever you choose\\. After you create a *key*, it is case\\-sensitive\\. For example, DevOps Guru works with a *key* named `devops-guru-rds` and a *key* named `DevOps-Guru-RDS`, and these act as two different *keys*\\. Possible *key*/*value* pairs in your application might be `Devops-Guru-production-application/RDS` or `Devops-Guru-production-application/containers`\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TagValues": "The values in an AWS tag collection\\. \nThe tag's *value* is an optional field used to associate a string with the tag *key* \\(for example, `111122223333`, `Production`, or a team name\\)\\. The *key* and *value* are the tag's *key* pair\\. Omitting the tag *value* is the same as using an empty string\\. Like tag *keys*, tag *values* are case\\-sensitive\\. You can specify a maximum of 256 characters for a tag value\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DeviceFarm::DevicePool": { "Description": "The device pool's description\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `16384` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -6661,19 +7535,19 @@ "Description": "A description for the directory\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `128` \n*Pattern*: `^([a-zA-Z0-9_])[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EnableSso": "Whether to enable single sign\\-on for a directory\\. If you don't specify a value, AWS CloudFormation disables single sign\\-on by default\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The fully qualified name for the directory, such as `corp.example.com`\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^([a-zA-Z0-9]+[\\\\.-])+([a-zA-Z0-9])+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Password": "The password for the directory administrator\\. The directory creation process creates a directory administrator account with the user name `Administrator` and this password\\. \nIf you need to change the password for the administrator account, see the [ResetUserPassword](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html) API call in the *AWS Directory Service API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `(?=^.{8,64}$)((?=.*\\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[^A-Za-z0-9\\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\\s]))^.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Password": "The password for the directory administrator\\. The directory creation process creates a directory administrator account with the user name `Administrator` and this password\\. \nIf you need to change the password for the administrator account, see the [ResetUserPassword](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html) API call in the *AWS Directory Service API Reference*\\. \n*Required*: No \n*Type*: String \n*Pattern*: `(?=^.{8,64}$)((?=.*\\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[^A-Za-z0-9\\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\\s]))^.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ShortName": "The NetBIOS name of the directory, such as `CORP`\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[^\\\\/:*?\"<>|.]+[^\\\\/:*?\"<>|]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Size": "The size of the directory\\. For valid values, see [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) in the *AWS Directory Service API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Large | Small` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "VpcSettings": "A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation\\. \n*Required*: Yes \n*Type*: [VpcSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-simplead-vpcsettings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::DirectoryService::SimpleAD VpcSettings": { - "SubnetIds": "The identifiers of the subnets for the directory servers\\. The two subnets must be in different Availability Zones\\. AWS Directory Service specifies a directory server and a DNS server in each of these subnets\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VpcId": "The identifier of the VPC in which to create the directory\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SubnetIds": "The identifiers of the subnets for the directory servers\\. The two subnets must be in different Availability Zones\\. AWS Directory Service specifies a directory server and a DNS server in each of these subnets\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "VpcId": "The identifier of the VPC in which to create the directory\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::DocDB::DBCluster": { "AvailabilityZones": "A list of Amazon EC2 Availability Zones that instances in the cluster can be created in\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "BackupRetentionPeriod": "The number of days for which automated backups are retained\\. You must specify a minimum value of 1\\. \nDefault: 1 \nConstraints: \n+ Must be a value from 1 to 35\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CopyTagsToSnapshot": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CopyTagsToSnapshot": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DBClusterIdentifier": "The cluster identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain from 1 to 63 letters, numbers, or hyphens\\. \n+ The first character must be a letter\\.\n+ Cannot end with a hyphen or contain two consecutive hyphens\\. \nExample: `my-cluster` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DBClusterParameterGroupName": "The name of the cluster parameter group to associate with this cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DBSubnetGroupName": "A subnet group to associate with this cluster\\. \nConstraints: Must match the name of an existing `DBSubnetGroup`\\. Must not be default\\. \nExample: `mySubnetgroup` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -6686,9 +7560,13 @@ "Port": "Specifies the port that the database engine is listening on\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PreferredBackupWindow": "The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter\\. \nThe default is a 30\\-minute window selected at random from an 8\\-hour block of time for each AWS Region\\. \nConstraints: \n+ Must be in the format `hh24:mi-hh24:mi`\\.\n+ Must be in Universal Coordinated Time \\(UTC\\)\\.\n+ Must not conflict with the preferred maintenance window\\. \n+ Must be at least 30 minutes\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \nFormat: `ddd:hh24:mi-ddd:hh24:mi` \nThe default is a 30\\-minute window selected at random from an 8\\-hour block of time for each AWS Region, occurring on a random day of the week\\. \nValid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun \nConstraints: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RestoreToTime": "The date and time to restore the cluster to\\. \nValid values: A time in Universal Coordinated Time \\(UTC\\) format\\. \nConstraints: \n+ Must be before the latest restorable time for the instance\\.\n+ Must be specified if the `UseLatestRestorableTime` parameter is not provided\\.\n+ Cannot be specified if the `UseLatestRestorableTime` parameter is `true`\\.\n+ Cannot be specified if the `RestoreType` parameter is `copy-on-write`\\.\nExample: `2015-03-07T23:45:00Z` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RestoreType": "The type of restore to be performed\\. You can specify one of the following values: \n+ `full-copy` \\- The new DB cluster is restored as a full copy of the source DB cluster\\.\n+ `copy-on-write` \\- The new DB cluster is restored as a clone of the source DB cluster\\.\nConstraints: You can't specify `copy-on-write` if the engine version of the source DB cluster is earlier than 1\\.11\\. \nIf you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SnapshotIdentifier": "The identifier for the snapshot or cluster snapshot to restore from\\. \nYou can use either the name or the Amazon Resource Name \\(ARN\\) to specify a cluster snapshot\\. However, you can use only the ARN to specify a snapshot\\. \nConstraints: \n+ Must match the identifier of an existing snapshot\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SourceDBClusterIdentifier": "The identifier of the source cluster from which to restore\\. \nConstraints: \n+ Must match the identifier of an existing `DBCluster`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "StorageEncrypted": "Specifies whether the cluster is encrypted\\. \n*Required*: Conditional \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The tags to be assigned to the cluster\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseLatestRestorableTime": "A value that is set to `true` to restore the cluster to the latest restorable backup time, and `false` otherwise\\. \nDefault: `false` \nConstraints: Cannot be specified if the `RestoreToTime` parameter is provided\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcSecurityGroupIds": "A list of EC2 VPC security groups to associate with this cluster\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DocDB::DBClusterParameterGroup": { @@ -6704,6 +7582,7 @@ "DBClusterIdentifier": "The identifier of the cluster that the instance will belong to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DBInstanceClass": "The compute and memory capacity of the instance; for example, `db.m4.large`\\. If you change the class of an instance there can be some interruption in the cluster's service\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DBInstanceIdentifier": "The instance identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain from 1 to 63 letters, numbers, or hyphens\\.\n+ The first character must be a letter\\.\n+ Cannot end with a hyphen or contain two consecutive hyphens\\.\nExample: `mydbinstance` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EnablePerformanceInsights": "A value that indicates whether to enable Performance Insights for the DB Instance\\. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PreferredMaintenanceWindow": "The time range each week during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \n Format: `ddd:hh24:mi-ddd:hh24:mi` \nThe default is a 30\\-minute window selected at random from an 8\\-hour block of time for each AWS Region, occurring on a random day of the week\\. \nValid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun \nConstraints: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags to be assigned to the instance\\. You can assign up to 10 tags to an instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -6713,22 +7592,35 @@ "SubnetIds": "The Amazon EC2 subnet IDs for the subnet group\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags to be assigned to the subnet group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::DocDBElastic::Cluster": { + "AdminUserName": "The name of the Amazon DocumentDB elastic clusters administrator\\. \n*Constraints*: \n+ Must be from 1 to 63 letters or numbers\\.\n+ The first character must be a letter\\.\n+ Cannot be a reserved word\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AdminUserPassword": "The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters\\. \n*Constraints*: \n+ Must contain from 8 to 100 characters\\.\n+ Cannot contain a forward slash \\(/\\), double quote \\(\"\\), or the \"at\" symbol \\(@\\)\\.\n+ A valid `AdminUserName` entry is also required\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthType": "The authentication type used to determine where to fetch the password used for accessing the elastic cluster\\. Valid types are `PLAIN_TEXT` or `SECRET_ARN`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ClusterName": "The name of the new elastic cluster\\. This parameter is stored as a lowercase string\\. \n*Constraints*: \n+ Must contain from 1 to 63 letters, numbers, or hyphens\\.\n+ The first character must be a letter\\.\n+ Cannot end with a hyphen or contain two consecutive hyphens\\.\n*Example*: `my-cluster` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "KmsKeyId": "The KMS key identifier to use to encrypt the new elastic cluster\\. \nThe KMS key identifier is the Amazon Resource Name \\(ARN\\) for the KMS encryption key\\. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key\\. \nIf an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account\\. Your account has a different default encryption key for each Amazon Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \n*Format*: `ddd:hh24:mi-ddd:hh24:mi` \n*Default*: a 30\\-minute window selected at random from an 8\\-hour block of time for each AWS Region, occurring on a random day of the week\\. \n*Valid days*: Mon, Tue, Wed, Thu, Fri, Sat, Sun \n*Constraints*: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ShardCapacity": "The number of vCPUs assigned to each elastic cluster shard\\. Maximum is 64\\. Allowed values are 2, 4, 8, 16, 32, 64\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ShardCount": "The number of shards assigned to the elastic cluster\\. Maximum is 32\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SubnetIds": "The Amazon EC2 subnet IDs for the new elastic cluster\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The tags to be assigned to the new elastic cluster\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcSecurityGroupIds": "A list of EC2 VPC security groups to associate with the new elastic cluster\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::DynamoDB::GlobalTable": { "AttributeDefinitions": "A list of attributes that describe the key schema for the global table and indexes\\. \n*Required*: Yes \n*Type*: List of [AttributeDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-attributedefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "BillingMode": "Specifies how you are charged for read and write throughput and how you manage capacity\\. Valid values are: \n+ `PAY_PER_REQUEST`\n+ `PROVISIONED`\nAll replicas in your global table will have the same billing mode\\. If you use `PROVISIONED` billing mode, you must provide an auto scaling configuration via the `WriteProvisionedThroughputSettings` property\\. The default value of this property is `PROVISIONED`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PAY_PER_REQUEST | PROVISIONED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BillingMode": "Specifies how you are charged for read and write throughput and how you manage capacity\\. Valid values are: \n+ `PAY_PER_REQUEST`\n+ `PROVISIONED`\nAll replicas in your global table will have the same billing mode\\. If you use `PROVISIONED` billing mode, you must provide an auto scaling configuration via the `WriteProvisionedThroughputSettings` property\\. The default value of this property is `PROVISIONED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GlobalSecondaryIndexes": "Global secondary indexes to be created on the global table\\. You can create up to 20 global secondary indexes\\. Each replica in your global table will have the same global secondary index settings\\. You can only create or delete one global secondary index in a single stack operation\\. \nSince the backfilling of an index could take a long time, CloudFormation does not wait for the index to become active\\. If a stack operation rolls back, CloudFormation might not delete an index that has been added\\. In that case, you will need to delete the index manually\\. \n*Required*: No \n*Type*: List of [GlobalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KeySchema": "Specifies the attributes that make up the primary key for the table\\. The attributes in the `KeySchema` property must also be defined in the `AttributeDefinitions` property\\. \n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "LocalSecondaryIndexes": "Local secondary indexes to be created on the table\\. You can create up to five local secondary indexes\\. Each index is scoped to a given hash key value\\. The size of each hash key can be up to 10 gigabytes\\. Each replica in your global table will have the same local secondary index settings\\. \n*Required*: No \n*Type*: List of [LocalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-localsecondaryindex.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Replicas": "Specifies the list of replicas for your global table\\. The list must contain at least one element, the region where the stack defining the global table is deployed\\. For example, if you define your table in a stack deployed to us\\-east\\-1, you must have an entry in `Replicas` with the region us\\-east\\-1\\. You cannot remove the replica in the stack region\\. \nAdding a replica might take a few minutes for an empty table, or up to several hours for large tables\\. If you want to add or remove a replica, we recommend submitting an `UpdateStack` operation containing only that change\\. \nIf you add or delete a replica during an update, we recommend that you don't update any other resources\\. If your stack fails to update and is rolled back while adding a new replica, you might need to manually delete the replica\\.\nYou can create a new global table with as many replicas as needed\\. You can add or remove replicas after table creation, but you can only add or remove a single replica in each update\\. \n*Required*: Yes \n*Type*: List of [ReplicaSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SSESpecification": "Specifies the settings to enable server\\-side encryption\\. These settings will be applied to all replicas\\. If you plan to use customer\\-managed KMS keys, you must provide a key for each replica using the `ReplicaSpecification.ReplicaSSESpecification` property\\. \n*Required*: No \n*Type*: [SSESpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-ssespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StreamSpecification": "Specifies the streams settings on your global table\\. You must provide a value for this property if your global table contains more than one replica\\. You can only change the streams settings if your global table has only one replica\\. \n*Required*: No \n*Type*: [StreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-streamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TableName": "A name for the global table\\. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name\\. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TableName": "A name for the global table\\. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name\\. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TimeToLiveSpecification": "Specifies the time to live \\(TTL\\) settings for the table\\. This setting will be applied to all replicas\\. \n*Required*: No \n*Type*: [TimeToLiveSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-timetolivespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WriteProvisionedThroughputSettings": "Specifies an auto scaling policy for write capacity\\. This policy will be applied to all replicas\\. This setting must be specified if `BillingMode` is set to `PROVISIONED`\\. \n*Required*: No \n*Type*: [WriteProvisionedThroughputSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::GlobalTable AttributeDefinition": { - "AttributeName": "A name for the attribute\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AttributeType": "The data type for the attribute, where: \n+ `S` \\- the attribute is of type String\n+ `N` \\- the attribute is of type Number\n+ `B` \\- the attribute is of type Binary\n*Required*: Yes \n*Type*: String \n*Allowed values*: `B | N | S` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AttributeName": "A name for the attribute\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AttributeType": "The data type for the attribute, where: \n+ `S` \\- the attribute is of type String\n+ `N` \\- the attribute is of type Number\n+ `B` \\- the attribute is of type Binary\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::GlobalTable CapacityAutoScalingSettings": { "MaxCapacity": "The maximum provisioned capacity units for the global table\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -6737,29 +7629,32 @@ "TargetTrackingScalingPolicyConfiguration": "Defines a target tracking scaling policy\\. \n*Required*: Yes \n*Type*: [TargetTrackingScalingPolicyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-targettrackingscalingpolicyconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::GlobalTable ContributorInsightsSpecification": { - "Enabled": "Indicates whether CloudWatch Contributor Insights are to be enabled \\(true\\) or disabled \\(false\\)\\. \n*Required*: Yes \n*Type*: Boolean \n*Allowed values*: `DISABLE | ENABLE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Enabled": "Indicates whether CloudWatch Contributor Insights are to be enabled \\(true\\) or disabled \\(false\\)\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::GlobalTable GlobalSecondaryIndex": { - "IndexName": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: Updates are not supported\\.", - "KeySchema": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) \n*Maximum*: `2` \n*Update requires*: Updates are not supported\\.", + "IndexName": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: Updates are not supported\\.", + "KeySchema": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) \n*Update requires*: Updates are not supported\\.", "Projection": "Represents attributes that are copied \\(projected\\) from the table into the global secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-projection.html) \n*Update requires*: Updates are not supported\\.", "WriteProvisionedThroughputSettings": "Defines write capacity settings for the global secondary index\\. You must specify a value for this property if the table's `BillingMode` is `PROVISIONED`\\. All replicas will have the same write capacity settings for this global secondary index\\. \n*Required*: No \n*Type*: [WriteProvisionedThroughputSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-writeprovisionedthroughputsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::GlobalTable KeySchema": { "AttributeName": "The name of a key attribute\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "KeyType": "The role that this key attribute will assume: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `HASH | RANGE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "KeyType": "The role that this key attribute will assume: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::DynamoDB::GlobalTable KinesisStreamSpecification": { + "StreamArn": "The ARN for a specific Kinesis data stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::GlobalTable LocalSecondaryIndex": { - "IndexName": "The name of the local secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: Updates are not supported\\.", - "KeySchema": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) \n*Maximum*: `2` \n*Update requires*: Updates are not supported\\.", + "IndexName": "The name of the local secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: Updates are not supported\\.", + "KeySchema": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) \n*Update requires*: Updates are not supported\\.", "Projection": "Represents attributes that are copied \\(projected\\) from the table into the local secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-projection.html) \n*Update requires*: Updates are not supported\\." }, "AWS::DynamoDB::GlobalTable PointInTimeRecoverySpecification": { "PointInTimeRecoveryEnabled": "Indicates whether point in time recovery is enabled \\(true\\) or disabled \\(false\\) on the table\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::GlobalTable Projection": { - "NonKeyAttributes": "Represents the non\\-key attribute names which will be projected into the index\\. \nFor local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, must not exceed 20\\. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ProjectionType": "The set of attributes that are projected into the index: \n+ `KEYS_ONLY` \\- Only the index and primary keys are projected into the index\\.\n+ `INCLUDE` \\- In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non\\-key attributes that you specify\\.\n+ `ALL` \\- All of the table attributes are projected into the index\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ALL | INCLUDE | KEYS_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "NonKeyAttributes": "Represents the non\\-key attribute names which will be projected into the index\\. \nFor local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, must not exceed 100\\. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "ProjectionType": "The set of attributes that are projected into the index: \n+ `KEYS_ONLY` \\- Only the index and primary keys are projected into the index\\.\n+ `INCLUDE` \\- In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non\\-key attributes that you specify\\.\n+ `ALL` \\- All of the table attributes are projected into the index\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)" }, "AWS::DynamoDB::GlobalTable ReadProvisionedThroughputSettings": { "ReadCapacityAutoScalingSettings": "Specifies auto scaling settings for the replica table or global secondary index\\. \n*Required*: No \n*Type*: [CapacityAutoScalingSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -6767,7 +7662,7 @@ }, "AWS::DynamoDB::GlobalTable ReplicaGlobalSecondaryIndexSpecification": { "ContributorInsightsSpecification": "Updates the status for contributor insights for a specific table or index\\. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and \\(if applicable\\) sort key of frequently accessed items and frequently throttled items in plaintext\\. If you require the use of AWS Key Management Service \\(KMS\\) to encrypt this table\u2019s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IndexName": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IndexName": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ReadProvisionedThroughputSettings": "Allows you to specify the read capacity settings for a replica global secondary index when the `BillingMode` is set to `PROVISIONED`\\. \n*Required*: No \n*Type*: [ReadProvisionedThroughputSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::GlobalTable ReplicaSSESpecification": { @@ -6776,19 +7671,20 @@ "AWS::DynamoDB::GlobalTable ReplicaSpecification": { "ContributorInsightsSpecification": "The settings used to enable or disable CloudWatch Contributor Insights for the specified replica\\. When not specified, defaults to contributor insights disabled for the replica\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GlobalSecondaryIndexes": "Defines additional settings for the global secondary indexes of this replica\\. \n*Required*: No \n*Type*: List of [ReplicaGlobalSecondaryIndexSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicaglobalsecondaryindexspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KinesisStreamSpecification": "Defines the Kinesis Data Streams configuration for the specified replica\\. \n*Required*: No \n*Type*: [KinesisStreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-kinesisstreamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PointInTimeRecoverySpecification": "The settings used to enable point in time recovery\\. When not specified, defaults to point in time recovery disabled for the replica\\. \n*Required*: No \n*Type*: [PointInTimeRecoverySpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-pointintimerecoveryspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ReadProvisionedThroughputSettings": "Defines read capacity settings for the replica table\\. \n*Required*: No \n*Type*: [ReadProvisionedThroughputSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-readprovisionedthroughputsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Region": "The region in which this replica exists\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SSESpecification": "Allows you to specify a customer\\-managed key for the replica\\. When using customer\\-managed keys for server\\-side encryption, this property must have a value in all replicas\\. \n*Required*: No \n*Type*: [ReplicaSSESpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-replicassespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TableClass": "The table class of the specified table\\. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `STANDARD | STANDARD_INFREQUENT_ACCESS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TableClass": "The table class of the specified table\\. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs to apply to this replica\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::GlobalTable SSESpecification": { - "SSEEnabled": "Indicates whether server\\-side encryption is performed using an AWS managed key or an AWS owned key\\. If disabled \\(false\\) or not specified, server\\-side encryption uses an AWS owned key\\. If enabled \\(true\\), the server\\-side encryption type is set to KMS and an AWS managed key is used \\(AWS KMS charges apply\\)\\. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the `ReplicaSpecification.SSESpecification` object\\. You cannot mix AWS managed and customer managed KMS keys\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SSEType": "Server\\-side encryption type\\. The only supported value is: \n+ `KMS` \\- Server\\-side encryption that uses AWS Key Management Service\\. The key is stored in your account and is managed by AWS KMS \\(AWS KMS charges apply\\)\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AES256 | KMS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SSEEnabled": "Indicates whether server\\-side encryption is performed using an AWS managed key or an AWS owned key\\. If enabled \\(true\\), server\\-side encryption type is set to KMS and an AWS managed key is used \\(AWS KMS charges apply\\)\\. If disabled \\(false\\) or not specified,server\\-side encryption is set to an AWS owned key\\. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the `ReplicaSpecification.SSESpecification` object\\. You cannot mix AWS managed and customer managed KMS keys\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SSEType": "Server\\-side encryption type\\. The only supported value is: \n+ `KMS` \\- Server\\-side encryption that uses AWS Key Management Service\\. The key is stored in your account and is managed by AWS KMS \\(AWS KMS charges apply\\)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::GlobalTable StreamSpecification": { - "StreamViewType": "When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table\\. Valid values for `StreamViewType` are: \n+ `KEYS_ONLY` \\- Only the key attributes of the modified item are written to the stream\\.\n+ `NEW_IMAGE` \\- The entire item, as it appears after it was modified, is written to the stream\\.\n+ `OLD_IMAGE` \\- The entire item, as it appeared before it was modified, is written to the stream\\.\n+ `NEW_AND_OLD_IMAGES` \\- Both the new and the old item images of the item are written to the stream\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `KEYS_ONLY | NEW_AND_OLD_IMAGES | NEW_IMAGE | OLD_IMAGE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "StreamViewType": "When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table\\. Valid values for `StreamViewType` are: \n+ `KEYS_ONLY` \\- Only the key attributes of the modified item are written to the stream\\.\n+ `NEW_IMAGE` \\- The entire item, as it appears after it was modified, is written to the stream\\.\n+ `OLD_IMAGE` \\- The entire item, as it appeared before it was modified, is written to the stream\\.\n+ `NEW_AND_OLD_IMAGES` \\- Both the new and the old item images of the item are written to the stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::GlobalTable TargetTrackingScalingPolicyConfiguration": { "DisableScaleIn": "Indicates whether scale in by the target tracking scaling policy is disabled\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -6797,65 +7693,84 @@ "TargetValue": "Defines a target value for the scaling policy\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::GlobalTable TimeToLiveSpecification": { - "AttributeName": "The name of the attribute used to store the expiration time for items in the table\\. \nCurrently, you cannot directly change the attribute name used to evaluate time to live\\. In order to do so, you must first disable time to live, and then re\\-enable it with the new attribute name\\. It can take up to one hour for changes to time to live to take effect\\. If you attempt to modify time to live within that time window, your stack operation might be delayed\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AttributeName": "The name of the attribute used to store the expiration time for items in the table\\. \nCurrently, you cannot directly change the attribute name used to evaluate time to live\\. In order to do so, you must first disable time to live, and then re\\-enable it with the new attribute name\\. It can take up to one hour for changes to time to live to take effect\\. If you attempt to modify time to live within that time window, your stack operation might be delayed\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "Indicates whether TTL is to be enabled \\(true\\) or disabled \\(false\\) on the table\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::GlobalTable WriteProvisionedThroughputSettings": { "WriteCapacityAutoScalingSettings": "Specifies auto scaling settings for the replica table or global secondary index\\. \n*Required*: No \n*Type*: [CapacityAutoScalingSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-capacityautoscalingsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::Table": { - "AttributeDefinitions": "A list of attributes that describe the key schema for the table and indexes\\. \nThis property is required to create a DynamoDB table\\. \nUpdate requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\\. Replacement if you edit an existing AttributeDefinition\\. \n*Required*: Conditional \n*Type*: List of [AttributeDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", - "BillingMode": "Specify how you are charged for read and write throughput and how you manage capacity\\. \nValid values include: \n+ `PROVISIONED` \\- We recommend using `PROVISIONED` for predictable workloads\\. `PROVISIONED` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual)\\.\n+ `PAY_PER_REQUEST` \\- We recommend using `PAY_PER_REQUEST` for unpredictable workloads\\. `PAY_PER_REQUEST` sets the billing mode to [On\\-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand)\\.\nIf not specified, the default is `PROVISIONED`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PAY_PER_REQUEST | PROVISIONED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ContributorInsightsSpecification": "The settings used to enable or disable CloudWatch Contributor Insights for the specified table\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "GlobalSecondaryIndexes": "Global secondary indexes to be created on the table\\. You can create up to 20 global secondary indexes\\. \nIf you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update\\. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table\\. You can't use the index or update the table until the index's status is `ACTIVE`\\. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command\\. \nIf you add or delete an index during an update, we recommend that you don't update any other resources\\. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index\\. \nUpdates are not supported\\. The following are exceptions: \n+ If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption\\.\n+ You can delete or add one global secondary index without interruption\\. If you do both in the same update \\(for example, by changing the index's logical ID\\), the update fails\\.\n*Required*: No \n*Type*: List of [GlobalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KeySchema": "Specifies the attributes that make up the primary key for the table\\. The attributes in the `KeySchema` property must also be defined in the `AttributeDefinitions` property\\. \n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "KinesisStreamSpecification": "The Kinesis Data Streams configuration for the specified table\\. \n*Required*: No \n*Type*: [KinesisStreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-kinesisstreamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LocalSecondaryIndexes": "Local secondary indexes to be created on the table\\. You can create up to 5 local secondary indexes\\. Each index is scoped to a given hash key value\\. The size of each hash key can be up to 10 gigabytes\\. \n*Required*: No \n*Type*: List of [LocalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AttributeDefinitions": "A list of attributes that describe the key schema for the table and indexes\\. \nThis property is required to create a DynamoDB table\\. \nUpdate requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\\. Replacement if you edit an existing AttributeDefinition\\. \n*Required*: Conditional \n*Type*: List of [AttributeDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-attributedefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BillingMode": "Specify how you are charged for read and write throughput and how you manage capacity\\. \nValid values include: \n+ `PROVISIONED` \\- We recommend using `PROVISIONED` for predictable workloads\\. `PROVISIONED` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual)\\.\n+ `PAY_PER_REQUEST` \\- We recommend using `PAY_PER_REQUEST` for unpredictable workloads\\. `PAY_PER_REQUEST` sets the billing mode to [On\\-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand)\\.\nIf not specified, the default is `PROVISIONED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContributorInsightsSpecification": "The settings used to enable or disable CloudWatch Contributor Insights for the specified table\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "GlobalSecondaryIndexes": "Global secondary indexes to be created on the table\\. You can create up to 20 global secondary indexes\\. \nIf you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update\\. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table\\. You can't use the index or update the table until the index's status is `ACTIVE`\\. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command\\. \nIf you add or delete an index during an update, we recommend that you don't update any other resources\\. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index\\. \nUpdates are not supported\\. The following are exceptions: \n+ If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption\\.\n+ You can delete or add one global secondary index without interruption\\. If you do both in the same update \\(for example, by changing the index's logical ID\\), the update fails\\.\n*Required*: No \n*Type*: List of [GlobalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ImportSourceSpecification": "Specifies the properties of data being imported from the S3 bucket source to the table\\. \nIf you specify the `ImportSourceSpecification` property, and also specify either the `StreamSpecification` or `TableClass` property, the IAM entity creating/updating stack must have `UpdateTable` permission\\.\n*Required*: No \n*Type*: [ImportSourceSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-importsourcespecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "KeySchema": "Specifies the attributes that make up the primary key for the table\\. The attributes in the `KeySchema` property must also be defined in the `AttributeDefinitions` property\\. \n*Required*: Yes \n*Type*: [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KinesisStreamSpecification": "The Kinesis Data Streams configuration for the specified table\\. \n*Required*: No \n*Type*: [KinesisStreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-kinesisstreamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LocalSecondaryIndexes": "Local secondary indexes to be created on the table\\. You can create up to 5 local secondary indexes\\. Each index is scoped to a given hash key value\\. The size of each hash key can be up to 10 gigabytes\\. \n*Required*: No \n*Type*: List of [LocalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-localsecondaryindex.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PointInTimeRecoverySpecification": "The settings used to enable point in time recovery\\. \n*Required*: No \n*Type*: [PointInTimeRecoverySpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ProvisionedThroughput": "Throughput for the specified table, which consists of values for `ReadCapacityUnits` and `WriteCapacityUnits`\\. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html)\\. \nIf you set `BillingMode` as `PROVISIONED`, you must specify this property\\. If you set `BillingMode` as `PAY_PER_REQUEST`, you cannot specify this property\\. \n*Required*: Conditional \n*Type*: [ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProvisionedThroughput": "Throughput for the specified table, which consists of values for `ReadCapacityUnits` and `WriteCapacityUnits`\\. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html)\\. \nIf you set `BillingMode` as `PROVISIONED`, you must specify this property\\. If you set `BillingMode` as `PAY_PER_REQUEST`, you cannot specify this property\\. \n*Required*: Conditional \n*Type*: [ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SSESpecification": "Specifies the settings to enable server\\-side encryption\\. \n*Required*: No \n*Type*: [SSESpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", - "StreamSpecification": "The settings for the DynamoDB table stream, which capture changes to items stored in the table\\. \n*Required*: No \n*Type*: [StreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-streamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TableClass": "The table class of the new table\\. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `STANDARD | STANDARD_INFREQUENT_ACCESS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StreamSpecification": "The settings for the DynamoDB table stream, which capture changes to items stored in the table\\. \n*Required*: No \n*Type*: [StreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-streamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TableClass": "The table class of the new table\\. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TableName": "A name for the table\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimeToLiveSpecification": "Specifies the Time to Live \\(TTL\\) settings for the table\\. \nFor detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide\\. \n*Required*: No \n*Type*: [TimeToLiveSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TimeToLiveSpecification": "Specifies the Time to Live \\(TTL\\) settings for the table\\. \nFor detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide\\. \n*Required*: No \n*Type*: [TimeToLiveSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-timetolivespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::Table AttributeDefinition": { - "AttributeName": "A name for the attribute\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AttributeType": "The data type for the attribute, where: \n+ `S` \\- the attribute is of type String\n+ `N` \\- the attribute is of type Number\n+ `B` \\- the attribute is of type Binary\n*Required*: Yes \n*Type*: String \n*Allowed values*: `B | N | S` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AttributeName": "A name for the attribute\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AttributeType": "The data type for the attribute, where: \n+ `S` \\- the attribute is of type String\n+ `N` \\- the attribute is of type Number\n+ `B` \\- the attribute is of type Binary\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::Table ContributorInsightsSpecification": { - "Enabled": "Indicates whether CloudWatch Contributor Insights are to be enabled \\(true\\) or disabled \\(false\\)\\. \n*Required*: Yes \n*Type*: Boolean \n*Allowed values*: `DISABLE | ENABLE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Enabled": "Indicates whether CloudWatch Contributor Insights are to be enabled \\(true\\) or disabled \\(false\\)\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::DynamoDB::Table Csv": { + "Delimiter": "The delimiter used for separating items in the CSV file being imported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "HeaderList": "List of the headers used to specify a common header for all source CSV files being imported\\. If this field is specified then the first line of each CSV file is treated as data instead of the header\\. If this field is not specified the the first line of each CSV file is treated as the header\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::DynamoDB::Table GlobalSecondaryIndex": { - "ContributorInsightsSpecification": "The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IndexName": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: Updates are not supported\\.", - "KeySchema": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) \n*Maximum*: `2` \n*Update requires*: Updates are not supported\\.", - "Projection": "Represents attributes that are copied \\(projected\\) from the table into the global secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html) \n*Update requires*: Updates are not supported\\.", - "ProvisionedThroughput": "Represents the provisioned throughput settings for the specified global secondary index\\. \nFor current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*\\. \n*Required*: No \n*Type*: [ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ContributorInsightsSpecification": "The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IndexName": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: Updates are not supported\\.", + "KeySchema": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) \n*Update requires*: Updates are not supported\\.", + "Projection": "Represents attributes that are copied \\(projected\\) from the table into the global secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-projection.html) \n*Update requires*: Updates are not supported\\.", + "ProvisionedThroughput": "Represents the provisioned throughput settings for the specified global secondary index\\. \nFor current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*\\. \n*Required*: No \n*Type*: [ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::DynamoDB::Table ImportSourceSpecification": { + "InputCompressionType": "Type of compression to be used on the input coming from the imported table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InputFormat": "The format of the source data\\. Valid values for `ImportFormat` are `CSV`, `DYNAMODB_JSON` or `ION`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InputFormatOptions": "Additional properties that specify how the input is formatted, \n*Required*: No \n*Type*: [InputFormatOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-inputformatoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "S3BucketSource": "The S3 bucket that provides the source for the import\\. \n*Required*: Yes \n*Type*: [S3BucketSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-s3bucketsource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::DynamoDB::Table InputFormatOptions": { + "Csv": "The options for imported source files in CSV format\\. The values are Delimiter and HeaderList\\. \n*Required*: No \n*Type*: [Csv](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-csv.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::DynamoDB::Table KeySchema": { "AttributeName": "The name of a key attribute\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KeyType": "The role that this key attribute will assume: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `HASH | RANGE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "KeyType": "The role that this key attribute will assume: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::Table KinesisStreamSpecification": { - "StreamArn": "The ARN for a specific Kinesis data stream\\. \nLength Constraints: Minimum length of 37\\. Maximum length of 1024\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `37` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "StreamArn": "The ARN for a specific Kinesis data stream\\. \nLength Constraints: Minimum length of 37\\. Maximum length of 1024\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::Table LocalSecondaryIndex": { - "IndexName": "The name of the local secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: Updates are not supported\\.", - "KeySchema": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) \n*Maximum*: `2` \n*Update requires*: Updates are not supported\\.", - "Projection": "Represents attributes that are copied \\(projected\\) from the table into the local secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html) \n*Update requires*: Updates are not supported\\." + "IndexName": "The name of the local secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: Updates are not supported\\.", + "KeySchema": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) \n*Update requires*: Updates are not supported\\.", + "Projection": "Represents attributes that are copied \\(projected\\) from the table into the local secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-projection.html) \n*Update requires*: Updates are not supported\\." }, "AWS::DynamoDB::Table PointInTimeRecoverySpecification": { "PointInTimeRecoveryEnabled": "Indicates whether point in time recovery is enabled \\(true\\) or disabled \\(false\\) on the table\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::Table Projection": { - "NonKeyAttributes": "Represents the non\\-key attribute names which will be projected into the index\\. \nFor local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, must not exceed 20\\. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ProjectionType": "The set of attributes that are projected into the index: \n+ `KEYS_ONLY` \\- Only the index and primary keys are projected into the index\\.\n+ `INCLUDE` \\- In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non\\-key attributes that you specify\\.\n+ `ALL` \\- All of the table attributes are projected into the index\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ALL | INCLUDE | KEYS_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "NonKeyAttributes": "Represents the non\\-key attribute names which will be projected into the index\\. \nFor local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, must not exceed 100\\. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProjectionType": "The set of attributes that are projected into the index: \n+ `KEYS_ONLY` \\- Only the index and primary keys are projected into the index\\.\n+ `INCLUDE` \\- In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non\\-key attributes that you specify\\.\n+ `ALL` \\- All of the table attributes are projected into the index\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::Table ProvisionedThroughput": { - "ReadCapacityUnits": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`\\. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide*\\. \nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0\\. \n*Required*: Yes \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "WriteCapacityUnits": "The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`\\. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide*\\. \nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0\\. \n*Required*: Yes \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ReadCapacityUnits": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`\\. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide*\\. \nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WriteCapacityUnits": "The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`\\. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide*\\. \nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::DynamoDB::Table S3BucketSource": { + "S3Bucket": "The S3 bucket that is being imported from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "S3BucketOwner": "The account number of the S3 bucket that is being imported from\\. If the bucket is owned by the requester this is optional\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "S3KeyPrefix": "The key prefix shared by all S3 Objects that are being imported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::DynamoDB::Table SSESpecification": { "KMSMasterKeyId": "The AWS KMS key that should be used for the AWS KMS encryption\\. To specify a key, use its key ID, Amazon Resource Name \\(ARN\\), alias name, or alias ARN\\. Note that you should only provide this parameter if the key is different from the default DynamoDB key `alias/aws/dynamodb`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -6863,10 +7778,10 @@ "SSEType": "Server\\-side encryption type\\. The only supported value is: \n+ `KMS` \\- Server\\-side encryption that uses AWS Key Management Service\\. The key is stored in your account and is managed by AWS KMS \\(AWS KMS charges apply\\)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::Table StreamSpecification": { - "StreamViewType": "When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table\\. Valid values for `StreamViewType` are: \n+ `KEYS_ONLY` \\- Only the key attributes of the modified item are written to the stream\\.\n+ `NEW_IMAGE` \\- The entire item, as it appears after it was modified, is written to the stream\\.\n+ `OLD_IMAGE` \\- The entire item, as it appeared before it was modified, is written to the stream\\.\n+ `NEW_AND_OLD_IMAGES` \\- Both the new and the old item images of the item are written to the stream\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `KEYS_ONLY | NEW_AND_OLD_IMAGES | NEW_IMAGE | OLD_IMAGE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "StreamViewType": "When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table\\. Valid values for `StreamViewType` are: \n+ `KEYS_ONLY` \\- Only the key attributes of the modified item are written to the stream\\.\n+ `NEW_IMAGE` \\- The entire item, as it appears after it was modified, is written to the stream\\.\n+ `OLD_IMAGE` \\- The entire item, as it appeared before it was modified, is written to the stream\\.\n+ `NEW_AND_OLD_IMAGES` \\- Both the new and the old item images of the item are written to the stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::DynamoDB::Table TimeToLiveSpecification": { - "AttributeName": "The name of the TTL attribute used to store the expiration time for items in the table\\. \nTo update this property, you must first disable TTL then enable TTL with the new attribute name\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AttributeName": "The name of the TTL attribute used to store the expiration time for items in the table\\. \nTo update this property, you must first disable TTL then enable TTL with the new attribute name\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "Indicates whether TTL is to be enabled \\(true\\) or disabled \\(false\\) on the table\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EC2::CapacityReservation": { @@ -6885,7 +7800,7 @@ "Tenancy": "Indicates the tenancy of the Capacity Reservation\\. A Capacity Reservation can have one of the following tenancy settings: \n+ `default` \\- The Capacity Reservation is created on hardware that is shared with other AWS accounts\\.\n+ `dedicated` \\- The Capacity Reservation is created on single\\-tenant hardware that is dedicated to a single AWS account\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `dedicated | default` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EC2::CapacityReservation TagSpecification": { - "ResourceType": "The type of resource to tag\\. Specify `capacity-reservation`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ResourceType": "The type of resource to tag\\. Specify `capacity-reservation`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The tags to apply to the resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EC2::CapacityReservationFleet": { @@ -6904,7 +7819,7 @@ "AvailabilityZoneId": "The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the capacity\\. A Capacity Reservation Fleet can't span Availability Zones\\. All instance type specifications that you specify for the Fleet must use the same Availability Zone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EbsOptimized": "Indicates whether the Capacity Reservation Fleet supports EBS\\-optimized instances types\\. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance\\. This optimization isn't available with all instance types\\. Additional usage charges apply when using EBS\\-optimized instance types\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InstancePlatform": "The type of operating system for which the Capacity Reservation Fleet reserves capacity\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Linux with SQL Server Enterprise | Linux with SQL Server Standard | Linux with SQL Server Web | Linux/UNIX | Red Hat Enterprise Linux | RHEL with HA | RHEL with HA and SQL Server Enterprise | RHEL with HA and SQL Server Standard | RHEL with SQL Server Enterprise | RHEL with SQL Server Standard | RHEL with SQL Server Web | SUSE Linux | Windows | Windows with SQL Server | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "InstanceType": "The instance type for which the Capacity Reservation Fleet reserves capacity\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InstanceType": "The instance type for which the Capacity Reservation Fleet reserves capacity\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Priority": "The priority to assign to the instance type\\. This value is used to determine which of the instance types specified for the Fleet should be prioritized for use\\. A lower value indicates a high priority\\. For more information, see [Instance type priority](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority) in the Amazon EC2 User Guide\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Weight": "The number of capacity units provided by the specified instance type\\. This value, together with the total target capacity that you specify for the Fleet determine the number of instances for which the Fleet reserves capacity\\. Both values are based on units that make sense for your workload\\. For more information, see [Total target capacity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) in the Amazon EC2 User Guide\\. \nValid Range: Minimum value of `0.001`\\. Maximum value of `99.999`\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -6971,7 +7886,7 @@ "SelfServiceSAMLProviderArn": "The Amazon Resource Name \\(ARN\\) of the IAM SAML identity provider for the self\\-service portal\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EC2::ClientVpnEndpoint TagSpecification": { - "ResourceType": "The type of resource to tag\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceType": "The type of resource to tag\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags to apply to the resource\\. \n*Required*: Yes \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EC2::ClientVpnRoute": { @@ -7039,7 +7954,7 @@ "AWS::EC2::EC2Fleet FleetLaunchTemplateOverridesRequest": { "AvailabilityZone": "The Availability Zone in which to launch the instances\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InstanceRequirements": "The attributes for the instance types\\. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes\\. \nIf you specify `InstanceRequirements`, you can't specify `InstanceType`\\.\n*Required*: No \n*Type*: [InstanceRequirementsRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-instancerequirementsrequest.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "InstanceType": "The instance type\\. \nIf you specify `InstanceType`, you can't specify `InstanceRequirements`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InstanceType": "The instance type\\. \nIf you specify `InstanceType`, you can't specify `InstanceRequirements`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "MaxPrice": "The maximum price per unit hour that you are willing to pay for a Spot Instance\\. We do not recommend using this parameter because it can lead to increased interruptions\\. If you do not specify this parameter, you will pay the current Spot price\\. \nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Placement": "The location where the instance launched, if applicable\\. \n*Required*: No \n*Type*: [Placement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Priority": "The priority for the launch template override\\. The highest priority is launched first\\. \nIf the On\\-Demand `AllocationStrategy` is set to `prioritized`, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On\\-Demand capacity\\. \nIf the Spot `AllocationStrategy` is set to `capacity-optimized-prioritized`, EC2 Fleet uses priority on a best\\-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first\\. \nValid values are whole numbers starting at `0`\\. The lower the number, the higher the priority\\. If no number is set, the launch template override has the lowest priority\\. You can set the same priority for different launch template overrides\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -7124,7 +8039,7 @@ "SingleInstanceType": "Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet\\. \nSupported only for fleets of type `instant`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EC2::EC2Fleet TagSpecification": { - "ResourceType": "The type of resource to tag\\. `ResourceType` must be `fleet`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ResourceType": "The type of resource to tag\\. `ResourceType` must be `fleet`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The tags to apply to the resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EC2::EC2Fleet TargetCapacitySpecificationRequest": { @@ -7148,7 +8063,7 @@ "NetworkBorderGroup": "A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses\\. Use this parameter to limit the IP address to this location\\. IP addresses cannot move between network border groups\\. \nUse [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups\\. \nYou cannot use a network border group with EC2 Classic\\. If you attempt this operation on EC2 Classic, you receive an `InvalidParameterCombination` error\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PublicIpv4Pool": "The ID of an address pool that you own\\. Use this parameter to let Amazon EC2 select an address from the address pool\\. \nUpdates to the `PublicIpv4Pool` property may require *some interruptions*\\. Updates on an EIP reassociates the address on its associated resource\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Any tags assigned to the Elastic IP address\\. \nUpdates to the `Tags` property may require *some interruptions*\\. Updates on an EIP reassociates the address on its associated resource\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TransferAddress": "The Elastic IP address you are accepting for transfer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "TransferAddress": "The Elastic IP address you are accepting for transfer\\. You can only accept one transferred address\\. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EC2::EIPAssociation": { "AllocationId": "\\[EC2\\-VPC\\] The allocation ID\\. This is required for EC2\\-VPC\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", @@ -7161,8 +8076,8 @@ "VpcId": "The ID of the VPC for which to create the egress\\-only internet gateway\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EC2::EnclaveCertificateIamRoleAssociation": { - "CertificateArn": "The ARN of the ACM certificate with which to associate the IAM role\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1283` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "RoleArn": "The ARN of the IAM role to associate with the ACM certificate\\. You can associate up to 16 IAM roles with an ACM certificate\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1283` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "CertificateArn": "The ARN of the ACM certificate with which to associate the IAM role\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RoleArn": "The ARN of the IAM role to associate with the ACM certificate\\. You can associate up to 16 IAM roles with an ACM certificate\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EC2::FlowLog": { "DeliverLogsPermissionArn": "The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account\\. \nThis parameter is required if the destination type is `cloud-watch-logs` and unsupported otherwise\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -7195,8 +8110,11 @@ "OutpostArn": "The Amazon Resource Name \\(ARN\\) of the AWS Outpost on which the Dedicated Host is allocated\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EC2::IPAM": { + "DefaultResourceDiscoveryAssociationId": "The IPAM's default resource discovery association ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefaultResourceDiscoveryId": "The IPAM's default resource discovery ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "The description for the IPAM\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OperatingRegions": "The operating Regions for an IPAM\\. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs\\. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions\\. \nFor more information about operating Regions, see [Create an IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User Guide*\\. \n*Required*: No \n*Type*: List of [IpamOperatingRegion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipam-ipamoperatingregion.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceDiscoveryAssociationCount": "The IPAM's resource discovery association count\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The key/value combination of a tag assigned to the resource\\. Use the tag key in the filter name and the tag value as the filter value\\. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EC2::IPAM IpamOperatingRegion": { @@ -7220,6 +8138,7 @@ "IpamScopeId": "The ID of the scope in which you would like to create the IPAM pool\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Locale": "The locale of the IPAM pool\\. In IPAM, the locale is the AWS Region where you want to make an IPAM pool available for allocations\\. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool\\. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC\u2019s Region\\. Note that once you choose a Locale for a pool, you cannot modify it\\. If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ProvisionedCidrs": "Information about the CIDRs provisioned to an IPAM pool\\. \n*Required*: No \n*Type*: List of [ProvisionedCidr](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipampool-provisionedcidr.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PublicIpSource": "The IP address source for pools in the public scope\\. Only used for provisioning IP address CIDRs to pools in the public scope\\. Default is `BYOIP`\\. For more information, see [Create IPv6 pools](https://docs.aws.amazon.com/vpc/latest/ipam/intro-create-ipv6-pools.html) in the *Amazon VPC IPAM User Guide*\\. By default, you can add only one Amazon\\-provided IPv6 CIDR block to a top\\-level IPv6 pool\\. For information on increasing the default limit, see [ Quotas for your IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) in the *Amazon VPC IPAM User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `amazon | byoip` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PubliclyAdvertisable": "Determines if a pool is publicly advertisable\\. This option is not available for pools with AddressFamily set to `ipv4`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SourceIpamPoolId": "The ID of the source IPAM pool\\. You can use this option to create an IPAM pool within an existing source pool\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The key/value combination of a tag assigned to the resource\\. Use the tag key in the filter name and the tag value as the filter value\\. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -7227,6 +8146,24 @@ "AWS::EC2::IPAMPool ProvisionedCidr": { "Cidr": "The CIDR provisioned to the IPAM pool\\. A CIDR is a representation of an IP address and its associated network mask \\(or netmask\\) and refers to a range of IP addresses\\. An IPv4 CIDR example is `10.24.34.0/23`\\. An IPv6 CIDR example is `2001:DB8::/32`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::EC2::IPAMPoolCidr": { + "Cidr": "The CIDR provisioned to the IPAM pool\\. A CIDR is a representation of an IP address and its associated network mask \\(or netmask\\) and refers to a range of IP addresses\\. An IPv4 CIDR example is `10.24.34.0/23`\\. An IPv6 CIDR example is `2001:DB8::/32`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IpamPoolId": "The ID of the IPAM pool\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "NetmaskLength": "The netmask length of the CIDR you'd like to provision to a pool\\. Can be used for provisioning Amazon\\-provided IPv6 CIDRs to top\\-level pools and for provisioning CIDRs to pools with source pools\\. Cannot be used to provision BYOIP CIDRs to top\\-level pools\\. \"NetmaskLength\" or \"Cidr\" is required\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::EC2::IPAMResourceDiscovery": { + "Description": "The resource discovery description\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OperatingRegions": "The operating Regions for the resource discovery\\. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs\\. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions\\. \n*Required*: No \n*Type*: List of [IpamOperatingRegion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamoperatingregion.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "A tag is a label that you assign to an AWS resource\\. Each tag consists of a key and an optional value\\. You can use tags to search and filter your resources or track your AWS costs\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::EC2::IPAMResourceDiscovery IpamOperatingRegion": { + "RegionName": "The name of the operating Region\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::EC2::IPAMResourceDiscoveryAssociation": { + "IpamId": "The IPAM ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IpamResourceDiscoveryId": "The resource discovery ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "A tag is a label that you assign to an AWS resource\\. Each tag consists of a key and an optional value\\. You can use tags to search and filter your resources or track your AWS costs\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::EC2::IPAMScope": { "Description": "The description of the scope\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IpamId": "The ID of the IPAM for which you're creating this scope\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -7250,7 +8187,7 @@ "IamInstanceProfile": "The name of an IAM instance profile\\. To create a new IAM instance profile, use the [AWS::IAM::InstanceProfile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html) resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ImageId": "The ID of the AMI\\. An AMI ID is required to launch an instance and must be specified here or in a launch template\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InstanceInitiatedShutdownBehavior": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance \\(using the operating system command for system shutdown\\)\\. \nDefault: `stop` \n*Required*: No \n*Type*: String \n*Allowed values*: `stop | terminate` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InstanceType": "The instance type\\. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*\\. \nDefault: `m1.small` \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "InstanceType": "The instance type\\. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*\\. \nDefault: `m1.small` \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "Ipv6AddressCount": "\\[EC2\\-VPC\\] The number of IPv6 addresses to associate with the primary network interface\\. Amazon EC2 chooses the IPv6 addresses from the range of your subnet\\. You cannot specify this option and the option to assign specific IPv6 addresses in the same request\\. You can specify this option if you've specified a minimum number of instances to launch\\. \nYou cannot specify this option and the network interfaces option in the same request\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Ipv6Addresses": "\\[EC2\\-VPC\\] The IPv6 addresses from the range of the subnet to associate with the primary network interface\\. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request\\. You cannot specify this option if you've specified a minimum number of instances to launch\\. \nYou cannot specify this option and the network interfaces option in the same request\\. \n*Required*: No \n*Type*: List of [InstanceIpv6Address](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-instanceipv6address.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KernelId": "The ID of the kernel\\. \nWe recommend that you use PV\\-GRUB instead of kernels and RAM disks\\. For more information, see [PV\\-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", @@ -7482,7 +8419,7 @@ "InstanceInitiatedShutdownBehavior": "Indicates whether an instance stops or terminates when you initiate shutdown from the instance \\(using the operating system command for system shutdown\\)\\. \nDefault: `stop` \n*Required*: No \n*Type*: String \n*Allowed values*: `stop | terminate` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InstanceMarketOptions": "The market \\(purchasing\\) option for the instances\\. \n*Required*: No \n*Type*: [InstanceMarketOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancemarketoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InstanceRequirements": "The attributes for the instance types\\. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes\\. \nIf you specify `InstanceRequirements`, you can't specify `InstanceType`\\. \n*Required*: No \n*Type*: [InstanceRequirements](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-instancerequirements.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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*\\. \nIf you specify `InstanceType`, you can't specify `InstanceRequirements`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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*\\. \nIf you specify `InstanceType`, you can't specify `InstanceRequirements`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KernelId": "The ID of the kernel\\. \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*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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)\\. \nIf 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\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LicenseSpecifications": "The license configurations\\. \n*Required*: No \n*Type*: List of [LicenseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-licensespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -7503,7 +8440,7 @@ "Type": "The type of elastic inference accelerator\\. The possible values are eia1\\.medium, eia1\\.large, and eia1\\.xlarge\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EC2::LaunchTemplate LaunchTemplateTagSpecification": { - "ResourceType": "The type of resource\\. To tag the launch template, `ResourceType` must be `launch-template`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceType": "The type of resource\\. To tag the launch template, `ResourceType` must be `launch-template`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags for the resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EC2::LaunchTemplate LicenseSpecification": { @@ -7587,7 +8524,7 @@ "ValidUntil": "The end date of the request, in UTC format \\(*YYYY\\-MM\\-DD*T*HH:MM:SS*Z\\)\\. Supported only for persistent requests\\. \n+ For a persistent request, the request remains active until the `ValidUntil` date and time is reached\\. Otherwise, the request remains active until you cancel it\\.\n+ For a one\\-time request, `ValidUntil` is not supported\\. The request remains active until all instances launch or you cancel the request\\.\nDefault: 7 days from the current date \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EC2::LaunchTemplate TagSpecification": { - "ResourceType": "The type of resource to tag\\. \nThe `Valid Values` are all the resource types that can be tagged\\. However, when creating a launch template, you can specify tags for the following resource types only: `instance` \\| `volume` \\| `elastic-gpu` \\| `network-interface` \\| `spot-instances-request` \nTo tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceType": "The type of resource to tag\\. \nThe `Valid Values` are all the resource types that can be tagged\\. However, when creating a launch template, you can specify tags for the following resource types only: `instance` \\| `volume` \\| `elastic-gpu` \\| `network-interface` \\| `spot-instances-request` \nTo tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags to apply to the resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EC2::LaunchTemplate TotalLocalStorageGB": { @@ -7612,11 +8549,11 @@ "AWS::EC2::NatGateway": { "AllocationId": "\\[Public NAT gateway only\\] The allocation ID of the Elastic IP address that's associated with the NAT gateway\\. This property is required for a public NAT gateway and cannot be specified with a private NAT gateway\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ConnectivityType": "Indicates whether the NAT gateway supports public or private connectivity\\. The default is public connectivity\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `private | public` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MaxDrainDurationSeconds": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxDrainDurationSeconds": "The maximum amount of time to wait \\(in seconds\\) before forcibly releasing the IP addresses if connections are still in progress\\. Default value is 350 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `4000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PrivateIpAddress": "The private IPv4 address to assign to the NAT gateway\\. If you don't provide an address, a private IPv4 address will be automatically assigned\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SecondaryAllocationIds": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecondaryPrivateIpAddressCount": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecondaryPrivateIpAddresses": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecondaryAllocationIds": "Secondary EIP allocation IDs\\. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecondaryPrivateIpAddressCount": "\\[Private NAT gateway only\\] The number of secondary private IPv4 addresses you want to assign to the NAT gateway\\. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*\\. \n`SecondaryPrivateIpAddressCount` and `SecondaryPrivateIpAddresses` cannot be set at the same time\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `7` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecondaryPrivateIpAddresses": "Secondary private IPv4 addresses\\. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*\\. \n`SecondaryPrivateIpAddressCount` and `SecondaryPrivateIpAddresses` cannot be set at the same time\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SubnetId": "The ID of the subnet in which the NAT gateway is located\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The tags for the NAT gateway\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -7685,7 +8622,9 @@ }, "AWS::EC2::NetworkInsightsAnalysis AdditionalDetail": { "AdditionalDetailType": "The information type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Component": "The path component\\. \n*Required*: No \n*Type*: [AnalysisComponent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Component": "The path component\\. \n*Required*: No \n*Type*: [AnalysisComponent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LoadBalancers": "Property description not available\\. \n*Required*: No \n*Type*: List of [AnalysisComponent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServiceName": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EC2::NetworkInsightsAnalysis AlternatePathHint": { "ComponentArn": "The Amazon Resource Name \\(ARN\\) of the component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -7806,6 +8745,7 @@ "RouteTableRoute": "The route table route\\. \n*Required*: No \n*Type*: [AnalysisRouteTableRoute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysisroutetableroute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityGroupRule": "The security group rule\\. \n*Required*: No \n*Type*: [AnalysisSecurityGroupRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysissecuritygrouprule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SequenceNumber": "The sequence number\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServiceName": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourceVpc": "The source VPC\\. \n*Required*: No \n*Type*: [AnalysisComponent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Subnet": "The subnet\\. \n*Required*: No \n*Type*: [AnalysisComponent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TransitGateway": "The transit gateway\\. \n*Required*: No \n*Type*: [AnalysisComponent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -7826,7 +8766,7 @@ "State": "The state of the route\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EC2::NetworkInsightsPath": { - "Destination": "The AWS resource that is the destination of the path\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Destination": "The AWS resource that is the destination of the path\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DestinationIp": "The IP address of the AWS resource that is the destination of the path\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `15` \n*Pattern*: `^([0-9]{1,3}.){3}[0-9]{1,3}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DestinationPort": "The destination port\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `65535` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Protocol": "The protocol\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `tcp | udp` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -7913,7 +8853,7 @@ "SecurityGroupEgress": "\\[VPC only\\] The outbound rules associated with the security group\\. There is a short interruption during which you cannot connect to the security group\\. \n*Required*: No \n*Type*: List of [Egress](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "SecurityGroupIngress": "The inbound rules associated with the security group\\. There is a short interruption during which you cannot connect to the security group\\. \n*Required*: No \n*Type*: List of [Ingress](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group-rule-1.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "Tags": "Any tags assigned to the security group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VpcId": "\\[VPC only\\] The ID of the VPC for the security group\\. Your default VPC ID will be used if you do not define the VpcId here\\. Furthermore\\, VpcId is required if you specify SecurityGroupEgress rules\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "VpcId": "\\[VPC only\\] The ID of the VPC for the security group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EC2::SecurityGroup Egress": { "CidrIp": "The IPv4 address range, in CIDR format\\. \nYou must specify a destination security group \\(`DestinationPrefixListId` or `DestinationSecurityGroupId`\\) or a CIDR range \\(`CidrIp` or `CidrIpv6`\\)\\. \nFor examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -8056,7 +8996,7 @@ "AWS::EC2::SpotFleet LaunchTemplateOverrides": { "AvailabilityZone": "The Availability Zone in which to launch the instances\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InstanceRequirements": "The instance requirements\\. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On\\-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types\\. \nIf you specify `InstanceRequirements`, you can't specify `InstanceType`\\.\n*Required*: No \n*Type*: [InstanceRequirementsRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "InstanceType": "The instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InstanceType": "The instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Priority": "The priority for the launch template override\\. The highest priority is launched first\\. \nIf `OnDemandAllocationStrategy` is set to `prioritized`, Spot Fleet uses priority to determine which launch template override to use first in fulfilling On\\-Demand capacity\\. \nIf the Spot `AllocationStrategy` is set to `capacityOptimizedPrioritized`, Spot Fleet uses priority on a best\\-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first\\. \nValid values are whole numbers starting at `0`\\. The lower the number, the higher the priority\\. If no number is set, the launch template override has the lowest priority\\. You can set the same priority for different launch template overrides\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SpotPrice": "The maximum price per unit hour that you are willing to pay for a Spot Instance\\. We do not recommend using this parameter because it can lead to increased interruptions\\. If you do not specify this parameter, you will pay the current Spot price\\. \nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SubnetId": "The ID of the subnet in which to launch the instances\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -8096,7 +9036,7 @@ "IamInstanceProfile": "The IAM instance profile\\. \n*Required*: No \n*Type*: [IamInstanceProfileSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-iaminstanceprofilespecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ImageId": "The ID of the AMI\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InstanceRequirements": "The attributes for the instance types\\. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes\\. \nIf you specify `InstanceRequirements`, you can't specify `InstanceType`\\.\n*Required*: No \n*Type*: [InstanceRequirementsRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-instancerequirementsrequest.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "InstanceType": "The instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InstanceType": "The instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KernelId": "The ID of the kernel\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KeyName": "The name of the key pair\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Monitoring": "Enable or disable monitoring for the instances\\. \n*Required*: No \n*Type*: [SpotFleetMonitoring](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleetmonitoring.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -8107,7 +9047,7 @@ "SpotPrice": "The maximum price per unit hour that you are willing to pay for a Spot Instance\\. We do not recommend using this parameter because it can lead to increased interruptions\\. If you do not specify this parameter, you will pay the current Spot price\\. \nIf you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SubnetId": "The IDs of the subnets in which to launch the instances\\. To specify multiple subnets, separate them using commas; for example, \"subnet\\-1234abcdeexample1, subnet\\-0987cdef6example2\"\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TagSpecifications": "The tags to apply during creation\\. \n*Required*: No \n*Type*: List of [SpotFleetTagSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-spotfleet-spotfleettagspecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "UserData": "The Base64\\-encoded user data that instances use when starting up\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "UserData": "The base64\\-encoded user data that instances use when starting up\\. User data is limited to 16 KB\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "WeightedCapacity": "The number of units provided by the specified instance type\\. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O\\. \nIf the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number\\. If this value is not specified, the default is 1\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EC2::SpotFleet SpotFleetMonitoring": { @@ -8139,7 +9079,7 @@ "ValidUntil": "The end date and time of the request, in UTC format \\(*YYYY*\\-*MM*\\-*DD*T*HH*:*MM*:*SS*Z\\)\\. After the end date and time, no new Spot Instance requests are placed or able to fulfill the request\\. If no value is specified, the Spot Fleet request remains until you cancel it\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EC2::SpotFleet SpotFleetTagSpecification": { - "ResourceType": "The type of resource\\. Currently, the only resource type that is supported is `instance`\\. To tag the Spot Fleet request on creation, use the `TagSpecifications` parameter in ` [SpotFleetRequestConfigData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html) `\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ResourceType": "The type of resource\\. Currently, the only resource type that is supported is `instance`\\. To tag the Spot Fleet request on creation, use the `TagSpecifications` parameter in ` [SpotFleetRequestConfigData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html) `\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The tags\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EC2::SpotFleet SpotMaintenanceStrategies": { @@ -8437,7 +9377,7 @@ "SnapshotId": "The snapshot from which to create the volume\\. You must specify either a snapshot ID or a volume size\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: Updates are not supported\\.", "Tags": "The tags to apply to the volume during creation\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Throughput": "The throughput to provision for a volume, with a maximum of 1,000 MiB/s\\. \nThis parameter is valid only for `gp3` volumes\\. The default value is 125\\. \nValid Range: Minimum value of 125\\. Maximum value of 1000\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VolumeType": "The volume type\\. This parameter can be one of the following values: \n+ General Purpose SSD: `gp2` \\| `gp3` \n+ Provisioned IOPS SSD: `io1` \\| `io2` \n+ Throughput Optimized HDD: `st1` \n+ Cold HDD: `sc1` \n+ Magnetic: `standard` \nThroughput Optimized HDD \\(`st1`\\) and Cold HDD \\(`sc1`\\) volumes can't be used as boot volumes\\.\nFor more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*\\. \nDefault: `gp2` \n*Required*: No \n*Type*: String \n*Allowed values*: `gp2 | gp3 | io1 | io2 | sc1 | st1 | standard` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "VolumeType": "The volume type\\. This parameter can be one of the following values: \n+ General Purpose SSD: `gp2` \\| `gp3` \n+ Provisioned IOPS SSD: `io1` \\| `io2` \n+ Throughput Optimized HDD: `st1` \n+ Cold HDD: `sc1` \n+ Magnetic: `standard` \nFor more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*\\. \nDefault: `gp2` \n*Required*: No \n*Type*: String \n*Allowed values*: `gp2 | gp3 | io1 | io2 | sc1 | st1 | standard` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EC2::VolumeAttachment": { "Device": "The device name \\(for example, `/dev/sdh` or `xvdh`\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -8445,11 +9385,18 @@ "VolumeId": "The ID of the Amazon EBS volume\\. The volume and instance must be within the same Availability Zone\\. This value can be a reference to an [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html) resource, or it can be the volume ID of an existing Amazon EBS volume\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECR::PublicRepository": { - "RepositoryCatalogData": "The details about the repository that are publicly visible in the Amazon ECR Public Gallery\\. For more information, see [Amazon ECR Public repository catalog data](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html) in the *Amazon ECR Public User Guide*\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RepositoryCatalogData": "The details about the repository that are publicly visible in the Amazon ECR Public Gallery\\. For more information, see [Amazon ECR Public repository catalog data](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html) in the *Amazon ECR Public User Guide*\\. \n*Required*: No \n*Type*: [RepositoryCatalogData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-publicrepository-repositorycatalogdata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RepositoryName": "The name to use for the public repository\\. The repository name may be specified on its own \\(such as `nginx-web-app`\\) or it can be prepended with a namespace to group the repository into a category \\(such as `project-a/nginx-web-app`\\)\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the repository name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RepositoryPolicyText": "The JSON repository policy text to apply to the public repository\\. For more information, see [Amazon ECR Public repository policies](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policies.html) in the *Amazon ECR Public User Guide*\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::ECR::PublicRepository RepositoryCatalogData": { + "AboutText": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Architectures": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OperatingSystems": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RepositoryDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UsageText": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::ECR::PullThroughCacheRule": { "EcrRepositoryPrefix": "The Amazon ECR repository prefix associated with the pull through cache rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `2` \n*Maximum*: `20` \n*Pattern*: `[a-z0-9]+(?:[._-][a-z0-9]+)*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "UpstreamRegistryUrl": "The upstream registry URL associated with the pull through cache rule\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" @@ -8493,7 +9440,7 @@ }, "AWS::ECR::Repository LifecyclePolicy": { "LifecyclePolicyText": "The JSON repository policy text to apply to the repository\\. \n*Required*: No \n*Type*: String \n*Minimum*: `100` \n*Maximum*: `30720` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RegistryId": "The AWS account ID associated with the registry that contains the repository\\. If you do not specify a registry, the default registry is assumed\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[0-9]{12}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "RegistryId": "The AWS account ID associated with the registry that contains the repository\\. If you do\u2028 not specify a registry, the default registry is assumed\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[0-9]{12}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::CapacityProvider": { "AutoScalingGroupProvider": "The Auto Scaling group settings for the capacity provider\\. \n*Required*: Yes \n*Type*: [AutoScalingGroupProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-autoscalinggroupprovider.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -8501,23 +9448,24 @@ "Tags": "The metadata that you apply to the capacity provider to help you categorize and organize it\\. Each tag consists of a key and an optional value\\. You define both\\. \nThe following basic restrictions apply to tags: \n+ Maximum number of tags per resource \\- 50\n+ For each resource, each tag key must be unique, and each tag key can have only one value\\.\n+ Maximum key length \\- 128 Unicode characters in UTF\\-8\n+ Maximum value length \\- 256 Unicode characters in UTF\\-8\n+ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters\\. Generally allowed characters are: letters, numbers, and spaces representable in UTF\\-8, and the following characters: \\+ \\- = \\. \\_ : / @\\.\n+ Tag keys and values are case\\-sensitive\\.\n+ Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use\\. You cannot edit or delete tag keys or values with this prefix\\. Tags with this prefix do not count against your tags per resource limit\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::CapacityProvider AutoScalingGroupProvider": { - "AutoScalingGroupArn": "The Amazon Resource Name \\(ARN\\) or short name that identifies the Auto Scaling group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AutoScalingGroupArn": "The Amazon Resource Name \\(ARN\\) that identifies the Auto Scaling group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ManagedScaling": "The managed scaling settings for the Auto Scaling group capacity provider\\. \n*Required*: No \n*Type*: [ManagedScaling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-managedscaling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ManagedTerminationProtection": "The managed termination protection setting to use for the Auto Scaling group capacity provider\\. This determines whether the Auto Scaling group has managed termination protection\\. The default is disabled\\. \nWhen using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work\\.\nWhen managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale\\-in action\\. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale\\-in actions enabled as well\\. For more information, see [Instance Protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) in the * AWS Auto Scaling User Guide*\\. \nWhen managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ManagedTerminationProtection": "The managed termination protection setting to use for the Auto Scaling group capacity provider\\. This determines whether the Auto Scaling group has managed termination protection\\. The default is off\\. \nWhen using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work\\.\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale\\-in action\\. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale\\-in actions enabled as well\\. For more information, see [Instance Protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) in the * AWS Auto Scaling User Guide*\\. \nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::CapacityProvider ManagedScaling": { "InstanceWarmupPeriod": "The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group\\. If this parameter is omitted, the default value of `300` seconds is used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaximumScalingStepSize": "The maximum number of container instances that Amazon ECS scales in or scales out at one time\\. If this parameter is omitted, the default value of `10000` is used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MinimumScalingStepSize": "The minimum number of container instances that Amazon ECS scales in or scales out at one time\\. If this parameter is omitted, the default value of `1` is used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumScalingStepSize": "The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time\\. The scale in process is not affected by this parameter\\. If this parameter is omitted, the default value of `1` is used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MinimumScalingStepSize": "The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time\\. The scale in process is not affected by this parameter If this parameter is omitted, the default value of `1` is used\\. \nWhen additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size\\. \nIf you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Status": "Determines whether to use managed scaling for the capacity provider\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TargetCapacity": "The target capacity value for the capacity provider\\. The specified value must be greater than `0` and less than or equal to `100`\\. A value of `100` results in the Amazon EC2 instances in your Auto Scaling group being completely used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::Cluster": { - "CapacityProviders": "The short name of one or more capacity providers to associate with the cluster\\. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy\\. \nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster\\. \nTo use an AWS Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers\\. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CapacityProviders": "The short name of one or more capacity providers to associate with the cluster\\. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) actions\\. \nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster\\. New Auto Scaling group capacity providers can be created with the [CreateCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) API operation\\. \nTo use a AWS Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers\\. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used\\. \nThe [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available capacity providers for a cluster after the cluster is created\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClusterName": "A user\\-generated string that you use to identify your cluster\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ClusterSettings": "The setting to use when creating a cluster\\. This parameter is used to enable CloudWatch Container Insights for a cluster\\. If this value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html) of [ClusterSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClusterSettings": "The setting to use when creating a cluster\\. This parameter is used to use CloudWatch Container Insights for a cluster\\. If this value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html) of [ClusterSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Configuration": "The execute command configuration for the cluster\\. \n*Required*: No \n*Type*: [ClusterConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clusterconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DefaultCapacityProviderStrategy": "The default capacity provider strategy for the cluster\\. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used\\. \n*Required*: No \n*Type*: List of [CapacityProviderStrategyItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServiceConnectDefaults": "Use this parameter to set a default Service Connect namespace\\. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace\\. This setting only applies to new services that set the `enabled` parameter to `true` in the `ServiceConnectConfiguration`\\. You can set the namespace of each service individually in the `ServiceConnectConfiguration` to override this default parameter\\. \nTasks that run in a namespace can use short names to connect to services in the namespace\\. Tasks can connect to services across all of the clusters in the namespace\\. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility\\. Only the tasks that Amazon ECS services create are supported with Service Connect\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [ServiceConnectDefaults](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-serviceconnectdefaults.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The metadata that you apply to the cluster to help you categorize and organize them\\. Each tag consists of a key and an optional value\\. You define both\\. \nThe following basic restrictions apply to tags: \n+ Maximum number of tags per resource \\- 50\n+ For each resource, each tag key must be unique, and each tag key can have only one value\\.\n+ Maximum key length \\- 128 Unicode characters in UTF\\-8\n+ Maximum value length \\- 256 Unicode characters in UTF\\-8\n+ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters\\. Generally allowed characters are: letters, numbers, and spaces representable in UTF\\-8, and the following characters: \\+ \\- = \\. \\_ : / @\\.\n+ Tag keys and values are case\\-sensitive\\.\n+ Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use\\. You cannot edit or delete tag keys or values with this prefix\\. Tags with this prefix do not count against your tags per resource limit\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::Cluster CapacityProviderStrategyItem": { @@ -8530,7 +9478,7 @@ }, "AWS::ECS::Cluster ClusterSettings": { "Name": "The name of the cluster setting\\. The only supported value is `containerInsights`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `containerInsights` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Value": "The value to set for the cluster setting\\. The supported values are `enabled` and `disabled`\\. If `enabled` is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the `containerInsights` account setting is enabled\\. If a cluster value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Value": "The value to set for the cluster setting\\. The supported values are `enabled` and `disabled`\\. If `enabled` is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be off unless the `containerInsights` account setting is turned on\\. If a cluster value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::Cluster ExecuteCommandConfiguration": { "KmsKeyId": "Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -8538,12 +9486,15 @@ "Logging": "The log setting to use for redirecting logs for your execute command results\\. The following log settings are available\\. \n+ `NONE`: The execute command session is not logged\\.\n+ `DEFAULT`: The `awslogs` configuration in the task definition is used\\. If no logging parameter is specified, it defaults to this value\\. If no `awslogs` log driver is configured in the task definition, the output won't be logged\\.\n+ `OVERRIDE`: Specify the logging details as a part of `logConfiguration`\\. If the `OVERRIDE` logging option is specified, the `logConfiguration` is required\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `DEFAULT | NONE | OVERRIDE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::Cluster ExecuteCommandLogConfiguration": { - "CloudWatchEncryptionEnabled": "Determines whether to use encryption on the CloudWatch logs\\. If not specified, encryption will be disabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CloudWatchEncryptionEnabled": "Determines whether to use encryption on the CloudWatch logs\\. If not specified, encryption will be off\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CloudWatchLogGroupName": "The name of the CloudWatch log group to send logs to\\. \nThe CloudWatch log group must already be created\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3BucketName": "The name of the S3 bucket to send logs to\\. \nThe S3 bucket must already be created\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3EncryptionEnabled": "Determines whether to use encryption on the S3 logs\\. If not specified, encryption is not used\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3KeyPrefix": "An optional folder in the S3 bucket to place logs in\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::ECS::Cluster ServiceConnectDefaults": { + "Namespace": "The namespace name or full Amazon Resource Name \\(ARN\\) of the AWS Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration\\. The namespace name can include up to 1024 characters\\. The name is case\\-sensitive\\. The name can't include hyphens \\(\\-\\), tilde \\(\\~\\), greater than \\(>\\), less than \\(<\\), or slash \\(/\\)\\. \nIf you enter an existing namespace name or ARN, then that namespace will be used\\. Any namespace type is supported\\. The namespace must be in this account and this AWS Region\\. \nIf you enter a new name, a AWS Cloud Map namespace will be created\\. Amazon ECS creates a AWS Cloud Map namespace with the \"API calls\" method of instance discovery only\\. This instance discovery method is the \"HTTP\" namespace type in the AWS Command Line Interface\\. Other types of instance discovery aren't used by Service Connect\\. \nIf you update the service with an empty string `\"\"` for the namespace name, the cluster configuration for Service Connect is removed\\. Note that the namespace will remain in AWS Cloud Map and must be deleted separately\\. \nFor more information about AWS Cloud Map, see [Working with Services](https://docs.aws.amazon.com/) in the * AWS Cloud Map Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::ECS::ClusterCapacityProviderAssociations": { "CapacityProviders": "The capacity providers to associate with the cluster\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Cluster": "The cluster the capacity provider association is the target of\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -8565,22 +9516,23 @@ "DeploymentConfiguration": "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks\\. \n*Required*: No \n*Type*: [DeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DeploymentController": "The deployment controller to use for the service\\. If no deployment controller is specified, the default value of `ECS` is used\\. \n*Required*: No \n*Type*: [DeploymentController](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcontroller.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DesiredCount": "The number of instantiations of the specified task definition to place and keep running on your cluster\\. \nFor new services, if a desired count is not specified, a default value of `1` is used\\. When using the `DAEMON` scheduling strategy, the desired count is not required\\. \nFor existing services, if a desired count is not specified, it is omitted from the operation\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EnableECSManagedTags": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service\\. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableECSManagedTags": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service\\. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnableExecuteCommand": "Determines whether the execute command functionality is enabled for the service\\. If `true`, the execute command functionality is enabled for all containers in tasks as part of the service\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "HealthCheckGracePeriodSeconds": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started\\. This is only used when your service is configured to use a load balancer\\. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of `0` is used\\. \nIf you do not use an Elastic Load Balancing, we recomend that you use the `startPeriod` in the task definition healtch check parameters\\. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html)\\. \nIf your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds \\(about 69 years\\)\\. During that time, the Amazon ECS service scheduler ignores health check status\\. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HealthCheckGracePeriodSeconds": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started\\. This is only used when your service is configured to use a load balancer\\. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of `0` is used\\. \nIf you do not use an Elastic Load Balancing, we recommend that you use the `startPeriod` in the task definition health check parameters\\. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html)\\. \nIf your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds \\(about 69 years\\)\\. During that time, the Amazon ECS service scheduler ignores health check status\\. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LaunchType": "The launch type on which to run your service\\. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EC2 | EXTERNAL | FARGATE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "LoadBalancers": "A list of load balancer objects to associate with the service\\. If you specify the `Role` property, `LoadBalancers` must be specified as well\\. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [LoadBalancer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-loadbalancer.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NetworkConfiguration": "The network configuration for the service\\. This parameter is required for task definitions that use the `awsvpc` network mode to receive their own elastic network interface, and it is not supported for other network modes\\. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: Conditional \n*Type*: [NetworkConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-networkconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PlacementConstraints": "An array of placement constraint objects to use for tasks in your service\\. You can specify a maximum of 10 constraints for each task\\. This limit includes constraints in the task definition and those specified at runtime\\. \n*Required*: No \n*Type*: List of [PlacementConstraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PlacementStrategies": "The placement strategy objects to use for tasks in your service\\. You can specify a maximum of five strategy rules per service\\. For more information, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [PlacementStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PlacementConstraints": "An array of placement constraint objects to use for tasks in your service\\. You can specify a maximum of 10 constraints for each task\\. This limit includes constraints in the task definition and those specified at runtime\\. \n*Required*: No \n*Type*: List of [PlacementConstraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PlacementStrategies": "The placement strategy objects to use for tasks in your service\\. You can specify a maximum of five strategy rules per service\\. For more information, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [PlacementStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PlatformVersion": "The platform version that your tasks in the service are running on\\. A platform version is specified only for tasks using the Fargate launch type\\. If one isn't specified, the `LATEST` platform version is used\\. For more information, see [AWS Fargate platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PropagateTags": "Specifies whether to propagate the tags from the task definition or the service to the tasks in the service\\. If no value is specified, the tags are not propagated\\. Tags can only be propagated to the tasks within the service during service creation\\. To add tags to a task after service creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | SERVICE | TASK_DEFINITION` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Role": "The name or full Amazon Resource Name \\(ARN\\) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf\\. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the `awsvpc` network mode\\. If you specify the `role` parameter, you must also specify a load balancer object with the `loadBalancers` parameter\\. \nIf your account has already created the Amazon ECS service\\-linked role, that role is used for your service unless you specify a role here\\. The service\\-linked role is required if your task definition uses the `awsvpc` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here\\. For more information, see [Using service\\-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*\\.\nIf your specified role has a path other than `/`, then you must either specify the full role ARN \\(this is 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*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SchedulingStrategy": "The scheduling strategy to use for the service\\. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html)\\. \nThere are two service scheduler strategies available: \n+ `REPLICA`\\-The replica scheduling strategy places and maintains the desired number of tasks across your cluster\\. By default, the service scheduler spreads tasks across Availability Zones\\. You can use task placement strategies and constraints to customize task placement decisions\\. This scheduler strategy is required if the service uses the `CODE_DEPLOY` or `EXTERNAL` deployment controller types\\.\n+ `DAEMON`\\-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster\\. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints\\. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies\\.\n**Note** \nTasks using the Fargate launch type or the `CODE_DEPLOY` or `EXTERNAL` deployment controller types don't support the `DAEMON` scheduling strategy\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `DAEMON | REPLICA` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ServiceConnectConfiguration": "The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace\\. \nTasks that run in a namespace can use short names to connect to services in the namespace\\. Tasks can connect to services across all of the clusters in the namespace\\. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility\\. Only the tasks that Amazon ECS services create are supported with Service Connect\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [ServiceConnectConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceName": "The name of your service\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, underscores, and hyphens are allowed\\. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ServiceRegistries": "The details of the service discovery registry to associate with this service\\. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html)\\. \nEach service may be associated with one service registry\\. Multiple service registries for each service isn't supported\\.\n*Required*: No \n*Type*: List of [ServiceRegistry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceregistry.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The metadata that you apply to the service to help you categorize and organize them\\. Each tag consists of a key and an optional value, both of which you define\\. When a service is deleted, the tags are deleted as well\\. \nThe following basic restrictions apply to tags: \n+ Maximum number of tags per resource \\- 50\n+ For each resource, each tag key must be unique, and each tag key can have only one value\\.\n+ Maximum key length \\- 128 Unicode characters in UTF\\-8\n+ Maximum value length \\- 256 Unicode characters in UTF\\-8\n+ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters\\. Generally allowed characters are: letters, numbers, and spaces representable in UTF\\-8, and the following characters: \\+ \\- = \\. \\_ : / @\\.\n+ Tag keys and values are case\\-sensitive\\.\n+ Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use\\. You cannot edit or delete tag keys or values with this prefix\\. Tags with this prefix do not count against your tags per resource limit\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TaskDefinition": "The `family` and `revision` \\(`family:revision`\\) or full ARN of the task definition to run in your service\\. The `revision` is required in order for the resource to stabilize\\. \nA task definition must be specified if the service is using either the `ECS` or `CODE_DEPLOY` deployment controllers\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TaskDefinition": "The `family` and `revision` \\(`family:revision`\\) or full ARN of the task definition to run in your service\\. The `revision` is required in order for the resource to stabilize\\. \nA task definition must be specified if the service is using either the `ECS` or `CODE_DEPLOY` deployment controllers\\. \nFor more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::Service AwsVpcConfiguration": { "AssignPublicIp": "Whether the task's elastic network interface receives a public IP address\\. The default value is `DISABLED`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -8592,14 +9544,20 @@ "CapacityProvider": "The short name of the capacity provider\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Weight": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider\\. The `weight` value is taken into consideration after the `base` value, if defined, is satisfied\\. \nIf no `weight` value is specified, the default value of `0` is used\\. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of `0` can't be used to place tasks\\. If you specify multiple capacity providers in a strategy that all have a weight of `0`, any `RunTask` or `CreateService` actions using the capacity provider strategy will fail\\. \nAn example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of `1`, then when the `base` is satisfied, the tasks will be split evenly across the two capacity providers\\. Using that same logic, if you specify a weight of `1` for *capacityProviderA* and a weight of `4` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::ECS::Service DeploymentAlarms": { + "AlarmNames": "One or more CloudWatch alarm names\\. Use a \",\" to separate the alarms\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Enable": "Determines whether to use the CloudWatch alarm option in the service deployment process\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Rollback": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails\\. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::ECS::Service DeploymentCircuitBreaker": { "Enable": "Determines whether to use the deployment circuit breaker logic for the service\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Rollback": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails\\. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Rollback": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails\\. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::Service DeploymentConfiguration": { - "DeploymentCircuitBreaker": "The deployment circuit breaker can only be used for services using the rolling update \\(`ECS`\\) deployment type that are not behind a Classic Load Balancer\\.\nThe **deployment circuit breaker** determines whether a service deployment will fail if the service can't reach a steady state\\. If enabled, a service deployment will transition to a failed state and stop launching new tasks\\. You can also enable Amazon ECS to roll back your service to the last completed deployment after a failure\\. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [DeploymentCircuitBreaker](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaximumPercent": "If a service is using the rolling update \\(`ECS`\\) deployment type, the **maximum percent** parameter represents an upper limit on the number of tasks in a service that are allowed in the `RUNNING` or `PENDING` state during a deployment, as a percentage of the desired number of tasks \\(rounded down to the nearest integer\\), and while any container instances are in the `DRAINING` state if the service contains tasks using the EC2 launch type\\. This parameter enables you to define the deployment batch size\\. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks \\(provided that the cluster resources required to do this are available\\)\\. The default value for maximum percent is 200%\\. \nIf a service is using the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and tasks that use the EC2 launch type, the **maximum percent** value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state\\. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MinimumHealthyPercent": "If a service is using the rolling update \\(`ECS`\\) deployment type, the **minimum healthy percent** represents a lower limit on the number of tasks in a service that must remain in the `RUNNING` state during a deployment, as a percentage of the desired number of tasks \\(rounded up to the nearest integer\\), and while any container instances are in the `DRAINING` state if the service contains tasks using the EC2 launch type\\. This parameter enables you to deploy without using additional cluster capacity\\. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks\\. Tasks for services that *do not* use a load balancer are considered healthy if they're in the `RUNNING` state; tasks for services that *do* use a load balancer are considered healthy if they're in the `RUNNING` state and they're reported as healthy by the load balancer\\. The default value for minimum healthy percent is 100%\\. \nIf a service is using the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and tasks that use the EC2 launch type, the **minimum healthy percent** value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state\\. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Alarms": "Information about the CloudWatch alarms\\. \n*Required*: No \n*Type*: [DeploymentAlarms](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentalarms.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeploymentCircuitBreaker": "The deployment circuit breaker can only be used for services using the rolling update \\(`ECS`\\) deployment type\\.\nThe **deployment circuit breaker** determines whether a service deployment will fail if the service can't reach a steady state\\. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks\\. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully\\. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide* \n*Required*: No \n*Type*: [DeploymentCircuitBreaker](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumPercent": "If a service is using the rolling update \\(`ECS`\\) deployment type, the `maximumPercent` parameter represents an upper limit on the number of your service's tasks that are allowed in the `RUNNING` or `PENDING` state during a deployment, as a percentage of the `desiredCount` \\(rounded down to the nearest integer\\)\\. This parameter enables you to define the deployment batch size\\. For example, if your service is using the `REPLICA` service scheduler and has a `desiredCount` of four tasks and a `maximumPercent` value of 200%, the scheduler may start four new tasks before stopping the four older tasks \\(provided that the cluster resources required to do this are available\\)\\. The default `maximumPercent` value for a service using the `REPLICA` service scheduler is 200%\\. \nIf a service is using either the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and tasks that use the EC2 launch type, the **maximum percent** value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state\\. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MinimumHealthyPercent": "If a service is using the rolling update \\(`ECS`\\) deployment type, the `minimumHealthyPercent` represents a lower limit on the number of your service's tasks that must remain in the `RUNNING` state during a deployment, as a percentage of the `desiredCount` \\(rounded up to the nearest integer\\)\\. This parameter enables you to deploy without using additional cluster capacity\\. For example, if your service has a `desiredCount` of four tasks and a `minimumHealthyPercent` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks\\. \nFor services that *do not* use a load balancer, the following should be noted: \n+ A service is considered healthy if all essential containers within the tasks in the service pass their health checks\\.\n+ If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a `RUNNING` state before the task is counted towards the minimum healthy percent total\\.\n+ If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total\\. A task is considered healthy when all essential containers within the task have passed their health checks\\. The amount of time the service scheduler can wait for is determined by the container health check settings\\. \nFor services are that *do* use a load balancer, the following should be noted: \n+ If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total\\.\n+ If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total\\.\nIf a service is using either the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and is running tasks that use the EC2 launch type, the **minimum healthy percent** value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state\\. If a service is using either the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::Service DeploymentController": { "Type": "The deployment controller type to use\\. There are three deployment controller types available: \nECS \nThe rolling update \\(`ECS`\\) deployment type involves replacing the current running version of the container with the latest version\\. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the [DeploymentConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeploymentConfiguration.html)\\. \nCODE\\_DEPLOY \nThe blue/green \\(`CODE_DEPLOY`\\) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it\\. \nEXTERNAL \nThe external \\(`EXTERNAL`\\) deployment type enables you to use any third\\-party deployment controller for full control over the deployment process for an Amazon ECS service\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `CODE_DEPLOY | ECS | EXTERNAL` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" @@ -8608,18 +9566,43 @@ "ContainerName": "The name of the container \\(as it appears in a container definition\\) to associate with the load balancer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ContainerPort": "The port on the container to associate with the load balancer\\. This port must correspond to a `containerPort` in the task definition the tasks in the service are using\\. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the `hostPort` of the port mapping\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LoadBalancerName": "The name of the load balancer to associate with the Amazon ECS service or task set\\. \nA load balancer name is only specified when using a Classic Load Balancer\\. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TargetGroupArn": "The full Amazon Resource Name \\(ARN\\) of the Elastic Load Balancing target group or groups associated with a service or task set\\. \nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer\\. If you're using a Classic Load Balancer, omit the target group ARN\\. \nFor services using the `ECS` deployment controller, you can specify one or multiple target groups\\. For more information, see [Registering Multiple Target Groups with a Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer\\. For more information, see [Blue/Green Deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance`\\. Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance\\. This network mode is required for the Fargate launch type\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TargetGroupArn": "The full Amazon Resource Name \\(ARN\\) of the Elastic Load Balancing target group or groups associated with a service or task set\\. \nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer\\. If you're using a Classic Load Balancer, omit the target group ARN\\. \nFor services using the `ECS` deployment controller, you can specify one or multiple target groups\\. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer\\. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance`\\. Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance\\. This network mode is required for the Fargate launch type\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ECS::Service LogConfiguration": { + "LogDriver": "The log driver to use for the container\\. \nFor tasks on AWS Fargate, the supported log drivers are `awslogs`, `splunk`, and `awsfirelens`\\. \nFor tasks hosted on Amazon EC2 instances, the supported log drivers are `awslogs`, `fluentd`, `gelf`, `json-file`, `journald`, `logentries`,`syslog`, `splunk`, and `awsfirelens`\\. \nFor more information about using the `awslogs` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor more information about using the `awsfirelens` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver\\. We encourage you to submit pull requests for changes that you would like to have included\\. However, we don't currently provide support for running modified copies of this software\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `awsfirelens | awslogs | fluentd | gelf | journald | json-file | splunk | syslog` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Options": "The configuration options to send to the log driver\\. This parameter requires version 1\\.19 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretOptions": "The secrets to pass to the log configuration\\. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [Secret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-secret.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::Service NetworkConfiguration": { "AwsvpcConfiguration": "The VPC subnets and security groups that are associated with a task\\. \nAll specified subnets and security groups must be from the same VPC\\.\n*Required*: No \n*Type*: [AwsVpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-awsvpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::Service PlacementConstraint": { - "Expression": "A cluster query language expression to apply to the constraint\\. The expression can have a maximum length of 2000 characters\\. You can't specify an expression if the constraint type is `distinctInstance`\\. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Type": "The type of constraint\\. Use `distinctInstance` to ensure that each task in a particular group is running on a different container instance\\. Use `memberOf` to restrict the selection to a group of valid candidates\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `distinctInstance | memberOf` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Expression": "A cluster query language expression to apply to the constraint\\. The expression can have a maximum length of 2000 characters\\. You can't specify an expression if the constraint type is `distinctInstance`\\. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of constraint\\. Use `distinctInstance` to ensure that each task in a particular group is running on a different container instance\\. Use `memberOf` to restrict the selection to a group of valid candidates\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `distinctInstance | memberOf` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::Service PlacementStrategy": { - "Field": "The field to apply the placement strategy against\\. For the `spread` placement strategy, valid values are `instanceId` \\(or `host`, which has the same effect\\), or any platform or custom attribute that's applied to a container instance, such as `attribute:ecs.availability-zone`\\. For the `binpack` placement strategy, valid values are `cpu` and `memory`\\. For the `random` placement strategy, this field is not used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Type": "The type of placement strategy\\. The `random` placement strategy randomly places tasks on available candidates\\. The `spread` placement strategy spreads placement across available candidates evenly based on the `field` parameter\\. The `binpack` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the `field` parameter\\. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `binpack | random | spread` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Field": "The field to apply the placement strategy against\\. For the `spread` placement strategy, valid values are `instanceId` \\(or `host`, which has the same effect\\), or any platform or custom attribute that is applied to a container instance, such as `attribute:ecs.availability-zone`\\. For the `binpack` placement strategy, valid values are `CPU` and `MEMORY`\\. For the `random` placement strategy, this field is not used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of placement strategy\\. The `random` placement strategy randomly places tasks on available candidates\\. The `spread` placement strategy spreads placement across available candidates evenly based on the `field` parameter\\. The `binpack` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the `field` parameter\\. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `binpack | random | spread` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ECS::Service Secret": { + "Name": "The name of the secret\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ValueFrom": "The secret to expose to the container\\. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store\\. \nFor information about the require AWS Identity and Access Management permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) \\(for Secrets Manager\\) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) \\(for Systems Manager Parameter store\\) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter\\. If the parameter exists in a different Region, then the full ARN must be specified\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ECS::Service ServiceConnectClientAlias": { + "DnsName": "The `dnsName` is the name that you use in the applications of client tasks to connect to this service\\. The name must be a valid DNS name but doesn't need to be fully\\-qualified\\. The name can include up to 127 characters\\. The name can include lowercase letters, numbers, underscores \\(\\_\\), hyphens \\(\\-\\), and periods \\(\\.\\)\\. The name can't start with a hyphen\\. \nIf this parameter isn't specified, the default value of `discoveryName.namespace` is used\\. If the `discoveryName` isn't specified, the port mapping name from the task definition is used in `portName.namespace`\\. \nTo avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default\\. For example, a few common names are `database`, `db`, or the lowercase name of a database, such as `mysql` or `redis`\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Port": "The listening port number for the Service Connect proxy\\. This port is available inside of all of the tasks within the same namespace\\. \nTo avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ECS::Service ServiceConnectConfiguration": { + "Enabled": "Specifies whether to use Service Connect with this service\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LogConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Namespace": "The namespace name or full Amazon Resource Name \\(ARN\\) of the AWS Cloud Map namespace for use with Service Connect\\. The namespace must be in the same AWS Region as the Amazon ECS service and cluster\\. The type of namespace doesn't affect Service Connect\\. For more information about AWS Cloud Map, see [Working with Services](https://docs.aws.amazon.com/) in the * AWS Cloud Map Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Services": "The list of Service Connect service objects\\. These are names and aliases \\(also known as endpoints\\) that are used by other Amazon ECS services to connect to this service\\. \nThis field is not required for a \"client\" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace\\. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means\\. \nAn object selects a port from the task definition, assigns a name for the AWS Cloud Map service, and a list of aliases \\(endpoints\\) and ports for client applications to refer to this service\\. \n*Required*: No \n*Type*: List of [ServiceConnectService](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ECS::Service ServiceConnectService": { + "ClientAliases": "The list of client aliases for this Service Connect service\\. You use these to assign names that can be used by client applications\\. The maximum number of client aliases that you can have in this list is 1\\. \nEach alias \\(\"endpoint\"\\) is a fully\\-qualified name and port number that other Amazon ECS tasks \\(\"clients\"\\) can use to connect to this service\\. \nEach name and port mapping must be unique within the namespace\\. \nFor each `ServiceConnectService`, you must provide at least one `clientAlias` with one `port`\\. \n*Required*: No \n*Type*: List of [ServiceConnectClientAlias](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DiscoveryName": "The `discoveryName` is the name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service\\. This must be unique within the AWS Cloud Map namespace\\. The name can contain up to 64 characters\\. The name can include lowercase letters, numbers, underscores \\(\\_\\), and hyphens \\(\\-\\)\\. The name can't start with a hyphen\\. \nIf this parameter isn't specified, the default value of `discoveryName.namespace` is used\\. If the `discoveryName` isn't specified, the port mapping name from the task definition is used in `portName.namespace`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IngressPortOverride": "The port number for the Service Connect proxy to listen on\\. \nUse the value of this field to bypass the proxy for traffic on the port number specified in the named `portMapping` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service\\. \nIn `awsvpc` mode and Fargate, the default value is the container port number\\. The container port number is in the `portMapping` in the task definition\\. In bridge mode, the default value is the ephemeral port of the Service Connect proxy\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PortName": "The `portName` must match the name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::Service ServiceRegistry": { "ContainerName": "The container name value to be used for your service discovery service\\. It's already specified in the task definition\\. If the task definition that your service task specifies uses the `bridge` or `host` network mode, you must specify a `containerName` and `containerPort` combination from the task definition\\. If the task definition that your service task specifies uses the `awsvpc` network mode and a type SRV DNS record is used, you must specify either a `containerName` and `containerPort` combination or a `port` value\\. However, you can't specify both\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -8628,55 +9611,55 @@ "RegistryArn": "The Amazon Resource Name \\(ARN\\) of the service registry\\. The currently supported service registry is AWS Cloud Map\\. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ECS::TaskDefinition": { - "ContainerDefinitions": "A list of container definitions in JSON format that describe the different containers that make up your task\\. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [ContainerDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Cpu": "The number of `cpu` units used by the task\\. If you use the EC2 launch type, this field is optional\\. Any value can be used\\. If you use the Fargate launch type, this field is required\\. You must use one of the following values\\. The value that you choose determines your range of valid values for the `memory` parameter\\. \nThe CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate\\. \n+ 256 \\(\\.25 vCPU\\) \\- Available `memory` values: 512 \\(0\\.5 GB\\), 1024 \\(1 GB\\), 2048 \\(2 GB\\)\n+ 512 \\(\\.5 vCPU\\) \\- Available `memory` values: 1024 \\(1 GB\\), 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\)\n+ 1024 \\(1 vCPU\\) \\- Available `memory` values: 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\), 5120 \\(5 GB\\), 6144 \\(6 GB\\), 7168 \\(7 GB\\), 8192 \\(8 GB\\)\n+ 2048 \\(2 vCPU\\) \\- Available `memory` values: Between 4096 \\(4 GB\\) and 16384 \\(16 GB\\) in increments of 1024 \\(1 GB\\)\n+ 4096 \\(4 vCPU\\) \\- Available `memory` values: Between 8192 \\(8 GB\\) and 30720 \\(30 GB\\) in increments of 1024 \\(1 GB\\)\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ContainerDefinitions": "A list of container definitions in JSON format that describe the different containers that make up your task\\. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [ContainerDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Cpu": "The number of `cpu` units used by the task\\. If you use the EC2 launch type, this field is optional\\. Any value can be used\\. If you use the Fargate launch type, this field is required\\. You must use one of the following values\\. The value that you choose determines your range of valid values for the `memory` parameter\\. \nThe CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate\\. \n+ 256 \\(\\.25 vCPU\\) \\- Available `memory` values: 512 \\(0\\.5 GB\\), 1024 \\(1 GB\\), 2048 \\(2 GB\\)\n+ 512 \\(\\.5 vCPU\\) \\- Available `memory` values: 1024 \\(1 GB\\), 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\)\n+ 1024 \\(1 vCPU\\) \\- Available `memory` values: 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\), 5120 \\(5 GB\\), 6144 \\(6 GB\\), 7168 \\(7 GB\\), 8192 \\(8 GB\\)\n+ 2048 \\(2 vCPU\\) \\- Available `memory` values: 4096 \\(4 GB\\) and 16384 \\(16 GB\\) in increments of 1024 \\(1 GB\\)\n+ 4096 \\(4 vCPU\\) \\- Available `memory` values: 8192 \\(8 GB\\) and 30720 \\(30 GB\\) in increments of 1024 \\(1 GB\\)\n+ 8192 \\(8 vCPU\\) \\- Available `memory` values: 16 GB and 60 GB in 4 GB increments", "EphemeralStorage": "The ephemeral storage settings to use for tasks run with the task definition\\. \n*Required*: No \n*Type*: [EphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-ephemeralstorage.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ExecutionRoleArn": "The Amazon Resource Name \\(ARN\\) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf\\. The task execution IAM role is required depending on the requirements of your task\\. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Family": "The name of a family that this task definition is registered to\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, hyphens, and underscores are allowed\\. \nA family groups multiple versions of a task definition\\. Amazon ECS gives the first task definition that you registered to a family a revision number of 1\\. Amazon ECS gives sequential revision numbers to each task definition that you add\\. \nTo use revision numbers when you update a task definition, specify this property\\. If you don't specify a value, AWS CloudFormation generates a new task definition each time that you update it\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InferenceAccelerators": "The Elastic Inference accelerators to use for the containers in the task\\. \n*Required*: No \n*Type*: List of [InferenceAccelerator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "IpcMode": "The IPC resource namespace to use for the containers in the task\\. The valid values are `host`, `task`, or `none`\\. If `host` is specified, then all containers within the tasks that specified the `host` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance\\. If `task` is specified, all containers within the specified task share the same IPC resources\\. If `none` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance\\. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance\\. For more information, see [IPC settings](https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*\\. \nIf the `host` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose\\. For more information, see [Docker security](https://docs.docker.com/engine/security/security/)\\. \nIf you are setting namespaced kernel parameters using `systemControls` for the containers in the task, the following will apply to your IPC resource namespace\\. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n+ For tasks that use the `host` IPC mode, IPC namespace related `systemControls` are not supported\\.\n+ For tasks that use the `task` IPC mode, IPC namespace related `systemControls` will apply to all containers within a task\\.\nThis parameter is not supported for Windows containers or tasks run on AWS Fargate\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `host | none | task` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Memory": "The amount \\(in MiB\\) of memory used by the task\\. \nIf your tasks runs on Amazon EC2 instances, you must specify either a task\\-level memory value or a container\\-level memory value\\. This field is optional and any value can be used\\. If a task\\-level memory value is specified, the container\\-level memory value is optional\\. For more information regarding container\\-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html)\\. \nIf your tasks runs on AWS Fargate, this field is required\\. You must use one of the following values\\. The value you choose determines your range of valid values for the `cpu` parameter\\. \n+ 512 \\(0\\.5 GB\\), 1024 \\(1 GB\\), 2048 \\(2 GB\\) \\- Available `cpu` values: 256 \\(\\.25 vCPU\\)\n+ 1024 \\(1 GB\\), 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\) \\- Available `cpu` values: 512 \\(\\.5 vCPU\\)\n+ 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\), 5120 \\(5 GB\\), 6144 \\(6 GB\\), 7168 \\(7 GB\\), 8192 \\(8 GB\\) \\- Available `cpu` values: 1024 \\(1 vCPU\\)\n+ Between 4096 \\(4 GB\\) and 16384 \\(16 GB\\) in increments of 1024 \\(1 GB\\) \\- Available `cpu` values: 2048 \\(2 vCPU\\)\n+ Between 8192 \\(8 GB\\) and 30720 \\(30 GB\\) in increments of 1024 \\(1 GB\\) \\- Available `cpu` values: 4096 \\(4 vCPU\\)\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "NetworkMode": "The Docker networking mode to use for the containers in the task\\. The valid values are `none`, `bridge`, `awsvpc`, and `host`\\. The default Docker network mode is `bridge`\\. If you are using the Fargate launch type, the `awsvpc` network mode is required\\. If you are using the EC2 launch type, any network mode can be used\\. If the network mode is set to `none`, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity\\. The `host` and `awsvpc` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the `bridge` mode\\. \nWith the `host` and `awsvpc` network modes, exposed container ports are mapped directly to the corresponding host port \\(for the `host` network mode\\) or the attached elastic network interface port \\(for the `awsvpc` network mode\\), so you cannot take advantage of dynamic host port mappings\\. \nIf the network mode is `awsvpc`, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) value when you create a service or run a task with the task definition\\. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nCurrently, only Amazon ECS\\-optimized AMIs, other Amazon Linux variants with the `ecs-init` package, or AWS Fargate infrastructure support the `awsvpc` network mode\\. \nIf the network mode is `host`, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used\\. \nDocker for Windows uses different network modes than Docker for Linux\\. When you register a task definition with Windows containers, you must not specify a network mode\\. If you use the console to register a task definition with Windows containers, you must choose the `` network mode object\\. \nFor more information, see [Network settings](https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `awsvpc | bridge | host | none` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Memory": "The amount \\(in MiB\\) of memory used by the task\\. \nIf your tasks runs on Amazon EC2 instances, you must specify either a task\\-level memory value or a container\\-level memory value\\. This field is optional and any value can be used\\. If a task\\-level memory value is specified, the container\\-level memory value is optional\\. For more information regarding container\\-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html)\\. \nIf your tasks runs on AWS Fargate, this field is required\\. You must use one of the following values\\. The value you choose determines your range of valid values for the `cpu` parameter\\. \n+ 512 \\(0\\.5 GB\\), 1024 \\(1 GB\\), 2048 \\(2 GB\\) \\- Available `cpu` values: 256 \\(\\.25 vCPU\\)\n+ 1024 \\(1 GB\\), 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\) \\- Available `cpu` values: 512 \\(\\.5 vCPU\\)\n+ 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\), 5120 \\(5 GB\\), 6144 \\(6 GB\\), 7168 \\(7 GB\\), 8192 \\(8 GB\\) \\- Available `cpu` values: 1024 \\(1 vCPU\\)\n+ Between 4096 \\(4 GB\\) and 16384 \\(16 GB\\) in increments of 1024 \\(1 GB\\) \\- Available `cpu` values: 2048 \\(2 vCPU\\)\n+ Between 8192 \\(8 GB\\) and 30720 \\(30 GB\\) in increments of 1024 \\(1 GB\\) \\- Available `cpu` values: 4096 \\(4 vCPU\\)\n+ Between 16 GB and 60 GB in 4 GB increments \\- Available `cpu` values: 8192 \\(8 vCPU\\)", + "NetworkMode": "The Docker networking mode to use for the containers in the task\\. The valid values are `none`, `bridge`, `awsvpc`, and `host`\\. If no network mode is specified, the default is `bridge`\\. \nFor Amazon ECS tasks on Fargate, the `awsvpc` network mode is required\\. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used\\. For Amazon ECS tasks on Amazon EC2 Windows instances, `` or `awsvpc` can be used\\. If the network mode is set to `none`, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity\\. The `host` and `awsvpc` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the `bridge` mode\\. \nWith the `host` and `awsvpc` network modes, exposed container ports are mapped directly to the corresponding host port \\(for the `host` network mode\\) or the attached elastic network interface port \\(for the `awsvpc` network mode\\), so you cannot take advantage of dynamic host port mappings\\. \nWhen using the `host` network mode, you should not run containers using the root user \\(UID 0\\)\\. It is considered best practice to use a non\\-root user\\.\nIf the network mode is `awsvpc`, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-networkconfiguration) value when you create a service or run a task with the task definition\\. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf the network mode is `host`, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used\\. \nFor more information, see [Network settings](https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `awsvpc | bridge | host | none` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PidMode": "The process namespace to use for the containers in the task\\. The valid values are `host` or `task`\\. If `host` is specified, then all containers within the tasks that specified the `host` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance\\. If `task` is specified, all containers within the specified task share the same process namespace\\. If no value is specified, the default is a private namespace\\. For more information, see [PID settings](https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*\\. \nIf the `host` PID mode is used, be aware that there is a heightened risk of undesired process namespace expose\\. For more information, see [Docker security](https://docs.docker.com/engine/security/security/)\\. \nThis parameter is not supported for Windows containers or tasks run on AWS Fargate\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `host | task` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PlacementConstraints": "An array of placement constraint objects to use for tasks\\. \nThis parameter isn't supported for tasks run on AWS Fargate\\.\n*Required*: No \n*Type*: List of [TaskDefinitionPlacementConstraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-taskdefinitionplacementconstraint.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ProxyConfiguration": "The `ProxyConfiguration` property specifies the configuration details for the App Mesh proxy\\. \nYour Amazon ECS container instances require at least version 1\\.26\\.0 of the container agent and at least version 1\\.26\\.0\\-1 of the `ecs-init` package to enable a proxy configuration\\. If your container instances are launched from the Amazon ECS\\-optimized AMI version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [ProxyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "RequiresCompatibilities": "The task launch types the task definition was validated against\\. To determine which task launch types the task definition is validated for, see the `TaskDefinition$compatibilities` parameter\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ProxyConfiguration": "The configuration details for the App Mesh proxy\\. \nYour Amazon ECS container instances require at least version 1\\.26\\.0 of the container agent and at least version 1\\.26\\.0\\-1 of the `ecs-init` package to use a proxy configuration\\. If your container instances are launched from the Amazon ECS optimized AMI version `20190301` or later, they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [ProxyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RequiresCompatibilities": "The task launch types the task definition was validated against\\. To determine which task launch types the task definition is validated for, see the `TaskDefinition$compatibilities` parameter\\. \nThe valid values are: \n+ `EC2` \\- The EC2 launch type\n+ `FARGATE` \\- The Fargate launch type\n+ `EXTERNAL` \\- The external instance \\(ECS Anywhere\\) launch type\n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RuntimePlatform": "The operating system that your tasks definitions run on\\. A platform family is specified only for tasks using the Fargate launch type\\. \nWhen you specify a task definition in a service, this value must match the `runtimePlatform` value of the service\\. \n*Required*: No \n*Type*: [RuntimePlatform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-runtimeplatform.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The metadata that you apply to the task definition to help you categorize and organize them\\. Each tag consists of a key and an optional value\\. You define both of them\\. \nThe following basic restrictions apply to tags: \n+ Maximum number of tags per resource \\- 50\n+ For each resource, each tag key must be unique, and each tag key can have only one value\\.\n+ Maximum key length \\- 128 Unicode characters in UTF\\-8\n+ Maximum value length \\- 256 Unicode characters in UTF\\-8\n+ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters\\. Generally allowed characters are: letters, numbers, and spaces representable in UTF\\-8, and the following characters: \\+ \\- = \\. \\_ : / @\\.\n+ Tag keys and values are case\\-sensitive\\.\n+ Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use\\. You cannot edit or delete tag keys or values with this prefix\\. Tags with this prefix do not count against your tags per resource limit\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TaskRoleArn": "The short name or full Amazon Resource Name \\(ARN\\) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf\\. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIAM roles for tasks on Windows require that the `-EnableTaskIAMRole` option is set when you launch the Amazon ECS\\-optimized Windows AMI\\. Your containers must also run some configuration code to use the feature\\. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Volumes": "The list of data volume definitions for the task\\. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nThe `host` and `sourcePath` parameters aren't supported for tasks run on AWS Fargate\\.\n*Required*: No \n*Type*: List of [Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Volumes": "The list of data volume definitions for the task\\. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nThe `host` and `sourcePath` parameters aren't supported for tasks run on AWS Fargate\\. \n*Required*: No \n*Type*: List of [Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition AuthorizationConfig": { - "AccessPointId": "The Amazon EFS access point ID to use\\. If an access point is specified, the root directory value specified in the `EFSVolumeConfiguration` must either be omitted or set to `/` which will enforce the path set on the EFS access point\\. If an access point is used, transit encryption must be enabled in the `EFSVolumeConfiguration`\\. For more information, see [Working with Amazon EFS Access Points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "IAM": "Determines whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system\\. If enabled, transit encryption must be enabled in the `EFSVolumeConfiguration`\\. If this parameter is omitted, the default value of `DISABLED` is used\\. For more information, see [Using Amazon EFS Access Points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "AccessPointId": "The Amazon EFS access point ID to use\\. If an access point is specified, the root directory value specified in the `EFSVolumeConfiguration` must either be omitted or set to `/` which will enforce the path set on the EFS access point\\. If an access point is used, transit encryption must be enabled in the `EFSVolumeConfiguration`\\. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IAM": "Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system\\. If enabled, transit encryption must be enabled in the `EFSVolumeConfiguration`\\. If this parameter is omitted, the default value of `DISABLED` is used\\. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition ContainerDefinition": { "Command": "The command that's passed to the container\\. This parameter maps to `Cmd` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `COMMAND` parameter to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. For more information, see [https://docs\\.docker\\.com/engine/reference/builder/\\#cmd](https://docs.docker.com/engine/reference/builder/#cmd)\\. If there are multiple arguments, each argument is a separated string in the array\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Cpu": "The number of `cpu` units reserved for the container\\. This parameter maps to `CpuShares` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--cpu-shares` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThis field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task\\-level `cpu` value\\. \nYou can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](http://aws.amazon.com/ec2/instance-types/) detail page by 1,024\\.\nLinux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount\\. For example, if you run a single\\-container task on a single\\-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time\\. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed\\. Moreover, each container could float to higher CPU usage if the other container was not using it\\. If both tasks were 100% active all of the time, they would be limited to 512 CPU units\\. \nOn Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers\\. For more information, see [CPU share constraint](https://docs.docker.com/engine/reference/run/#cpu-share-constraint) in the Docker documentation\\. The minimum valid CPU share value that the Linux kernel allows is 2\\. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions\\. For CPU values below 2 \\(including null\\), the behavior varies based on your Amazon ECS container agent version: \n+ **Agent versions less than or equal to 1\\.1\\.0:** Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares\\. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares\\.\n+ **Agent versions greater than or equal to 1\\.2\\.0:** Null, zero, and CPU values of 1 are passed to Docker as 2\\.\nOn Windows container instances, the CPU limit is enforced as an absolute limit, or a quota\\. Windows containers only have access to the specified amount of CPU that's described in the task definition\\. A null or zero CPU value is passed to Docker as `0`, which Windows interprets as 1% of one CPU\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DependsOn": "The dependencies defined for container startup and shutdown\\. A container can contain multiple dependencies\\. When a dependency is defined for container startup, for container shutdown it is reversed\\. \nFor tasks using the EC2 launch type, the container instances require at least version 1\\.26\\.0 of the container agent to turn on container dependencies\\. However, we recommend using the latest container agent version\\. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*\\. If you're using an Amazon ECS\\-optimized Linux AMI, your instance needs at least version 1\\.26\\.0\\-1 of the `ecs-init` package\\. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor tasks using the Fargate launch type, the task or service requires the following platforms: \n+ Linux platform version `1.3.0` or later\\.\n+ Windows platform version `1.0.0` or later\\.\n*Required*: No \n*Type*: List of [ContainerDependency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DisableNetworking": "When this parameter is true, networking is disabled within the container\\. This parameter maps to `NetworkDisabled` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/)\\. \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DependsOn": "The dependencies defined for container startup and shutdown\\. A container can contain multiple dependencies\\. When a dependency is defined for container startup, for container shutdown it is reversed\\. \nFor tasks using the EC2 launch type, the container instances require at least version 1\\.26\\.0 of the container agent to turn on container dependencies\\. However, we recommend using the latest container agent version\\. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*\\. If you're using an Amazon ECS\\-optimized Linux AMI, your instance needs at least version 1\\.26\\.0\\-1 of the `ecs-init` package\\. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor tasks using the Fargate launch type, the task or service requires the following platforms: \n+ Linux platform version `1.3.0` or later\\.\n+ Windows platform version `1.0.0` or later\\.\nIf the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the `dependsOn` parameter is not supported\\. For more information see [Issue \\#680](https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website\\. \n*Required*: No \n*Type*: List of [ContainerDependency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DisableNetworking": "When this parameter is true, networking is off within the container\\. This parameter maps to `NetworkDisabled` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/)\\. \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DnsSearchDomains": "A list of DNS search domains that are presented to the container\\. This parameter maps to `DnsSearch` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--dns-search` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DnsServers": "A list of DNS servers that are presented to the container\\. This parameter maps to `Dns` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--dns` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DockerLabels": "A key/value map of labels to add to the container\\. This parameter maps to `Labels` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--label` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. This parameter requires version 1\\.18 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DockerSecurityOptions": "A list of strings to provide custom labels for SELinux and AppArmor multi\\-level security systems\\. This field isn't valid for containers in tasks using the Fargate launch type\\. \nWith Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication\\. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nThis parameter maps to `SecurityOpt` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--security-opt` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThe Amazon ECS container agent running on a container instance must register with the `ECS_SELINUX_CAPABLE=true` or `ECS_APPARMOR_CAPABLE=true` environment variables before containers placed on that instance can use these security options\\. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*\\.\nFor more information about valid values, see [Docker Run Security Configuration](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nValid values: \"no\\-new\\-privileges\" \\| \"apparmor:PROFILE\" \\| \"label:value\" \\| \"credentialspec:CredentialSpecFilePath\" \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EntryPoint": "Early versions of the Amazon ECS container agent don't properly handle `entryPoint` parameters\\. If you have problems using `entryPoint`, update your container agent or enter your commands and arguments as `command` array items instead\\.\nThe entry point that's passed to the container\\. This parameter maps to `Entrypoint` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--entrypoint` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. For more information, see [https://docs\\.docker\\.com/engine/reference/builder/\\#entrypoint](https://docs.docker.com/engine/reference/builder/#entrypoint)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Environment": "The environment variables to pass to a container\\. This parameter maps to `Env` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--env` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWe don't recommend that you use plaintext environment variables for sensitive information, such as credential data\\.\n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Environment": "The environment variables to pass to a container\\. This parameter maps to `Env` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--env` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWe don't recommend that you use plaintext environment variables for sensitive information, such as credential data\\.\n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-keyvaluepair.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EnvironmentFiles": "A list of files containing the environment variables to pass to a container\\. This parameter maps to the `--env-file` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nYou can specify up to ten environment files\\. The file must have a `.env` file extension\\. Each line in an environment file contains an environment variable in `VARIABLE=VALUE` format\\. Lines beginning with `#` are treated as comments and are ignored\\. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.docker.com/compose/env-file/)\\. \nIf there are environment variables specified using the `environment` parameter in a container definition, they take precedence over the variables contained within an environment file\\. If multiple environment files are specified that contain the same variable, they're processed from the top down\\. We recommend that you use unique variable names\\. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [EnvironmentFile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-environmentfile.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Essential": "If the `essential` parameter of a container is marked as `true`, and that container fails or stops for any reason, all other containers that are part of the task are stopped\\. If the `essential` parameter of a container is marked as `false`, its failure doesn't affect the rest of the containers in a task\\. If this parameter is omitted, a container is assumed to be essential\\. \nAll tasks must have at least one essential container\\. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions\\. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ExtraHosts": "A list of hostnames and IP address mappings to append to the `/etc/hosts` file on the container\\. This parameter maps to `ExtraHosts` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--add-host` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThis parameter isn't supported for Windows containers or tasks that use the `awsvpc` network mode\\.\n*Required*: No \n*Type*: List of [HostEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ExtraHosts": "A list of hostnames and IP address mappings to append to the `/etc/hosts` file on the container\\. This parameter maps to `ExtraHosts` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--add-host` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThis parameter isn't supported for Windows containers or tasks that use the `awsvpc` network mode\\.\n*Required*: No \n*Type*: List of [HostEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-hostentry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FirelensConfiguration": "The FireLens configuration for the container\\. This is used to specify and configure a log router for container logs\\. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [FirelensConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-firelensconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "HealthCheck": "The container health check command and associated configuration parameters for the container\\. This parameter maps to `HealthCheck` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `HEALTHCHECK` parameter of [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: No \n*Type*: [HealthCheck](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Hostname": "The hostname to use for your container\\. This parameter maps to `Hostname` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--hostname` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThe `hostname` parameter is not supported if you're using the `awsvpc` network mode\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Image": "The image used to start a container\\. This string is passed directly to the Docker daemon\\. By default, images in the Docker Hub registry are available\\. Other repositories are specified with either ` repository-url/image:tag ` or ` repository-url/image@digest `\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed\\. This parameter maps to `Image` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `IMAGE` parameter of [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n+ When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use\\. However, subsequent updates to a repository image aren't propagated to already running tasks\\.\n+ Images in Amazon ECR repositories can be specified by either using the full `registry/repository:tag` or `registry/repository@digest`\\. For example, `012345678910.dkr.ecr..amazonaws.com/:latest` or `012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE`\\. \n+ Images in official repositories on Docker Hub use a single name \\(for example, `ubuntu` or `mongo`\\)\\.\n+ Images in other repositories on Docker Hub are qualified with an organization name \\(for example, `amazon/amazon-ecs-agent`\\)\\.\n+ Images in other online repositories are qualified further by a domain name \\(for example, `quay.io/assemblyline/ubuntu`\\)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Image": "The image used to start a container\\. This string is passed directly to the Docker daemon\\. By default, images in the Docker Hub registry are available\\. Other repositories are specified with either ` repository-url/image:tag ` or ` repository-url/image@digest `\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed\\. This parameter maps to `Image` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `IMAGE` parameter of [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n+ When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use\\. However, subsequent updates to a repository image aren't propagated to already running tasks\\.\n+ Images in Amazon ECR repositories can be specified by either using the full `registry/repository:tag` or `registry/repository@digest`\\. For example, `012345678910.dkr.ecr..amazonaws.com/:latest` or `012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE`\\. \n+ Images in official repositories on Docker Hub use a single name \\(for example, `ubuntu` or `mongo`\\)\\.\n+ Images in other repositories on Docker Hub are qualified with an organization name \\(for example, `amazon/amazon-ecs-agent`\\)\\.\n+ Images in other online repositories are qualified further by a domain name \\(for example, `quay.io/assemblyline/ubuntu`\\)\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Interactive": "When this parameter is `true`, you can deploy containerized applications that require `stdin` or a `tty` to be allocated\\. This parameter maps to `OpenStdin` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--interactive` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Links": "The `links` parameter allows containers to communicate with each other without the need for port mappings\\. This parameter is only supported if the network mode of a task definition is `bridge`\\. The `name:internalName` construct is analogous to `name:alias` in Docker links\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, underscores, and hyphens are allowed\\. For more information about linking Docker containers, go to [Legacy container links](https://docs.docker.com/network/links/) in the Docker documentation\\. This parameter maps to `Links` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--link` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThis parameter is not supported for Windows containers\\.\nContainers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings\\. Network isolation is achieved on the container instance using security groups and VPC settings\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "LinuxParameters": "Linux\\-specific modifications that are applied to the container, such as Linux kernel capabilities\\. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html)\\. \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: [LinuxParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "LogConfiguration": "The log configuration specification for the container\\. \nThis parameter maps to `LogConfig` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--log-driver` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. By default, containers use the same logging driver that the Docker daemon uses\\. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition\\. To use a different logging driver for a container, the log system must be configured properly on the container instance \\(or on a different log server for remote logging options\\)\\. For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation\\. \nAmazon ECS currently supports a subset of the logging drivers available to the Docker daemon \\(shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type\\)\\. Additional log drivers may be available in future releases of the Amazon ECS container agent\\.\nThis parameter requires version 1\\.18 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \nThe Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options\\. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*\\.\n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "LogConfiguration": "The log configuration specification for the container\\. \nThis parameter maps to `LogConfig` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--log-driver` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. By default, containers use the same logging driver that the Docker daemon uses\\. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition\\. To use a different logging driver for a container, the log system must be configured properly on the container instance \\(or on a different log server for remote logging options\\)\\. For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation\\. \nAmazon ECS currently supports a subset of the logging drivers available to the Docker daemon \\(shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type\\)\\. Additional log drivers may be available in future releases of the Amazon ECS container agent\\.\nThis parameter requires version 1\\.18 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \nThe Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options\\. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*\\.\n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-logconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Memory": "The amount \\(in MiB\\) of memory to present to the container\\. If your container attempts to exceed the memory specified here, the container is killed\\. The total amount of memory reserved for all containers within a task must be lower than the task `memory` value, if one is specified\\. This parameter maps to `Memory` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--memory` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nIf using the Fargate launch type, this parameter is optional\\. \nIf using the EC2 launch type, you must specify either a task\\-level memory value or a container\\-level memory value\\. If you specify both a container\\-level `memory` and `memoryReservation` value, `memory` must be greater than `memoryReservation`\\. If you specify `memoryReservation`, then that value is subtracted from the available memory resources for the container instance where the container is placed\\. Otherwise, the value of `memory` is used\\. \nThe Docker 20\\.10\\.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers\\. \nThe Docker 19\\.03\\.13\\-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MemoryReservation": "The soft limit \\(in MiB\\) of memory to reserve for the container\\. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit\\. However, your container can consume more memory when it needs to, up to either the hard limit specified with the `memory` parameter \\(if applicable\\), or all of the available memory on the container instance, whichever comes first\\. This parameter maps to `MemoryReservation` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--memory-reservation` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nIf a task\\-level memory value is not specified, you must specify a non\\-zero integer for one or both of `memory` or `memoryReservation` in a container definition\\. If you specify both, `memory` must be greater than `memoryReservation`\\. If you specify `memoryReservation`, then that value is subtracted from the available memory resources for the container instance where the container is placed\\. Otherwise, the value of `memory` is used\\. \nFor example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a `memoryReservation` of 128 MiB, and a `memory` hard limit of 300 MiB\\. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed\\. \nThe Docker daemon reserves a minimum of 4 MiB of memory for a container\\. Therefore, we recommend that you specify fewer than 4 MiB of memory for your containers\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MountPoints": "The mount points for data volumes in your container\\. \nThis parameter maps to `Volumes` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--volume` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWindows containers can mount whole directories on the same drive as `$env:ProgramData`\\. Windows containers can't mount directories on a different drive, and mount point can't be across drives\\. \n*Required*: No \n*Type*: List of [MountPoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Name": "The name of a container\\. If you're linking multiple containers together in a task definition, the `name` of one container can be entered in the `links` of another container to connect the containers\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, underscores, and hyphens are allowed\\. This parameter maps to `name` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--name` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PortMappings": "The list of port mappings for the container\\. Port mappings allow containers to access ports on the host container instance to send or receive traffic\\. \nFor task definitions that use the `awsvpc` network mode, you should only specify the `containerPort`\\. The `hostPort` can be left blank or it must be the same value as the `containerPort`\\. \nPort mappings on Windows use the `NetNAT` gateway address rather than `localhost`\\. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself\\. \nThis parameter maps to `PortBindings` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--publish` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. If the network mode of a task definition is set to `none`, then you can't specify port mappings\\. If the network mode of a task definition is set to `host`, then host ports must either be undefined or they must match the container port in the port mapping\\. \nAfter a task reaches the `RUNNING` status, manual and automatic host and container port assignments are visible in the **Network Bindings** section of a container description for a selected task in the Amazon ECS console\\. The assignments are also visible in the `networkBindings` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses\\.\n*Required*: No \n*Type*: List of [PortMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MemoryReservation": "The soft limit \\(in MiB\\) of memory to reserve for the container\\. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit\\. However, your container can consume more memory when it needs to, up to either the hard limit specified with the `memory` parameter \\(if applicable\\), or all of the available memory on the container instance, whichever comes first\\. This parameter maps to `MemoryReservation` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--memory-reservation` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nIf a task\\-level memory value is not specified, you must specify a non\\-zero integer for one or both of `memory` or `memoryReservation` in a container definition\\. If you specify both, `memory` must be greater than `memoryReservation`\\. If you specify `memoryReservation`, then that value is subtracted from the available memory resources for the container instance where the container is placed\\. Otherwise, the value of `memory` is used\\. \nFor example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a `memoryReservation` of 128 MiB, and a `memory` hard limit of 300 MiB\\. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed\\. \nThe Docker 20\\.10\\.0 or later daemon reserves a minimum of 6 MiB of memory for a container\\. So, don't specify less than 6 MiB of memory for your containers\\. \nThe Docker 19\\.03\\.13\\-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container\\. So, don't specify less than 4 MiB of memory for your containers\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MountPoints": "The mount points for data volumes in your container\\. \nThis parameter maps to `Volumes` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--volume` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWindows containers can mount whole directories on the same drive as `$env:ProgramData`\\. Windows containers can't mount directories on a different drive, and mount point can't be across drives\\. \n*Required*: No \n*Type*: List of [MountPoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-mountpoint.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of a container\\. If you're linking multiple containers together in a task definition, the `name` of one container can be entered in the `links` of another container to connect the containers\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, underscores, and hyphens are allowed\\. This parameter maps to `name` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--name` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PortMappings": "The list of port mappings for the container\\. Port mappings allow containers to access ports on the host container instance to send or receive traffic\\. \nFor task definitions that use the `awsvpc` network mode, you should only specify the `containerPort`\\. The `hostPort` can be left blank or it must be the same value as the `containerPort`\\. \nPort mappings on Windows use the `NetNAT` gateway address rather than `localhost`\\. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself\\. \nThis parameter maps to `PortBindings` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--publish` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. If the network mode of a task definition is set to `none`, then you can't specify port mappings\\. If the network mode of a task definition is set to `host`, then host ports must either be undefined or they must match the container port in the port mapping\\. \nAfter a task reaches the `RUNNING` status, manual and automatic host and container port assignments are visible in the **Network Bindings** section of a container description for a selected task in the Amazon ECS console\\. The assignments are also visible in the `networkBindings` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses\\.\n*Required*: No \n*Type*: List of [PortMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-portmapping.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Privileged": "When this parameter is true, the container is given elevated privileges on the host container instance \\(similar to the `root` user\\)\\. This parameter maps to `Privileged` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--privileged` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThis parameter is not supported for Windows containers or tasks run on AWS Fargate\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PseudoTerminal": "When this parameter is `true`, a TTY is allocated\\. This parameter maps to `Tty` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--tty` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ReadonlyRootFilesystem": "When this parameter is true, the container is given read\\-only access to its root file system\\. This parameter maps to `ReadonlyRootfs` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--read-only` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -8686,9 +9669,9 @@ "StartTimeout": "Time duration \\(in seconds\\) to wait before giving up on resolving dependencies for a container\\. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a `COMPLETE`, `SUCCESS`, or `HEALTHY` status\\. If a `startTimeout` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start\\. This results in the task transitioning to a `STOPPED` state\\. \nWhen the `ECS_CONTAINER_START_TIMEOUT` container agent configuration variable is used, it's enforced independently from this start timeout value\\.\nFor tasks using the Fargate launch type, the task or service requires the following platforms: \n+ Linux platform version `1.3.0` or later\\.\n+ Windows platform version `1.0.0` or later\\.\nFor tasks using the EC2 launch type, your container instances require at least version `1.26.0` of the container agent to use a container start timeout value\\. However, we recommend using the latest container agent version\\. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*\\. If you're using an Amazon ECS\\-optimized Linux AMI, your instance needs at least version `1.26.0-1` of the `ecs-init` package\\. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "StopTimeout": "Time duration \\(in seconds\\) to wait before the container is forcefully killed if it doesn't exit normally on its own\\. \nFor tasks using the Fargate launch type, the task or service requires the following platforms: \n+ Linux platform version `1.3.0` or later\\.\n+ Windows platform version `1.0.0` or later\\.\nThe max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used\\. \nFor tasks that use the EC2 launch type, if the `stopTimeout` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable `ECS_CONTAINER_STOP_TIMEOUT` is used\\. If neither the `stopTimeout` parameter or the `ECS_CONTAINER_STOP_TIMEOUT` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used\\. Your container instances require at least version 1\\.26\\.0 of the container agent to use a container stop timeout value\\. However, we recommend using the latest container agent version\\. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*\\. If you're using an Amazon ECS\\-optimized Linux AMI, your instance needs at least version 1\\.26\\.0\\-1 of the `ecs-init` package\\. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SystemControls": "A list of namespaced kernel parameters to set in the container\\. This parameter maps to `Sysctls` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--sysctl` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWe don't recommended that you specify network\\-related `systemControls` parameters for multiple containers in a single task that also uses either the `awsvpc` or `host` network modes\\. For tasks that use the `awsvpc` network mode, the container that's started last determines which `systemControls` parameters take effect\\. For tasks that use the `host` network mode, it changes the container instance's namespaced kernel parameters as well as the containers\\.\n*Required*: No \n*Type*: List of [SystemControl](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Ulimits": "A list of `ulimits` to set in the container\\. This parameter maps to `Ulimits` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--ulimit` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type\\. This parameter requires version 1\\.18 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: List of [Ulimit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Ulimits": "A list of `ulimits` to set in the container\\. This parameter maps to `Ulimits` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--ulimit` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type\\. This parameter requires version 1\\.18 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: List of [Ulimit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-ulimit.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "User": "The user to use inside the container\\. This parameter maps to `User` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--user` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWhen running tasks using the `host` network mode, don't run containers using the root user \\(UID 0\\)\\. We recommend using a non\\-root user for better security\\.\nYou can specify the `user` using the following formats\\. If specifying a UID or GID, you must specify it as a positive integer\\. \n+ `user` \n+ `user:group` \n+ `uid` \n+ `uid:gid` \n+ `user:gid` \n+ `uid:group` \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "VolumesFrom": "Data volumes to mount from another container\\. This parameter maps to `VolumesFrom` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--volumes-from` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: No \n*Type*: List of [VolumeFrom](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "VolumesFrom": "Data volumes to mount from another container\\. This parameter maps to `VolumesFrom` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--volumes-from` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: No \n*Type*: List of [VolumeFrom](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumefrom.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "WorkingDirectory": "The working directory to run commands inside the container in\\. This parameter maps to `WorkingDir` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--workdir` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition ContainerDependency": { @@ -8711,8 +9694,8 @@ "AuthorizationConfig": "The authorization configuration details for the Amazon EFS file system\\. \n*Required*: No \n*Type*: [AuthorizationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-authorizationconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FilesystemId": "The Amazon EFS file system ID to use\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RootDirectory": "The directory within the Amazon EFS file system to mount as the root directory inside the host\\. If this parameter is omitted, the root of the Amazon EFS volume will be used\\. Specifying `/` will have the same effect as omitting this parameter\\. \nIf an EFS access point is specified in the `authorizationConfig`, the root directory parameter must either be omitted or set to `/` which will enforce the path set on the EFS access point\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "TransitEncryption": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server\\. Transit encryption must be enabled if Amazon EFS IAM authorization is used\\. If this parameter is omitted, the default value of `DISABLED` is used\\. For more information, see [Encrypting Data in Transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "TransitEncryptionPort": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server\\. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses\\. For more information, see [EFS Mount Helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "TransitEncryption": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server\\. Transit encryption must be enabled if Amazon EFS IAM authorization is used\\. If this parameter is omitted, the default value of `DISABLED` is used\\. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TransitEncryptionPort": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server\\. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses\\. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition EnvironmentFile": { "Type": "The file type to use\\. The only supported value is `s3`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `s3` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -8726,10 +9709,10 @@ "Type": "The log router to use\\. The valid values are `fluentd` or `fluentbit`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `fluentbit | fluentd` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition HealthCheck": { - "Command": "A string array representing the command that the container runs to determine if it is healthy\\. The string array must start with `CMD` to execute the command arguments directly, or `CMD-SHELL` to run the command with the container's default shell\\. \n When you use the AWS Management Console JSON panel, the AWS Command Line Interface, or the APIs, enclose the list of commands in brackets\\. \n `[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]` \nYou don't need to include the brackets when you use the AWS Management Console\\. \n ` \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ` \nAn exit code of 0 indicates success, and non\\-zero exit code indicates failure\\. For more information, see `HealthCheck` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Command": "A string array representing the command that the container runs to determine if it is healthy\\. The string array must start with `CMD` to run the command arguments directly, or `CMD-SHELL` to run the command with the container's default shell\\. \n When you use the AWS Management Console JSON panel, the AWS Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets\\. \n `[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]` \nYou don't include the double quotes and brackets when you use the AWS Management Console\\. \n ` CMD-SHELL, curl -f http://localhost/ || exit 1` \nAn exit code of 0 indicates success, and non\\-zero exit code indicates failure\\. For more information, see `HealthCheck` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Interval": "The time period in seconds between each health check execution\\. You may specify between 5 and 300 seconds\\. The default value is 30 seconds\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Retries": "The number of times to retry a failed health check before the container is considered unhealthy\\. You may specify between 1 and 10 retries\\. The default value is 3\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StartPeriod": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries\\. You can specify between 0 and 300 seconds\\. By default, the `startPeriod` is disabled\\. \nIf a health check succeeds within the `startPeriod`, then the container is considered healthy and any subsequent failures count toward the maximum number of retries\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StartPeriod": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries\\. You can specify between 0 and 300 seconds\\. By default, the `startPeriod` is off\\. \nIf a health check succeeds within the `startPeriod`, then the container is considered healthy and any subsequent failures count toward the maximum number of retries\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Timeout": "The time period in seconds to wait for a health check to succeed before it is considered a failure\\. You may specify between 2 and 60 seconds\\. The default value is 5\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition HostEntry": { @@ -8763,7 +9746,7 @@ "AWS::ECS::TaskDefinition LogConfiguration": { "LogDriver": "The log driver to use for the container\\. \nFor tasks on AWS Fargate, the supported log drivers are `awslogs`, `splunk`, and `awsfirelens`\\. \nFor tasks hosted on Amazon EC2 instances, the supported log drivers are `awslogs`, `fluentd`, `gelf`, `json-file`, `journald`, `logentries`,`syslog`, `splunk`, and `awsfirelens`\\. \nFor more information about using the `awslogs` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor more information about using the `awsfirelens` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver\\. We encourage you to submit pull requests for changes that you would like to have included\\. However, we don't currently provide support for running modified copies of this software\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `awsfirelens | awslogs | fluentd | gelf | journald | json-file | splunk | syslog` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Options": "The configuration options to send to the log driver\\. This parameter requires version 1\\.19 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SecretOptions": "The secrets to pass to the log configuration\\. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [Secret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "SecretOptions": "The secrets to pass to the log configuration\\. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [Secret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition MountPoint": { "ContainerPath": "The path on the container to mount the host volume at\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -8771,13 +9754,16 @@ "SourceVolume": "The name of the volume to mount\\. Must be a volume name referenced in the `name` parameter of task definition `volume`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition PortMapping": { + "AppProtocol": "The application protocol that's used for the port mapping\\. This parameter only applies to Service Connect\\. We recommend that you set this parameter to be consistent with the protocol that your application uses\\. If you set this parameter, Amazon ECS adds protocol\\-specific connection handling to the Service Connect proxy\\. If you set this parameter, Amazon ECS adds protocol\\-specific telemetry in the Amazon ECS console and CloudWatch\\. \nIf you don't set a value for this parameter, then TCP is used\\. However, Amazon ECS doesn't add protocol\\-specific telemetry for TCP\\. \nTasks that run in a namespace can use short names to connect to services in the namespace\\. Tasks can connect to services across all of the clusters in the namespace\\. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility\\. Only the tasks that Amazon ECS services create are supported with Service Connect\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `grpc | http | http2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ContainerPort": "The port number on the container that's bound to the user\\-specified or automatically assigned host port\\. \nIf you use containers in a task with the `awsvpc` or `host` network mode, specify the exposed ports using `containerPort`\\. \nIf you use containers in a task with the `bridge` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range\\. For more information, see `hostPort`\\. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ContainerPortRange": "The port number range on the container that's bound to the dynamically mapped host port range\\. \nThe following rules apply when you specify a `containerPortRange`: \n+ You must use either the `bridge` network mode or the `awsvpc` network mode\\.\n+ This parameter is available for both the EC2 and AWS Fargate launch types\\.\n+ This parameter is available for both the Linux and Windows operating systems\\.\n+ The container instance must have at least version 1\\.67\\.0 of the container agent and at least version 1\\.67\\.0\\-1 of the `ecs-init` package \n+ You can specify a maximum of 100 port ranges per container\\.\n+ You do not specify a `hostPortRange`\\. The value of the `hostPortRange` is set as follows:\n + For containers in a task with the `awsvpc` network mode, the `hostPort` is set to the same value as the `containerPort`\\. This is a static mapping strategy\\.\n + For containers in a task with the `bridge` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports\\.\n+ The `containerPortRange` valid values are between 1 and 65535\\.\n+ A port can only be included in one port mapping per container\\.\n+ You cannot specify overlapping port ranges\\.\n+ The first port in the range must be less than last port in the range\\.\n+ Docker recommends that you turn off the docker\\-proxy in the Docker daemon config file when you have a large number of ports\\.", "HostPort": "The port number on the container instance to reserve for your container\\. \nIf you are using containers in a task with the `awsvpc` or `host` network mode, the `hostPort` can either be left blank or set to the same value as the `containerPort`\\. \nIf you are using containers in a task with the `bridge` network mode, you can specify a non\\-reserved host port for your container port mapping, or you can omit the `hostPort` \\(or set it to `0`\\) while specifying a `containerPort` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version\\. \nThe default ephemeral port range for Docker version 1\\.6\\.0 and later is listed on the instance under `/proc/sys/net/ipv4/ip_local_port_range`\\. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used\\. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment\\. In general, ports below 32768 are outside of the ephemeral port range\\. \nThe default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1\\.6\\.0\\.\nThe default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678\\-51680\\. Any host port that was previously specified in a running task is also reserved while the task is running \\(after a task stops, the host port is released\\)\\. The current reserved ports are displayed in the `remainingResources` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output\\. A container instance can have up to 100 reserved ports at a time, including the default reserved ports\\. Automatically assigned ports don't count toward the 100 reserved ports limit\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name that's used for the port mapping\\. This parameter only applies to Service Connect\\. This parameter is the name that you use in the `serviceConnectConfiguration` of a service\\. The name can include up to 64 characters\\. The characters can include lowercase letters, numbers, underscores \\(\\_\\), and hyphens \\(\\-\\)\\. The name can't start with a hyphen\\. \nFor more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Protocol": "The protocol used for the port mapping\\. Valid values are `tcp` and `udp`\\. The default is `tcp`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `tcp | udp` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition ProxyConfiguration": { "ContainerName": "The name of the container that will serve as the App Mesh proxy\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ProxyConfigurationProperties": "The set of network configuration parameters to provide the Container Network Interface \\(CNI\\) plugin, specified as key\\-value pairs\\. \n+ `IgnoredUID` \\- \\(Required\\) The user ID \\(UID\\) of the proxy container as defined by the `user` parameter in a container definition\\. This is used to ensure the proxy ignores its own traffic\\. If `IgnoredGID` is specified, this field can be empty\\.\n+ `IgnoredGID` \\- \\(Required\\) The group ID \\(GID\\) of the proxy container as defined by the `user` parameter in a container definition\\. This is used to ensure the proxy ignores its own traffic\\. If `IgnoredUID` is specified, this field can be empty\\.\n+ `AppPorts` \\- \\(Required\\) The list of ports that the application uses\\. Network traffic to these ports is forwarded to the `ProxyIngressPort` and `ProxyEgressPort`\\.\n+ `ProxyIngressPort` \\- \\(Required\\) Specifies the port that incoming traffic to the `AppPorts` is directed to\\.\n+ `ProxyEgressPort` \\- \\(Required\\) Specifies the port that outgoing traffic from the `AppPorts` is directed to\\.\n+ `EgressIgnoredPorts` \\- \\(Required\\) The egress traffic going to the specified ports is ignored and not redirected to the `ProxyEgressPort`\\. It can be an empty list\\.\n+ `EgressIgnoredIPs` \\- \\(Required\\) The egress traffic going to the specified IP addresses is ignored and not redirected to the `ProxyEgressPort`\\. It can be an empty list\\.\n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ProxyConfigurationProperties": "The set of network configuration parameters to provide the Container Network Interface \\(CNI\\) plugin, specified as key\\-value pairs\\. \n+ `IgnoredUID` \\- \\(Required\\) The user ID \\(UID\\) of the proxy container as defined by the `user` parameter in a container definition\\. This is used to ensure the proxy ignores its own traffic\\. If `IgnoredGID` is specified, this field can be empty\\.\n+ `IgnoredGID` \\- \\(Required\\) The group ID \\(GID\\) of the proxy container as defined by the `user` parameter in a container definition\\. This is used to ensure the proxy ignores its own traffic\\. If `IgnoredUID` is specified, this field can be empty\\.\n+ `AppPorts` \\- \\(Required\\) The list of ports that the application uses\\. Network traffic to these ports is forwarded to the `ProxyIngressPort` and `ProxyEgressPort`\\.\n+ `ProxyIngressPort` \\- \\(Required\\) Specifies the port that incoming traffic to the `AppPorts` is directed to\\.\n+ `ProxyEgressPort` \\- \\(Required\\) Specifies the port that outgoing traffic from the `AppPorts` is directed to\\.\n+ `EgressIgnoredPorts` \\- \\(Required\\) The egress traffic going to the specified ports is ignored and not redirected to the `ProxyEgressPort`\\. It can be an empty list\\.\n+ `EgressIgnoredIPs` \\- \\(Required\\) The egress traffic going to the specified IP addresses is ignored and not redirected to the `ProxyEgressPort`\\. It can be an empty list\\.\n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-keyvaluepair.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Type": "The proxy type\\. The only supported value is `APPMESH`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `APPMESH` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition RepositoryCredentials": { @@ -8788,7 +9774,7 @@ "Value": "The value for the specified resource type\\. \nIf the `GPU` type is used, the value is the number of physical `GPUs` the Amazon ECS container agent will reserve for the container\\. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on\\. \nIf the `InferenceAccelerator` type is used, the `value` should match the `DeviceName` for an [InferenceAccelerator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-inferenceaccelerator.html) specified in a task definition\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition RuntimePlatform": { - "CpuArchitecture": "The CPU architecture\\. \nYou can run your Linux tasks on an ARM\\-based platform by setting the value to `ARM64`\\. This option is avaiable for tasks that run on Linuc Amazon EC2 instance or Linux containers on Fargate\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ARM64 | X86_64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CpuArchitecture": "The CPU architecture\\. \nYou can run your Linux tasks on an ARM\\-based platform by setting the value to `ARM64`\\. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ARM64 | X86_64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "OperatingSystemFamily": "The operating system\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `LINUX | WINDOWS_SERVER_2004_CORE | WINDOWS_SERVER_2016_FULL | WINDOWS_SERVER_2019_CORE | WINDOWS_SERVER_2019_FULL | WINDOWS_SERVER_2022_CORE | WINDOWS_SERVER_2022_FULL | WINDOWS_SERVER_20H2_CORE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition Secret": { @@ -8809,14 +9795,14 @@ "Size": "The maximum size \\(in MiB\\) of the tmpfs volume\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition Ulimit": { - "HardLimit": "The hard limit for the ulimit type\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "HardLimit": "The hard limit for the `ulimit` type\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "The `type` of the `ulimit`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `core | cpu | data | fsize | locks | memlock | msgqueue | nice | nofile | nproc | rss | rtprio | rttime | sigpending | stack` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SoftLimit": "The soft limit for the ulimit type\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "SoftLimit": "The soft limit for the `ulimit` type\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition Volume": { "DockerVolumeConfiguration": "This parameter is specified when you use Docker volumes\\. \nWindows containers only support the use of the `local` driver\\. To use bind mounts, specify the `host` parameter instead\\. \nDocker volumes aren't supported by tasks run on AWS Fargate\\.\n*Required*: No \n*Type*: [DockerVolumeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EFSVolumeConfiguration": "This parameter is specified when you use an Amazon Elastic File System file system for task storage\\. \n*Required*: No \n*Type*: [EFSVolumeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-efsvolumeconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Host": "This parameter is specified when you use bind mount host volumes\\. The contents of the `host` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored\\. If the `host` parameter is empty, then the Docker daemon assigns a host path for your data volume\\. However, the data isn't guaranteed to persist after the containers that are associated with it stop running\\. \nWindows containers can mount whole directories on the same drive as `$env:ProgramData`\\. Windows containers can't mount directories on a different drive, and mount point can't be across drives\\. For example, you can mount `C:\\my\\path:C:\\my\\path` and `D:\\:D:\\`, but not `D:\\my\\path:C:\\my\\path` or `D:\\:C:\\my\\path`\\. \n*Required*: No \n*Type*: [HostVolumeProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes-host.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Host": "This parameter is specified when you use bind mount host volumes\\. The contents of the `host` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored\\. If the `host` parameter is empty, then the Docker daemon assigns a host path for your data volume\\. However, the data isn't guaranteed to persist after the containers that are associated with it stop running\\. \nWindows containers can mount whole directories on the same drive as `$env:ProgramData`\\. Windows containers can't mount directories on a different drive, and mount point can't be across drives\\. For example, you can mount `C:\\my\\path:C:\\my\\path` and `D:\\:D:\\`, but not `D:\\my\\path:C:\\my\\path` or `D:\\:C:\\my\\path`\\. \n*Required*: No \n*Type*: [HostVolumeProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-hostvolumeproperties.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "The name of the volume\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, underscores, and hyphens are allowed\\. This name is referenced in the `sourceVolume` parameter of container definition `mountPoints`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskDefinition VolumeFrom": { @@ -8826,13 +9812,13 @@ "AWS::ECS::TaskSet": { "Cluster": "The short name or full Amazon Resource Name \\(ARN\\) of the cluster that hosts the service to create the task set in\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ExternalId": "An optional non\\-unique tag that identifies this task set in external systems\\. If the task set is associated with a service discovery registry, the tasks in this task set will have the `ECS_TASK_SET_EXTERNAL_ID` AWS Cloud Map attribute set to the provided value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "LaunchType": "The launch type that new tasks in the task set uses\\. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf a `launchType` is specified, the `capacityProviderStrategy` parameter must be omitted\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EC2 | EXTERNAL | FARGATE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "LaunchType": "The launch type that new tasks in the task set uses\\. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf a `launchType` is specified, the `capacityProviderStrategy` parameter must be omitted\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EC2 | EXTERNAL | FARGATE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "LoadBalancers": "A load balancer object representing the load balancer to use with the task set\\. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer\\. \n*Required*: No \n*Type*: List of [LoadBalancer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-loadbalancer.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "NetworkConfiguration": "The network configuration for the task set\\. \n*Required*: No \n*Type*: [NetworkConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-networkconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PlatformVersion": "The platform version that the tasks in the task set uses\\. A platform version is specified only for tasks using the Fargate launch type\\. If one isn't specified, the `LATEST` platform version is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Scale": "A floating\\-point percentage of your desired number of tasks to place and keep running in the task set\\. \n*Required*: No \n*Type*: [Scale](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-scale.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Service": "The short name or full Amazon Resource Name \\(ARN\\) of the service to create the task set in\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ServiceRegistries": "The details of the service discovery registries to assign to this task set\\. For more information, see [Service Discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html)\\. \n*Required*: No \n*Type*: List of [ServiceRegistry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ServiceRegistries": "The details of the service discovery registries to assign to this task set\\. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html)\\. \n*Required*: No \n*Type*: List of [ServiceRegistry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TaskDefinition": "The task definition for the tasks in the task set to use\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskSet AwsVpcConfiguration": { @@ -8844,7 +9830,7 @@ "ContainerName": "The name of the container \\(as it appears in a container definition\\) to associate with the load balancer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ContainerPort": "The port on the container to associate with the load balancer\\. This port must correspond to a `containerPort` in the task definition the tasks in the service are using\\. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the `hostPort` of the port mapping\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "LoadBalancerName": "The name of the load balancer to associate with the Amazon ECS service or task set\\. \nA load balancer name is only specified when using a Classic Load Balancer\\. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "TargetGroupArn": "The full Amazon Resource Name \\(ARN\\) of the Elastic Load Balancing target group or groups associated with a service or task set\\. \nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer\\. If you're using a Classic Load Balancer, omit the target group ARN\\. \nFor services using the `ECS` deployment controller, you can specify one or multiple target groups\\. For more information, see [Registering Multiple Target Groups with a Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer\\. For more information, see [Blue/Green Deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance`\\. Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance\\. This network mode is required for the Fargate launch type\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "TargetGroupArn": "The full Amazon Resource Name \\(ARN\\) of the Elastic Load Balancing target group or groups associated with a service or task set\\. \nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer\\. If you're using a Classic Load Balancer, omit the target group ARN\\. \nFor services using the `ECS` deployment controller, you can specify one or multiple target groups\\. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer\\. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance`\\. Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance\\. This network mode is required for the Fargate launch type\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ECS::TaskSet NetworkConfiguration": { "AwsVpcConfiguration": "The VPC subnets and security groups that are associated with a task\\. \nAll specified subnets and security groups must be from the same VPC\\.\n*Required*: No \n*Type*: [AwsVpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-awsvpcconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" @@ -8887,15 +9873,15 @@ "AWS::EFS::FileSystem": { "AvailabilityZoneName": "Used to create a file system that uses One Zone storage classes\\. It specifies the AWS Availability Zone in which to create the file system\\. Use the format `us-east-1a` to specify the Availability Zone\\. For more information about One Zone storage classes, see [Using EFS storage classes](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide*\\. \nOne Zone storage classes are not available in all Availability Zones in AWS Regions where Amazon EFS is available\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "BackupPolicy": "Use the `BackupPolicy` to turn automatic backups on or off for the file system\\. \n*Required*: No \n*Type*: [BackupPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-backuppolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "BypassPolicyLockoutSafetyCheck": "\\(Optional\\) Use this boolean to use or bypass the `FileSystemPolicy` lockout safety check\\. The policy lockout safety check determines if the `FileSystemPolicy` in the request will lock out the IAM principal making the request, preventing them from making future `PutFileSystemPolicy` requests on the file system\\. Set `BypassPolicyLockoutSafetyCheck` to `True` only when you intend to prevent the IAM principal that is making the request from making a subsequent `PutFileSystemPolicy` request on the file system\\. The default value is `False`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BypassPolicyLockoutSafetyCheck": "\\(Optional\\) A boolean that specifies whether or not to bypass the `FileSystemPolicy` lockout safety check\\. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future `PutFileSystemPolicy` requests on this file system\\. Set `BypassPolicyLockoutSafetyCheck` to `True` only when you intend to prevent the IAM principal that is making the request from making subsequent `PutFileSystemPolicy` requests on this file system\\. The default value is `False`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Encrypted": "A Boolean value that, if true, creates an encrypted file system\\. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing AWS KMS key\\. If you don't specify a KMS key, then the default KMS key for Amazon EFS, `/aws/elasticfilesystem`, is used to protect the encrypted file system\\. \n*Required*: Conditional \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FileSystemPolicy": "The `FileSystemPolicy` for the EFS file system\\. A file system policy is an IAM resource policy used to control NFS access to an EFS file system\\. For more information, see [Using IAM to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*\\. \n*Required*: No \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `20000` \n*Pattern*: `[\\s\\S]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FileSystemTags": "Use to create one or more tags associated with the file system\\. Each tag is a user\\-defined key\\-value pair\\. Name your file system on creation by including a `\"Key\":\"Name\",\"Value\":\"{value}\"` key\\-value pair\\. Each key must be unique\\. For more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the * AWS General Reference Guide*\\. \n*Required*: No \n*Type*: List of [ElasticFileSystemTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-elasticfilesystemtag.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KmsKeyId": "The ID of the AWS KMS key to be used to protect the encrypted file system\\. This parameter is only required if you want to use a nondefault KMS key\\. If this parameter is not specified, the default KMS key for Amazon EFS is used\\. This ID can be in one of the following formats: \n+ Key ID \\- A unique identifier of the key, for example `1234abcd-12ab-34cd-56ef-1234567890ab`\\.\n+ ARN \\- An Amazon Resource Name \\(ARN\\) for the key, for example `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`\\.\n+ Key alias \\- A previously created display name for a key, for example `alias/projectKey1`\\.\n+ Key alias ARN \\- An ARN for a key alias, for example `arn:aws:kms:us-west-2:444455556666:alias/projectKey1`\\.\nIf `KmsKeyId` is specified, the `Encrypted` parameter must be set to true\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "LifecyclePolicies": "A list of one LifecyclePolicy that tells EFS lifecycle management when to transition files to the Infrequent Access \\(IA\\) storage classes\\. \n*Required*: No \n*Type*: List of [LifecyclePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LifecyclePolicies": "An array of `LifecyclePolicy` objects that define the file system's `LifecycleConfiguration` object\\. A `LifecycleConfiguration` object informs EFS lifecycle management and intelligent tiering of the following: \n+ When to move files in the file system from primary storage to the IA storage class\\.\n+ When to move files that are in IA storage to primary storage\\.\nAmazon EFS requires that each `LifecyclePolicy` object have only a single transition\\. This means that in a request body, `LifecyclePolicies` needs to be structured as an array of `LifecyclePolicy` objects, one object for each transition, `TransitionToIA`, `TransitionToPrimaryStorageClass`\\. See the example requests in the following section for more information\\.\n*Required*: No \n*Type*: List of [LifecyclePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html) \n*Maximum*: `2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PerformanceMode": "The performance mode of the file system\\. We recommend `generalPurpose` performance mode for most file systems\\. File systems using the `maxIO` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations\\. The performance mode can't be changed after the file system has been created\\. \nThe `maxIO` mode is not supported on file systems using One Zone storage classes\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `generalPurpose | maxIO` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ProvisionedThroughputInMibps": "The throughput, measured in MiB/s, that you want to provision for a file system that you're creating\\. Valid values are 1\\-1024\\. Required if `ThroughputMode` is set to `provisioned`\\. The upper limit for throughput is 1024 MiB/s\\. To increase this limit, contact AWS Support\\. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*\\. \n*Required*: Conditional \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ThroughputMode": "Specifies the throughput mode for the file system, either `bursting` or `provisioned`\\. If you set `ThroughputMode` to `provisioned`, you must also set a value for `ProvisionedThroughputInMibps`\\. After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, as long as it\u2019s been more than 24 hours since the last decrease or throughput mode change\\. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*\\. \nDefault is `bursting`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `bursting | provisioned` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ThroughputMode": "Specifies the throughput mode for the file system\\. The mode can be `bursting`, `provisioned`, or `elastic`\\. If you set `ThroughputMode` to `provisioned`, you must also set a value for `ProvisionedThroughputInMibps`\\. After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, with certain time restrictions\\. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*\\. \nDefault is `bursting`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `bursting | elastic | provisioned` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EFS::FileSystem BackupPolicy": { "Status": "Set the backup policy status for the file system\\. \n+ ** `ENABLED`** \\- Turns automatic backups on for the file system\\. \n+ ** `DISABLED`** \\- Turns automatic backups off for the file system\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DISABLED | DISABLING | ENABLED | ENABLING` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -8905,7 +9891,7 @@ "Value": "The value of the tag key\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EFS::FileSystem LifecyclePolicy": { - "TransitionToIA": "Describes the period of time that a file is not accessed, after which it transitions to IA storage\\. Metadata operations such as listing the contents of a directory don't count as file access events\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AFTER_14_DAYS | AFTER_30_DAYS | AFTER_60_DAYS | AFTER_7_DAYS | AFTER_90_DAYS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TransitionToIA": "Describes the period of time that a file is not accessed, after which it transitions to IA storage\\. Metadata operations such as listing the contents of a directory don't count as file access events\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AFTER_14_DAYS | AFTER_1_DAY | AFTER_30_DAYS | AFTER_60_DAYS | AFTER_7_DAYS | AFTER_90_DAYS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TransitionToPrimaryStorageClass": "Describes when to transition a file from IA storage to primary storage\\. Metadata operations such as listing the contents of a directory don't count as file access events\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AFTER_1_ACCESS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EFS::MountTarget": { @@ -8918,7 +9904,9 @@ "AddonName": "The name of the add\\-on\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "AddonVersion": "The version of the add\\-on\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClusterName": "The name of the cluster\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[0-9A-Za-z][A-Za-z0-9\\-_]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ResolveConflicts": "How to resolve parameter value conflicts when migrating an existing add\\-on to an Amazon EKS add\\-on\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | OVERWRITE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConfigurationValues": "The configuration values that you provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PreserveOnDelete": "Specifying this option preserves the add\\-on software on your cluster but Amazon EKS stops managing any settings for the add\\-on\\. If an IAM account is associated with the add\\-on, it isn't removed\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResolveConflicts": "How to resolve field value conflicts for an Amazon EKS add\\-on\\. Conflicts are handled based on the value you choose: \n+ **None** \u2013 If the self\\-managed version of the add\\-on is installed on your cluster, Amazon EKS doesn't change the value\\. Creation of the add\\-on might fail\\.\n+ **Overwrite** \u2013 If the self\\-managed version of the add\\-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value\\.\n+ **Preserve** \u2013 Not supported\\. You can set this value when updating an add\\-on though\\. For more information, see [UpdateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html)\\.\nIf you don't currently have the self\\-managed version of the add\\-on installed on your cluster, the Amazon EKS add\\-on is installed\\. Amazon EKS sets all values to default values, regardless of the option that you specify\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | OVERWRITE | PRESERVE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceAccountRoleArn": "The Amazon Resource Name \\(ARN\\) of an existing IAM role to bind to the add\\-on's service account\\. The role must be assigned the IAM permissions required by the add\\-on\\. If you don't specify an existing IAM role, then the add\\-on uses the permissions assigned to the node IAM role\\. For more information, see [Amazon EKS node IAM role](https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) in the *Amazon EKS User Guide*\\. \nTo specify an existing IAM role, you must have an IAM OpenID Connect \\(OIDC\\) provider created for your cluster\\. For more information, see [Enabling IAM roles for service accounts on your cluster](https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html) in the *Amazon EKS User Guide*\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The metadata that you apply to the add\\-on to assist with categorization and organization\\. Each tag consists of a key and an optional value, both of which you define\\. Add\\-on tags do not propagate to any other resources associated with the cluster\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -8927,21 +9915,25 @@ "KubernetesNetworkConfig": "The Kubernetes network configuration for the cluster\\. \n*Required*: No \n*Type*: [KubernetesNetworkConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Logging": "The logging configuration for your cluster\\. \n*Required*: No \n*Type*: [Logging](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-logging.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The unique name to give to your cluster\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[0-9A-Za-z][A-Za-z0-9\\-_]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "OutpostConfig": "An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost\\. This object isn't available for clusters on the AWS cloud\\. \n*Required*: No \n*Type*: [OutpostConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-outpostconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ResourcesVpcConfig": "The VPC configuration that's used by the cluster control plane\\. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes\\. For more information, see [Cluster VPC Considerations](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and [Cluster Security Group Considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the *Amazon EKS User Guide*\\. You must specify at least two subnets\\. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane\\. \nUpdates require replacement of the `SecurityGroupIds` and `SubnetIds` sub\\-properties\\.\n*Required*: Yes \n*Type*: [ResourcesVpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The Amazon Resource Name \\(ARN\\) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf\\. For more information, see [Amazon EKS Service IAM Role](https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html) in the * *Amazon EKS User Guide* *\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The metadata that you apply to the cluster to assist with categorization and organization\\. Each tag consists of a key and an optional value, both of which you define\\. Cluster tags don't propagate to any other resources associated with the cluster\\. \nYou must have the `eks:TagResource` and `eks:UntagResource` permissions in your IAM user or IAM role used to manage the CloudFormation stack\\. If you don't have these permissions, there might be unexpected behavior with stack\\-level tags propagating to the resource during resource creation and update\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Version": "The desired Kubernetes version for your cluster\\. If you don't specify a value here, the latest version available in Amazon EKS is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Version": "The desired Kubernetes version for your cluster\\. If you don't specify a value here, the default version available in Amazon EKS is used\\. \nThe default version might not be the latest version available\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EKS::Cluster ClusterLogging": { "EnabledTypes": "The enabled control plane logs for your cluster\\. All log types are disabled if the array is empty\\. \nWhen updating a resource, you must include this `EnabledTypes` property if the previous CloudFormation template of the resource had it\\.\n*Required*: No \n*Type*: List of [LoggingTypeConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-loggingtypeconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::EKS::Cluster ControlPlanePlacement": { + "GroupName": "The name of the placement group for the Kubernetes control plane instances\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::EKS::Cluster EncryptionConfig": { - "Provider": "The encryption provider for the cluster\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Provider": "The encryption provider for the cluster\\. \n*Required*: No \n*Type*: [Provider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Resources": "Specifies the resources to be encrypted\\. The only supported value is \"secrets\"\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EKS::Cluster KubernetesNetworkConfig": { - "IpFamily": "Specify which IP family is used to assign Kubernetes pod and service IP addresses\\. If you don't specify a value, `ipv4` is used by default\\. You can only specify an IP family when you create a cluster and can't change this value once the cluster is created\\. If you specify `ipv6`, the VPC and subnets that you specify for cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them\\. You can't specify `ipv6` for clusters in China Regions\\. \nYou can only specify `ipv6` for 1\\.21 and later clusters that use version 1\\.10\\.1 or later of the Amazon VPC CNI add\\-on\\. If you specify `ipv6`, then ensure that your VPC meets the requirements listed in the considerations listed in [Assigning IPv6 addresses to pods and services](https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html) in the Amazon EKS User Guide\\. Kubernetes assigns services IPv6 addresses from the unique local address range \\(fc00::/7\\)\\. You can't specify a custom IPv6 CIDR block\\. Pod addresses are assigned from the subnet's IPv6 CIDR\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ipv4 | ipv6` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ServiceIpv4Cidr": "Don't specify a value if you select `ipv6` for **ipFamily**\\. The CIDR block to assign Kubernetes service IP addresses from\\. If you don't specify a block, Kubernetes assigns addresses from either the 10\\.100\\.0\\.0/16 or 172\\.20\\.0\\.0/16 CIDR blocks\\. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC\\. The block must meet the following requirements: \n+ Within one of the following private IP address blocks: 10\\.0\\.0\\.0/8, 172\\.16\\.0\\.0/12, or 192\\.168\\.0\\.0/16\\.\n+ Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC\\.\n+ Between /24 and /12\\.\nYou can only specify a custom CIDR block when you create a cluster and can't change this value once the cluster is created\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IpFamily": "Specify which IP family is used to assign Kubernetes pod and service IP addresses\\. If you don't specify a value, `ipv4` is used by default\\. You can only specify an IP family when you create a cluster and can't change this value once the cluster is created\\. If you specify `ipv6`, the VPC and subnets that you specify for cluster creation must have both `IPv4` and `IPv6` CIDR blocks assigned to them\\. You can't specify `ipv6` for clusters in China Regions\\. \nYou can only specify `ipv6` for `1.21` and later clusters that use version `1.10.1` or later of the Amazon VPC CNI add\\-on\\. If you specify `ipv6`, then ensure that your VPC meets the requirements listed in the considerations listed in [Assigning IPv6 addresses to pods and services](https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html) in the Amazon EKS User Guide\\. Kubernetes assigns services `IPv6` addresses from the unique local address range `(fc00::/7)`\\. You can't specify a custom `IPv6` CIDR block\\. Pod addresses are assigned from the subnet's `IPv6` CIDR\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ipv4 | ipv6` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ServiceIpv4Cidr": "Don't specify a value if you select `ipv6` for **ipFamily**\\. The CIDR block to assign Kubernetes service IP addresses from\\. If you don't specify a block, Kubernetes assigns addresses from either the `10.100.0.0/16` or `172.20.0.0/16` CIDR blocks\\. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC\\. The block must meet the following requirements: \n+ Within one of the following private IP address blocks: `10.0.0.0/8`, `172.16.0.0/12`, or `192.168.0.0/16`\\.\n+ Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC\\.\n+ Between /24 and /12\\.\nYou can only specify a custom CIDR block when you create a cluster and can't change this value once the cluster is created\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ServiceIpv6Cidr": "The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1\\.21 or later cluster with version 1\\.10\\.1 or later of the Amazon VPC CNI add\\-on and specified `ipv6` for **ipFamily** when you created the cluster\\. Kubernetes assigns service addresses from the unique local address range \\(`fc00::/7`\\) because you can't specify a custom IPv6 CIDR block when you create the cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EKS::Cluster Logging": { @@ -8950,11 +9942,19 @@ "AWS::EKS::Cluster LoggingTypeConfig": { "Type": "The name of the log type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::EKS::Cluster OutpostConfig": { + "ControlPlaneInstanceType": "The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts\\. Choose an instance type based on the number of nodes that your cluster will have\\. For more information, see [Capacity considerations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the *Amazon EKS User Guide*\\. \nThe instance type that you specify is used for all Kubernetes control plane instances\\. The instance type can't be changed after cluster creation\\. The control plane is not automatically scaled by Amazon EKS\\. \n \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ControlPlanePlacement": "An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an AWS Outpost\\. For more information, see [Capacity considerations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: [ControlPlanePlacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-controlplaneplacement.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "OutpostArns": "The ARN of the Outpost that you want to use for your local Amazon EKS cluster on Outposts\\. Only a single Outpost ARN is supported\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::EKS::Cluster Provider": { + "KeyArn": "Amazon Resource Name \\(ARN\\) or alias of the KMS key\\. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key\\. For more information, see [Allowing Users in Other Accounts to Use a KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html) in the * AWS Key Management Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::EKS::Cluster ResourcesVpcConfig": { "EndpointPrivateAccess": "Set this value to `true` to enable private access for your cluster's Kubernetes API server endpoint\\. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint\\. The default value for this parameter is `false`, which disables private access for your Kubernetes API server\\. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that `publicAccessCidrs` includes the necessary CIDR blocks for communication with the nodes or Fargate pods\\. For more information, see [Amazon EKS cluster endpoint access control](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the * *Amazon EKS User Guide* *\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EndpointPublicAccess": "Set this value to `false` to disable public access to your cluster's Kubernetes API server endpoint\\. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC\\. The default value for this parameter is `true`, which enables public access for your Kubernetes API server\\. For more information, see [Amazon EKS cluster endpoint access control](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the * *Amazon EKS User Guide* *\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PublicAccessCidrs": "The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint\\. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied\\. The default value is `0.0.0.0/0`\\. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks\\. For more information, see [Amazon EKS cluster endpoint access control](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the * *Amazon EKS User Guide* *\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecurityGroupIds": "Specify one or more security groups for the cross\\-account elastic network interfaces that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes control plane\\. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes: \n+ 1\\.14 Amazon EKS platform version `eks.2` and earlier\n+ 1\\.14 Amazon EKS platform version `eks.3` and later \nFor more information, see [Amazon EKS security group considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the * *Amazon EKS User Guide* *\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SecurityGroupIds": "Specify one or more security groups for the cross\\-account elastic network interfaces that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes control plane\\. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes\\. For more information, see [Amazon EKS security group considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the * *Amazon EKS User Guide* *\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SubnetIds": "Specify subnets for your Amazon EKS nodes\\. Amazon EKS creates cross\\-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EKS::FargateProfile": { @@ -8976,7 +9976,7 @@ "AWS::EKS::IdentityProviderConfig": { "ClusterName": "The cluster that the configuration is associated to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "IdentityProviderConfigName": "The name of the configuration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Oidc": "An object that represents an OpenID Connect \\(OIDC\\) identity provider configuration\\. \n*Required*: No \n*Type*: [OidcIdentityProviderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Oidc": "An object representing an OpenID Connect \\(OIDC\\) identity provider configuration\\. \n*Required*: No \n*Type*: [OidcIdentityProviderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The metadata to apply to the provider configuration to assist with categorization and organization\\. Each tag consists of a key and an optional value\\. You define both\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Type": "The type of the identity provider configuration\\. The only type available is `oidc`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -8994,33 +9994,33 @@ "Value": "The value for the key from the token\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EKS::Nodegroup": { - "AmiType": "The AMI type for your node group\\. GPU instance types should use the `AL2_x86_64_GPU` AMI type\\. Non\\-GPU instances should use the `AL2_x86_64` AMI type\\. Arm instances should use the `AL2_ARM_64` AMI type\\. All types use the Amazon EKS optimized Amazon Linux 2 AMI\\. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `amiType`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AL2_ARM_64 | AL2_x86_64 | AL2_x86_64_GPU | BOTTLEROCKET_ARM_64 | BOTTLEROCKET_x86_64 | CUSTOM` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AmiType": "The AMI type for your node group\\. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `amiType`, or the node group deployment will fail\\. If your launch template uses a Windows custom AMI, then add `eks:kube-proxy-windows` to your Windows nodes `rolearn` in the `aws-auth` `ConfigMap`\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AL2_ARM_64 | AL2_x86_64 | AL2_x86_64_GPU | BOTTLEROCKET_ARM_64 | BOTTLEROCKET_ARM_64_NVIDIA | BOTTLEROCKET_x86_64 | BOTTLEROCKET_x86_64_NVIDIA | CUSTOM | WINDOWS_CORE_2019_x86_64 | WINDOWS_CORE_2022_x86_64 | WINDOWS_FULL_2019_x86_64 | WINDOWS_FULL_2022_x86_64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "CapacityType": "The capacity type of your managed node group\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ON_DEMAND | SPOT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ClusterName": "The name of the cluster to create the node group in\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DiskSize": "The root device disk size \\(in GiB\\) for your node group instances\\. The default disk size is 20 GiB\\. If you specify `launchTemplate`, then don't specify `diskSize`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DiskSize": "The root device disk size \\(in GiB\\) for your node group instances\\. The default disk size is 20 GiB for Linux and Bottlerocket\\. The default disk size is 50 GiB for Windows\\. If you specify `launchTemplate`, then don't specify `diskSize`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ForceUpdateEnabled": "Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue\\. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InstanceTypes": "Specify the instance types for a node group\\. If you specify a GPU instance type, be sure to specify `AL2_x86_64_GPU` with the `amiType` parameter\\. If you specify `launchTemplate`, then you can specify zero or one instance type in your launch template *or* you can specify 0\\-20 instance types for `instanceTypes`\\. If however, you specify an instance type in your launch template *and* specify any `instanceTypes`, the node group deployment will fail\\. If you don't specify an instance type in a launch template or for `instanceTypes`, then `t3.medium` is used, by default\\. If you specify `Spot` for `capacityType`, then we recommend specifying multiple values for `instanceTypes`\\. For more information, see [Managed node group capacity types](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types) and [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Labels": "The Kubernetes labels to be applied to the nodes in the node group when they are created\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InstanceTypes": "Specify the instance types for a node group\\. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the `amiType` parameter\\. If you specify `launchTemplate`, then you can specify zero or one instance type in your launch template *or* you can specify 0\\-20 instance types for `instanceTypes`\\. If however, you specify an instance type in your launch template *and* specify any `instanceTypes`, the node group deployment will fail\\. If you don't specify an instance type in a launch template or for `instanceTypes`, then `t3.medium` is used, by default\\. If you specify `Spot` for `capacityType`, then we recommend specifying multiple values for `instanceTypes`\\. For more information, see [Managed node group capacity types](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types) and [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Labels": "The Kubernetes labels applied to the nodes in the node group\\. \nOnly labels that are applied with the Amazon EKS API are shown here\\. There may be other Kubernetes labels applied to the nodes in this group\\.\n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LaunchTemplate": "An object representing a node group's launch template specification\\. If specified, then do not specify `instanceTypes`, `diskSize`, or `remoteAccess` and make sure that the launch template meets the requirements in `launchTemplateSpecification`\\. \n*Required*: No \n*Type*: [LaunchTemplateSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-launchtemplatespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NodeRole": "The Amazon Resource Name \\(ARN\\) of the IAM role to associate with your node group\\. The Amazon EKS worker node `kubelet` daemon makes calls to AWS APIs on your behalf\\. Nodes receive permissions for these API calls through an IAM instance profile and associated policies\\. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched\\. For more information, see [Amazon EKS node IAM role](https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) in the * *Amazon EKS User Guide* *\\. If you specify `launchTemplate`, then don't specify [https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html) in your launch template, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "NodegroupName": "The unique name to give your node group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ReleaseVersion": "The AMI version of the Amazon EKS optimized AMI to use with your node group \\(for example, `1.14.7-YYYYMMDD`\\)\\. By default, the latest available AMI version for the node group's current Kubernetes version is used\\. For more information, see [Amazon EKS optimized Linux AMI Versions](https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html) in the *Amazon EKS User Guide*\\. \nChanging this value triggers an update of the node group if one is available\\. You can't update other properties at the same time as updating `Release Version`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RemoteAccess": "The remote access \\(SSH\\) configuration to use with your node group\\. If you specify `launchTemplate`, then don't specify `remoteAccess`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: [RemoteAccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RemoteAccess": "The remote access configuration to use with your node group\\. For Linux, the protocol is SSH\\. For Windows, the protocol is RDP\\. If you specify `launchTemplate`, then don't specify `remoteAccess`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: [RemoteAccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ScalingConfig": "The scaling configuration details for the Auto Scaling group that is created for your node group\\. \n*Required*: No \n*Type*: [ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-scalingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Subnets": "The subnets to use for the Auto Scaling group that is created for your node group\\. If you specify `launchTemplate`, then don't specify [https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html) in your launch template, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "The metadata to apply to the node group to assist with categorization and organization\\. Each tag consists of a key and an optional value\\. You define both\\. Node group tags don't propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets\\. \nUpdates to `Tags` can't be combined with updates to `ReleaseVersion`, `Version`, or `LaunchTemplate`\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The metadata applied to the node group to assist with categorization and organization\\. Each tag consists of a key and an optional value\\. You define both\\. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Taints": "The Kubernetes taints to be applied to the nodes in the node group when they are created\\. Effect is one of `No_Schedule`, `Prefer_No_Schedule`, or `No_Execute`\\. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes\\. For more information, see [Node taints on managed node groups](https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html)\\. \n*Required*: No \n*Type*: List of [Taint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-taint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UpdateConfig": "The node group update configuration\\. \n*Required*: No \n*Type*: [UpdateConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-updateconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Version": "The Kubernetes version to use for your managed nodes\\. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value\\. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `version`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \nYou can't update other properties at the same time as updating `Version`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EKS::Nodegroup LaunchTemplateSpecification": { - "Id": "The ID of the launch template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the launch template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Version": "The version of the launch template to use\\. If no version is specified, then the template's default version is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Id": "The ID of the launch template\\. \nYou must specify either the launch template ID or the launch template name in the request, but not both\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the launch template\\. \nYou must specify either the launch template name or the launch template ID in the request, but not both\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Version": "The version number of the launch template to use\\. If no version is specified, then the template's default version is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EKS::Nodegroup RemoteAccess": { - "Ec2SshKey": "The Amazon EC2 SSH key that provides access for SSH communication with the nodes in the managed node group\\. For more information, see [Amazon EC2 key pairs and Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SourceSecurityGroups": "The security groups that are allowed SSH access \\(port 22\\) to the nodes\\. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the nodes is opened to the internet \\(0\\.0\\.0\\.0/0\\)\\. For more information, see [Security Groups for Your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Ec2SshKey": "The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group\\. For more information, see [Amazon EC2 key pairs and Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*\\. For Windows, an Amazon EC2 SSH key is used to obtain the RDP password\\. For more information, see [Amazon EC2 key pairs and Windows instances](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html) in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SourceSecurityGroups": "The security group IDs that are allowed SSH access \\(port 22\\) to the nodes\\. For Windows, the port is 3389\\. If you specify an Amazon EC2 SSH key but don't specify a source security group when you create a managed node group, then the port on the nodes is opened to the internet \\(`0.0.0.0/0`\\)\\. For more information, see [Security Groups for Your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EKS::Nodegroup ScalingConfig": { "DesiredSize": "The current number of nodes that the managed node group should maintain\\. \nIf you use Cluster Autoscaler, you shouldn't change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down\\.\nWhenever this parameter changes, the number of worker nodes in the node group is updated to the specified size\\. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value\\. When using CloudFormation, no action occurs if you remove this parameter from your CFN template\\. \nThis parameter can be different from minSize in some cases, such as when starting with extra hosts for testing\\. This parameter can also be different when you want to start with an estimated number of needed hosts, but let Cluster Autoscaler reduce the number if there are too many\\. When Cluster Autoscaler is used, the desiredSize parameter is altered by Cluster Autoscaler \\(but can be out\\-of\\-date for short periods of time\\)\\. Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -9040,6 +10040,7 @@ "AdditionalInfo": "A JSON string for selecting additional features\\. \n*Required*: No \n*Type*: Json \n*Minimum*: `0` \n*Maximum*: `10280` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Applications": "The applications to install on this cluster, for example, Spark, Flink, Oozie, Zeppelin, and so on\\. \n*Required*: No \n*Type*: List of [Application](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-application.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "AutoScalingRole": "An IAM role for automatic scaling policies\\. The default role is `EMR_AutoScaling_DefaultRole`\\. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `10280` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AutoTerminationPolicy": "Property description not available\\. \n*Required*: No \n*Type*: [AutoTerminationPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoterminationpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BootstrapActions": "A list of bootstrap actions to run before Hadoop starts on the cluster nodes\\. \n*Required*: No \n*Type*: List of [BootstrapActionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-bootstrapactionconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Configurations": "Applies only to Amazon EMR releases 4\\.x and later\\. The list of Configurations supplied to the EMR cluster\\. \n*Required*: No \n*Type*: List of [Configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-configuration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "CustomAmiId": "Available only in Amazon EMR version 5\\.7\\.0 and later\\. The ID of a custom Amazon EBS\\-backed Linux AMI if the cluster uses a custom AMI\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -9051,6 +10052,7 @@ "LogUri": "The path to the Amazon S3 location where logs for this cluster are stored\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ManagedScalingPolicy": "Creates or updates a managed scaling policy for an Amazon EMR cluster\\. The managed scaling policy defines the limits for resources, such as EC2 instances that can be added or terminated from a cluster\\. The policy only applies to the core and task nodes\\. The master node cannot be scaled after initial configuration\\. \n*Required*: No \n*Type*: [ManagedScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-managedscalingpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the cluster\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "OSReleaseLabel": "The Amazon Linux release specified in a cluster launch RunJobFlow request\\. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ReleaseLabel": "The Amazon EMR release label, which determines the version of open\\-source application packages installed on the cluster\\. Release labels are in the form `emr-x.x.x`, where x\\.x\\.x is an Amazon EMR release version such as `emr-5.14.0`\\. For more information about Amazon EMR release versions and included application versions and features, see [https://docs.aws.amazon.com/emr/latest/ReleaseGuide/](https://docs.aws.amazon.com/emr/latest/ReleaseGuide/)\\. The release label applies only to Amazon EMR releases version 4\\.0 and later\\. Earlier versions use `AmiVersion`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ScaleDownBehavior": "The way that individual Amazon EC2 instances terminate when an automatic scale\\-in activity occurs or an instance group is resized\\. `TERMINATE_AT_INSTANCE_HOUR` indicates that Amazon EMR terminates nodes at the instance\\-hour boundary, regardless of when the request to terminate the instance was submitted\\. This option is only available with Amazon EMR 5\\.1\\.0 and later and is the default for clusters created using that version\\. `TERMINATE_AT_TASK_COMPLETION` indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance\\-hour boundary\\. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption\\. `TERMINATE_AT_TASK_COMPLETION` is available only in Amazon EMR version 4\\.1\\.0 and later, and is the default for versions of Amazon EMR earlier than 5\\.1\\.0\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `TERMINATE_AT_INSTANCE_HOUR | TERMINATE_AT_TASK_COMPLETION` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SecurityConfiguration": "The name of the security configuration applied to the cluster\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `10280` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -9070,6 +10072,9 @@ "Constraints": "The upper and lower EC2 instance limits for an automatic scaling policy\\. Automatic scaling activity will not cause an instance group to grow above or below these limits\\. \n*Required*: Yes \n*Type*: [ScalingConstraints](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingconstraints.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Rules": "The scale\\-in and scale\\-out rules that comprise the automatic scaling policy\\. \n*Required*: Yes \n*Type*: List of [ScalingRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::EMR::Cluster AutoTerminationPolicy": { + "IdleTimeout": "Specifies the amount of idle time in seconds after which the cluster automatically terminates\\. You can specify a minimum of 60 seconds and a maximum of 604800 seconds \\(seven days\\)\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::EMR::Cluster BootstrapActionConfig": { "Name": "The name of the bootstrap action\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ScriptBootstrapAction": "The script run by the bootstrap action\\. \n*Required*: Yes \n*Type*: [ScriptBootstrapActionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scriptbootstrapactionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -9098,8 +10103,8 @@ "Configurations": "A list of additional configurations to apply within a configuration object\\. \n*Required*: No \n*Type*: List of [Configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-elasticmapreduce-cluster-configuration.html#aws-properties-elasticmapreduce-cluster-configuration) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EMR::Cluster EbsBlockDeviceConfig": { - "VolumeSpecification": "EBS volume specifications such as volume type, IOPS, and size \\(GiB\\) that will be requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VolumesPerInstance": "Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "VolumeSpecification": "EBS volume specifications such as volume type, IOPS, size \\(GiB\\) and throughput \\(MiB/s\\) that are requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VolumesPerInstance": "Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EMR::Cluster EbsConfiguration": { "EbsBlockDeviceConfigs": "An array of Amazon EBS volume specifications attached to a cluster instance\\. \n*Required*: No \n*Type*: List of [EbsBlockDeviceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ebsblockdeviceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -9120,7 +10125,7 @@ }, "AWS::EMR::Cluster InstanceFleetProvisioningSpecifications": { "OnDemandSpecification": "The launch specification for On\\-Demand Instances in the instance fleet, which determines the allocation strategy\\. \nThe instance fleet configuration is available only in Amazon EMR versions 4\\.8\\.0 and later, excluding 5\\.0\\.x versions\\. On\\-Demand Instances allocation strategy is available in Amazon EMR version 5\\.12\\.1 and later\\.\n*Required*: No \n*Type*: [OnDemandProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-ondemandprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SpotSpecification": "The launch specification for Spot Instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy\\. \n*Required*: No \n*Type*: [SpotProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SpotSpecification": "The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy\\. \n*Required*: No \n*Type*: [SpotProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EMR::Cluster InstanceGroupConfig": { "AutoScalingPolicy": "`AutoScalingPolicy` is a subproperty of the [InstanceGroupConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-cluster-jobflowinstancesconfig-instancegroupconfig.html) property type that specifies the constraints and rules of an automatic scaling policy in Amazon EMR\\. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric\\. Only core and task instance groups can use automatic scaling policies\\. For more information, see [Using Automatic Scaling in Amazon EMR](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-automatic-scaling.html)\\. \n*Required*: No \n*Type*: [AutoScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoscalingpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -9158,6 +10163,8 @@ "MasterInstanceGroup": "Describes the EC2 instances and instance configurations for the master instance group when using clusters with the uniform instance group configuration\\. \n*Required*: No \n*Type*: [InstanceGroupConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Placement": "The Availability Zone in which the cluster runs\\. \n*Required*: No \n*Type*: [PlacementType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-placementtype.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ServiceAccessSecurityGroup": "The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TaskInstanceFleets": "Describes the EC2 instances and instance configurations for the task instance fleets when using clusters with the instance fleet configuration\\. These task instance fleets are added to the cluster as part of the cluster launch\\. Each task instance fleet must have a unique name specified so that CloudFormation can differentiate between the task instance fleets\\. \nYou can currently specify only one task instance fleet for a cluster\\. After creating the cluster, you can only modify the mutable properties of `InstanceFleetConfig`, which are `TargetOnDemandCapacity` and `TargetSpotCapacity`\\. Modifying any other property results in cluster replacement\\.\nTo allow a maximum of 30 Amazon EC2 instance types per fleet, include `TaskInstanceFleets` when you create your cluster\\. If you create your cluster without `TaskInstanceFleets`, Amazon EMR uses its default allocation strategy, which allows for a maximum of five Amazon EC2 instance types\\.\n*Required*: No \n*Type*: List of [InstanceFleetConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "TaskInstanceGroups": "Describes the EC2 instances and instance configurations for task instance groups when using clusters with the uniform instance group configuration\\. These task instance groups are added to the cluster as part of the cluster launch\\. Each task instance group must have a unique name specified so that CloudFormation can differentiate between the task instance groups\\. \nAfter creating the cluster, you can only modify the mutable properties of `InstanceGroupConfig`, which are `AutoScalingPolicy` and `InstanceCount`\\. Modifying any other property results in cluster replacement\\.\n*Required*: No \n*Type*: List of [InstanceGroupConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "TerminationProtected": "Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job\\-flow error\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EMR::Cluster KerberosAttributes": { @@ -9214,7 +10221,7 @@ "AllocationStrategy": "Specifies the strategy to use in launching Spot Instance fleets\\. Currently, the only option is capacity\\-optimized \\(the default\\), which launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-optimized` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BlockDurationMinutes": "The defined duration for Spot Instances \\(also known as Spot blocks\\) in minutes\\. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot Instances applies\\. Valid values are 60, 120, 180, 240, 300, or 360\\. The duration period starts as soon as a Spot Instance receives its instance ID\\. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two\\-minute warning before it terminates\\. \nSpot Instances with a defined duration \\(also known as Spot blocks\\) are no longer available to new customers from July 1, 2021\\. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TimeoutAction": "The action to take when `TargetSpotCapacity` has not been fulfilled when the `TimeoutDurationMinutes` has expired; that is, when all Spot Instances could not be provisioned within the Spot provisioning timeout\\. Valid values are `TERMINATE_CLUSTER` and `SWITCH_TO_ON_DEMAND`\\. SWITCH\\_TO\\_ON\\_DEMAND specifies that if no Spot Instances are available, On\\-Demand Instances should be provisioned to fulfill any remaining Spot capacity\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SWITCH_TO_ON_DEMAND | TERMINATE_CLUSTER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimeoutDurationMinutes": "The spot provisioning timeout period in minutes\\. If Spot Instances are not provisioned within this time period, the `TimeOutAction` is taken\\. Minimum value is 5 and maximum value is 1440\\. The timeout applies only during initial provisioning, when the cluster is first created\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TimeoutDurationMinutes": "The Spot provisioning timeout period in minutes\\. If Spot Instances are not provisioned within this time period, the `TimeOutAction` is taken\\. Minimum value is 5 and maximum value is 1440\\. The timeout applies only during initial provisioning, when the cluster is first created\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EMR::Cluster StepConfig": { "ActionOnFailure": "The action to take when the cluster step fails\\. Possible values are `CANCEL_AND_WAIT` and `CONTINUE`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -9224,7 +10231,7 @@ "AWS::EMR::Cluster VolumeSpecification": { "Iops": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SizeInGB": "The volume size, in gibibytes \\(GiB\\)\\. This can be a number from 1 \\- 1024\\. If the volume type is EBS\\-optimized, the minimum value is 10\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VolumeType": "The volume type\\. Volume types supported are gp2, io1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "VolumeType": "The volume type\\. Volume types supported are gp3, gp2, io1, st1, sc1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EMR::InstanceFleetConfig": { "ClusterId": "The unique identifier of the EMR cluster\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -9241,8 +10248,8 @@ "Configurations": "A list of additional configurations to apply within a configuration object\\. \n*Required*: No \n*Type*: List of [Configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-elasticmapreduce-instancefleetconfig-configuration.html#aws-properties-elasticmapreduce-instancefleetconfig-configuration) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EMR::InstanceFleetConfig EbsBlockDeviceConfig": { - "VolumeSpecification": "EBS volume specifications such as volume type, IOPS, and size \\(GiB\\) that will be requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "VolumesPerInstance": "Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "VolumeSpecification": "EBS volume specifications such as volume type, IOPS, size \\(GiB\\) and throughput \\(MiB/s\\) that are requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "VolumesPerInstance": "Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EMR::InstanceFleetConfig EbsConfiguration": { "EbsBlockDeviceConfigs": "An array of Amazon EBS volume specifications attached to a cluster instance\\. \n*Required*: No \n*Type*: List of [EbsBlockDeviceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ebsblockdeviceconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -9250,7 +10257,7 @@ }, "AWS::EMR::InstanceFleetConfig InstanceFleetProvisioningSpecifications": { "OnDemandSpecification": "The launch specification for On\\-Demand Instances in the instance fleet, which determines the allocation strategy\\. \nThe instance fleet configuration is available only in Amazon EMR versions 4\\.8\\.0 and later, excluding 5\\.0\\.x versions\\. On\\-Demand Instances allocation strategy is available in Amazon EMR version 5\\.12\\.1 and later\\.\n*Required*: No \n*Type*: [OnDemandProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-ondemandprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SpotSpecification": "The launch specification for Spot Instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy\\. \n*Required*: No \n*Type*: [SpotProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SpotSpecification": "The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy\\. \n*Required*: No \n*Type*: [SpotProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EMR::InstanceFleetConfig InstanceTypeConfig": { "BidPrice": "The bid price for each EC2 Spot Instance type as defined by `InstanceType`\\. Expressed in USD\\. If neither `BidPrice` nor `BidPriceAsPercentageOfOnDemandPrice` is provided, `BidPriceAsPercentageOfOnDemandPrice` defaults to 100%\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -9268,12 +10275,12 @@ "AllocationStrategy": "Specifies the strategy to use in launching Spot Instance fleets\\. Currently, the only option is capacity\\-optimized \\(the default\\), which launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-optimized` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BlockDurationMinutes": "The defined duration for Spot Instances \\(also known as Spot blocks\\) in minutes\\. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot Instances applies\\. Valid values are 60, 120, 180, 240, 300, or 360\\. The duration period starts as soon as a Spot Instance receives its instance ID\\. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two\\-minute warning before it terminates\\. \nSpot Instances with a defined duration \\(also known as Spot blocks\\) are no longer available to new customers from July 1, 2021\\. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TimeoutAction": "The action to take when `TargetSpotCapacity` has not been fulfilled when the `TimeoutDurationMinutes` has expired; that is, when all Spot Instances could not be provisioned within the Spot provisioning timeout\\. Valid values are `TERMINATE_CLUSTER` and `SWITCH_TO_ON_DEMAND`\\. SWITCH\\_TO\\_ON\\_DEMAND specifies that if no Spot Instances are available, On\\-Demand Instances should be provisioned to fulfill any remaining Spot capacity\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SWITCH_TO_ON_DEMAND | TERMINATE_CLUSTER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimeoutDurationMinutes": "The spot provisioning timeout period in minutes\\. If Spot Instances are not provisioned within this time period, the `TimeOutAction` is taken\\. Minimum value is 5 and maximum value is 1440\\. The timeout applies only during initial provisioning, when the cluster is first created\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TimeoutDurationMinutes": "The Spot provisioning timeout period in minutes\\. If Spot Instances are not provisioned within this time period, the `TimeOutAction` is taken\\. Minimum value is 5 and maximum value is 1440\\. The timeout applies only during initial provisioning, when the cluster is first created\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EMR::InstanceFleetConfig VolumeSpecification": { "Iops": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SizeInGB": "The volume size, in gibibytes \\(GiB\\)\\. This can be a number from 1 \\- 1024\\. If the volume type is EBS\\-optimized, the minimum value is 10\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "VolumeType": "The volume type\\. Volume types supported are gp2, io1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "VolumeType": "The volume type\\. Volume types supported are gp3, gp2, io1, st1, sc1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EMR::InstanceGroupConfig": { "AutoScalingPolicy": "`AutoScalingPolicy` is a subproperty of `InstanceGroupConfig`\\. `AutoScalingPolicy` defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric\\. For more information, see [Using Automatic Scaling in Amazon EMR](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-automatic-scaling.html) in the *Amazon EMR Management Guide*\\. \n*Required*: No \n*Type*: [AutoScalingPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancegroupconfig-autoscalingpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -9309,8 +10316,8 @@ "Configurations": "A list of additional configurations to apply within a configuration object\\. \n*Required*: No \n*Type*: List of [Configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-emr-cluster-configuration.html#aws-properties-emr-cluster-configuration) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EMR::InstanceGroupConfig EbsBlockDeviceConfig": { - "VolumeSpecification": "EBS volume specifications such as volume type, IOPS, and size \\(GiB\\) that will be requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VolumesPerInstance": "Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "VolumeSpecification": "EBS volume specifications such as volume type, IOPS, size \\(GiB\\) and throughput \\(MiB/s\\) that are requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VolumesPerInstance": "Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EMR::InstanceGroupConfig EbsConfiguration": { "EbsBlockDeviceConfigs": "An array of Amazon EBS volume specifications attached to a cluster instance\\. \n*Required*: No \n*Type*: List of [EbsBlockDeviceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -9345,7 +10352,7 @@ "AWS::EMR::InstanceGroupConfig VolumeSpecification": { "Iops": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SizeInGB": "The volume size, in gibibytes \\(GiB\\)\\. This can be a number from 1 \\- 1024\\. If the volume type is EBS\\-optimized, the minimum value is 10\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VolumeType": "The volume type\\. Volume types supported are gp2, io1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "VolumeType": "The volume type\\. Volume types supported are gp3, gp2, io1, st1, sc1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EMR::SecurityConfiguration": { "Name": "The name of the security configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `10280` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -9368,7 +10375,7 @@ "Value": "The value part of the identified key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `10280` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EMR::Studio": { - "AuthMode": "Specifies whether the Studio authenticates users using AWS SSO or IAM\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IAM | SSO` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AuthMode": "Specifies whether the Studio authenticates users using IAM Identity Center or IAM\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IAM | SSO` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DefaultS3Location": "The Amazon S3 location to back up EMR Studio Workspaces and notebook files\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `10280` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A detailed description of the Amazon EMR Studio\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EngineSecurityGroupId": "The ID of the Amazon EMR Studio Engine security group\\. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by `VpcId`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -9383,7 +10390,7 @@ "WorkspaceSecurityGroupId": "The ID of the Workspace security group associated with the Amazon EMR Studio\\. The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EMR::StudioSessionMapping": { - "IdentityName": "The name of the user or group\\. For more information, see [UserName](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) and [DisplayName](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) in the *AWS SSO Identity Store API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IdentityName": "The name of the user or group\\. For more information, see [UserName](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) and [DisplayName](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) in the *IAM Identity Center Identity Store API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "IdentityType": "Specifies whether the identity to map to the Amazon EMR Studio is a user or a group\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `GROUP | USER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SessionPolicyArn": "The Amazon Resource Name \\(ARN\\) for the session policy that will be applied to the user or group\\. Session policies refine Studio user permissions without the need to use multiple IAM user roles\\. For more information, see [Create an EMR Studio user role with session policies](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-studio-user-role.html) in the *Amazon EMR Management Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StudioId": "The ID of the Amazon EMR Studio to which the user or group will be mapped\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" @@ -9394,16 +10401,65 @@ "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::EMRContainers::VirtualCluster ContainerInfo": { - "EksInfo": "The information about the EKS cluster\\. \n*Required*: Yes \n*Type*: [EksInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-eksinfo.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "EksInfo": "The information about the Amazon EKS cluster\\. \n*Required*: Yes \n*Type*: [EksInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-eksinfo.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EMRContainers::VirtualCluster ContainerProvider": { "Id": "The ID of the container cluster\\. \n*Minimum*: 1 \n*Maximum*: 100 \n*Pattern*: `^[0-9A-Za-z][A-Za-z0-9\\-_]*` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Info": "The information about the container cluster\\. \n*Required*: Yes \n*Type*: [ContainerInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-containerinfo.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Type": "The type of the container provider\\. EKS is the only supported type as of now\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `EKS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Type": "The type of the container provider\\. Amazon EKS is the only supported type as of now\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `EKS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::EMRContainers::VirtualCluster EksInfo": { "Namespace": "The namespaces of the EKS cluster\\. \n*Minimum*: 1 \n*Maximum*: 63 \n*Pattern*: `[a-z0-9]([-a-z0-9]*[a-z0-9])?` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::EMRServerless::Application": { + "Architecture": "The CPU architecture type of the application\\. Allowed values: `X86_64` or `ARM64` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AutoStartConfiguration": "The configuration for an application to automatically start on job submission\\. \n*Required*: No \n*Type*: [AutoStartConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostartconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AutoStopConfiguration": "The configuration for an application to automatically stop after a certain amount of time being idle\\. \n*Required*: No \n*Type*: [AutoStopConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostopconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ImageConfiguration": "The image configuration applied to all worker types\\. \n*Required*: No \n*Type*: [ImageConfigurationInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-imageconfigurationinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InitialCapacity": "The initial capacity of the application\\. \n*Required*: No \n*Type*: List of [InitialCapacityConfigKeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfigkeyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumCapacity": "The maximum capacity of the application\\. This is cumulative across all workers at any given point in time during the lifespan of the application is created\\. No new resources will be created once any one of the defined limits is hit\\. \n*Required*: No \n*Type*: [MaximumAllowedResources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-maximumallowedresources.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the application\\. \n*Minimum*: 1 \n*Maximum*: 64 \n*Pattern*: `^[A-Za-z0-9._\\\\/#-]+$` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "NetworkConfiguration": "The network configuration for customer VPC connectivity for the application\\. \n*Required*: No \n*Type*: [NetworkConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-networkconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReleaseLabel": "The EMR release version associated with the application\\. \n*Minimum*: 1 \n*Maximum*: 64 \n*Pattern*: `^[A-Za-z0-9._/-]+$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "The tags assigned to the application\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of application, such as Spark or Hive\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "WorkerTypeSpecifications": "The specification applied to each worker type\\. \n*Required*: No \n*Type*: Map of [WorkerTypeSpecificationInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workertypespecificationinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::EMRServerless::Application AutoStartConfiguration": { + "Enabled": "Enables the application to automatically start on job submission\\. Defaults to true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::EMRServerless::Application AutoStopConfiguration": { + "Enabled": "Enables the application to automatically stop after a certain amount of time being idle\\. Defaults to true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IdleTimeoutMinutes": "The amount of idle time in minutes after which your application will automatically stop\\. Defaults to 15 minutes\\. \n*Minimum*: 1 \n*Maximum*: 10080 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::EMRServerless::Application ImageConfigurationInput": { + "ImageUri": "The URI of an image in the Amazon ECR registry\\. This field is required when you create a new application\\. If you leave this field blank in an update, Amazon EMR will remove the image configuration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::EMRServerless::Application InitialCapacityConfig": { + "WorkerConfiguration": "The resource configuration of the initial capacity configuration\\. \n*Required*: Yes \n*Type*: [WorkerConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workerconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WorkerCount": "The number of workers in the initial capacity configuration\\. \n*Minimum*: 1 \n*Maximum*: 1000000 \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::EMRServerless::Application InitialCapacityConfigKeyValuePair": { + "Key": "The worker type for an analytics framework\\. For Spark applications, the key can either be set to `Driver` or `Executor`\\. For Hive applications, it can be set to `HiveDriver` or `TezTask`\\. \n*Minimum*: 1 \n*Maximum*: 50 \n*Pattern*: `^[a-zA-Z]+[-_]*[a-zA-Z]+$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The value for the initial capacity configuration per worker\\. \n*Required*: Yes \n*Type*: [InitialCapacityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::EMRServerless::Application MaximumAllowedResources": { + "Cpu": "The maximum allowed CPU for an application\\. \n*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(vCPU|vcpu|VCPU)?$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Disk": "The maximum allowed disk for an application\\. \n*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(GB|gb|gB|Gb)$\"` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Memory": "The maximum allowed resources for an application\\. \n*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(GB|gb|gB|Gb)?$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::EMRServerless::Application NetworkConfiguration": { + "SecurityGroupIds": "The array of security group Ids for customer VPC connectivity\\. \n*Minimum*: 1 \n*Maximum*: 32 \n*Pattern*: `^[-0-9a-zA-Z]+` \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SubnetIds": "The array of subnet Ids for customer VPC connectivity\\. \n*Minimum*: 1 \n*Maximum*: 32 \n*Pattern*: `^[-0-9a-zA-Z]+` \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::EMRServerless::Application WorkerConfiguration": { + "Cpu": "*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(vCPU|vcpu|VCPU)?$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Disk": "*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(GB|gb|gB|Gb)$\"` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Memory": "*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(GB|gb|gB|Gb)?$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::EMRServerless::Application WorkerTypeSpecificationInput": { + "ImageConfiguration": "The image configuration for a worker type\\. \n*Required*: No \n*Type*: [ImageConfigurationInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-imageconfigurationinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::ElastiCache::CacheCluster": { "AZMode": "Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region\\. \nThis parameter is only supported for Memcached clusters\\. \nIf the `AZMode` and `PreferredAvailabilityZones` are not specified, ElastiCache assumes `single-az` mode\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `cross-az | single-az` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "AutoMinorVersionUpgrade": "If you are running Redis engine version 6\\.0 or later, set this parameter to yes if you want to opt\\-in to the next minor version upgrade campaign\\. This parameter is disabled for previous versions\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -9414,7 +10470,9 @@ "ClusterName": "A name for the cache cluster\\. If you don't specify a name, AWSCloudFormation generates a unique physical ID and uses that ID for the cache cluster\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nThe name must contain 1 to 50 alphanumeric characters or hyphens\\. The name must start with a letter and cannot end with a hyphen or contain two consecutive hyphens\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Engine": "The name of the cache engine to be used for this cluster\\. \nValid values for this parameter are: `memcached` \\| `redis` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EngineVersion": "The version number of the cache engine to be used for this cluster\\. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation\\. \n **Important:** You can upgrade to a newer engine version \\(see [Selecting a Cache Engine and Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)\\), but you cannot downgrade to an earlier engine version\\. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IpDiscovery": "The network type you choose when modifying a cluster, either `ipv4` \\| `ipv6`\\. IPv6 is supported for workloads using Redis engine version 6\\.2 onward or Memcached engine version 1\\.6\\.6 on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ipv4 | ipv6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LogDeliveryConfigurations": "Specifies the destination, format and type of the logs\\. \n*Required*: No \n*Type*: List of [LogDeliveryConfigurationRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-cachecluster-logdeliveryconfigurationrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NetworkType": "Must be either `ipv4` \\| `ipv6` \\| `dual_stack`\\. IPv6 is supported for workloads using Redis engine version 6\\.2 onward or Memcached engine version 1\\.6\\.6 on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `dual_stack | ipv4 | ipv6` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "NotificationTopicArn": "The Amazon Resource Name \\(ARN\\) of the Amazon Simple Notification Service \\(SNS\\) topic to which notifications are sent\\. \nThe Amazon SNS topic owner must be the same as the cluster owner\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NumCacheNodes": "The number of cache nodes that the cache cluster should have\\. \nHowever, if the `PreferredAvailabilityZone` and `PreferredAvailabilityZones `properties were not previously specified and you don't specify any new values, an update requires [ replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "Port": "The port number on which each of the cache nodes accepts connections\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -9426,6 +10484,7 @@ "SnapshotRetentionLimit": "The number of days for which ElastiCache retains automatic snapshots before deleting them\\. For example, if you set `SnapshotRetentionLimit` to 5, a snapshot taken today is retained for 5 days before being deleted\\. \nThis parameter is only valid if the `Engine` parameter is `redis`\\.\nDefault: 0 \\(i\\.e\\., automatic backups are disabled for this cache cluster\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SnapshotWindow": "The daily time range \\(in UTC\\) during which ElastiCache begins taking a daily snapshot of your node group \\(shard\\)\\. \nExample: `05:00-09:00` \nIf you do not specify this parameter, ElastiCache automatically chooses an appropriate time range\\. \nThis parameter is only valid if the `Engine` parameter is `redis`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A list of tags to be added to this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TransitEncryptionEnabled": "A flag that enables in\\-transit encryption when set to true\\. \n Only available when creating a cache cluster in an Amazon VPC using Memcached version 1\\.6\\.12 or later\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcSecurityGroupIds": "One or more VPC security groups associated with the cluster\\. \nUse this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud \\(Amazon VPC\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElastiCache::CacheCluster CloudWatchLogsDestinationDetails": { @@ -9453,7 +10512,7 @@ "GlobalReplicationGroupDescription": "The optional description of the Global datastore \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GlobalReplicationGroupIdSuffix": "The suffix name of a Global Datastore\\. The suffix guarantees uniqueness of the Global Datastore name across multiple regions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Members": "The replication groups that comprise the Global datastore\\. \n*Required*: Yes \n*Type*: List of [GlobalReplicationGroupMember](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-globalreplicationgroupmember.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RegionalConfigurations": "The Amazon Regions that comprise the Global Datastore\\. \n*Required*: No \n*Type*: List of [RegionalConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "RegionalConfigurations": "The Regions that comprise the Global Datastore\\. \n*Required*: No \n*Type*: List of [RegionalConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElastiCache::GlobalReplicationGroup GlobalReplicationGroupMember": { "ReplicationGroupId": "The replication group id of the Global datastore member\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -9470,14 +10529,14 @@ "PreferredAvailabilityZones": "A list of preferred availability zones for the nodes in this cluster\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElastiCache::ParameterGroup": { - "CacheParameterGroupFamily": "The name of the cache parameter group family that this cache parameter group is compatible with\\. \nValid values are: `memcached1.4` \\| `memcached1.5` \\| `memcached1.6` \\| `redis2.6` \\| `redis2.8` \\| `redis3.2` \\| `redis4.0` \\| `redis5.0` \\| `redis6.x` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CacheParameterGroupFamily": "The name of the cache parameter group family that this cache parameter group is compatible with\\. \nValid values are: `memcached1.4` \\| `memcached1.5` \\| `memcached1.6` \\| `redis2.6` \\| `redis2.8` \\| `redis3.2` \\| `redis4.0` \\| `redis5.0` \\| `redis6.x` \\| `redis7` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "The description for this cache parameter group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Properties": "A comma\\-delimited list of parameter name/value pairs\\. For more information, see [ModifyCacheParameterGroup](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheParameterGroup.html) in the *Amazon ElastiCache API Reference Guide*\\. \nFor example:", "Tags": "A tag that can be added to an ElastiCache parameter group\\. Tags are composed of a Key/Value pair\\. You can use tags to categorize and track all your parameter groups\\. A tag with a null Value is permitted\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElastiCache::ReplicationGroup": { "AtRestEncryptionEnabled": "A flag that enables encryption at rest when set to `true`\\. \nYou cannot modify the value of `AtRestEncryptionEnabled` after the replication group is created\\. To enable encryption at rest on a replication group you must set `AtRestEncryptionEnabled` to `true` when you create the replication group\\. \n **Required:** Only available when creating a replication group in an Amazon VPC using redis version `3.2.6` or `4.x` onward\\. \nDefault: `false` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "AuthToken": "**Reserved parameter\\.** The password used to access a password protected server\\. \n `AuthToken` can be specified only on replication groups where `TransitEncryptionEnabled` is `true`\\. For more information, see [Authenticating Users with the Redis AUTH Command](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html)\\. \nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`\\.\nPassword constraints: \n+ Must be only printable ASCII characters\\.\n+ Must be at least 16 characters and no more than 128 characters in length\\.\n+ Nonalphanumeric characters are restricted to \\(\\!, &, \\#, $, ^, <, >, \\-, \\)\\. \nFor more information, see [AUTH password](http://redis.io/commands/AUTH) at http://redis\\.io/commands/AUTH\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "AuthToken": "**Reserved parameter\\.** The password used to access a password protected server\\. \n `AuthToken` can be specified only on replication groups where `TransitEncryptionEnabled` is `true`\\. For more information, see [Authenticating Users with the Redis AUTH Command](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html)\\. \nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`\\.\nPassword constraints: \n+ Must be only printable ASCII characters\\.\n+ Must be at least 16 characters and no more than 128 characters in length\\.\n+ Nonalphanumeric characters are restricted to \\(\\!, &, \\#, $, ^, <, >, \\-, \\)\\. \nFor more information, see [AUTH password](http://redis.io/commands/AUTH) at http://redis\\.io/commands/AUTH\\. \nIf ADDING the AuthToken, update requires [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "AutoMinorVersionUpgrade": "If you are running Redis engine version 6\\.0 or later, set this parameter to yes if you want to opt\\-in to the next minor version upgrade campaign\\. This parameter is disabled for previous versions\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AutomaticFailoverEnabled": "Specifies whether a read\\-only replica is automatically promoted to read/write primary if the existing primary fails\\. \n `AutomaticFailoverEnabled` must be enabled for Redis \\(cluster mode enabled\\) replication groups\\. \nDefault: false \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CacheNodeType": "The compute and memory capacity of the nodes in the node group \\(shard\\)\\. \nThe following node types are supported by ElastiCache\\. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts\\. \n+ General purpose:\n + Current generation:", @@ -9485,12 +10544,14 @@ "CacheSecurityGroupNames": "A list of cache security group names to associate with this replication group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CacheSubnetGroupName": "The name of the cache subnet group to be used for the replication group\\. \nIf you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster\\. For more information, see [AWS::ElastiCache::SubnetGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DataTieringEnabled": "Enables data tiering\\. Data tiering is only supported for replication groups using the r6gd node type\\. This parameter must be set to true when using r6gd nodes\\. For more information, see [Data tiering](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Engine": "The name of the cache engine to be used for the clusters in this replication group\\. Must be Redis\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Engine": "The name of the cache engine to be used for the clusters in this replication group\\. The value must be set to `Redis`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EngineVersion": "The version number of the cache engine to be used for the clusters in this replication group\\. To view the supported cache engine versions, use the `DescribeCacheEngineVersions` operation\\. \n **Important:** You can upgrade to a newer engine version \\(see [Selecting a Cache Engine and Version](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)\\) in the *ElastiCache User Guide*, but you cannot downgrade to an earlier engine version\\. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GlobalReplicationGroupId": "The name of the Global datastore \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IpDiscovery": "The network type you choose when creating a replication group, either `ipv4` \\| `ipv6`\\. IPv6 is supported for workloads using Redis engine version 6\\.2 onward or Memcached engine version 1\\.6\\.6 on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ipv4 | ipv6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KmsKeyId": "The ID of the KMS key used to encrypt the disk on the cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "LogDeliveryConfigurations": "Specifies the destination, format and type of the logs\\. \n*Required*: No \n*Type*: List of [LogDeliveryConfigurationRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-logdeliveryconfigurationrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MultiAZEnabled": "A flag indicating if you have Multi\\-AZ enabled to enhance fault tolerance\\. For more information, see [Minimizing Downtime: Multi\\-AZ](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NetworkType": "Must be either `ipv4` \\| `ipv6` \\| `dual_stack`\\. IPv6 is supported for workloads using Redis engine version 6\\.2 onward or Memcached engine version 1\\.6\\.6 on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `dual_stack | ipv4 | ipv6` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "NodeGroupConfiguration": "`NodeGroupConfiguration ` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache \\(ElastiCache\\) Redis cluster node group\\. \nIf you set [UseOnlineResharding](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-useonlineresharding) to `true`, you can update `NodeGroupConfiguration` without interruption\\. When `UseOnlineResharding` is set to `false`, or is not specified, updating `NodeGroupConfiguration` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html) of [NodeGroupConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-replicationgroup-nodegroupconfiguration.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "NotificationTopicArn": "The Amazon Resource Name \\(ARN\\) of the Amazon Simple Notification Service \\(SNS\\) topic to which notifications are sent\\. \nThe Amazon SNS topic owner must be the same as the cluster owner\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NumCacheClusters": "The number of clusters this replication group initially has\\. \nThis parameter is not used if there is more than one node group \\(shard\\)\\. You should use `ReplicasPerNodeGroup` instead\\. \nIf `AutomaticFailoverEnabled` is `true`, the value of this parameter must be at least 2\\. If `AutomaticFailoverEnabled` is `false` you can omit this parameter \\(it will default to 1\\), or you can explicitly set it to a value between 2 and 6\\. \nThe maximum permitted value for `NumCacheClusters` is 6 \\(1 primary plus 5 replicas\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -9509,8 +10570,9 @@ "SnapshotWindow": "The daily time range \\(in UTC\\) during which ElastiCache begins taking a daily snapshot of your node group \\(shard\\)\\. \nExample: `05:00-09:00` \nIf you do not specify this parameter, ElastiCache automatically chooses an appropriate time range\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SnapshottingClusterId": "The cluster ID that is used as the daily snapshot source for the replication group\\. This parameter cannot be set for Redis \\(cluster mode enabled\\) replication groups\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A list of tags to be added to this resource\\. Tags are comma\\-separated key,value pairs \\(e\\.g\\. Key=`myKey`, Value=`myKeyValue`\\. You can include multiple tags as shown following: Key=`myKey`, Value=`myKeyValue` Key=`mySecondKey`, Value=`mySecondKeyValue`\\. Tags on replication groups will be replicated to all nodes\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TransitEncryptionEnabled": "A flag that enables in\\-transit encryption when set to `true`\\. \nYou cannot modify the value of `TransitEncryptionEnabled` after the cluster is created\\. To enable in\\-transit encryption on a cluster you must set `TransitEncryptionEnabled` to `true` when you create a cluster\\. \nThis parameter is valid only if the `Engine` parameter is `redis`, the `EngineVersion` parameter is `3.2.6` or `4.x` onward, and the cluster is being created in an Amazon VPC\\. \nIf you enable in\\-transit encryption, you must also specify a value for `CacheSubnetGroup`\\. \n **Required:** Only available when creating a replication group in an Amazon VPC using redis version `3.2.6` or `4.x` onward\\. \nDefault: `false` \nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "UserGroupIds": "The list of user groups to associate with the replication group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TransitEncryptionEnabled": "A flag that enables in\\-transit encryption when set to `true`\\. \nYou cannot modify the value of `TransitEncryptionEnabled` after the cluster is created\\. To enable in\\-transit encryption on a cluster you must set `TransitEncryptionEnabled` to `true` when you create a cluster\\. \nThis parameter is valid only if the `Engine` parameter is `redis`, the `EngineVersion` parameter is `3.2.6` or `4.x` onward, and the cluster is being created in an Amazon VPC\\. \nIf you enable in\\-transit encryption, you must also specify a value for `CacheSubnetGroup`\\. \n **Required:** Only available when creating a replication group in an Amazon VPC using redis version `3.2.6` or `4.x` onward\\. \nDefault: `false` \nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TransitEncryptionMode": "A setting that allows you to migrate your clients to use in\\-transit encryption, with no downtime\\. \nWhen setting `TransitEncryptionEnabled` to `true`, you can set your `TransitEncryptionMode` to `preferred` in the same request, to allow both encrypted and unencrypted connections at the same time\\. Once you migrate all your Redis clients to use encrypted connections you can modify the value to `required` to allow encrypted connections only\\. \nSetting `TransitEncryptionMode` to `required` is a two\\-step process that requires you to first set the `TransitEncryptionMode` to `preferred`, after that you can set `TransitEncryptionMode` to `required`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `preferred | required` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UserGroupIds": "The ID of user group to associate with the replication group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElastiCache::ReplicationGroup CloudWatchLogsDestinationDetails": { "LogGroup": "The name of the CloudWatch Logs log group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -9552,12 +10614,17 @@ }, "AWS::ElastiCache::User": { "AccessString": "Access permissions string used for this user\\. \n*Required*: No \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthenticationMode": "Specifies the authentication mode to use\\. Below is an example of the possible JSON values:", "Engine": "The current supported value is redis\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[a-zA-Z]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "NoPasswordRequired": "Indicates a password is not required for this user\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Passwords": "Passwords used for this user\\. You can create up to two passwords for each user\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserId": "The ID of the user\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Pattern*: `[a-zA-Z][a-zA-Z0-9\\-]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "UserName": "The username of the user\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::ElastiCache::User AuthenticationMode": { + "Passwords": "Specifies the passwords to use for authentication if `Type` is set to `password`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "Specifies the authentication type\\. Possible options are IAM authentication, password and no password\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `iam | no-password-required | password` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::ElastiCache::UserGroup": { "Engine": "The current supported value is redis\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[a-zA-Z]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "UserGroupId": "The ID of the user group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -9589,7 +10656,7 @@ "AWS::ElasticBeanstalk::ApplicationVersion": { "ApplicationName": "The name of the Elastic Beanstalk application that is associated with this application version\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "A description of this application version\\. \n*Required*: No \n*Type*: String \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SourceBundle": "The Amazon S3 bucket and key that identify the location of the source bundle for this version\\. \nThe Amazon S3 bucket must be in the same region as the environment\\.\n*Required*: Yes \n*Type*: [SourceBundle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-sourcebundle.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "SourceBundle": "The Amazon S3 bucket and key that identify the location of the source bundle for this version\\. \nThe Amazon S3 bucket must be in the same region as the environment\\.\n*Required*: Yes \n*Type*: [SourceBundle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-sourcebundle.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ElasticBeanstalk::ApplicationVersion SourceBundle": { "S3Bucket": "The Amazon S3 bucket where the data is located\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -9733,13 +10800,14 @@ "AuthenticationRequestExtraParams": "The query parameters \\(up to 10\\) to include in the redirect request to the authorization endpoint\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AuthorizationEndpoint": "The authorization endpoint of the IdP\\. This must be a full URL, including the HTTPS protocol, the domain, and the path\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClientId": "The OAuth 2\\.0 client identifier\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ClientSecret": "The OAuth 2\\.0 client secret\\. This parameter is required if you are creating a rule\\. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientSecret": "The OAuth 2\\.0 client secret\\. This parameter is required if you are creating a rule\\. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Issuer": "The OIDC issuer identifier of the IdP\\. This must be a full URL, including the HTTPS protocol, the domain, and the path\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OnUnauthenticatedRequest": "The behavior if the user is not authenticated\\. The following are possible values: \n+ deny`` \\- Return an HTTP 401 Unauthorized error\\.\n+ allow`` \\- Allow the request to be forwarded to the target\\.\n+ authenticate`` \\- Redirect the request to the IdP authorization endpoint\\. This is the default value\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `allow | authenticate | deny` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Scope": "The set of user claims to be requested from the IdP\\. The default is `openid`\\. \nTo verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SessionCookieName": "The name of the cookie used to maintain session information\\. The default is AWSELBAuthSessionCookie\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SessionTimeout": "The maximum duration of the authentication session, in seconds\\. The default is 604800 seconds \\(7 days\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TokenEndpoint": "The token endpoint of the IdP\\. This must be a full URL, including the HTTPS protocol, the domain, and the path\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseExistingClientSecret": "Indicates whether to use the existing client secret when modifying a rule\\. If you are creating a rule, you can omit this parameter or set it to false\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserInfoEndpoint": "The user info endpoint of the IdP\\. This must be a full URL, including the HTTPS protocol, the domain, and the path\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElasticLoadBalancingV2::Listener Certificate": { @@ -9771,7 +10839,7 @@ "Weight": "The weight\\. The range is 0 to 999\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElasticLoadBalancingV2::ListenerCertificate": { - "Certificates": "The certificate\\. You can specify one certificate per resource\\. \n*Required*: Yes \n*Type*: List of [Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Certificates": "The certificate\\. You can specify one certificate per resource\\. \n*Required*: Yes \n*Type*: List of [Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ListenerArn": "The Amazon Resource Name \\(ARN\\) of the listener\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ElasticLoadBalancingV2::ListenerCertificate Certificate": { @@ -9807,7 +10875,7 @@ "AuthenticationRequestExtraParams": "The query parameters \\(up to 10\\) to include in the redirect request to the authorization endpoint\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AuthorizationEndpoint": "The authorization endpoint of the IdP\\. This must be a full URL, including the HTTPS protocol, the domain, and the path\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClientId": "The OAuth 2\\.0 client identifier\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ClientSecret": "The OAuth 2\\.0 client secret\\. This parameter is required if you are creating a rule\\. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientSecret": "The OAuth 2\\.0 client secret\\. This parameter is required if you are creating a rule\\. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Issuer": "The OIDC issuer identifier of the IdP\\. This must be a full URL, including the HTTPS protocol, the domain, and the path\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OnUnauthenticatedRequest": "The behavior if the user is not authenticated\\. The following are possible values: \n+ deny`` \\- Return an HTTP 401 Unauthorized error\\.\n+ allow`` \\- Allow the request to be forwarded to the target\\.\n+ authenticate`` \\- Redirect the request to the IdP authorization endpoint\\. This is the default value\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `allow | authenticate | deny` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Scope": "The set of user claims to be requested from the IdP\\. The default is `openid`\\. \nTo verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -9827,20 +10895,20 @@ "TargetGroups": "Information about how traffic will be distributed between multiple target groups in a forward rule\\. \n*Required*: No \n*Type*: List of [TargetGroupTuple](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-targetgrouptuple.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElasticLoadBalancingV2::ListenerRule HostHeaderConfig": { - "Values": "One or more host names\\. The maximum size of each name is 128 characters\\. The comparison is case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf you specify multiple strings, the condition is satisfied if one of the strings matches the host name\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Values": "The host names\\. The maximum size of each name is 128 characters\\. The comparison is case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf you specify multiple strings, the condition is satisfied if one of the strings matches the host name\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElasticLoadBalancingV2::ListenerRule HttpHeaderConfig": { "HttpHeaderName": "The name of the HTTP header field\\. The maximum size is 40 characters\\. The header name is case insensitive\\. The allowed characters are specified by RFC 7230\\. Wildcards are not supported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Values": "One or more strings to compare against the value of the HTTP header\\. The maximum size of each string is 128 characters\\. The comparison strings are case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf the same header appears multiple times in the request, we search them in order until a match is found\\. \nIf you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header\\. To require that all of the strings are a match, create one condition per string\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Values": "The strings to compare against the value of the HTTP header\\. The maximum size of each string is 128 characters\\. The comparison strings are case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf the same header appears multiple times in the request, we search them in order until a match is found\\. \nIf you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header\\. To require that all of the strings are a match, create one condition per string\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElasticLoadBalancingV2::ListenerRule HttpRequestMethodConfig": { "Values": "The name of the request method\\. The maximum size is 40 characters\\. The allowed characters are A\\-Z, hyphen \\(\\-\\), and underscore \\(\\_\\)\\. The comparison is case sensitive\\. Wildcards are not supported; therefore, the method name must be an exact match\\. \nIf you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method\\. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElasticLoadBalancingV2::ListenerRule PathPatternConfig": { - "Values": "One or more path patterns to compare against the request URL\\. The maximum size of each string is 128 characters\\. The comparison is case sensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf you specify multiple strings, the condition is satisfied if one of them matches the request URL\\. The path pattern is compared only to the path of the URL, not to its query string\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Values": "The path patterns to compare against the request URL\\. The maximum size of each string is 128 characters\\. The comparison is case sensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf you specify multiple strings, the condition is satisfied if one of them matches the request URL\\. The path pattern is compared only to the path of the URL, not to its query string\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElasticLoadBalancingV2::ListenerRule QueryStringConfig": { - "Values": "One or more key/value pairs or values to find in the query string\\. The maximum size of each string is 128 characters\\. The comparison is case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. To search for a literal '\\*' or '?' character in a query string, you must escape these characters in `Values` using a '\\\\' character\\. \nIf you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string\\. \n*Required*: No \n*Type*: List of [QueryStringKeyValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Values": "The key/value pairs or values to find in the query string\\. The maximum size of each string is 128 characters\\. The comparison is case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. To search for a literal '\\*' or '?' character in a query string, you must escape these characters in `Values` using a '\\\\' character\\. \nIf you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string\\. \n*Required*: No \n*Type*: List of [QueryStringKeyValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElasticLoadBalancingV2::ListenerRule QueryStringKeyValue": { "Key": "The key\\. You can omit the key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -9865,7 +10933,7 @@ "Values": "The condition value\\. Specify only when `Field` is `host-header` or `path-pattern`\\. Alternatively, to specify multiple host names or multiple path patterns, use `HostHeaderConfig` or `PathPatternConfig`\\. \nIf `Field` is `host-header` and you're not using `HostHeaderConfig`, you can specify a single host name \\(for example, my\\.example\\.com\\)\\. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters\\. \n+ A\\-Z, a\\-z, 0\\-9\n+ \\- \\.\n+ \\* \\(matches 0 or more characters\\)\n+ ? \\(matches exactly 1 character\\)\nIf `Field` is `path-pattern` and you're not using `PathPatternConfig`, you can specify a single path pattern \\(for example, /img/\\*\\)\\. A path pattern is case\\-sensitive, can be up to 128 characters in length, and can contain any of the following characters\\. \n+ A\\-Z, a\\-z, 0\\-9\n+ \\_ \\- \\. $ / \\~ \" ' @ : \\+\n+ & \\(using &\\)\n+ \\* \\(matches 0 or more characters\\)\n+ ? \\(matches exactly 1 character\\)\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElasticLoadBalancingV2::ListenerRule SourceIpConfig": { - "Values": "One or more source IP addresses, in CIDR format\\. You can use both IPv4 and IPv6 addresses\\. Wildcards are not supported\\. \nIf you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks\\. This condition is not satisfied by the addresses in the X\\-Forwarded\\-For header\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Values": "The source IP addresses, in CIDR format\\. You can use both IPv4 and IPv6 addresses\\. Wildcards are not supported\\. \nIf you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks\\. This condition is not satisfied by the addresses in the X\\-Forwarded\\-For header\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElasticLoadBalancingV2::ListenerRule TargetGroupStickinessConfig": { "DurationSeconds": "The time period, in seconds, during which requests from a client should be routed to the same target group\\. The range is 1\\-604800 seconds \\(7 days\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -9887,7 +10955,7 @@ "Type": "The type of load balancer\\. The default is `application`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `application | gateway | network` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ElasticLoadBalancingV2::LoadBalancer LoadBalancerAttribute": { - "Key": "The name of the attribute\\. \nThe following attribute is supported by all load balancers: \n+ `deletion_protection.enabled` \\- Indicates whether deletion protection is enabled\\. The value is `true` or `false`\\. The default is `false`\\.\nThe following attributes are supported by both Application Load Balancers and Network Load Balancers: \n+ `access_logs.s3.enabled` \\- Indicates whether access logs are enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `access_logs.s3.bucket` \\- The name of the S3 bucket for the access logs\\. This attribute is required if access logs are enabled\\. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket\\.\n+ `access_logs.s3.prefix` \\- The prefix for the location in the S3 bucket for the access logs\\.\n+ `ipv6.deny_all_igw_traffic` \\- Blocks internet gateway \\(IGW\\) access to the load balancer\\. It is set to `false` for internet\\-facing load balancers and `true` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway\\.\nThe following attributes are supported by only Application Load Balancers: \n+ `idle_timeout.timeout_seconds` \\- The idle timeout value, in seconds\\. The valid range is 1\\-4000 seconds\\. The default is 60 seconds\\.\n+ `routing.http.desync_mitigation_mode` \\- Determines how the load balancer handles requests that might pose a security risk to your application\\. The possible values are `monitor`, `defensive`, and `strictest`\\. The default is `defensive`\\.\n+ `routing.http.drop_invalid_header_fields.enabled` \\- Indicates whether HTTP headers with invalid header fields are removed by the load balancer \\(`true`\\) or routed to targets \\(`false`\\)\\. The default is `false`\\.\n+ `routing.http.x_amzn_tls_version_and_cipher_suite.enabled` \\- Indicates whether the two headers \\(`x-amzn-tls-version` and `x-amzn-tls-cipher-suite`\\), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target\\. The `x-amzn-tls-version` header has information about the TLS protocol version negotiated with the client, and the `x-amzn-tls-cipher-suite` header has information about the cipher suite negotiated with the client\\. Both headers are in OpenSSL format\\. The possible values for the attribute are `true` and `false`\\. The default is `false`\\.\n+ `routing.http.xff_client_port.enabled` \\- Indicates whether the `X-Forwarded-For` header should preserve the source port that the client used to connect to the load balancer\\. The possible values are `true` and `false`\\. The default is `false`\\.\n+ `routing.http2.enabled` \\- Indicates whether HTTP/2 is enabled\\. The possible values are `true` and `false`\\. The default is `true`\\. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens\\.\n+ `waf.fail_open.enabled` \\- Indicates whether to allow a WAF\\-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF\\. The possible values are `true` and `false`\\. The default is `false`\\.\nThe following attribute is supported by Network Load Balancers and Gateway Load Balancers: \n+ `load_balancing.cross_zone.enabled` \\- Indicates whether cross\\-zone load balancing is enabled\\. The possible values are `true` and `false`\\. The default is `false`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Key": "The name of the attribute\\. \nThe following attributes are supported by all load balancers: \n+ `deletion_protection.enabled` \\- Indicates whether deletion protection is enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `load_balancing.cross_zone.enabled` \\- Indicates whether cross\\-zone load balancing is enabled\\. The possible values are `true` and `false`\\. The default for Network Load Balancers and Gateway Load Balancers is `false`\\. The default for Application Load Balancers is `true`, and cannot be changed\\.\nThe following attributes are supported by both Application Load Balancers and Network Load Balancers: \n+ `access_logs.s3.enabled` \\- Indicates whether access logs are enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `access_logs.s3.bucket` \\- The name of the S3 bucket for the access logs\\. This attribute is required if access logs are enabled\\. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket\\.\n+ `access_logs.s3.prefix` \\- The prefix for the location in the S3 bucket for the access logs\\.\n+ `ipv6.deny_all_igw_traffic` \\- Blocks internet gateway \\(IGW\\) access to the load balancer\\. It is set to `false` for internet\\-facing load balancers and `true` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway\\.\nThe following attributes are supported by only Application Load Balancers: \n+ `idle_timeout.timeout_seconds` \\- The idle timeout value, in seconds\\. The valid range is 1\\-4000 seconds\\. The default is 60 seconds\\.\n+ `routing.http.desync_mitigation_mode` \\- Determines how the load balancer handles requests that might pose a security risk to your application\\. The possible values are `monitor`, `defensive`, and `strictest`\\. The default is `defensive`\\.\n+ `routing.http.drop_invalid_header_fields.enabled` \\- Indicates whether HTTP headers with invalid header fields are removed by the load balancer \\(`true`\\) or routed to targets \\(`false`\\)\\. The default is `false`\\.\n+ `routing.http.preserve_host_header.enabled` \\- Indicates whether the Application Load Balancer should preserve the `Host` header in the HTTP request and send it to the target without any change\\. The possible values are `true` and `false`\\. The default is `false`\\.\n+ `routing.http.x_amzn_tls_version_and_cipher_suite.enabled` \\- Indicates whether the two headers \\(`x-amzn-tls-version` and `x-amzn-tls-cipher-suite`\\), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target\\. The `x-amzn-tls-version` header has information about the TLS protocol version negotiated with the client, and the `x-amzn-tls-cipher-suite` header has information about the cipher suite negotiated with the client\\. Both headers are in OpenSSL format\\. The possible values for the attribute are `true` and `false`\\. The default is `false`\\.\n+ `routing.http.xff_client_port.enabled` \\- Indicates whether the `X-Forwarded-For` header should preserve the source port that the client used to connect to the load balancer\\. The possible values are `true` and `false`\\. The default is `false`\\.\n+ `routing.http.xff_header_processing.mode` \\- Enables you to modify, preserve, or remove the `X-Forwarded-For` header in the HTTP request before the Application Load Balancer sends the request to the target\\. The possible values are `append`, `preserve`, and `remove`\\. The default is `append`\\.\n + If the value is `append`, the Application Load Balancer adds the client IP address \\(of the last hop\\) to the `X-Forwarded-For` header in the HTTP request before it sends it to targets\\.\n + If the value is `preserve` the Application Load Balancer preserves the `X-Forwarded-For` header in the HTTP request, and sends it to targets without any change\\.\n + If the value is `remove`, the Application Load Balancer removes the `X-Forwarded-For` header in the HTTP request before it sends it to targets\\.\n+ `routing.http2.enabled` \\- Indicates whether HTTP/2 is enabled\\. The possible values are `true` and `false`\\. The default is `true`\\. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens\\.\n+ `waf.fail_open.enabled` \\- Indicates whether to allow a WAF\\-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF\\. The possible values are `true` and `false`\\. The default is `false`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Value": "The value of the attribute\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElasticLoadBalancingV2::LoadBalancer SubnetMapping": { @@ -9898,14 +10966,14 @@ }, "AWS::ElasticLoadBalancingV2::TargetGroup": { "HealthCheckEnabled": "Indicates whether health checks are enabled\\. If the target type is `lambda`, health checks are disabled by default but can be enabled\\. If the target type is `instance`, `ip`, or `alb`, health checks are always enabled and cannot be disabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "HealthCheckIntervalSeconds": "The approximate amount of time, in seconds, between health checks of an individual target\\. If the target group protocol is HTTP or HTTPS, the default is 30 seconds\\. If the target group protocol is TCP, TLS, UDP, or TCP\\_UDP, the supported values are 10 and 30 seconds and the default is 30 seconds\\. If the target group protocol is GENEVE, the default is 10 seconds\\. If the target type is `lambda`, the default is 35 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `5` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HealthCheckIntervalSeconds": "The approximate amount of time, in seconds, between health checks of an individual target\\. The range is 5\\-300\\. If the target group protocol is TCP, TLS, UDP, TCP\\_UDP, HTTP or HTTPS, the default is 30 seconds\\. If the target group protocol is GENEVE, the default is 10 seconds\\. If the target type is `lambda`, the default is 35 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `5` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HealthCheckPath": "\\[HTTP/HTTPS health checks\\] The destination for health checks on the targets\\. \n\\[HTTP1 or HTTP2 protocol version\\] The ping path\\. The default is /\\. \n\\[GRPC protocol version\\] The path of a custom health check method with the format /package\\.service/method\\. The default is /AWS\\.ALB/healthcheck\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HealthCheckPort": "The port the load balancer uses when performing health checks on targets\\. If the protocol is HTTP, HTTPS, TCP, TLS, UDP, or TCP\\_UDP, the default is `traffic-port`, which is the port on which each target receives traffic from the load balancer\\. If the protocol is GENEVE, the default is port 80\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HealthCheckProtocol": "The protocol the load balancer uses when performing health checks on targets\\. For Application Load Balancers, the default is HTTP\\. For Network Load Balancers and Gateway Load Balancers, the default is TCP\\. The TCP protocol is not supported for health checks if the protocol of the target group is HTTP or HTTPS\\. The GENEVE, TLS, UDP, and TCP\\_UDP protocols are not supported for health checks\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GENEVE | HTTP | HTTPS | TCP | TCP_UDP | TLS | UDP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "HealthCheckTimeoutSeconds": "The amount of time, in seconds, during which no response from a target means a failed health check\\. For target groups with a protocol of HTTP, HTTPS, or GENEVE, the default is 5 seconds\\. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks\\. If the target type is `lambda`, the default is 30 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `120` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "HealthyThresholdCount": "The number of consecutive health checks successes required before considering an unhealthy target healthy\\. For target groups with a protocol of HTTP or HTTPS, the default is 5\\. For target groups with a protocol of TCP, TLS, or GENEVE, the default is 3\\. If the target type is `lambda`, the default is 5\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HealthCheckTimeoutSeconds": "The amount of time, in seconds, during which no response from a target means a failed health check\\. The range is 2\u2013120 seconds\\. For target groups with a protocol of HTTP, the default is 6 seconds\\. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds\\. For target groups with a protocol of GENEVE, the default is 5 seconds\\. If the target type is `lambda`, the default is 30 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `120` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HealthyThresholdCount": "The number of consecutive health check successes required before considering a target healthy\\. The range is 2\\-10\\. If the target group protocol is TCP, TCP\\_UDP, UDP, TLS, HTTP or HTTPS, the default is 5\\. For target groups with a protocol of GENEVE, the default is 5\\. If the target type is `lambda`, the default is 5\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IpAddressType": "The type of IP address used for this target group\\. The possible values are `ipv4` and `ipv6`\\. This is an optional parameter\\. If not specified, the IP address type defaults to `ipv4`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ipv4 | ipv6` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Matcher": "\\[HTTP/HTTPS health checks\\] The HTTP or gRPC codes to use when checking for a successful response from a target\\. \n*Required*: No \n*Type*: [Matcher](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Matcher": "\\[HTTP/HTTPS health checks\\] The HTTP or gRPC codes to use when checking for a successful response from a target\\. For target groups with a protocol of TCP, TCP\\_UDP, UDP or TLS the range is 200\\-599\\. For target groups with a protocol of HTTP or HTTPS, the range is 200\\-499\\. For target groups with a protocol of GENEVE, the range is 200\\-399\\. \n*Required*: No \n*Type*: [Matcher](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the target group\\. \nThis name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Port": "The port on which the targets receive traffic\\. This port is used unless you specify a port override when registering the target\\. If the target is a Lambda function, this parameter does not apply\\. If the protocol is GENEVE, the supported port is 6081\\. \n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Protocol": "The protocol to use for routing traffic to the targets\\. For Application Load Balancers, the supported protocols are HTTP and HTTPS\\. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP\\_UDP\\. For Gateway Load Balancers, the supported protocol is GENEVE\\. A TCP\\_UDP listener must be associated with a TCP\\_UDP target group\\. If the target is a Lambda function, this parameter does not apply\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `GENEVE | HTTP | HTTPS | TCP | TCP_UDP | TLS | UDP` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -9914,29 +10982,29 @@ "TargetGroupAttributes": "The attributes\\. \n*Required*: No \n*Type*: List of [TargetGroupAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetgroupattribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TargetType": "The type of target that you must specify when registering targets with this target group\\. You can't specify targets for a target group using more than one target type\\. \n+ `instance` \\- Register targets by instance ID\\. This is the default value\\.\n+ `ip` \\- Register targets by IP address\\. You can specify IP addresses from the subnets of the virtual private cloud \\(VPC\\) for the target group, the RFC 1918 range \\(10\\.0\\.0\\.0/8, 172\\.16\\.0\\.0/12, and 192\\.168\\.0\\.0/16\\), and the RFC 6598 range \\(100\\.64\\.0\\.0/10\\)\\. You can't specify publicly routable IP addresses\\.\n+ `lambda` \\- Register a single Lambda function as a target\\.\n+ `alb` \\- Register a single Application Load Balancer as a target\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `alb | instance | ip | lambda` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Targets": "The targets\\. \n*Required*: No \n*Type*: List of [TargetDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-targetdescription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UnhealthyThresholdCount": "The number of consecutive health check failures required before considering a target unhealthy\\. If the target group protocol is HTTP or HTTPS, the default is 2\\. If the target group protocol is TCP or TLS, this value must be the same as the healthy threshold count\\. If the target group protocol is GENEVE, the default is 3\\. If the target type is `lambda`, the default is 2\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UnhealthyThresholdCount": "The number of consecutive health check failures required before considering a target unhealthy\\. The range is 2\\-10\\. If the target group protocol is TCP, TCP\\_UDP, UDP, TLS, HTTP or HTTPS, the default is 2\\. For target groups with a protocol of GENEVE, the default is 2\\. If the target type is `lambda`, the default is 5\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcId": "The identifier of the virtual private cloud \\(VPC\\)\\. If the target is a Lambda function, this parameter does not apply\\. Otherwise, this parameter is required\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ElasticLoadBalancingV2::TargetGroup Matcher": { "GrpcCode": "You can specify values between 0 and 99\\. You can specify multiple values \\(for example, \"0,1\"\\) or a range of values \\(for example, \"0\\-5\"\\)\\. The default value is 12\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "HttpCode": "For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200\\. You can specify multiple values \\(for example, \"200,202\"\\) or a range of values \\(for example, \"200\\-299\"\\)\\. \nFor Network Load Balancers and Gateway Load Balancers, this must be \"200\u2013399\"\\. \nNote that when using shorthand syntax, some values such as commas need to be escaped\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "HttpCode": "For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200\\. You can specify multiple values \\(for example, \"200,202\"\\) or a range of values \\(for example, \"200\\-299\"\\)\\. \nFor Network Load Balancers, you can specify values between 200 and 599, with the default value being 200\\-399\\. You can specify multiple values \\(for example, \"200,202\"\\) or a range of values \\(for example, \"200\\-299\"\\)\\. \nFor Gateway Load Balancers, this must be \"200\u2013399\"\\. \nNote that when using shorthand syntax, some values such as commas need to be escaped\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElasticLoadBalancingV2::TargetGroup TargetDescription": { - "AvailabilityZone": "An Availability Zone or `all`\\. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer\\. \nThis parameter is not supported if the target type of the target group is `instance` or `alb`\\. \nIf the target type is `ip` and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional\\. If the IP address is outside the VPC, this parameter is required\\. \nWith an Application Load Balancer, if the target type is `ip` and the IP address is outside the VPC for the target group, the only supported value is `all`\\. \nIf the target type is `lambda`, this parameter is optional and the only supported value is `all`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AvailabilityZone": "An Availability Zone or `all`\\. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer\\. \nFor Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross\\-zone load balancing is off\\. Otherwise the parameter is ignored and treated as `all`\\. \nThis parameter is not supported if the target type of the target group is `instance` or `alb`\\. \nIf the target type is `ip` and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional\\. If the IP address is outside the VPC, this parameter is required\\. \nFor Application Load Balancer target groups with cross\\-zone load balancing off, if the target type is `ip` and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group\\. \nIf the target type is `lambda`, this parameter is optional and the only supported value is `all`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Id": "The ID of the target\\. If the target type of the target group is `instance`, specify an instance ID\\. If the target type is `ip`, specify an IP address\\. If the target type is `lambda`, specify the ARN of the Lambda function\\. If the target type is `alb`, specify the ARN of the Application Load Balancer target\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Port": "The port on which the target is listening\\. If the target group protocol is GENEVE, the supported port is 6081\\. If the target type is `alb`, the targeted Application Load Balancer must have at least one listener whose port matches the target group port\\. Not used if the target is a Lambda function\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ElasticLoadBalancingV2::TargetGroup TargetGroupAttribute": { - "Key": "The name of the attribute\\. \nThe following attribute is supported by all load balancers: \n+ `deregistration_delay.timeout_seconds` \\- The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from `draining` to `unused`\\. The range is 0\\-3600 seconds\\. The default value is 300 seconds\\. If the target is a Lambda function, this attribute is not supported\\.\nThe following attributes are supported by both Application Load Balancers and Network Load Balancers: \n+ `stickiness.enabled` \\- Indicates whether sticky sessions are enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `stickiness.type` \\- The type of sticky sessions\\. The possible values are `lb_cookie` and `app_cookie` for Application Load Balancers or `source_ip` for Network Load Balancers\\.\nThe following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address: \n+ `load_balancing.algorithm.type` \\- The load balancing algorithm determines how the load balancer selects targets when routing requests\\. The value is `round_robin` or `least_outstanding_requests`\\. The default is `round_robin`\\.\n+ `slow_start.duration_seconds` \\- The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group\\. After this time period ends, the target receives its full share of traffic\\. The range is 30\\-900 seconds \\(15 minutes\\)\\. The default is 0 seconds \\(disabled\\)\\.\n+ `stickiness.app_cookie.cookie_name` \\- Indicates the name of the application\\-based cookie\\. Names that start with the following prefixes are not allowed: `AWSALB`, `AWSALBAPP`, and `AWSALBTG`; they're reserved for use by the load balancer\\.\n+ `stickiness.app_cookie.duration_seconds` \\- The time period, in seconds, during which requests from a client should be routed to the same target\\. After this time period expires, the application\\-based cookie is considered stale\\. The range is 1 second to 1 week \\(604800 seconds\\)\\. The default value is 1 day \\(86400 seconds\\)\\.\n+ `stickiness.lb_cookie.duration_seconds` \\- The time period, in seconds, during which requests from a client should be routed to the same target\\. After this time period expires, the load balancer\\-generated cookie is considered stale\\. The range is 1 second to 1 week \\(604800 seconds\\)\\. The default value is 1 day \\(86400 seconds\\)\\.\nThe following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function: \n+ `lambda.multi_value_headers.enabled` \\- Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings\\. The value is `true` or `false`\\. The default is `false`\\. If the value is `false` and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client\\.\nThe following attributes are supported only by Network Load Balancers: \n+ `deregistration_delay.connection_termination.enabled` \\- Indicates whether the load balancer terminates connections at the end of the deregistration timeout\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `preserve_client_ip.enabled` \\- Indicates whether client IP preservation is enabled\\. The value is `true` or `false`\\. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS\\. Otherwise, the default is enabled\\. Client IP preservation cannot be disabled for UDP and TCP\\_UDP target groups\\.\n+ `proxy_protocol_v2.enabled` \\- Indicates whether Proxy Protocol version 2 is enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Key": "The name of the attribute\\. \nThe following attributes are supported by all load balancers: \n+ `deregistration_delay.timeout_seconds` \\- The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from `draining` to `unused`\\. The range is 0\\-3600 seconds\\. The default value is 300 seconds\\. If the target is a Lambda function, this attribute is not supported\\.\n+ `stickiness.enabled` \\- Indicates whether target stickiness is enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `stickiness.type` \\- Indicates the type of stickiness\\. The possible values are:\n + `lb_cookie` and `app_cookie` for Application Load Balancers\\.\n + `source_ip` for Network Load Balancers\\.\n + `source_ip_dest_ip` and `source_ip_dest_ip_proto` for Gateway Load Balancers\\.\nThe following attributes are supported by Application Load Balancers and Network Load Balancers: \n+ `load_balancing.cross_zone.enabled` \\- Indicates whether cross zone load balancing is enabled\\. The value is `true`, `false` or `use_load_balancer_configuration`\\. The default is `use_load_balancer_configuration`\\.\n+ `target_group_health.dns_failover.minimum_healthy_targets.count` \\- The minimum number of targets that must be healthy\\. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones\\. The possible values are `off` or an integer from 1 to the maximum number of targets\\. The default is `off`\\.\n+ `target_group_health.dns_failover.minimum_healthy_targets.percentage` \\- The minimum percentage of targets that must be healthy\\. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones\\. The possible values are `off` or an integer from 1 to 100\\. The default is `off`\\.\n+ `target_group_health.unhealthy_state_routing.minimum_healthy_targets.count` \\- The minimum number of targets that must be healthy\\. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets\\. The possible values are 1 to the maximum number of targets\\. The default is 1\\.\n+ `target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage` \\- The minimum percentage of targets that must be healthy\\. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets\\. The possible values are `off` or an integer from 1 to 100\\. The default is `off`\\.\nThe following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address: \n+ `load_balancing.algorithm.type` \\- The load balancing algorithm determines how the load balancer selects targets when routing requests\\. The value is `round_robin` or `least_outstanding_requests`\\. The default is `round_robin`\\.\n+ `slow_start.duration_seconds` \\- The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group\\. After this time period ends, the target receives its full share of traffic\\. The range is 30\\-900 seconds \\(15 minutes\\)\\. The default is 0 seconds \\(disabled\\)\\.\n+ `stickiness.app_cookie.cookie_name` \\- Indicates the name of the application\\-based cookie\\. Names that start with the following prefixes are not allowed: `AWSALB`, `AWSALBAPP`, and `AWSALBTG`; they're reserved for use by the load balancer\\.\n+ `stickiness.app_cookie.duration_seconds` \\- The time period, in seconds, during which requests from a client should be routed to the same target\\. After this time period expires, the application\\-based cookie is considered stale\\. The range is 1 second to 1 week \\(604800 seconds\\)\\. The default value is 1 day \\(86400 seconds\\)\\.\n+ `stickiness.lb_cookie.duration_seconds` \\- The time period, in seconds, during which requests from a client should be routed to the same target\\. After this time period expires, the load balancer\\-generated cookie is considered stale\\. The range is 1 second to 1 week \\(604800 seconds\\)\\. The default value is 1 day \\(86400 seconds\\)\\. \nThe following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function: \n+ `lambda.multi_value_headers.enabled` \\- Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings\\. The value is `true` or `false`\\. The default is `false`\\. If the value is `false` and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client\\.\nThe following attributes are supported only by Network Load Balancers: \n+ `deregistration_delay.connection_termination.enabled` \\- Indicates whether the load balancer terminates connections at the end of the deregistration timeout\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `preserve_client_ip.enabled` \\- Indicates whether client IP preservation is enabled\\. The value is `true` or `false`\\. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS\\. Otherwise, the default is enabled\\. Client IP preservation cannot be disabled for UDP and TCP\\_UDP target groups\\.\n+ `proxy_protocol_v2.enabled` \\- Indicates whether Proxy Protocol version 2 is enabled\\. The value is `true` or `false`\\. The default is `false`\\. \nThe following attributes are supported only by Gateway Load Balancers: \n+ `target_failover.on_deregistration` \\- Indicates how the Gateway Load Balancer handles existing flows when a target is deregistered\\. The possible values are `rebalance` and `no_rebalance`\\. The default is `no_rebalance`\\. The two attributes \\(`target_failover.on_deregistration` and `target_failover.on_unhealthy`\\) can't be set independently\\. The value you set for both attributes must be the same\\. \n+ `target_failover.on_unhealthy` \\- Indicates how the Gateway Load Balancer handles existing flows when a target is unhealthy\\. The possible values are `rebalance` and `no_rebalance`\\. The default is `no_rebalance`\\. The two attributes \\(`target_failover.on_deregistration` and `target_failover.on_unhealthy`\\) cannot be set independently\\. The value you set for both attributes must be the same\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Value": "The value of the attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Elasticsearch::Domain": { "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\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AdvancedSecurityOptions": "Specifies options for fine\\-grained access control\\. \n*Required*: No \n*Type*: [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AdvancedSecurityOptions": "Specifies options for fine\\-grained access control\\. \n*Required*: No \n*Type*: [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "CognitoOptions": "Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards\\. \n*Required*: No \n*Type*: [CognitoOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DomainEndpointOptions": "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*Required*: No \n*Type*: [DomainEndpointOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-domainendpointoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DomainName": "A name for the OpenSearch Service domain\\. For valid values, see the [DomainName](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname) data type in the *Amazon OpenSearch Service Developer Guide*\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DomainName": "A name for the OpenSearch Service domain\\. For valid values, see the [DomainName](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname) data type in the *Amazon OpenSearch Service Developer Guide*\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EBSOptions": "The configurations of Amazon Elastic Block Store \\(Amazon EBS\\) volumes that are attached to data nodes in the OpenSearch Service domain\\. For more information, see [EBS volume size limits](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide*\\. \n*Required*: No \n*Type*: [EBSOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-ebsoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ElasticsearchClusterConfig": "ElasticsearchClusterConfig is a property of the AWS::Elasticsearch::Domain resource that configures the cluster of an Amazon OpenSearch Service domain\\. \n*Required*: No \n*Type*: [ElasticsearchClusterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-elasticsearchclusterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ElasticsearchVersion": "The version of Elasticsearch to use, such as 2\\.3\\. If not specified, 1\\.5 is used as the default\\. For information about the versions that OpenSearch Service supports, see [Supported versions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide*\\. \nIf you set the [EnableVersionUpgrade](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain) update policy to `true`, you can update `ElasticsearchVersion` without interruption\\. When `EnableVersionUpgrade` is set to `false`, or is not specified, updating `ElasticsearchVersion` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", @@ -9948,29 +11016,30 @@ "VPCOptions": "The virtual private cloud \\(VPC\\) configuration for the OpenSearch Service domain\\. For more information, see [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer Guide*\\. \n*Required*: No \n*Type*: [VPCOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-vpcoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Elasticsearch::Domain AdvancedSecurityOptionsInput": { + "AnonymousAuthEnabled": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "True to enable fine\\-grained access control\\. You must also enable encryption of data at rest and node\\-to\\-node encryption\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InternalUserDatabaseEnabled": "True to enable the internal user database\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MasterUserOptions": "Specifies information about the master user\\. \n*Required*: No \n*Type*: [MasterUserOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-masteruseroptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Elasticsearch::Domain CognitoOptions": { "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)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IdentityPoolId": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RoleArn": "The `AmazonESCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UserPoolId": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "IdentityPoolId": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. Required if you enable Cognito authentication\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleArn": "The `AmazonESCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool\\. Required if you enable Cognito authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UserPoolId": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. Required if you enable Cognito authentication\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Elasticsearch::Domain ColdStorageOptions": { "Enabled": "Whether to enable or disable cold storage on the domain\\. You must enable UltraWarm storage in order to enable cold storage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Elasticsearch::Domain DomainEndpointOptions": { - "CustomEndpoint": "The fully qualified URL for your custom endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CustomEndpointCertificateArn": "The AWS Certificate Manager ARN for your domain's SSL/TLS certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomEndpoint": "The fully qualified URL for your custom endpoint\\. Required if you enabled a custom endpoint for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomEndpointCertificateArn": "The AWS Certificate Manager ARN for your domain's SSL/TLS certificate\\. Required if you enabled a custom endpoint for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomEndpointEnabled": "True to enable a custom endpoint for the domain\\. If enabled, you must also provide values for `CustomEndpoint` and `CustomEndpointCertificateArn`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnforceHTTPS": "True to require that all traffic to the domain arrive over HTTPS\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TLSSecurityPolicy": "The minimum TLS version required for traffic to the domain\\. Valid values are TLS 1\\.0 \\(default\\) or 1\\.2: \n+ `Policy-Min-TLS-1-0-2019-07`\n+ `Policy-Min-TLS-1-2-2019-07`\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Elasticsearch::Domain EBSOptions": { "EBSEnabled": "Specifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service domain\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Iops": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. This property applies only to the Provisioned IOPS \\(SSD\\) EBS volume type\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Iops": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. This property applies only to provisioned IOPS EBS volume types\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VolumeSize": "The size \\(in GiB\\) of the EBS volume for each data node\\. The minimum and maximum size of an EBS volume depends on the EBS volume type and the instance type to which it is attached\\. For more information, see [EBS volume size limits](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VolumeType": "The EBS volume type to use with the OpenSearch Service domain, such as standard, gp2, or io1\\. For more information about each type, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide for Linux Instances*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -9981,24 +11050,24 @@ "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)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InstanceCount": "The number of data nodes \\(instances\\) to use in the OpenSearch Service domain\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "WarmCount": "The number of warm nodes in the cluster\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WarmCount": "The number of warm nodes in the cluster\\. Required if you enable warm storage\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WarmEnabled": "Whether to enable warm storage for the cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "WarmType": "The instance type for the cluster's warm nodes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ZoneAwarenessConfig": "Specifies zone awareness configuration options\\. Only use if `ZoneAwarenessEnabled` is `true`\\. \n*Required*: No \n*Type*: [ZoneAwarenessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WarmType": "The instance type for the cluster's warm nodes\\. Required if you enable warm storage\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ZoneAwarenessConfig": "Specifies zone awareness configuration options\\. Only use if `ZoneAwarenessEnabled` is `true`\\. \n*Required*: Conditional \n*Type*: [ZoneAwarenessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Elasticsearch::Domain EncryptionAtRestOptions": { "Enabled": "Specify `true` to enable encryption at rest\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", - "KmsKeyId": "The KMS key ID\\. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "KmsKeyId": "The KMS key ID\\. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`\\. Required if you enable encryption at rest\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Elasticsearch::Domain LogPublishingOption": { - "CloudWatchLogsLogGroupArn": "Specifies the CloudWatch log group to publish to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CloudWatchLogsLogGroupArn": "Specifies the CloudWatch log group to publish to\\. Required if you enable log publishing for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "If `true`, enables the publishing of logs to CloudWatch\\. \nDefault: `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Elasticsearch::Domain MasterUserOptions": { - "MasterUserARN": "ARN for the master user\\. Only specify if `InternalUserDatabaseEnabled` is false in `AdvancedSecurityOptions`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MasterUserName": "Username for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MasterUserPassword": "Password for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "MasterUserARN": "ARN for the master user\\. Only specify if `InternalUserDatabaseEnabled` is false in `AdvancedSecurityOptions`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MasterUserName": "Username for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MasterUserPassword": "Password for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Elasticsearch::Domain NodeToNodeEncryptionOptions": { "Enabled": "Specifies whether node\\-to\\-node encryption is enabled, as a Boolean\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)" @@ -10008,7 +11077,7 @@ }, "AWS::Elasticsearch::Domain VPCOptions": { "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*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "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*\\. \nRequired if you're creating your domain inside a VPC\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Elasticsearch::Domain ZoneAwarenessConfig": { "AvailabilityZoneCount": "If you enabled multiple Availability Zones \\(AZs\\), the number of AZs that you want the domain to use\\. \nValid values are `2` and `3`\\. Default is 2\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -10161,7 +11230,7 @@ "RoleArn": "The Amazon Resource Name \\(ARN\\) of the role that is used for target invocation\\. \nIf you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a `RoleArn` with proper permissions in the `Target` structure, instead of here in this parameter\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1600` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ScheduleExpression": "The scheduling expression\\. For example, \"cron\\(0 20 \\* \\* ? \\*\\)\", \"rate\\(5 minutes\\)\"\\. For more information, see [Creating an Amazon EventBridge rule that runs on a schedule](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html)\\. \n*Required*: Conditional \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "State": "The state of the rule\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Targets": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule\\. \nTargets are the resources that are invoked when a rule is triggered\\. \nEach rule can have up to five \\(5\\) targets associated with it at one time\\.\nYou can configure the following as targets for Events: \n+ [API destination](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) \n+ [API Gateway](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html) \n+ Batch job queue\n+ CloudWatch group\n+ CodeBuild project\n+ CodePipeline\n+ EC2 `CreateSnapshot` API call\n+ EC2 Image Builder\n+ EC2 `RebootInstances` API call\n+ EC2 `StopInstances` API call\n+ EC2 `TerminateInstances` API call\n+ ECS task\n+ [Event bus in a different account or Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html) \n+ [Event bus in the same account and Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html) \n+ Firehose delivery stream\n+ Glue workflow\n+ [Incident Manager response plan](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge) \n+ Inspector assessment template\n+ Kinesis stream\n+ Lambda function\n+ Redshift cluster\n+ SageMaker Pipeline\n+ SNS topic\n+ SQS queue\n+ Step Functions state machine\n+ Systems Manager Automation\n+ Systems Manager OpsItem\n+ Systems Manager Run Command\nCreating rules with built\\-in targets is supported only in the AWS Management Console\\. The built\\-in targets are `EC2 CreateSnapshot API call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`, and `EC2 TerminateInstances API call`\\. \nFor some target types, `PutTargets` provides target\\-specific parameters\\. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument\\. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field\\. \nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions\\. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource\\-based policies\\. For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets`\\. For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide*\\. \nIf another AWS account is in the same region and has granted you permission \\(using `PutPermission`\\), you can send events to that account\\. Set that account's event bus as a target of the rules in your account\\. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets`\\. If your account sends events to another account, your account is charged for each sent event\\. Each event sent to another account is charged as a custom event\\. The account receiving the event is not charged\\. For more information, see [Amazon EventBridge Pricing](http://aws.amazon.com/eventbridge/pricing/)\\. \n `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account\\.\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure\\. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*\\. \nFor more information about enabling cross\\-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html)\\. \n **Input**, **InputPath**, and **InputTransformer** are mutually exclusive and optional parameters of a target\\. When a rule is triggered due to a matched event: \n+ If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format \\(unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target\\)\\.\n+ If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant\\.\n+ If **InputPath** is specified in the form of JSONPath \\(for example, `$.detail`\\), then only the part of the event specified in the path is passed to the target \\(for example, only the detail part of the event is passed\\)\\.\n+ If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target\\.\nWhen you specify `InputPath` or `InputTransformer`, you must use JSON dot notation, not bracket notation\\. \nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked\\. Allow a short period of time for changes to take effect\\. \nThis action can partially fail if too many requests are made at the same time\\. If that happens, `FailedEntryCount` is non\\-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code\\. \n*Required*: No \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Targets": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule\\. \nTargets are the resources that are invoked when a rule is triggered\\. \nThe maximum number of entries per request is 10\\. \nEach rule can have up to five \\(5\\) targets associated with it at one time\\.\nFor a list of services you can configure as targets for events, see [EventBridge targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html) in the *Amazon EventBridge User Guide*\\. \nCreating rules with built\\-in targets is supported only in the AWS Management Console\\. The built\\-in targets are: \n+ `Amazon EBS CreateSnapshot API call` \n+ `Amazon EC2 RebootInstances API call` \n+ `Amazon EC2 StopInstances API call` \n+ `Amazon EC2 TerminateInstances API call` \nFor some target types, `PutTargets` provides target\\-specific parameters\\. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument\\. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field\\. \nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions: \n+ For AWS Lambda and Amazon SNS resources, EventBridge relies on resource\\-based policies\\.\n+ For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets`\\.\nFor more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide*\\. \nIf another AWS account is in the same region and has granted you permission \\(using `PutPermission`\\), you can send events to that account\\. Set that account's event bus as a target of the rules in your account\\. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets`\\. If your account sends events to another account, your account is charged for each sent event\\. Each event sent to another account is charged as a custom event\\. The account receiving the event is not charged\\. For more information, see [Amazon EventBridge Pricing](http://aws.amazon.com/eventbridge/pricing/)\\. \n `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account\\.\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure\\. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*\\. \nFor more information about enabling cross\\-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html)\\. \n **Input**, **InputPath**, and **InputTransformer** are mutually exclusive and optional parameters of a target\\. When a rule is triggered due to a matched event: \n+ If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format \\(unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target\\)\\.\n+ If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant\\.\n+ If **InputPath** is specified in the form of JSONPath \\(for example, `$.detail`\\), then only the part of the event specified in the path is passed to the target \\(for example, only the detail part of the event is passed\\)\\.\n+ If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target\\.\nWhen you specify `InputPath` or `InputTransformer`, you must use JSON dot notation, not bracket notation\\. \nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked\\. Allow a short period of time for changes to take effect\\. \nThis action can partially fail if too many requests are made at the same time\\. If that happens, `FailedEntryCount` is non\\-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code\\. \n*Required*: No \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Events::Rule AwsVpcConfiguration": { "AssignPublicIp": "Specifies whether the task's elastic network interface receives a public IP address\\. You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -10285,14 +11354,17 @@ "OnlineAbConfig": "A structure that contains the configuration of which variation to use as the \"control\" version\\. The \"control\" version is used for comparison with other variations\\. This structure also specifies how much experiment traffic is allocated to each variation\\. \n*Required*: Yes \n*Type*: [OnlineAbConfigObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-onlineabconfigobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Project": "The name or the ARN of the project where this experiment is to be created\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RandomizationSalt": "When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served\\. This randomization ID is a combination of the entity ID and `randomizationSalt`\\. If you omit `randomizationSalt`, Evidently uses the experiment name as the `randomizationSalt`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RemoveSegment": "Set this to `true` to remove the segment that is associated with this experiment\\. You can't use this parameter if the experiment is currently running\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RunningStatus": "A structure that you can use to start and stop the experiment\\. \n*Required*: No \n*Type*: [RunningStatusObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SamplingRate": "The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent\\. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature\\. \nThis is represented in thousandths of a percent\\. For example, specify 10,000 to allocate 10% of the available audience\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Segment": "Specifies an audience *segment* to use in the experiment\\. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment\\. \nFor more information, see [ Segment rule pattern syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments-syntax.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Assigns one or more tags \\(key\\-value pairs\\) to the experiment\\. \nTags can help you organize and categorize your resources\\. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values\\. \nTags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters\\. \nYou can associate as many as 50 tags with an experiment\\. \nFor more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Treatments": "An array of structures that describe the configuration of each feature variation used in the experiment\\. \n*Required*: Yes \n*Type*: List of [TreatmentObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmentobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Evidently::Experiment MetricGoalObject": { "DesiredChange": "`INCREASE` means that a variation with a higher number for this metric is performing better\\. \n`DECREASE` means that a variation with a lower number for this metric is performing better\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EntityIdKey": "The entity, such as a user or session, that does an action that causes a metric value to be recorded\\. An example is `userDetails.userID`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EventPattern": "The EventBridge event pattern that defines how the metric is recorded\\. \nFor more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventPattern": "The EventBridge event pattern that defines how the metric is recorded\\. \nFor more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MetricName": "A name for the metric\\. It can include up to 255 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UnitLabel": "A label for the units that the metric is measuring\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ValueKey": "The JSON path to reference the numerical metric value in the event\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -10301,6 +11373,12 @@ "ControlTreatmentName": "The name of the variation that is to be the default variation that the other variations are compared to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TreatmentWeights": "A set of key\\-value pairs\\. The keys are treatment names, and the values are the portion of experiment traffic to be assigned to that treatment\\. Specify the traffic portion in thousandths of a percent, so 20,000 for a variation would allocate 20% of the experiment traffic to that variation\\. \n*Required*: No \n*Type*: List of [TreatmentToWeight](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-treatmenttoweight.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Evidently::Experiment RunningStatusObject": { + "AnalysisCompleteTime": "If you are using AWS CloudFormation to start the experiment, use this field to specify when the experiment is to end\\. The format is as a UNIX timestamp\\. For more information about this format, see [The Current Epoch Unix Timestamp](https://www.unixtimestamp.com/index.php)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DesiredState": "If you are using AWS CloudFormation to stop this experiment, specify either `COMPLETED` or `CANCELLED` here to indicate how to classify this experiment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Reason": "If you are using AWS CloudFormation to stop this experiment, this is an optional field that you can use to record why the experiment is being stopped or cancelled\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "To start the experiment now, specify `START` for this parameter\\. If this experiment is currently running and you want to stop it now, specify `STOP`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Evidently::Experiment TreatmentObject": { "Description": "The description of the treatment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Feature": "The name of the feature for this experiment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -10330,10 +11408,11 @@ "DoubleValue": "The value assigned to this variation, if the variation type is a double\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LongValue": "The value assigned to this variation, if the variation type is a long\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StringValue": "The value assigned to this variation, if the variation type is a string\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VariationName": "A name for the variation\\. It can include up to 127 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "VariationName": "A name for the variation\\. It can include up to 127 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Evidently::Launch": { "Description": "An optional description for the launch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExecutionStatus": "A structure that you can use to start and stop the launch\\. \n*Required*: No \n*Type*: [ExecutionStatusObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Groups": "An array of structures that contains the feature and variations that are to be used for the launch\\. You can up to five launch groups in a launch\\. \n*Required*: Yes \n*Type*: List of [LaunchGroupObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-launchgroupobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MetricMonitors": "An array of structures that define the metrics that will be used to monitor the launch performance\\. You can have up to three metric monitors in the array\\. \n*Required*: No \n*Type*: List of [MetricDefinitionObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name for the launch\\. It can include up to 127 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -10342,6 +11421,11 @@ "ScheduledSplitsConfig": "An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch\\. \n*Required*: Yes \n*Type*: List of [StepConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-stepconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Assigns one or more tags \\(key\\-value pairs\\) to the launch\\. \nTags can help you organize and categorize your resources\\. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values\\. \nTags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters\\. \nYou can associate as many as 50 tags with a launch\\. \nFor more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Evidently::Launch ExecutionStatusObject": { + "DesiredState": "If you are using AWS CloudFormation to stop this launch, specify either `COMPLETED` or `CANCELLED` here to indicate how to classify this experiment\\. If you omit this parameter, the default of `COMPLETED` is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Reason": "If you are using AWS CloudFormation to stop this launch, this is an optional field that you can use to record why the launch is being stopped or cancelled\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "To start the launch now, specify `START` for this parameter\\. If this launch is currently running and you want to stop it now, specify `STOP`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Evidently::Launch GroupToWeight": { "GroupName": "The name of the launch group\\. It can include up to 127 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SplitWeight": "The portion of launch traffic to allocate to this launch group\\. \nThis is represented in thousandths of a percent\\. For example, specify 20,000 to allocate 20% of the launch audience to this launch group\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -10354,21 +11438,32 @@ }, "AWS::Evidently::Launch MetricDefinitionObject": { "EntityIdKey": "The entity, such as a user or session, that does an action that causes a metric value to be recorded\\. An example is `userDetails.userID`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EventPattern": "The EventBridge event pattern that defines how the metric is recorded\\. \nFor more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventPattern": "The EventBridge event pattern that defines how the metric is recorded\\. \nFor more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MetricName": "A name for the metric\\. It can include up to 255 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UnitLabel": "A label for the units that the metric is measuring\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ValueKey": "The value that is tracked to produce the metric\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Evidently::Launch SegmentOverride": { + "EvaluationOrder": "A number indicating the order to use to evaluate segment overrides, if there are more than one\\. Segment overrides with lower numbers are evaluated first\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Segment": "The ARN of the segment to use for this override\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Weights": "The traffic allocation percentages among the feature variations to assign to this segment\\. This is a set of key\\-value pairs\\. The keys are variation names\\. The values represent the amount of traffic to allocate to that variation for this segment\\. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic\\. \n*Required*: Yes \n*Type*: List of [GroupToWeight](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-grouptoweight.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Evidently::Launch StepConfig": { "GroupWeights": "An array of structures that define how much launch traffic to allocate to each launch group during this step of the launch\\. \n*Required*: Yes \n*Type*: List of [GroupToWeight](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-grouptoweight.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SegmentOverrides": "An array of structures that you can use to specify different traffic splits for one or more audience *segments*\\. A segment is a portion of your audience that share one or more characteristics\\. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age\\. \nFor more information, see [ Use segments to focus your audience](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html)\\. \n*Required*: No \n*Type*: List of [SegmentOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StartTime": "The date and time to start this step of the launch\\. Use UTC format, `yyyy-MM-ddTHH:mm:ssZ`\\. For example, `2025-11-25T23:59:59Z` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Evidently::Project": { + "AppConfigResource": "Use this parameter if the project will use *client\\-side evaluation powered by AWS AppConfig*\\. Client\\-side evaluation allows your application to assign variations to user sessions locally instead of by calling the [EvaluateFeature](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) operation\\. This mitigates the latency and availability risks that come with an API call\\. For more information, see [ Use client\\-side evaluation \\- powered by AWS AppConfig\\.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-client-side-evaluation.html) \nThis parameter is a structure that contains information about the AWS AppConfig application that will be used as for client\\-side evaluation\\. \nTo create a project that uses client\\-side evaluation, you must have the `evidently:ExportProjectAsConfiguration` permission\\. \n*Required*: No \n*Type*: [AppConfigResourceObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-appconfigresourceobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DataDelivery": "A structure that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so\\. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view\\. \nYou can't specify both `CloudWatchLogs` and `S3Destination` in the same operation\\. \n*Required*: No \n*Type*: [DataDeliveryObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-datadeliveryobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "An optional description of the project\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name for the project\\. It can include up to 127 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Assigns one or more tags \\(key\\-value pairs\\) to the project\\. \nTags can help you organize and categorize your resources\\. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values\\. \nTags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters\\. \nYou can associate as many as 50 tags with a project\\. \nFor more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Evidently::Project AppConfigResourceObject": { + "ApplicationId": "The ID of the AWS AppConfig application to use for client\\-side evaluation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnvironmentId": "The ID of the AWS AppConfig environment to use for client\\-side evaluation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Evidently::Project DataDeliveryObject": { "LogGroup": "If the project stores evaluation events in CloudWatch Logs, this structure stores the log group name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3": "If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix\\. \n*Required*: No \n*Type*: [S3Destination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-s3destination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -10377,6 +11472,12 @@ "BucketName": "The name of the bucket in which Evidently stores evaluation events\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Prefix": "The bucket prefix in which Evidently stores evaluation events\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Evidently::Segment": { + "Description": "An optional description for this segment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "A name for the segment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Pattern": "The pattern to use for the segment\\. For more information about pattern syntax, see [ Segment rule pattern syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments-syntax.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Assigns one or more tags \\(key\\-value pairs\\) to the feature\\. \nTags can help you organize and categorize your resources\\. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values\\. \nTags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters\\. \nYou can associate as many as 50 tags with a feature\\. \nFor more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::FIS::ExperimentTemplate": { "Actions": "The actions for the experiment\\. \n*Required*: No \n*Type*: Map of [ExperimentTemplateAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplateaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description for the experiment template\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\s\\S]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -10386,6 +11487,9 @@ "Tags": "The tags to apply to the experiment template\\. \n*Required*: Yes \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Targets": "The targets for the experiment\\. \n*Required*: Yes \n*Type*: Map of [ExperimentTemplateTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-experimenttemplatetarget.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::FIS::ExperimentTemplate CloudWatchLogsConfiguration": { + "LogGroupArn": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::FIS::ExperimentTemplate ExperimentTemplateAction": { "ActionId": "The ID of the action\\. The format of the action ID is: aws:*service\\-name*:*action\\-type*\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `[\\S]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description for the action\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\s\\S]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -10394,9 +11498,9 @@ "Targets": "The targets for the action\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::FIS::ExperimentTemplate ExperimentTemplateLogConfiguration": { - "CloudWatchLogsConfiguration": "The configuration for experiment logging to Amazon CloudWatch Logs\\. The supported field is `logGroupArn`\\. For example: \n`{\"logGroupArn\": \"aws:arn:logs:region_name:account_id:log-group:log_group_name\"}` \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CloudWatchLogsConfiguration": "The configuration for experiment logging to Amazon CloudWatch Logs\\. The supported field is `LogGroupArn`\\. For example: \n`{\"LogGroupArn\": \"aws:arn:logs:region_name:account_id:log-group:log_group_name\"}` \n*Required*: No \n*Type*: [CloudWatchLogsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-cloudwatchlogsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LogSchemaVersion": "The schema version\\. The supported value is 1\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3Configuration": "The configuration for experiment logging to Amazon S3\\. The following fields are supported: \n+ `bucketName` \\- The name of the destination bucket\\.\n+ `prefix` \\- An optional bucket prefix\\.\nFor example: \n`{\"bucketName\": \"my-s3-bucket\", \"prefix\": \"log-folder\"}` \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "S3Configuration": "The configuration for experiment logging to Amazon S3\\. The following fields are supported: \n+ `bucketName` \\- The name of the destination bucket\\.\n+ `prefix` \\- An optional bucket prefix\\.\nFor example: \n`{\"BucketName\": \"my-s3-bucket\", \"Prefix\": \"log-folder\"}` \n*Required*: No \n*Type*: [S3Configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-s3configuration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::FIS::ExperimentTemplate ExperimentTemplateStopCondition": { "Source": "The source for the stop condition\\. Specify `aws:cloudwatch:alarm` if the stop condition is defined by a CloudWatch alarm\\. Specify `none` if there is no stop condition\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `64` \n*Pattern*: `[\\S]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -10414,6 +11518,10 @@ "Path": "The attribute path for the filter\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[\\S]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Values": "The attribute values for the filter\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::FIS::ExperimentTemplate S3Configuration": { + "BucketName": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Prefix": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::FMS::NotificationChannel": { "SnsRoleName": "The Amazon Resource Name \\(ARN\\) of the IAM role that allows Amazon SNS to record AWS Firewall Manager activity\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SnsTopicArn": "The Amazon Resource Name \\(ARN\\) of the SNS topic that collects notifications from AWS Firewall Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -10423,10 +11531,12 @@ "ExcludeMap": "Specifies the AWS account IDs and AWS Organizations organizational units \\(OUs\\) to exclude from the policy\\. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time\\. \nYou can specify inclusions or exclusions, but not both\\. If you specify an `IncludeMap`, AWS Firewall Manager applies the policy to all accounts specified by the `IncludeMap`, and does not evaluate any `ExcludeMap` specifications\\. If you do not specify an `IncludeMap`, then Firewall Manager applies the policy to all accounts except for those specified by the `ExcludeMap`\\. \nYou can specify account IDs, OUs, or a combination: \n+ Specify account IDs by setting the key to `ACCOUNT`\\. For example, the following is a valid map: `{\u201cACCOUNT\u201d : [\u201caccountID1\u201d, \u201caccountID2\u201d]}`\\.\n+ Specify OUs by setting the key to `ORGUNIT`\\. For example, the following is a valid map: `{\u201cORGUNIT\u201d : [\u201couid111\u201d, \u201couid112\u201d]}`\\.\n+ Specify accounts and OUs together in a single map, separated with a comma\\. For example, the following is a valid map: `{\u201cACCOUNT\u201d : [\u201caccountID1\u201d, \u201caccountID2\u201d], \u201cORGUNIT\u201d : [\u201couid111\u201d, \u201couid112\u201d]}`\\.\n*Required*: No \n*Type*: [IEMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-iemap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExcludeResourceTags": "Used only when tags are specified in the `ResourceTags` property\\. If this property is `True`, resources with the specified tags are not in scope of the policy\\. If it's `False`, only resources with the specified tags are in scope of the policy\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeMap": "Specifies the AWS account IDs and AWS Organizations organizational units \\(OUs\\) to include in the policy\\. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time\\. \nYou can specify inclusions or exclusions, but not both\\. If you specify an `IncludeMap`, AWS Firewall Manager applies the policy to all accounts specified by the `IncludeMap`, and does not evaluate any `ExcludeMap` specifications\\. If you do not specify an `IncludeMap`, then Firewall Manager applies the policy to all accounts except for those specified by the `ExcludeMap`\\. \nYou can specify account IDs, OUs, or a combination: \n+ Specify account IDs by setting the key to `ACCOUNT`\\. For example, the following is a valid map: `{\u201cACCOUNT\u201d : [\u201caccountID1\u201d, \u201caccountID2\u201d]}`\\.\n+ Specify OUs by setting the key to `ORGUNIT`\\. For example, the following is a valid map: `{\u201cORGUNIT\u201d : [\u201couid111\u201d, \u201couid112\u201d]}`\\.\n+ Specify accounts and OUs together in a single map, separated with a comma\\. For example, the following is a valid map: `{\u201cACCOUNT\u201d : [\u201caccountID1\u201d, \u201caccountID2\u201d], \u201cORGUNIT\u201d : [\u201couid111\u201d, \u201couid112\u201d]}`\\.\n*Required*: No \n*Type*: [IEMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-iemap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PolicyDescription": "The definition of the AWS Network Firewall firewall policy\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PolicyName": "The name of the AWS Firewall Manager policy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RemediationEnabled": "Indicates if the policy should be automatically applied to new resources\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceSetIds": "The unique identifiers of the resource sets used by the policy\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResourceTags": "An array of `ResourceTag` objects, used to explicitly include resources in the policy scope or explicitly exclude them\\. If this isn't set, then tags aren't used to modify policy scope\\. See also `ExcludeResourceTags`\\. \n*Required*: No \n*Type*: List of [ResourceTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-resourcetag.html) \n*Maximum*: `8` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResourceType": "The type of resource protected by or in scope of the policy\\. This is in the format shown in the [AWS Resource Types Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)\\. To apply this policy to multiple resource types, specify a resource type of `ResourceTypeList` and then specify the resource types in a `ResourceTypeList`\\. \nFor AWS WAF and Shield Advanced, example resource types include `AWS::ElasticLoadBalancingV2::LoadBalancer` and `AWS::CloudFront::Distribution`\\. For a security group common policy, valid values are `AWS::EC2::NetworkInterface` and `AWS::EC2::Instance`\\. For a security group content audit policy, valid values are `AWS::EC2::SecurityGroup`, `AWS::EC2::NetworkInterface`, and `AWS::EC2::Instance`\\. For a security group usage audit policy, the value is `AWS::EC2::SecurityGroup`\\. For an AWS Network Firewall policy or DNS Firewall policy, the value is `AWS::EC2::VPC`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceType": "The type of resource protected by or in scope of the policy\\. This is in the format shown in the [AWS Resource Types Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)\\. To apply this policy to multiple resource types, specify a resource type of `ResourceTypeList` and then specify the resource types in a `ResourceTypeList`\\. \nFor AWS WAF and Shield Advanced, example resource types include `AWS::ElasticLoadBalancingV2::LoadBalancer` and `AWS::CloudFront::Distribution`\\. For a security group common policy, valid values are `AWS::EC2::NetworkInterface` and `AWS::EC2::Instance`\\. For a security group content audit policy, valid values are `AWS::EC2::SecurityGroup`, `AWS::EC2::NetworkInterface`, and `AWS::EC2::Instance`\\. For a security group usage audit policy, the value is `AWS::EC2::SecurityGroup`\\. For an AWS Network Firewall policy or DNS Firewall policy, the value is `AWS::EC2::VPC`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResourceTypeList": "An array of `ResourceType` objects\\. Use this only to specify multiple resource types\\. To specify a single resource type, use `ResourceType`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResourcesCleanUp": "Indicates whether AWS Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope\\. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope\\. \nBy default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources\\. \nThis option is not available for Shield Advanced or AWS WAF Classic policies\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityServicePolicyData": "Details about the security service that is being used to protect the resources\\. \nThis contains the following settings: \n+ Type \\- Indicates the service type that the policy uses to protect the resource\\. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy\\. This is an adjustable limit that you can increase by contacting AWS Support\\.", @@ -10436,6 +11546,13 @@ "ACCOUNT": "The account list for the map\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ORGUNIT": "The organizational unit list for the map\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::FMS::Policy NetworkFirewallPolicy": { + "FirewallDeploymentModel": "Defines the deployment model to use for the firewall policy\\. To use a distributed model, set [PolicyOption](https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) to `NULL`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CENTRALIZED | DISTRIBUTED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FMS::Policy PolicyOption": { + "NetworkFirewallPolicy": "Defines the deployment model to use for the firewall policy\\. \n*Required*: No \n*Type*: [NetworkFirewallPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ThirdPartyFirewallPolicy": "Defines the policy options for a third\\-party firewall policy\\. \n*Required*: No \n*Type*: [ThirdPartyFirewallPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-thirdpartyfirewallpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::FMS::Policy PolicyTag": { "Key": "Part of the key:value pair that defines a tag\\. You can use a tag key to describe a category of information, such as \"customer\\.\" Tag keys are case\\-sensitive\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Value": "Part of the key:value pair that defines a tag\\. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB\\.\" Tag values are case\\-sensitive\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -10444,19 +11561,46 @@ "Key": "The resource tag key\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Value": "The resource tag value\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::FMS::Policy SecurityServicePolicyData": { + "ManagedServiceData": "Details about the service that are specific to the service type, in JSON format\\. \n+ Example: `DNS_FIREWALL`", + "PolicyOption": "Contains the Network Firewall firewall policy options to configure a centralized deployment model\\. \n*Required*: No \n*Type*: [PolicyOption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-policyoption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The service that the policy is using to protect the resources\\. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy\\. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy\\. This is an adjustable limit that you can increase by contacting AWS Support\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DNS_FIREWALL | IMPORT_NETWORK_FIREWALL | NETWORK_FIREWALL | SECURITY_GROUPS_COMMON | SECURITY_GROUPS_CONTENT_AUDIT | SECURITY_GROUPS_USAGE_AUDIT | SHIELD_ADVANCED | THIRD_PARTY_FIREWALL | WAF | WAFV2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FMS::Policy ThirdPartyFirewallPolicy": { + "FirewallDeploymentModel": "Defines the deployment model to use for the third\\-party firewall policy\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CENTRALIZED | DISTRIBUTED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FSx::DataRepositoryAssociation": { + "BatchImportMetaDataOnCreate": "A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created\\. The task runs if this flag is set to `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DataRepositoryPath": "The path to the Amazon S3 data repository that will be linked to the file system\\. The path can be an S3 bucket or prefix in the format `s3://myBucket/myPrefix/`\\. This path specifies where in the S3 data repository files will be imported from or exported to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FileSystemId": "The ID of the file system on which the data repository association is configured\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FileSystemPath": "A path on the Amazon FSx for Lustre file system that points to a high\\-level directory \\(such as `/ns1/`\\) or subdirectory \\(such as `/ns1/subdir/`\\) that will be mapped 1\\-1 with `DataRepositoryPath`\\. The leading forward slash in the name is required\\. Two data repository associations cannot have overlapping file system paths\\. For example, if a data repository is associated with file system path `/ns1/`, then you cannot link another data repository with file system path `/ns1/ns2`\\. \nThis path specifies where in your file system files will be exported from or imported to\\. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory\\. \nIf you specify only a forward slash \\(`/`\\) as the file system path, you can link only one data repository to the file system\\. You can only specify \"/\" as the file system path for the first data repository associated with a file system\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4096` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,4096}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ImportedFileChunkSize": "For files imported from a data repository, this value determines the stripe count and maximum amount of data per file \\(in MiB\\) stored on a single physical disk\\. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache\\. \nThe default chunk size is 1,024 MiB \\(1 GiB\\) and can go as high as 512,000 MiB \\(500 GiB\\)\\. Amazon S3 objects have a maximum size of 5 TB\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `512000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3": "The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association\\. The configuration defines which file events \\(new, changed, or deleted files or directories\\) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository\\. \n*Required*: No \n*Type*: [S3](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-s3.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FSx::DataRepositoryAssociation AutoExportPolicy": { + "Events": "The `AutoExportPolicy` can have the following event values: \n+ `NEW` \\- New files and directories are automatically exported to the data repository as they are added to the file system\\.\n+ `CHANGED` \\- Changes to files and directories on the file system are automatically exported to the data repository\\.\n+ `DELETED` \\- Files and directories are automatically deleted on the data repository when they are deleted on the file system\\.\nYou can define any combination of event types for your `AutoExportPolicy`\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FSx::DataRepositoryAssociation AutoImportPolicy": { + "Events": "The `AutoImportPolicy` can have the following event values: \n+ `NEW` \\- Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system\\.\n+ `CHANGED` \\- Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository\\.\n+ `DELETED` \\- Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository\\.\nYou can define any combination of event types for your `AutoImportPolicy`\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FSx::DataRepositoryAssociation S3": { + "AutoExportPolicy": "Describes a data repository association's automatic export policy\\. The `AutoExportPolicy` defines the types of updated objects on the file system that will be automatically exported to the data repository\\. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file\\. \nThis `AutoExportPolicy` is supported only for Amazon FSx for Lustre file systems with the `Persistent_2` deployment type\\. \n*Required*: No \n*Type*: [AutoExportPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoexportpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AutoImportPolicy": "Describes the data repository association's automatic import policy\\. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket\\. \nThe `AutoImportPolicy` is supported only for Amazon FSx for Lustre file systems with the `Persistent_2` deployment type\\. \n*Required*: No \n*Type*: [AutoImportPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoimportpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::FSx::FileSystem": { - "BackupId": "The ID of the source backup\\. Specifies the backup that you are copying\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "BackupId": "The ID of the file system backup that you are using to create a file system\\. For more information, see [CreateFileSystemFromBackup](https://docs.aws.amazon.com/fsx/latest/APIReference/API_CreateFileSystemFromBackup.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FileSystemType": "The type of Amazon FSx file system, which can be `LUSTRE`, `WINDOWS`, `ONTAP`, or `OPENZFS`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FileSystemTypeVersion": "\\(Optional\\) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating\\. Valid values are `2.10` and `2.12`: \n+ 2\\.10 is supported by the Scratch and Persistent\\_1 Lustre deployment types\\.\n+ 2\\.12 is supported by all Lustre deployment types\\. `2.12` is required when setting FSx for Lustre `DeploymentType` to `PERSISTENT_2`\\.\nDefault value = `2.10`, except when `DeploymentType` is set to `PERSISTENT_2`, then the default is `2.12`\\. \nIf you set `FileSystemTypeVersion` to `2.10` for a `PERSISTENT_2` Lustre deployment type, the `CreateFileSystem` operation fails\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `20` \n*Pattern*: `^[0-9](.[0-9]*)*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "KmsKeyId": "The ID of the AWS Key Management Service \\(AWS KMS\\) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and `PERSISTENT` Amazon FSx for Lustre file systems at rest\\. If this ID isn't specified, the Amazon FSx\\-managed key for your account is used\\. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using the Amazon FSx\\-managed key for your account\\. For more information, see [Encrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) in the * AWS Key Management Service API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "LustreConfiguration": "The Lustre configuration for the file system being created\\. \nThe following parameters are not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation` to create a data repository association to link your Lustre file system to a data repository\\. \n+ `AutoImportPolicy` \n+ `ExportPath` \n+ `ImportedChunkSize` \n+ `ImportPath` \n*Required*: No \n*Type*: [LustreConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsKeyId": "The ID of the AWS Key Management Service \\(AWS KMS\\) key used to encrypt Amazon FSx file system data\\. Used as follows with Amazon FSx file system types: \n+ Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment types only\\.", + "LustreConfiguration": "The Lustre configuration for the file system being created\\. \nThe following parameters are not supported for file systems with the Lustre `Persistent_2` deployment type\\. \n+ `AutoImportPolicy` \n+ `ExportPath` \n+ `ImportedChunkSize` \n+ `ImportPath` \n*Required*: Conditional \n*Type*: [LustreConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OntapConfiguration": "The ONTAP configuration properties of the FSx for ONTAP file system that you are creating\\. \n*Required*: No \n*Type*: [OntapConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OpenZFSConfiguration": "The Amazon FSx for OpenZFS configuration properties for the file system that you are creating\\. \n*Required*: No \n*Type*: [OpenZFSConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityGroupIds": "A list of IDs specifying the security groups to apply to all network interfaces created for file system access\\. This list isn't returned in later requests to describe the file system\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StorageCapacity": "Sets the storage capacity of the file system that you're creating\\. `StorageCapacity` is required if you are creating a new file system\\. Do not include `StorageCapacity` if you are creating a file system from a backup\\. \nFor Lustre file systems: \n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StorageType": "Sets the storage type for the file system that you're creating\\. Valid values are `SSD` and `HDD`\\. \n+ Set to `SSD` to use solid state drive storage\\. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types\\.\n+ Set to `HDD` to use hard disk drive storage\\. HDD is supported on `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types, and on `PERSISTENT` Lustre file system deployment types\\. \nDefault value is `SSD`\\. For more information, see [ Storage type options](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options) in the *FSx for Windows File Server User Guide* and [Multiple storage options](https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options) in the *FSx for Lustre User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HDD | SSD` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StorageCapacity": "Sets the storage capacity of the file system that you're creating\\. `StorageCapacity` is required if you are creating a new file system\\. \n**FSx for Lustre file systems** \\- The amount of storage capacity that you can configure depends on the value that you set for `StorageType` and the Lustre `DeploymentType`, as follows: \n+ For `SCRATCH_2`, `PERSISTENT_2` and `PERSISTENT_1` deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB\\.\n+ For `PERSISTENT_1` HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems\\.\n+ For `SCRATCH_1` deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB\\.\n**FSx for ONTAP file systems** \\- The amount of storage capacity that you can configure is from 1024 GiB up to 196,608 GiB \\(192 TiB\\)\\. \n**FSx for OpenZFS file systems** \\- The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB \\(512 TiB\\)\\. If you are creating a file system from a backup, you can specify a storage capacity equal to or greater than the original file system's storage capacity\\. \n**FSx for Windows File Server file systems** \\- The amount of storage capacity that you can configure depends on the value that you set for `StorageType` as follows: \n+ For SSD storage, valid values are 32 GiB\\-65,536 GiB \\(64 TiB\\)\\.\n+ For HDD storage, valid values are 2000 GiB\\-65,536 GiB \\(64 TiB\\)\\.\n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StorageType": "Sets the storage type for the file system that you're creating\\. Valid values are `SSD` and `HDD`\\. \n+ Set to `SSD` to use solid state drive storage\\. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types\\.\n+ Set to `HDD` to use hard disk drive storage\\. HDD is supported on `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types, and on `PERSISTENT_1` Lustre file system deployment types\\. \nDefault value is `SSD`\\. For more information, see [ Storage type options](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options) in the *FSx for Windows File Server User Guide* and [Multiple storage options](https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options) in the *FSx for Lustre User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HDD | SSD` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SubnetIds": "Specifies the IDs of the subnets that the file system will be accessible from\\. For Windows and ONTAP `MULTI_AZ_1` deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server\\. You specify one of these subnets as the preferred subnet using the `WindowsConfiguration > PreferredSubnetID` or `OntapConfiguration > PreferredSubnetID` properties\\. For more information about Multi\\-AZ file system configuration, see [ Availability and durability: Single\\-AZ and Multi\\-AZ file systems](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html) in the *Amazon FSx for Windows User Guide* and [ Availability and durability](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html) in the *Amazon FSx for ONTAP User Guide*\\. \nFor Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` and all Lustre deployment types, provide exactly one subnet ID\\. The file server is launched in that subnet's Availability Zone\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "The tags to associate with the file system\\. For more information, see [Tagging your Amazon EC2 resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the *Amazon EC2 User Guide*\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WindowsConfiguration": "The configuration object for the Microsoft Windows file system you are creating\\. This value is required if `FileSystemType` is set to `WINDOWS`\\. \n*Required*: Conditional \n*Type*: [WindowsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::FSx::FileSystem AuditLogConfiguration": { @@ -10473,18 +11617,18 @@ "Mode": "Specifies whether the number of IOPS for the file system is using the system default \\(`AUTOMATIC`\\) or was provisioned by the customer \\(`USER_PROVISIONED`\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | USER_PROVISIONED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::FSx::FileSystem LustreConfiguration": { - "AutoImportPolicy": "\\(Optional\\) Available with `Scratch` and `Persistent_1` deployment types\\. When you create your file system, your existing S3 objects appear as file and directory listings\\. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket\\. `AutoImportPolicy` can have the following values: \n+ `NONE` \\- \\(Default\\) AutoImport is off\\. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created\\. FSx does not update file and directory listings for any new or changed objects after choosing this option\\.\n+ `NEW` \\- AutoImport is on\\. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system\\. \n+ `NEW_CHANGED` \\- AutoImport is on\\. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option\\.\n+ `NEW_CHANGED_DELETED` \\- AutoImport is on\\. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket\\.\nFor more information, see [ Automatically import updates from your S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html)\\. \nThis parameter is not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation` to create a data repository association to link your Lustre file system to a data repository\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `NEW | NEW_CHANGED | NEW_CHANGED_DELETED | NONE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AutomaticBackupRetentionDays": "The number of days to retain automatic backups\\. Setting this to 0 disables automatic backups\\. You can retain automatic backups for a maximum of 90 days\\. The default is 0\\. Only valid for use with `PERSISTENT_1` deployment types\\. For more information, see [Working with backups](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html) in the *Amazon FSx for Lustre User Guide*\\. \\(Default = 0\\) \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `90` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AutoImportPolicy": "\\(Optional\\) Available with `Scratch` and `Persistent_1` deployment types\\. When you create your file system, your existing S3 objects appear as file and directory listings\\. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket\\. `AutoImportPolicy` can have the following values: \n+ `NONE` \\- \\(Default\\) AutoImport is off\\. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created\\. FSx does not update file and directory listings for any new or changed objects after choosing this option\\.\n+ `NEW` \\- AutoImport is on\\. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system\\. \n+ `NEW_CHANGED` \\- AutoImport is on\\. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option\\.\n+ `NEW_CHANGED_DELETED` \\- AutoImport is on\\. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket\\.\nFor more information, see [ Automatically import updates from your S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html)\\. \nThis parameter is not supported for Lustre file systems using the `Persistent_2` deployment type\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `NEW | NEW_CHANGED | NEW_CHANGED_DELETED | NONE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AutomaticBackupRetentionDays": "The number of days to retain automatic backups\\. Setting this property to `0` disables automatic backups\\. You can retain automatic backups for a maximum of 90 days\\. The default is `0`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CopyTagsToBackups": "A Boolean flag indicating whether tags for the file system should be copied to backups\\. This value defaults to false\\. If it's set to true, all tags for the file system are copied to all automatic and user\\-initiated backups where the user doesn't specify tags\\. If this value is true, and you specify one or more tags, only the specified tags are copied to backups\\. If you specify one or more tags when creating a user\\-initiated backup, no tags are copied from the file system, regardless of this value\\. Only valid for use with `PERSISTENT_1` deployment types\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DailyAutomaticBackupStartTime": "A recurring daily time, in the format` HH:MM`\\. `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. For example, `05:00` specifies 5 AM daily\\. Only valid for use with `PERSISTENT_1` deployment types\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DailyAutomaticBackupStartTime": "A recurring daily time, in the format `HH:MM`\\. `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. For example, `05:00` specifies 5 AM daily\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DataCompressionType": "Sets the data compression configuration for the file system\\. `DataCompressionType` can have the following values: \n+ `NONE` \\- \\(Default\\) Data compression is turned off when the file system is created\\.\n+ `LZ4` \\- Data compression is turned on with the LZ4 algorithm\\.\nFor more information, see [Lustre data compression](https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html) in the *Amazon FSx for Lustre User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `LZ4 | NONE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeploymentType": "\\(Optional\\) Choose `SCRATCH_1` and `SCRATCH_2` deployment types when you need temporary storage and shorter\\-term processing of data\\. The `SCRATCH_2` deployment type provides in\\-transit encryption of data and higher burst throughput capacity than `SCRATCH_1`\\. \nChoose `PERSISTENT_1` for longer\\-term storage and for throughput\\-focused workloads that aren\u2019t latency\\-sensitive\\. `PERSISTENT_1` supports encryption of data in transit, and is available in all AWS Regions in which FSx for Lustre is available\\. \nChoose `PERSISTENT_2` for longer\\-term storage and for latency\\-sensitive workloads that require the highest levels of IOPS/throughput\\. `PERSISTENT_2` supports SSD storage, and offers higher `PerUnitStorageThroughput` \\(up to 1000 MB/s/TiB\\)\\. `PERSISTENT_2` is available in a limited number of AWS Regions\\. For more information, and an up\\-to\\-date list of AWS Regions in which `PERSISTENT_2` is available, see [File system deployment options for FSx for Lustre](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types) in the *Amazon FSx for Lustre User Guide*\\. \nIf you choose `PERSISTENT_2`, and you set `FileSystemTypeVersion` to `2.10`, the `CreateFileSystem` operation fails\\.\nEncryption of data in transit is automatically turned on when you access `SCRATCH_2`, `PERSISTENT_1` and `PERSISTENT_2` file systems from Amazon EC2 instances that [support automatic encryption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data- protection.html) in the AWS Regions where they are available\\. For more information about encryption in transit for FSx for Lustre file systems, see [Encrypting data in transit](https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html) in the *Amazon FSx for Lustre User Guide*\\. \n\\(Default = `SCRATCH_1`\\) \n*Required*: No \n*Type*: String \n*Allowed values*: `PERSISTENT_1 | PERSISTENT_2 | SCRATCH_1 | SCRATCH_2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DriveCacheType": "The type of drive cache used by `PERSISTENT_1` file systems that are provisioned with HDD storage devices\\. This parameter is required when storage type is HDD\\. Set this property to `READ` to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system\\. \nThis parameter is required when `StorageType` is set to `HDD`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | READ` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ExportPath": "\\(Optional\\) Available with `Scratch` and `Persistent_1` deployment types\\. Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported\\. The path must use the same Amazon S3 bucket as specified in ImportPath\\. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system\\. If an `ExportPath` value is not provided, Amazon FSx sets a default export path, `s3://import-bucket/FSxLustre[creation-timestamp]`\\. The timestamp is in UTC format, for example `s3://import-bucket/FSxLustre20181105T222312Z`\\. \nThe Amazon S3 export bucket must be the same as the import bucket specified by `ImportPath`\\. If you specify only a bucket name, such as `s3://import-bucket`, you get a 1:1 mapping of file system objects to S3 bucket objects\\. This mapping means that the input data in S3 is overwritten on export\\. If you provide a custom prefix in the export path, such as `s3://import-bucket/[custom-optional-prefix]`, Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket\\. \nThis parameter is not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation` to create a data repository association to link your Lustre file system to a data repository\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ImportPath": "\\(Optional\\) The path to the Amazon S3 bucket \\(including the optional prefix\\) that you're using as the data repository for your Amazon FSx for Lustre file system\\. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select\\. An example is `s3://import-bucket/optional-prefix`\\. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system\\. \nThis parameter is not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation`to create a data repository association to link your Lustre file system to a data repository\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ImportedFileChunkSize": "\\(Optional\\) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file \\(in MiB\\) stored on a single physical disk\\. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system\\. \nThe default chunk size is 1,024 MiB \\(1 GiB\\) and can go as high as 512,000 MiB \\(500 GiB\\)\\. Amazon S3 objects have a maximum size of 5 TB\\. \nThis parameter is not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation` to create a data repository association to link your Lustre file system to a data repository\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `512000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DeploymentType": "\\(Optional\\) Choose `SCRATCH_1` and `SCRATCH_2` deployment types when you need temporary storage and shorter\\-term processing of data\\. The `SCRATCH_2` deployment type provides in\\-transit encryption of data and higher burst throughput capacity than `SCRATCH_1`\\. \nChoose `PERSISTENT_1` for longer\\-term storage and for throughput\\-focused workloads that aren\u2019t latency\\-sensitive\\. `PERSISTENT_1` supports encryption of data in transit, and is available in all AWS Regions in which FSx for Lustre is available\\. \nChoose `PERSISTENT_2` for longer\\-term storage and for latency\\-sensitive workloads that require the highest levels of IOPS/throughput\\. `PERSISTENT_2` supports SSD storage, and offers higher `PerUnitStorageThroughput` \\(up to 1000 MB/s/TiB\\)\\. `PERSISTENT_2` is available in a limited number of AWS Regions\\. For more information, and an up\\-to\\-date list of AWS Regions in which `PERSISTENT_2` is available, see [File system deployment options for FSx for Lustre](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types) in the *Amazon FSx for Lustre User Guide*\\. \nIf you choose `PERSISTENT_2`, and you set `FileSystemTypeVersion` to `2.10`, the `CreateFileSystem` operation fails\\.\nEncryption of data in transit is automatically turned on when you access `SCRATCH_2`, `PERSISTENT_1` and `PERSISTENT_2` file systems from Amazon EC2 instances that support automatic encryption in the AWS Regions where they are available\\. For more information about encryption in transit for FSx for Lustre file systems, see [Encrypting data in transit](https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html) in the *Amazon FSx for Lustre User Guide*\\. \n\\(Default = `SCRATCH_1`\\) \n*Required*: No \n*Type*: String \n*Allowed values*: `PERSISTENT_1 | PERSISTENT_2 | SCRATCH_1 | SCRATCH_2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DriveCacheType": "The type of drive cache used by `PERSISTENT_1` file systems that are provisioned with HDD storage devices\\. This parameter is required when storage type is HDD\\. Set this property to `READ` to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system\\. \nThis parameter is required when `StorageType` is set to `HDD` and `DeploymentType` is `PERSISTENT_1`\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `NONE | READ` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ExportPath": "\\(Optional\\) Available with `Scratch` and `Persistent_1` deployment types\\. Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported\\. The path must use the same Amazon S3 bucket as specified in ImportPath\\. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system\\. If an `ExportPath` value is not provided, Amazon FSx sets a default export path, `s3://import-bucket/FSxLustre[creation-timestamp]`\\. The timestamp is in UTC format, for example `s3://import-bucket/FSxLustre20181105T222312Z`\\. \nThe Amazon S3 export bucket must be the same as the import bucket specified by `ImportPath`\\. If you specify only a bucket name, such as `s3://import-bucket`, you get a 1:1 mapping of file system objects to S3 bucket objects\\. This mapping means that the input data in S3 is overwritten on export\\. If you provide a custom prefix in the export path, such as `s3://import-bucket/[custom-optional-prefix]`, Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket\\. \nThis parameter is not supported for file systems using the `Persistent_2` deployment type\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ImportPath": "\\(Optional\\) The path to the Amazon S3 bucket \\(including the optional prefix\\) that you're using as the data repository for your Amazon FSx for Lustre file system\\. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select\\. An example is `s3://import-bucket/optional-prefix`\\. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system\\. \nThis parameter is not supported for Lustre file systems using the `Persistent_2` deployment type\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ImportedFileChunkSize": "\\(Optional\\) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file \\(in MiB\\) stored on a single physical disk\\. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system\\. \nThe default chunk size is 1,024 MiB \\(1 GiB\\) and can go as high as 512,000 MiB \\(500 GiB\\)\\. Amazon S3 objects have a maximum size of 5 TB\\. \nThis parameter is not supported for Lustre file systems using the `Persistent_2` deployment type\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `512000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PerUnitStorageThroughput": "Required with `PERSISTENT_1` and `PERSISTENT_2` deployment types, provisions the amount of read and write throughput for each 1 tebibyte \\(TiB\\) of file system storage capacity, in MB/s/TiB\\. File system throughput capacity is calculated by multiplying \ufb01le system storage capacity \\(TiB\\) by the `PerUnitStorageThroughput` \\(MB/s/TiB\\)\\. For a 2\\.4\\-TiB \ufb01le system, provisioning 50 MB/s/TiB of `PerUnitStorageThroughput` yields 120 MB/s of \ufb01le system throughput\\. You pay for the amount of throughput that you provision\\. \nValid values: \n+ For `PERSISTENT_1` SSD storage: 50, 100, 200 MB/s/TiB\\.\n+ For `PERSISTENT_1` HDD storage: 12, 40 MB/s/TiB\\.\n+ For `PERSISTENT_2` SSD storage: 125, 250, 500, 1000 MB/s/TiB\\.\n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `12` \n*Maximum*: `1000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "WeeklyMaintenanceStartTime": "\\(Optional\\) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "WeeklyMaintenanceStartTime": "A recurring weekly time, in the format `D:HH:MM`\\. \n `D` is the day of the week, for which 1 represents Monday and 7 represents Sunday\\. For further details, see [the ISO\\-8601 spec as described on Wikipedia](https://en.wikipedia.org/wiki/ISO_week_date)\\. \n `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. \nFor example, `1:05:00` specifies maintenance at 5 AM Monday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::FSx::FileSystem NfsExports": { "ClientConfigurations": "A list of configuration objects that contain the client and options for mounting the OpenZFS file system\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-nfsexports-clientconfigurations.html) of [ClientConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-nfsexports-clientconfigurations.html) \n*Maximum*: `25` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" @@ -10492,24 +11636,25 @@ "AWS::FSx::FileSystem OntapConfiguration": { "AutomaticBackupRetentionDays": "The number of days to retain automatic backups\\. Setting this property to `0` disables automatic backups\\. You can retain automatic backups for a maximum of 90 days\\. The default is `0`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DailyAutomaticBackupStartTime": "A recurring daily time, in the format `HH:MM`\\. `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. For example, `05:00` specifies 5 AM daily\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeploymentType": "Specifies the FSx for ONTAP file system deployment type to use in creating the file system\\. `MULTI_AZ_1` is the supported ONTAP deployment type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `MULTI_AZ_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DeploymentType": "Specifies the FSx for ONTAP file system deployment type to use in creating the file system\\. \n+ `MULTI_AZ_1` \\- \\(Default\\) A high availability file system configured for Multi\\-AZ redundancy to tolerate temporary Availability Zone \\(AZ\\) unavailability\\. \n+ `SINGLE_AZ_1` \\- A file system configured for Single\\-AZ redundancy\\.\nFor information about the use cases for Multi\\-AZ and Single\\-AZ deployments, refer to [Choosing a file system deployment type](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-AZ.html)\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `MULTI_AZ_1 | SINGLE_AZ_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DiskIopsConfiguration": "The SSD IOPS configuration for the FSx for ONTAP file system\\. \n*Required*: No \n*Type*: [DiskIopsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-diskiopsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EndpointIpAddressRange": "Specifies the IP address range in which the endpoints to access your file system will be created\\. By default, Amazon FSx selects an unused IP address range for you from the 198\\.19\\.\\* range\\. \nThe Endpoint IP address range you select for your file system must exist outside the VPC's CIDR range and must be at least /30 or larger\\.\n*Required*: No \n*Type*: String \n*Minimum*: `9` \n*Maximum*: `17` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{9,17}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EndpointIpAddressRange": "\\(Multi\\-AZ only\\) Specifies the IP address range in which the endpoints to access your file system will be created\\. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198\\.19\\.\\* range\\. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC\u2019s primary CIDR range to use as the endpoint IP address range for the file system\\. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables\\. \n*Required*: No \n*Type*: String \n*Minimum*: `9` \n*Maximum*: `17` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{9,17}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FsxAdminPassword": "The ONTAP administrative password for the `fsxadmin` user with which you administer your file system using the NetApp ONTAP CLI and REST API\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `50` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{8,50}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PreferredSubnetId": "Required when `DeploymentType` is set to `MULTI_AZ_1`\\. This specifies the subnet in which you want the preferred file server to be located\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "RouteTableIds": "Specifies the virtual private cloud \\(VPC\\) route tables in which your file system's endpoints will be created\\. You should specify all VPC route tables associated with the subnets in which your clients are located\\. By default, Amazon FSx selects your VPC's default route table\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ThroughputCapacity": "Sets the throughput capacity for the file system that you're creating\\. Valid values are 128, 256, 512, 1024, and 2048 MBps\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `4096` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RouteTableIds": "\\(Multi\\-AZ only\\) Specifies the virtual private cloud \\(VPC\\) route tables in which your file system's endpoints will be created\\. You should specify all VPC route tables associated with the subnets in which your clients are located\\. By default, Amazon FSx selects your VPC's default route table\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ThroughputCapacity": "Sets the throughput capacity for the file system that you're creating\\. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WeeklyMaintenanceStartTime": "A recurring weekly time, in the format `D:HH:MM`\\. \n `D` is the day of the week, for which 1 represents Monday and 7 represents Sunday\\. For further details, see [the ISO\\-8601 spec as described on Wikipedia](https://en.wikipedia.org/wiki/ISO_week_date)\\. \n `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. \nFor example, `1:05:00` specifies maintenance at 5 AM Monday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::FSx::FileSystem OpenZFSConfiguration": { "AutomaticBackupRetentionDays": "The number of days to retain automatic backups\\. Setting this property to `0` disables automatic backups\\. You can retain automatic backups for a maximum of 90 days\\. The default is `0`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CopyTagsToBackups": "A Boolean value indicating whether tags for the file system should be copied to backups\\. This value defaults to `false`\\. If it's set to `true`, all tags for the file system are copied to all automatic and user\\-initiated backups where the user doesn't specify tags\\. If this value is `true`, and you specify one or more tags, only the specified tags are copied to backups\\. If you specify one or more tags when creating a user\\-initiated backup, no tags are copied from the file system, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CopyTagsToVolumes": "A Boolean value indicating whether tags for the volume should be copied to snapshots\\. This value defaults to `false`\\. If it's set to `true`, all tags for the volume are copied to snapshots where the user doesn't specify tags\\. If this value is `true`, and you specify one or more tags, only the specified tags are copied to snapshots\\. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CopyTagsToVolumes": "A Boolean value indicating whether tags for the file system should be copied to volumes\\. This value defaults to `false`\\. If it's set to `true`, all tags for the file system are copied to volumes where the user doesn't specify tags\\. If this value is `true`, and you specify one or more tags, only the specified tags are copied to volumes\\. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DailyAutomaticBackupStartTime": "A recurring daily time, in the format `HH:MM`\\. `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. For example, `05:00` specifies 5 AM daily\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeploymentType": "Specifies the file system deployment type\\. Amazon FSx for OpenZFS supports `SINGLE_AZ_1`\\. `SINGLE_AZ_1` deployment type is configured for redundancy within a single Availability Zone\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SINGLE_AZ_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DeploymentType": "Specifies the file system deployment type\\. Single AZ deployment types are configured for redundancy within a single Availability Zone in an AWS Region \\. Valid values are the following: \n+ `SINGLE_AZ_1`\\- \\(Default\\) Creates file systems with throughput capacities of 64 \\- 4,096 MB/s\\. `Single_AZ_1` is available in all AWS Regions where Amazon FSx for OpenZFS is available, except US West \\(Oregon\\)\\.\n+ `SINGLE_AZ_2`\\- Creates file systems with throughput capacities of 160 \\- 10,240 MB/s using an NVMe L2ARC cache\\. `Single_AZ_2` is available only in the US East \\(N\\. Virginia\\), US East \\(Ohio\\), US West \\(Oregon\\), and Europe \\(Ireland\\) AWS Regions\\.\nFor more information, see: [Deployment type availability](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions) and [File system performance](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SINGLE_AZ_1 | SINGLE_AZ_2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DiskIopsConfiguration": "The SSD IOPS \\(input/output operations per second\\) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system\\. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage\\. The configuration consists of the total number of provisioned SSD IOPS and how the amount was provisioned \\(by the customer or by the system\\)\\. \n*Required*: No \n*Type*: [DiskIopsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-diskiopsconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Options": "To delete a file system if there are child volumes present below the root volume, use the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`\\. If your file system has child volumes and you don't use this option, the delete request will fail\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RootVolumeConfiguration": "The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system\\. All volumes are children of the root volume\\. \n*Required*: No \n*Type*: [RootVolumeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ThroughputCapacity": "Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second \\(MB/s\\)\\. Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s\\. You pay for additional throughput capacity that you provision\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ThroughputCapacity": "Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second \\(MB/s\\)\\. Valid values depend on the DeploymentType you choose, as follows: \n+ For `SINGLE_AZ_1`, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s\\.\n+ For `SINGLE_AZ_2`, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s\\.\nYou pay for additional throughput capacity that you provision\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WeeklyMaintenanceStartTime": "A recurring weekly time, in the format `D:HH:MM`\\. \n `D` is the day of the week, for which 1 represents Monday and 7 represents Sunday\\. For further details, see [the ISO\\-8601 spec as described on Wikipedia](https://en.wikipedia.org/wiki/ISO_week_date)\\. \n `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. \nFor example, `1:05:00` specifies maintenance at 5 AM Monday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::FSx::FileSystem RootVolumeConfiguration": { @@ -10517,14 +11662,15 @@ "DataCompressionType": "Specifies the method used to compress the data on the volume\\. The compression type is `NONE` by default\\. \n+ `NONE` \\- Doesn't compress the data on the volume\\. `NONE` is the default\\.\n+ `ZSTD` \\- Compresses the data in the volume using the Zstandard \\(ZSTD\\) compression algorithm\\. Compared to LZ4, Z\\-Standard provides a better compression ratio to minimize on\\-disk storage utilization\\.\n+ `LZ4` \\- Compresses the data in the volume using the LZ4 compression algorithm\\. Compared to Z\\-Standard, LZ4 is less compute\\-intensive and delivers higher write throughput speeds\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `LZ4 | NONE | ZSTD` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "NfsExports": "The configuration object for mounting a file system\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-nfsexports.html) of [NfsExports](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-nfsexports.html) \n*Maximum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ReadOnly": "A Boolean value indicating whether the volume is read\\-only\\. Setting this value to `true` can be useful after you have completed changes to a volume and no longer want changes to occur\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "UserAndGroupQuotas": "An object specifying how much storage users or groups can use on the volume\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html) of [UserAndGroupQuotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html) \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "RecordSizeKiB": "Specifies the record size of an OpenZFS root volume, in kibibytes \\(KiB\\)\\. Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB\\. The default is 128 KiB\\. Most workloads should use the default record size\\. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size\\. For additional guidance on setting a custom record size, see [ Tips for maximizing performance](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `4` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "UserAndGroupQuotas": "An object specifying how much storage users or groups can use on the volume\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html) of [UserAndGroupQuotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html) \n*Maximum*: `500` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::FSx::FileSystem SelfManagedActiveDirectoryConfiguration": { "DnsIps": "A list of up to three IP addresses of DNS servers or domain controllers in the self\\-managed AD directory\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DomainName": "The fully qualified domain name of the self\\-managed AD directory, such as `corp.example.com`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FileSystemAdministratorsGroup": "\\(Optional\\) The name of the domain group whose members are granted administrative privileges for the file system\\. Administrative privileges include taking ownership of files and folders, setting audit controls \\(audit ACLs\\) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell\\. The group that you specify must already exist in your domain\\. If you don't provide one, your AD domain's Domain Admins group is used\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "OrganizationalUnitDistinguishedName": "\\(Optional\\) The fully qualified distinguished name of the organizational unit within your self\\-managed AD directory\\. Amazon FSx only accepts OU as the direct parent of the file system\\. An example is `OU=FSx,DC=yourdomain,DC=corp,DC=com`\\. To learn more, see [RFC 2253](https://tools.ietf.org/html/rfc2253)\\. If none is provided, the FSx file system is created in the default location of your self\\-managed AD directory\\. \nOnly Organizational Unit \\(OU\\) objects can be the direct parent of the file system that you're creating\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2000` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,2000}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Password": "The password for the service account on your self\\-managed AD domain that Amazon FSx will use to join to your AD domain\\. We strongly suggest that you follow best practices and *do not* embed passwords in your CFN templates\\. \nThe recommended approach is to use AWS Secrets Manager to store your passwords\\. You can retrieve them for use in your templates using the `secretsmanager` dynamic reference\\. There are additional costs associated with using AWS Secrets Manager\\. To learn more, see [Secrets Manager secrets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) in the *AWS CloudFormation User Guide*\\. \nAlternatively, you can use the `NoEcho` property to obfuscate the password parameter value\\. For more information, see [Do Not Embed Credentials in Your Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html#creds) in the *AWS CloudFormation User Guide*\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^.{1,256}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Password": "The password for the service account on your self\\-managed AD domain that Amazon FSx will use to join to your AD domain\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^.{1,256}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserName": "The user name for the service account on your self\\-managed AD domain that Amazon FSx will use to join to your AD domain\\. This account must have the permission to join computers to the domain in the organizational unit provided in `OrganizationalUnitDistinguishedName`, or in the default location of your AD domain\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::FSx::FileSystem UserAndGroupQuotas": { @@ -10533,17 +11679,94 @@ "Type": "A value that specifies whether the quota applies to a user or group\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GROUP | USER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::FSx::FileSystem WindowsConfiguration": { - "ActiveDirectoryId": "The ID for an existing AWS Managed Microsoft Active Directory \\(AD\\) instance that the file system should join when it's created\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `12` \n*Maximum*: `12` \n*Pattern*: `^d-[0-9a-f]{10}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ActiveDirectoryId": "The ID for an existing AWS Managed Microsoft Active Directory \\(AD\\) instance that the file system should join when it's created\\. Required if you are joining the file system to an existing AWS Managed Microsoft AD\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `12` \n*Maximum*: `12` \n*Pattern*: `^d-[0-9a-f]{10}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Aliases": "An array of one or more DNS alias names that you want to associate with the Amazon FSx file system\\. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system\\. You can associate up to 50 aliases with a file system at any time\\. \nFor more information, see [Working with DNS Aliases](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) and [Walkthrough 5: Using DNS aliases to access your file system](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html), including additional steps you must take to be able to access your file system using a DNS alias\\. \nAn alias name has to meet the following requirements: \n+ Formatted as a fully\\-qualified domain name \\(FQDN\\), `hostname.domain`, for example, `accounting.example.com`\\.\n+ Can contain alphanumeric characters, the underscore \\(\\_\\), and the hyphen \\(\\-\\)\\.\n+ Cannot start or end with a hyphen\\.\n+ Can start with a numeric\\.\nFor DNS alias names, Amazon FSx stores alphabetical characters as lowercase letters \\(a\\-z\\), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AuditLogConfiguration": "The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system\\. \n*Required*: No \n*Type*: [AuditLogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-auditlogconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AutomaticBackupRetentionDays": "The number of days to retain automatic backups\\. The default is to retain backups for 7 days\\. Setting this value to 0 disables the creation of automatic backups\\. The maximum retention period for backups is 90 days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `90` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CopyTagsToBackups": "A Boolean flag indicating whether tags for the file system should be copied to backups\\. This value defaults to false\\. If it's set to true, all tags for the file system are copied to all automatic and user\\-initiated backups where the user doesn't specify tags\\. If this value is true, and you specify one or more tags, only the specified tags are copied to backups\\. If you specify one or more tags when creating a user\\-initiated backup, no tags are copied from the file system, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DailyAutomaticBackupStartTime": "The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AutomaticBackupRetentionDays": "The number of days to retain automatic backups\\. Setting this property to `0` disables automatic backups\\. You can retain automatic backups for a maximum of 90 days\\. The default is `0`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CopyTagsToBackups": "A boolean flag indicating whether tags for the file system should be copied to backups\\. This value defaults to false\\. If it's set to true, all tags for the file system are copied to all automatic and user\\-initiated backups where the user doesn't specify tags\\. If this value is true, and you specify one or more tags, only the specified tags are copied to backups\\. If you specify one or more tags when creating a user\\-initiated backup, no tags are copied from the file system, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DailyAutomaticBackupStartTime": "A recurring daily time, in the format `HH:MM`\\. `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. For example, `05:00` specifies 5 AM daily\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DeploymentType": "Specifies the file system deployment type, valid values are the following: \n+ `MULTI_AZ_1` \\- Deploys a high availability file system that is configured for Multi\\-AZ redundancy to tolerate temporary Availability Zone \\(AZ\\) unavailability\\. You can only deploy a Multi\\-AZ file system in AWS Regions that have a minimum of three Availability Zones\\. Also supports HDD storage type\n+ `SINGLE_AZ_1` \\- \\(Default\\) Choose to deploy a file system that is configured for single AZ redundancy\\.\n+ `SINGLE_AZ_2` \\- The latest generation Single AZ file system\\. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type\\.\nFor more information, see [ Availability and Durability: Single\\-AZ and Multi\\-AZ File Systems](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `MULTI_AZ_1 | SINGLE_AZ_1 | SINGLE_AZ_2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PreferredSubnetId": "Required when `DeploymentType` is set to `MULTI_AZ_1`\\. This specifies the subnet in which you want the preferred file server to be located\\. For in\\-AWS applications, we recommend that you launch your clients in the same Availability Zone \\(AZ\\) as your preferred file server to reduce cross\\-AZ data transfer costs and minimize latency\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PreferredSubnetId": "Required when `DeploymentType` is set to `MULTI_AZ_1`\\. This specifies the subnet in which you want the preferred file server to be located\\. For in\\-AWS applications, we recommend that you launch your clients in the same availability zone as your preferred file server to reduce cross\\-availability zone data transfer costs and minimize latency\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SelfManagedActiveDirectoryConfiguration": "The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an ONTAP storage virtual machine \\(SVM\\) to a self\\-managed \\(including on\\-premises\\) Microsoft Active Directory \\(AD\\) directory\\. For more information, see [ Using Amazon FSx with your self\\-managed Microsoft Active Directory](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html) or [Managing SVMs](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html)\\. \n*Required*: No \n*Type*: [SelfManagedActiveDirectoryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ThroughputCapacity": "Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second \\(MB/s\\), in 2 to the *n*th increments, between 2^3 \\(8\\) and 2^11 \\(2048\\)\\. \n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "WeeklyMaintenanceStartTime": "The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ThroughputCapacity": "Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second \\(MB/s\\), in 2 to the *n*th increments, between 2^3 \\(8\\) and 2^11 \\(2048\\)\\. \n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WeeklyMaintenanceStartTime": "A recurring weekly time, in the format `D:HH:MM`\\. \n `D` is the day of the week, for which 1 represents Monday and 7 represents Sunday\\. For further details, see [the ISO\\-8601 spec as described on Wikipedia](https://en.wikipedia.org/wiki/ISO_week_date)\\. \n `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. \nFor example, `1:05:00` specifies maintenance at 5 AM Monday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FSx::Snapshot": { + "Name": "The name of the snapshot\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `203` \n*Pattern*: `^[a-zA-Z0-9_:.-]{1,203}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VolumeId": "The ID of the volume that the snapshot is of\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `23` \n*Maximum*: `23` \n*Pattern*: `^(fsvol-[0-9a-f]{17,})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::FSx::StorageVirtualMachine": { + "ActiveDirectoryConfiguration": "Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable\\. \n*Required*: No \n*Type*: [ActiveDirectoryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FileSystemId": "Specifies the FSx for ONTAP file system on which to create the SVM\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the SVM\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `47` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,47}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RootVolumeSecurityStyle": "The security style of the root volume of the SVM\\. Specify one of the following values: \n+ `UNIX` if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account\\.\n+ `NTFS` if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account\\.\n+ `MIXED` if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `MIXED | NTFS | UNIX` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SvmAdminPassword": "Specifies the password to use when logging on to the SVM using a secure shell \\(SSH\\) connection to the SVM's management endpoint\\. Doing so enables you to manage the SVM using the NetApp ONTAP CLI or REST API\\. If you do not specify a password, you can still use the file system's `fsxadmin` user to manage the SVM\\. For more information, see [ Managing SVMs using the NetApp ONTAP CLI](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html#vsadmin-ontap-cli) in the *FSx for ONTAP User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FSx::StorageVirtualMachine ActiveDirectoryConfiguration": { + "NetBiosName": "The NetBIOS name of the Active Directory computer object that will be created for your SVM\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `15` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SelfManagedActiveDirectoryConfiguration": "The configuration that Amazon FSx uses to join the ONTAP storage virtual machine \\(SVM\\) to your self\\-managed \\(including on\\-premises\\) Microsoft Active Directory \\(AD\\) directory\\. \n*Required*: No \n*Type*: [SelfManagedActiveDirectoryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FSx::StorageVirtualMachine SelfManagedActiveDirectoryConfiguration": { + "DnsIps": "A list of up to three IP addresses of DNS servers or domain controllers in the self\\-managed AD directory\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DomainName": "The fully qualified domain name of the self\\-managed AD directory, such as `corp.example.com`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FileSystemAdministratorsGroup": "\\(Optional\\) The name of the domain group whose members are granted administrative privileges for the file system\\. Administrative privileges include taking ownership of files and folders, setting audit controls \\(audit ACLs\\) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell\\. The group that you specify must already exist in your domain\\. If you don't provide one, your AD domain's Domain Admins group is used\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "OrganizationalUnitDistinguishedName": "\\(Optional\\) The fully qualified distinguished name of the organizational unit within your self\\-managed AD directory\\. Amazon FSx only accepts OU as the direct parent of the file system\\. An example is `OU=FSx,DC=yourdomain,DC=corp,DC=com`\\. To learn more, see [RFC 2253](https://tools.ietf.org/html/rfc2253)\\. If none is provided, the FSx file system is created in the default location of your self\\-managed AD directory\\. \nOnly Organizational Unit \\(OU\\) objects can be the direct parent of the file system that you're creating\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2000` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,2000}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Password": "The password for the service account on your self\\-managed AD domain that Amazon FSx will use to join to your AD domain\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^.{1,256}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UserName": "The user name for the service account on your self\\-managed AD domain that Amazon FSx will use to join to your AD domain\\. This account must have the permission to join computers to the domain in the organizational unit provided in `OrganizationalUnitDistinguishedName`, or in the default location of your AD domain\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FSx::Volume": { + "BackupId": "Specifies the ID of the volume backup to use to create a new volume\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the volume\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `203` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,203}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OntapConfiguration": "The configuration of an Amazon FSx for NetApp ONTAP volume\\. \n*Required*: No \n*Type*: [OntapConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OpenZFSConfiguration": "The configuration of an Amazon FSx for OpenZFS volume\\. \n*Required*: No \n*Type*: [OpenZFSConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VolumeType": "The type of the volume\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ONTAP | OPENZFS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::FSx::Volume ClientConfigurations": { + "Clients": "A value that specifies who can mount the file system\\. You can provide a wildcard character \\(`*`\\), an IP address \\(`0.0.0.0`\\), or a CIDR address \\(`192.0.2.0/24`\\)\\. By default, Amazon FSx uses the wildcard character when specifying the client\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[ -~]{1,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Options": "The options to use when mounting the file system\\. For a list of options that you can use with Network File System \\(NFS\\), see the [exports\\(5\\) \\- Linux man page](https://linux.die.net/man/5/exports)\\. When choosing your options, consider the following: \n+ `crossmnt` is used by default\\. If you don't specify `crossmnt` when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory\\.\n+ `sync` is used by default\\. If you instead specify `async`, the system acknowledges writes before writing to disk\\. If the system crashes before the writes are finished, you lose the unwritten data\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FSx::Volume NfsExports": { + "ClientConfigurations": "A list of configuration objects that contain the client and options for mounting the OpenZFS file system\\. \n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports-clientconfigurations.html) of [ClientConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports-clientconfigurations.html) \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FSx::Volume OntapConfiguration": { + "CopyTagsToBackups": "A boolean flag indicating whether tags for the volume should be copied to backups\\. This value defaults to false\\. If it's set to true, all tags for the volume are copied to all automatic and user\\-initiated backups where the user doesn't specify tags\\. If this value is true, and you specify one or more tags, only the specified tags are copied to backups\\. If you specify one or more tags when creating a user\\-initiated backup, no tags are copied from the volume, regardless of this value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "JunctionPath": "Specifies the location in the SVM's namespace where the volume is mounted\\. The `JunctionPath` must have a leading forward slash, such as `/vol3`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OntapVolumeType": "Specifies the type of volume you are creating\\. Valid values are the following: \n+ `RW` specifies a read/write volume\\. `RW` is the default\\.\n+ `DP` specifies a data\\-protection volume\\. A `DP` volume is read\\-only and can be used as the destination of a NetApp SnapMirror relationship\\.\nFor more information, see [Volume types](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types) in the *Amazon FSx for NetApp ONTAP User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DP | RW` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SecurityStyle": "Specifies the security style for the volume\\. If a volume's security style is not specified, it is automatically set to the root volume's security style\\. The security style determines the type of permissions that FSx for ONTAP uses to control data access\\. For more information, see [Volume security style](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style) in the *Amazon FSx for NetApp ONTAP User Guide*\\. Specify one of the following values: \n+ `UNIX` if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account\\. \n+ `NTFS` if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account\\.\n+ `MIXED` if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `MIXED | NTFS | UNIX` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SizeInMegabytes": "Specifies the size of the volume, in megabytes \\(MB\\), that you are creating\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SnapshotPolicy": "Specifies the snapshot policy for the volume\\. There are three built\\-in snapshot policies: \n+ `default`: This is the default policy\\. A maximum of six hourly snapshots taken five minutes past the hour\\. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight\\. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight\\.\n+ `default-1weekly`: This policy is the same as the `default` policy except that it only retains one snapshot from the weekly schedule\\.\n+ `none`: This policy does not take any snapshots\\. This policy can be assigned to volumes to prevent automatic snapshots from being taken\\.\nYou can also provide the name of a custom policy that you created with the ONTAP CLI or REST API\\. \nFor more information, see [Snapshot policies](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies) in the *Amazon FSx for NetApp ONTAP User Guide*\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StorageEfficiencyEnabled": "Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StorageVirtualMachineId": "Specifies the ONTAP SVM in which to create the volume\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `21` \n*Maximum*: `21` \n*Pattern*: `^(svm-[0-9a-f]{17,})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TieringPolicy": "Describes the data tiering policy for an ONTAP volume\\. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns\\. \nValid tiering policies are the following: \n+ `SNAPSHOT_ONLY` \\- \\(Default value\\) moves cold snapshots to the capacity pool storage tier\\.\n+ `AUTO` \\- moves cold user data and snapshots to the capacity pool storage tier based on your access patterns\\.\n+ `ALL` \\- moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier\\.\n+ `NONE` \\- keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier\\.\n*Required*: No \n*Type*: [TieringPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-tieringpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FSx::Volume OpenZFSConfiguration": { + "CopyTagsToSnapshots": "A Boolean value indicating whether tags for the volume should be copied to snapshots\\. This value defaults to `false`\\. If it's set to `true`, all tags for the volume are copied to snapshots where the user doesn't specify tags\\. If this value is `true`, and you specify one or more tags, only the specified tags are copied to snapshots\\. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataCompressionType": "Specifies the method used to compress the data on the volume\\. The compression type is `NONE` by default\\. \n+ `NONE` \\- Doesn't compress the data on the volume\\. `NONE` is the default\\.\n+ `ZSTD` \\- Compresses the data in the volume using the Zstandard \\(ZSTD\\) compression algorithm\\. Compared to LZ4, Z\\-Standard provides a better compression ratio to minimize on\\-disk storage utilization\\.\n+ `LZ4` \\- Compresses the data in the volume using the LZ4 compression algorithm\\. Compared to Z\\-Standard, LZ4 is less compute\\-intensive and delivers higher write throughput speeds\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `LZ4 | NONE | ZSTD` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NfsExports": "The configuration object for mounting a Network File System \\(NFS\\) file system\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports.html) of [NfsExports](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Options": "To delete the volume's child volumes, snapshots, and clones, use the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OriginSnapshot": "The configuration object that specifies the snapshot to use as the origin of the data for the volume\\. \n*Required*: No \n*Type*: [OriginSnapshot](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-originsnapshot.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ParentVolumeId": "The ID of the volume to use as the parent volume of the volume that you are creating\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `23` \n*Maximum*: `23` \n*Pattern*: `^(fsvol-[0-9a-f]{17,})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ReadOnly": "A Boolean value indicating whether the volume is read\\-only\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RecordSizeKiB": "Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes \\(KiB\\)\\. Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB\\. The default is 128 KiB\\. We recommend using the default setting for the majority of use cases\\. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads \\(small record size\\) or media streaming workloads \\(large record size\\)\\. For additional guidance on when to set a custom record size, see [ ZFS Record size](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `4` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StorageCapacityQuotaGiB": "Sets the maximum storage size in gibibytes \\(GiB\\) for the volume\\. You can specify a quota that is larger than the storage on the parent volume\\. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume\\. To guarantee quota space, you must also set `StorageCapacityReservationGiB`\\. To *not* specify a storage capacity quota, set this to `-1`\\. \nFor more information, see [Volume properties](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `-1` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StorageCapacityReservationGiB": "Specifies the amount of storage in gibibytes \\(GiB\\) to reserve from the parent volume\\. Setting `StorageCapacityReservationGiB` guarantees that the specified amount of storage space on the parent volume will always be available for the volume\\. You can't reserve more storage than the parent volume has\\. To *not* specify a storage capacity reservation, set this to `0` or `-1`\\. For more information, see [Volume properties](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `-1` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UserAndGroupQuotas": "An object specifying how much storage users or groups can use on the volume\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-userandgroupquotas.html) of [UserAndGroupQuotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-userandgroupquotas.html) \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FSx::Volume OriginSnapshot": { + "CopyStrategy": "The strategy used when copying data from the snapshot to the new volume\\. \n+ `CLONE` \\- The new volume references the data in the origin snapshot\\. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput\\. However, the origin snapshot can't be deleted if there is a volume using its copied data\\. \n+ `FULL_COPY` \\- Copies all data from the snapshot to the new volume\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CLONE | FULL_COPY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SnapshotARN": "Specifies the snapshot to use when creating an OpenZFS volume from a snapshot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::FSx::Volume TieringPolicy": { + "CoolingPeriod": "Specifies the number of days that user data in a volume must remain inactive before it is considered \"cold\" and moved to the capacity pool\\. Used with the `AUTO` and `SNAPSHOT_ONLY` tiering policies\\. Enter a whole number between 2 and 183\\. Default values are 31 days for `AUTO` and 2 days for `SNAPSHOT_ONLY`\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `183` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "Specifies the tiering policy used to transition data\\. Default value is `SNAPSHOT_ONLY`\\. \n+ `SNAPSHOT_ONLY` \\- moves cold snapshots to the capacity pool storage tier\\.\n+ `AUTO` \\- moves cold user data and snapshots to the capacity pool storage tier based on your access patterns\\.\n+ `ALL` \\- moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier\\.\n+ `NONE` \\- keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ALL | AUTO | NONE | SNAPSHOT_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::FSx::Volume UserAndGroupQuotas": { + "Id": "The ID of the user or group\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StorageCapacityQuotaGiB": "The amount of storage that the user or group can use in gibibytes \\(GiB\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "A value that specifies whether the quota applies to a user or group\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `GROUP | USER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::FinSpace::Environment": { "DataBundles": "The list of Amazon Resource Names \\(ARN\\) of the data bundles to install\\. Currently supported data bundle ARNs: \n+ `arn:aws:finspace:${Region}::data-bundle/capital-markets-sample` \\- Contains sample Capital Markets datasets, categories and controlled vocabularies\\.\n+ `arn:aws:finspace:${Region}::data-bundle/taq` \\(default\\) \\- Contains trades and quotes data in addition to sample Capital Markets data\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -10568,13 +11791,28 @@ "LastName": "The last name of the superuser\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `^[a-zA-Z0-9]{1,50}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Forecast::Dataset": { - "DataFrequency": "The frequency of data collection\\. This parameter is required for RELATED\\_TIME\\_SERIES datasets\\. \nValid intervals are Y \\(Year\\), M \\(Month\\), W \\(Week\\), D \\(Day\\), H \\(Hour\\), 30min \\(30 minutes\\), 15min \\(15 minutes\\), 10min \\(10 minutes\\), 5min \\(5 minutes\\), and 1min \\(1 minute\\)\\. For example, \"D\" indicates every day and \"15min\" indicates every 15 minutes\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `5` \n*Pattern*: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataFrequency": "The frequency of data collection\\. This parameter is required for RELATED\\_TIME\\_SERIES datasets\\. \nValid intervals are an integer followed by Y \\(Year\\), M \\(Month\\), W \\(Week\\), D \\(Day\\), H \\(Hour\\), and min \\(Minute\\)\\. For example, \"1D\" indicates every day and \"15min\" indicates every 15 minutes\\. You cannot specify a value that would overlap with the next larger frequency\\. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour\\. The valid values for each frequency are the following: \n+ Minute \\- 1\\-59\n+ Hour \\- 1\\-23\n+ Day \\- 1\\-6\n+ Week \\- 1\\-4\n+ Month \\- 1\\-11\n+ Year \\- 1\nThus, if you want every other week forecasts, specify \"2W\"\\. Or, if you want quarterly forecasts, you specify \"3M\"\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `5` \n*Pattern*: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DatasetName": "The name of the dataset\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DatasetType": "The dataset type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ITEM_METADATA | RELATED_TIME_SERIES | TARGET_TIME_SERIES` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Domain": "The domain associated with the dataset\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CUSTOM | EC2_CAPACITY | INVENTORY_PLANNING | METRICS | RETAIL | WEB_TRAFFIC | WORK_FORCE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EncryptionConfig": "A Key Management Service \\(KMS\\) key and the Identity and Access Management \\(IAM\\) role that Amazon Forecast can assume to access the key\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Schema": "The schema for the dataset\\. The schema attributes and their order must match the fields in your data\\. The dataset `Domain` and `DatasetType` that you choose determine the minimum required fields in your training data\\. For information about the required fields for a specific dataset domain and type, see [Dataset Domains and Dataset Types](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html)\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "EncryptionConfig": "A Key Management Service \\(KMS\\) key and the Identity and Access Management \\(IAM\\) role that Amazon Forecast can assume to access the key\\. \n*Required*: No \n*Type*: [EncryptionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-encryptionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Schema": "The schema for the dataset\\. The schema attributes and their order must match the fields in your data\\. The dataset `Domain` and `DatasetType` that you choose determine the minimum required fields in your training data\\. For information about the required fields for a specific dataset domain and type, see [Dataset Domains and Dataset Types](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html)\\. \n*Required*: Yes \n*Type*: [Schema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-schema.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [TagsItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-tagsitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Forecast::Dataset AttributesItems": { + "AttributeName": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AttributeType": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Forecast::Dataset EncryptionConfig": { + "KmsKeyArn": "The Amazon Resource Name \\(ARN\\) of the KMS key\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:aws:kms:.*:key/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleArn": "The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key\\. \nPassing a role across AWS accounts is not allowed\\. If you pass a role that isn't in your account, you get an `InvalidInputException` error\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:([a-z\\d-]+):forecast:.*:.*:.+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Forecast::Dataset Schema": { + "Attributes": "An array of attributes specifying the name and type of each field in a dataset\\. \n*Required*: No \n*Type*: List of [AttributesItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-attributesitems.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Forecast::Dataset TagsItems": { + "Key": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Forecast::DatasetGroup": { "DatasetArns": "An array of Amazon Resource Names \\(ARNs\\) of the datasets that you want to include in the dataset group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -10735,37 +11973,42 @@ }, "AWS::GameLift::Build": { "Name": "A descriptive label that is associated with a build\\. Build names do not need to be unique\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OperatingSystem": "The operating system that the game server binaries are built to run on\\. This value determines the type of fleet resources that you can use for this build\\. If your game build contains multiple executables, they all must run on the same operating system\\. If an operating system is not specified when creating a build, Amazon GameLift uses the default value \\(WINDOWS\\_2012\\)\\. This value cannot be changed later\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AMAZON_LINUX | AMAZON_LINUX_2 | WINDOWS_2012` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StorageLocation": "Information indicating where your game build files are stored\\. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own\\. The storage location must specify an Amazon S3 bucket name and key\\. The location must also specify a role ARN that you set up to allow Amazon Web Services to access your Amazon S3 bucket\\. The S3 bucket and your new build must be in the same Region\\. \nIf a `StorageLocation` is specified, the size of your file can be found in your Amazon S3 bucket\\. Amazon Web Services will report a `SizeOnDisk` of 0\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "OperatingSystem": "The operating system that you built the game server binaries to run on\\. This value determines the type of fleet resources that you can use for this build\\. If your game build contains multiple executables, they all must run on the same operating system\\. If an operating system is not specified when creating a build, GameLift uses the default value \\(WINDOWS\\_2012\\)\\. This value cannot be changed later\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AMAZON_LINUX | AMAZON_LINUX_2 | WINDOWS_2012` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StorageLocation": "Information indicating where your game build files are stored\\. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own\\. The storage location must specify an Amazon S3 bucket name and key\\. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket\\. The S3 bucket and your new build must be in the same Region\\. \nIf a `StorageLocation` is specified, the size of your file can be found in your Amazon S3 bucket\\. Amazon GameLift will report a `SizeOnDisk` of 0\\. \n*Required*: No \n*Type*: [StorageLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Version": "Version information that is associated with this build\\. Version strings do not need to be unique\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, - "AWS::GameLift::Build S3Location": { - "Bucket": "An Amazon S3 bucket identifier\\. This is the name of the S3 bucket\\. \nGameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot \\(\\.\\)\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Key": "The name of the zip file that contains the build files or script files\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ObjectVersion": "The version of the file, if object versioning is turned on for the bucket\\. Amazon GameLift uses this information when retrieving files from your S3 bucket\\. To retrieve a specific version of the file, provide an object version\\. To retrieve the latest version of the file, do not set this parameter\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "RoleArn": "The Amazon Resource Name \\([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)\\) for an IAM role that allows Amazon Web Services to access the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "AWS::GameLift::Build StorageLocation": { + "Bucket": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Key": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ObjectVersion": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RoleArn": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::GameLift::Fleet": { + "AnywhereConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [AnywhereConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-anywhereconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BuildId": "A unique identifier for a build to be deployed on the new fleet\\. If you are deploying the fleet with a custom game build, you must specify this property\\. The build must have been successfully uploaded to Amazon GameLift and be in a `READY` status\\. This fleet setting cannot be changed once the fleet is created\\. \n*Required*: Conditional \n*Type*: String \n*Pattern*: `^build-\\S+|^arn:.*:build\\/build-\\S+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "CertificateConfiguration": "Prompts GameLift to generate a TLS/SSL certificate for the fleet\\. TLS certificates are used for encrypting traffic between game clients and the game servers that are running on GameLift\\. By default, the `CertificateConfiguration` is set to `DISABLED`\\. This property cannot be changed after the fleet is created\\. \nNote: This feature requires the AWS Certificate Manager \\(ACM\\) service, which is not available in all AWS regions\\. When working in a region that does not support this feature, a fleet creation request with certificate generation fails with a 4xx error\\. \n*Required*: No \n*Type*: [CertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Description": "A human\\-readable description of the fleet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CertificateConfiguration": "Prompts GameLift to generate a TLS/SSL certificate for the fleet\\. GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift\\. By default, the `CertificateConfiguration` is `DISABLED`\\. You can't change this property after you create the fleet\\. \n AWS Certificate Manager \\(ACM\\) certificates expire after 13 months\\. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet\\. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition\\. \nACM isn't available in all AWS regions\\. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error\\. For more information about the supported Regions, see [Supported Regions](https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html) in the * AWS Certificate Manager User Guide*\\.\n*Required*: No \n*Type*: [CertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ComputeType": "The type of compute resource used to host your game servers\\. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ANYWHERE | EC2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Description": "A description for the fleet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DesiredEC2Instances": "The number of EC2 instances that you want this fleet to host\\. When creating a new fleet, GameLift automatically sets this value to \"1\" and initiates a single instance\\. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EC2InboundPermissions": "The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet\\. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions\\. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges\\. \n*Required*: No \n*Type*: List of [IpPermission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-ippermission.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EC2InstanceType": "The GameLift\\-supported Amazon EC2 instance type to use for all fleet instances\\. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity\\. See [Amazon Elastic Compute Cloud Instance Types](http://aws.amazon.com/ec2/instance-types/) for detailed descriptions of Amazon EC2 instance types\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | t2.large | t2.medium | t2.micro | t2.small` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EC2InstanceType": "The GameLift\\-supported Amazon EC2 instance type to use for all fleet instances\\. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity\\. See [Amazon Elastic Compute Cloud Instance Types](http://aws.amazon.com/ec2/instance-types/) for detailed descriptions of Amazon EC2 instance types\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.xlarge | t2.large | t2.medium | t2.micro | t2.small` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FleetType": "Indicates whether to use On\\-Demand or Spot instances for this fleet\\. By default, this property is set to `ON_DEMAND`\\. Learn more about when to use [ On\\-Demand versus Spot Instances](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot)\\. This property cannot be changed after the fleet is created\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ON_DEMAND | SPOT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InstanceRoleARN": "A unique identifier for an IAM role that manages access to your AWS services\\. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons \\(background processes\\)\\. Create a role or look up a role's ARN by using the [IAM dashboard](https://console.aws.amazon.com/iam/) in the AWS Management Console\\. Learn more about using on\\-box credentials for your game servers at [ Access external resources from a game server](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html)\\. This property cannot be changed after the fleet is created\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Locations": "A set of remote locations to deploy additional instances to and manage as part of the fleet\\. This parameter can only be used when creating fleets in AWS Regions that support multiple locations\\. You can add any GameLift\\-supported AWS Region as a remote location, in the form of an AWS Region code such as `us-west-2`\\. To create a fleet with instances in the home Region only, omit this parameter\\. \n*Required*: No \n*Type*: List of [LocationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxSize": "The maximum number of instances that are allowed in the specified fleet location\\. If this parameter is not set, the default is 1\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MetricGroups": "The name of an AWS CloudWatch metric group to add this fleet to\\. A metric group is used to aggregate the metrics for multiple fleets\\. You can specify an existing metric group name or set a new name to create a new metric group\\. A fleet can be included in only one metric group at a time\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MinSize": "The minimum number of instances that are allowed in the specified fleet location\\. If this parameter is not set, the default is 0\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "A descriptive label that is associated with a fleet\\. Fleet names do not need to be unique\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "A descriptive label that is associated with a fleet\\. Fleet names do not need to be unique\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NewGameSessionProtectionPolicy": "The status of termination protection for active game sessions on the fleet\\. By default, this property is set to `NoProtection`\\. \n+ **NoProtection** \\- Game sessions can be terminated during active gameplay as a result of a scale\\-down event\\. \n+ **FullProtection** \\- Game sessions in `ACTIVE` status cannot be terminated during a scale\\-down event\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `FullProtection | NoProtection` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PeerVpcAwsAccountId": "Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC\\. You can find your account ID in the AWS Management Console under account settings\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PeerVpcId": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet\\. The VPC must be in the same Region as your fleet\\. To look up a VPC ID, use the [VPC Dashboard](https://console.aws.amazon.com/vpc/) in the AWS Management Console\\. Learn more about VPC peering in [VPC Peering with GameLift Fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PeerVpcId": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet\\. The VPC must be in the same Region as your fleet\\. To look up a VPC ID, use the [VPC Dashboard](https://console.aws.amazon.com/vpc/) in the AWS Management Console\\. Learn more about VPC peering in [VPC Peering with GameLift Fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ResourceCreationLimitPolicy": "A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time\\. \n*Required*: No \n*Type*: [ResourceCreationLimitPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-resourcecreationlimitpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RuntimeConfiguration": "Instructions for how to launch and maintain server processes on instances in the fleet\\. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently\\. \nThe `RuntimeConfiguration` parameter is required unless the fleet is being configured using the older parameters `ServerLaunchPath` and `ServerLaunchParameters`, which are still supported for backward compatibility\\.\n*Required*: Conditional \n*Type*: [RuntimeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ScriptId": "The unique identifier for a Realtime configuration script to be deployed on fleet instances\\. You can use either the script ID or ARN\\. Scripts must be uploaded to GameLift prior to creating the fleet\\. This fleet property cannot be changed later\\. \nYou can't use the `!Ref` command to reference a script created with a CloudFormation template for the fleet property `ScriptId`\\. Instead, use `Fn::GetAtt Script.Arn` or `Fn::GetAtt Script.Id` to retrieve either of these properties as input for `ScriptId`\\. Alternatively, enter a `ScriptId` string manually\\.\n*Required*: Conditional \n*Type*: String \n*Pattern*: `^script-\\S+|^arn:.*:script\\/script-\\S+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::GameLift::Fleet AnywhereConfiguration": { + "Cost": "The cost to run your fleet per hour\\. GameLift uses the provided cost of your fleet to balance usage in queues\\. For more information about queues, see [Setting up queues](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) in the *Amazon GameLift Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `11` \n*Pattern*: `^\\d{1,5}(?:\\.\\d{1,5})?$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::GameLift::Fleet CertificateConfiguration": { "CertificateType": "Indicates whether a TLS/SSL certificate is generated for a fleet\\. \nValid values include: \n+ **GENERATED** \\- Generate a TLS/SSL certificate for this fleet\\.\n+ **DISABLED** \\- \\(default\\) Do not generate a TLS/SSL certificate for this fleet\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DISABLED | GENERATED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -10781,11 +12024,11 @@ "MinSize": "The minimum number of instances that are allowed in the specified fleet location\\. If this parameter is not set, the default is 0\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GameLift::Fleet LocationConfiguration": { - "Location": "An AWS Region code, such as `us-west-2`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-z]+(-([a-z]+|\\d))*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Location": "An AWS Region code, such as `us-west-2`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[A-Za-z0-9\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LocationCapacity": "Current resource capacity settings in a specified fleet or location\\. The location value might refer to a fleet's remote location or its home Region\\. \n **Related actions** \n [DescribeFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html) \\| [DescribeFleetLocationCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html) \\| [UpdateFleetCapacity](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html) \n*Required*: No \n*Type*: [LocationCapacity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationcapacity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GameLift::Fleet ResourceCreationLimitPolicy": { - "NewGameSessionsPerCreator": "The maximum number of game sessions that an individual can create during the policy period\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NewGameSessionsPerCreator": "A policy that puts limits on the number of game sessions that a player can create within a specified span of time\\. With this policy, you can control players' ability to consume available resources\\. \nThe policy is evaluated when a player tries to create a new game session\\. On receiving a `CreateGameSession` request, GameLift checks that the player \\(identified by `CreatorId`\\) has created fewer than game session limit in the specified time period\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PolicyPeriodInMinutes": "The time span used in evaluating the resource creation limit policy\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GameLift::Fleet RuntimeConfiguration": { @@ -10808,7 +12051,7 @@ "LaunchTemplate": "The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group\\. You can specify the template using either the template name or ID\\. For help with creating a launch template, see [Creating a Launch Template for an Auto Scaling Group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon Elastic Compute Cloud Auto Scaling User Guide*\\. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs\\. \nIf you specify network interfaces in your launch template, you must explicitly set the property `AssociatePublicIpAddress` to \"true\"\\. If no network interface is specified in the launch template, GameLift FleetIQ uses your account's default VPC\\.\n*Required*: Yes \n*Type*: [LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gameservergroup-launchtemplate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxSize": "The maximum number of instances allowed in the Amazon EC2 Auto Scaling group\\. During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum\\. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MinSize": "The minimum number of instances allowed in the Amazon EC2 Auto Scaling group\\. During automatic scaling events, GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum\\. In production, this value should be set to at least 1\\. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RoleArn": "The Amazon Resource Name \\([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)\\) for an IAM role that allows Amazon Web Services to access your Amazon EC2 Auto Scaling groups\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^arn:.*:role\\/[\\w+=,.@-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleArn": "The Amazon Resource Name \\([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)\\) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^arn:.*:role\\/[\\w+=,.@-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A list of labels to assign to the new game server group resource\\. Tags are developer\\-defined key\\-value pairs\\. Tagging AWS resources is useful for resource management, access management, and cost allocation\\. For more information, see [ Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the * AWS General Reference*\\. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags, respectively\\. The maximum tag limit may be lower than stated\\. See the AWS General Reference for actual tagging limits\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcSubnets": "A list of virtual private cloud \\(VPC\\) subnets to use with instances in the game server group\\. By default, all GameLift FleetIQ\\-supported Availability Zones are used\\. You can use this parameter to specify VPCs that you've set up\\. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -10829,7 +12072,7 @@ "TargetValue": "Desired value to use with a game server group target\\-based scaling policy\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GameLift::GameSessionQueue": { - "CustomEventData": "Information to be added to all events that are related to this game session queue\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomEventData": "Information to be added to all events that are related to this game session queue\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Destinations": "A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue\\. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference\\. \n*Required*: No \n*Type*: List of [Destination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-destination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FilterConfiguration": "A list of locations where a queue is allowed to place new game sessions\\. Locations are specified in the form of AWS Region codes, such as `us-west-2`\\. If this parameter is not set, game sessions can be placed in any queue location\\. \n*Required*: No \n*Type*: [FilterConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-gamesessionqueue-filterconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A descriptive label that is associated with game session queue\\. Queue names must be unique within each Region\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[a-zA-Z0-9-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -10840,7 +12083,7 @@ "TimeoutInSeconds": "The maximum time, in seconds, that a new game session placement request remains in the queue\\. When a request exceeds this time, the game session placement changes to a `TIMED_OUT` status\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GameLift::GameSessionQueue Destination": { - "DestinationArn": "The Amazon Resource Name \\(ARN\\) that is assigned to fleet or fleet alias\\. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9:/-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DestinationArn": "The Amazon Resource Name \\(ARN\\) that is assigned to fleet or fleet alias\\. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9:/-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GameLift::GameSessionQueue FilterConfiguration": { "AllowedLocations": "A list of locations to allow game session placement in, in the form of AWS Region codes such as `us-west-2`\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -10853,13 +12096,17 @@ "LocationOrder": "The prioritization order to use for fleet locations, when the `PriorityOrder` property includes `LOCATION`\\. Locations are identified by AWS Region codes such as `us-west-2`\\. Each location can only be listed once\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PriorityOrder": "The recommended sequence to use when prioritizing where to place new game sessions\\. Each type can only be listed once\\. \n+ `LATENCY` \\-\\- FleetIQ prioritizes locations where the average player latency \\(provided in each game session request\\) is lowest\\. \n+ `COST` \\-\\- FleetIQ prioritizes destinations with the lowest current hosting costs\\. Cost is evaluated based on the location, instance type, and fleet type \\(Spot or On\\-Demand\\) for each destination in the queue\\.\n+ `DESTINATION` \\-\\- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration\\.\n+ `LOCATION` \\-\\- FleetIQ prioritizes based on the provided order of locations, as defined in `LocationOrder`\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::GameLift::Location": { + "LocationName": "The location's name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[A-Za-z0-9\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::GameLift::MatchmakingConfiguration": { "AcceptanceRequired": "A flag that determines whether a match that was created with this configuration must be accepted by the matched players\\. To require acceptance, set to `TRUE`\\. With this option enabled, matchmaking tickets use the status `REQUIRES_ACCEPTANCE` to indicate when a completed potential match is waiting for player acceptance\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AcceptanceTimeoutSeconds": "The length of time \\(in seconds\\) to wait for players to accept a proposed match, if acceptance is required\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `600` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AdditionalPlayerCount": "The number of player slots in a match to keep open for future players\\. For example, if the configuration's rule set specifies a match for a single 12\\-person team, and the additional player count is set to 2, only 10 players are selected for the match\\. This parameter is not used if `FlexMatchMode` is set to `STANDALONE`\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BackfillMode": "The method used to backfill game sessions that are created with this matchmaking configuration\\. Specify `MANUAL` when your game manages backfill requests manually or does not use the match backfill feature\\. Specify `AUTOMATIC` to have GameLift create a `StartMatchBackfill` request whenever a game session has one or more open slots\\. Learn more about manual and automatic backfill in [Backfill Existing Games with FlexMatch](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html)\\. Automatic backfill is not available when `FlexMatchMode` is set to `STANDALONE`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | MANUAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomEventData": "Information to add to all events related to the matchmaking configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "A descriptive label that is associated with matchmaking configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "A description for the matchmaking configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FlexMatchMode": "Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution\\. \n+ **STANDALONE** \\- FlexMatch forms matches and returns match information, including players and team assignments, in a [ MatchmakingSucceeded](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded) event\\.\n+ **WITH\\_QUEUE** \\- FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `STANDALONE | WITH_QUEUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GameProperties": "A set of custom properties for a game session, formatted as key\\-value pairs\\. These properties are passed to a game server process with a request to start a new game session\\. See [ Start a Game Session](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)\\. This parameter is not used if `FlexMatchMode` is set to `STANDALONE`\\. \n*Required*: No \n*Type*: List of [GameProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html) \n*Maximum*: `16` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GameSessionData": "A set of custom game session properties, formatted as a single string value\\. This data is passed to a game server process with a request to start a new game session\\. See [Start a Game Session](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)\\. This parameter is not used if`FlexMatchMode` is set to `STANDALONE`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -10881,21 +12128,21 @@ }, "AWS::GameLift::Script": { "Name": "A descriptive label that is associated with a script\\. Script names do not need to be unique\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StorageLocation": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored\\. The storage location must specify the Amazon S3 bucket name, the zip file name \\(the \"key\"\\), and a role ARN that allows Amazon Web Services to access the Amazon S3 storage location\\. The S3 bucket must be in the same Region where you want to create a new script\\. By default, Amazon Web Services uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the `ObjectVersion` parameter to specify an earlier version\\. \n*Required*: Yes \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StorageLocation": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored\\. The storage location must specify the Amazon S3 bucket name, the zip file name \\(the \"key\"\\), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location\\. The S3 bucket must be in the same Region where you want to create a new script\\. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the `ObjectVersion` parameter to specify an earlier version\\. \n*Required*: Yes \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A list of labels to assign to the new script resource\\. Tags are developer\\-defined key\\-value pairs\\. Tagging AWS resources are useful for resource management, access management and cost allocation\\. For more information, see [ Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the * AWS General Reference*\\. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags\\. The maximum tag limit may be lower than stated\\. See the AWS General Reference for actual tagging limits\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Version": "The version that is associated with a build or script\\. Version strings do not need to be unique\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GameLift::Script S3Location": { - "Bucket": "An Amazon S3 bucket identifier\\. This is the name of the S3 bucket\\. \nGameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot \\(\\.\\)\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Bucket": "An Amazon S3 bucket identifier\\. Thename of the S3 bucket\\. \nGameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot \\(\\.\\)\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Key": "The name of the zip file that contains the build files or script files\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ObjectVersion": "The version of the file, if object versioning is turned on for the bucket\\. Amazon Web Services uses this information when retrieving files from an S3 bucket that you own\\. Use this parameter to specify a specific version of the file\\. If not set, the latest version of the file is retrieved\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RoleArn": "The Amazon Resource Name \\([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)\\) for an IAM role that allows Amazon Web Services to access the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ObjectVersion": "The version of the file, if object versioning is turned on for the bucket\\. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own\\. Use this parameter to specify a specific version of the file\\. If not set, the latest version of the file is retrieved\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleArn": "The Amazon Resource Name \\([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)\\) for an IAM role that allows Amazon GameLift to access the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GlobalAccelerator::Accelerator": { "Enabled": "Indicates whether the accelerator is enabled\\. The value is true or false\\. The default value is true\\. \nIf the value is set to true, the accelerator cannot be deleted\\. If set to false, accelerator can be deleted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IpAddressType": "The value for the address type must be IPv4\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IPV4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IpAddressType": "The IP address type that an accelerator supports\\. For a standard accelerator, the value can be IPV4 or DUAL\\_STACK\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DUAL_STACK | IPV4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IpAddresses": "Optionally, if you've added your own IP address pool to Global Accelerator \\(BYOIP\\), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator\\. You can specify one or two addresses, separated by a comma\\. Do not include the /32 suffix\\. \nOnly one IP address from each of your IP address ranges can be used for each accelerator\\. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool\\. \n Note that you can't update IP addresses for an existing accelerator\\. To change them, you must create a new accelerator with the new addresses\\. \nFor more information, see [Bring Your Own IP Addresses \\(BYOIP\\)](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in the *AWS Global Accelerator Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the accelerator\\. The name must contain only alphanumeric characters or hyphens \\(\\-\\), and must not begin or end with a hyphen\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the accelerator\\. The name must contain only alphanumeric characters or hyphens \\(\\-\\), and must not begin or end with a hyphen\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Create tags for an accelerator\\. \nFor more information, see [Tagging ](https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) in the *AWS Global Accelerator Developer Guide*\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GlobalAccelerator::EndpointGroup": { @@ -10906,7 +12153,7 @@ "HealthCheckPort": "The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group\\. \nThe default port is the port for the listener that this endpoint group is associated with\\. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HealthCheckProtocol": "The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group\\. The default value is TCP\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HTTP | HTTPS | TCP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ListenerArn": "The Amazon Resource Name \\(ARN\\) of the listener\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PortOverrides": "Allows you to override the destination ports used to route traffic to an endpoint\\. Using a port override lets you to map a list of external destination ports \\(that your users send traffic to\\) to a list of internal destination ports that you want an application endpoint to receive traffic on\\. \n*Required*: No \n*Type*: List of [PortOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-portoverride.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PortOverrides": "Allows you to override the destination ports used to route traffic to an endpoint\\. Using a port override lets you map a list of external destination ports \\(that your users send traffic to\\) to a list of internal destination ports that you want an application endpoint to receive traffic on\\. \n*Required*: No \n*Type*: List of [PortOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-portoverride.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ThresholdCount": "The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy\\. The default value is 3\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TrafficDialPercentage": "The percentage of traffic to send to an AWS Regions\\. Additional traffic is distributed to other endpoint groups for this listener\\. \nUse this action to increase \\(dial up\\) or decrease \\(dial down\\) traffic to a specific Region\\. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing\\. \nThe default value is 100\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -10937,7 +12184,7 @@ }, "AWS::Glue::Classifier CsvClassifier": { "AllowSingleColumn": "Enables the processing of files that contain only one column\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ContainsHeader": "Indicates whether the CSV file contains a header\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContainsHeader": "Indicates whether the CSV file contains a header\\. \nA value of `UNKNOWN` specifies that the classifier will detect whether the CSV file contains headings\\. \nA value of `PRESENT` specifies that the CSV file contains headings\\. \nA value of `ABSENT` specifies that the CSV file does not contain headings\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Delimiter": "A custom symbol to denote what separates each column entry in the row\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DisableValueTrimming": "Specifies not to trim values before identifying the type of column values\\. The default value is `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Header": "A list of strings representing column names\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -10965,10 +12212,10 @@ }, "AWS::Glue::Connection ConnectionInput": { "ConnectionProperties": "These key\\-value pairs define parameters for the connection\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ConnectionType": "The type of the connection\\. Currently, these types are supported: \n+ `JDBC` \\- Designates a connection to a database through Java Database Connectivity \\(JDBC\\)\\.\n+ `KAFKA` \\- Designates a connection to an Apache Kafka streaming platform\\.\n+ `MONGODB` \\- Designates a connection to a MongoDB document database\\.\n+ `NETWORK` \\- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment \\(Amazon VPC\\)\\.\nSFTP is not supported\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConnectionType": "The type of the connection\\. Currently, these types are supported: \n+ `JDBC` \\- Designates a connection to a database through Java Database Connectivity \\(JDBC\\)\\.", "Description": "The description of the connection\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MatchCriteria": "A list of criteria that can be used in selecting this connection\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the connection\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the connection\\. Connection will not function as expected without a name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PhysicalConnectionRequirements": "A map of physical connection requirements, such as virtual private cloud \\(VPC\\) and `SecurityGroup`, that are needed to successfully make this connection\\. \n*Required*: No \n*Type*: [PhysicalConnectionRequirements](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Glue::Connection PhysicalConnectionRequirements": { @@ -10977,7 +12224,7 @@ "SubnetId": "The subnet ID used by the connection\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Glue::Crawler": { - "Classifiers": "A list of UTF\\-8 strings that specify the custom classifiers that are associated with the crawler\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Classifiers": "A list of UTF\\-8 strings that specify the names of custom classifiers that are associated with the crawler\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Configuration": "Crawler configuration information\\. This versioned JSON string allows users to specify aspects of a crawler's behavior\\. For more information, see [Configuring a Crawler](https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CrawlerSecurityConfiguration": "The name of the `SecurityConfiguration` structure to be used by this crawler\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DatabaseName": "The name of the database in which the crawler's output is stored\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -10986,7 +12233,7 @@ "RecrawlPolicy": "A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run\\. \n*Required*: No \n*Type*: [RecrawlPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-recrawlpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Role": "The Amazon Resource Name \\(ARN\\) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service \\(Amazon S3\\) data\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Schedule": "For scheduled crawlers, the schedule when the crawler runs\\. \n*Required*: No \n*Type*: [Schedule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schedule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SchemaChangePolicy": "The policy that specifies update and delete behaviors for the crawler\\. \n*Required*: No \n*Type*: [SchemaChangePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SchemaChangePolicy": "The policy that specifies update and delete behaviors for the crawler\\. The policy tells the crawler what to do in the event that it detects a change in a table that already exists in the customer's database at the time of the crawl\\. The `SchemaChangePolicy` does not affect whether or how new tables and partitions are added\\. New tables and partitions are always created regardless of the `SchemaChangePolicy` on a crawler\\. \nThe SchemaChangePolicy consists of two components, `UpdateBehavior` and `DeleteBehavior`\\. \n*Required*: No \n*Type*: [SchemaChangePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TablePrefix": "The prefix added to the names of tables that are created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags to use with this crawler\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Targets": "A collection of targets to crawl\\. \n*Required*: Yes \n*Type*: [Targets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -11012,8 +12259,8 @@ }, "AWS::Glue::Crawler S3Target": { "ConnectionName": "The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment \\(Amazon VPC\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DlqEventQueueArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EventQueueArn": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DlqEventQueueArn": "A valid Amazon dead\\-letter SQS ARN\\. For example, `arn:aws:sqs:region:account:deadLetterQueue`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventQueueArn": "A valid Amazon SQS ARN\\. For example, `arn:aws:sqs:region:account:sqs`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Exclusions": "A list of glob patterns used to exclude from the crawl\\. For more information, see [Catalog Tables with a Crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Path": "The path to the Amazon S3 target\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SampleSize": "Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset\\. If not set, all the files are crawled\\. A valid value is an integer between 1 and 249\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -11022,8 +12269,8 @@ "ScheduleExpression": "A `cron` expression used to specify the schedule\\. For more information, see [Time\\-Based Schedules for Jobs and Crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html)\\. For example, to run something every day at 12:15 UTC, specify `cron(15 12 * * ? *)`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Glue::Crawler SchemaChangePolicy": { - "DeleteBehavior": "The deletion behavior when the crawler finds a deleted object\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UpdateBehavior": "The update behavior when the crawler finds a changed schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DeleteBehavior": "The deletion behavior when the crawler finds a deleted object\\. \nA value of `LOG` specifies that if a table or partition is found to no longer exist, do not delete it, only log that it was found to no longer exist\\. \nA value of `DELETE_FROM_DATABASE` specifies that if a table or partition is found to have been removed, delete it from the database\\. \nA value of `DEPRECATE_IN_DATABASE` specifies that if a table has been found to no longer exist, to add a property to the table that says \"DEPRECATED\" and includes a timestamp with the time of deprecation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UpdateBehavior": "The update behavior when the crawler finds a changed schema\\. \nA value of `LOG` specifies that if a table or a partition already exists, and a change is detected, do not update it, only log that a change was detected\\. Add new tables and new partitions \\(including on existing tables\\)\\. \nA value of `UPDATE_IN_DATABASE` specifies that if a table or partition already exists, and a change is detected, update it\\. Add new tables and partitions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Glue::Crawler Targets": { "CatalogTargets": "Specifies AWS Glue Data Catalog targets\\. \n*Required*: No \n*Type*: List of [CatalogTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -11060,7 +12307,7 @@ "DatabaseName": "The name of the catalog database\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Glue::Database DatabaseInput": { - "CreateTableDefaultPermissions": "Creates a set of default permissions on the table for principals\\. \n*Required*: No \n*Type*: List of [PrincipalPrivileges](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-principalprivileges.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CreateTableDefaultPermissions": "Creates a set of default permissions on the table for principals\\. Used by AWS Lake Formation\\. Not used in the normal course of AWS Glue operations\\. \n*Required*: No \n*Type*: List of [PrincipalPrivileges](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-principalprivileges.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description of the database\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LocationUri": "The location of the database \\(for example, an HDFS path\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the database\\. For Hive compatibility, this is folded to lowercase when it is stored\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -11089,17 +12336,19 @@ "WorkerType": "The type of predefined worker that is allocated to the development endpoint\\. Accepts a value of Standard, G\\.1X, or G\\.2X\\. \n+ For the `Standard` worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker\\.\n+ For the `G.1X` worker type, each worker maps to 1 DPU \\(4 vCPU, 16 GB of memory, 64 GB disk\\), and provides 1 executor per worker\\. We recommend this worker type for memory\\-intensive jobs\\.\n+ For the `G.2X` worker type, each worker maps to 2 DPU \\(8 vCPU, 32 GB of memory, 128 GB disk\\), and provides 1 executor per worker\\. We recommend this worker type for memory\\-intensive jobs\\.\nKnown issue: when a development endpoint is created with the `G.2X` `WorkerType` configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Glue::Job": { - "AllocatedCapacity": "The number of capacity units that are allocated to this job\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AllocatedCapacity": "This parameter is no longer supported\\. Use `MaxCapacity` instead\\. \nThe number of capacity units that are allocated to this job\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Command": "The code that executes a job\\. \n*Required*: Yes \n*Type*: [JobCommand](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Connections": "The connections used for this job\\. \n*Required*: No \n*Type*: [ConnectionsList](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-connectionslist.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DefaultArguments": "The default arguments for this job, specified as name\\-value pairs\\. \nYou can specify arguments here that your own job\\-execution script consumes, in addition to arguments that AWS Glue itself consumes\\. \nFor information about how to specify and consume your own job arguments, see [Calling AWS Glue APIs in Python](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) in the *AWS Glue Developer Guide*\\. \nFor information about the key\\-value pairs that AWS Glue consumes to set up your job, see [Special Parameters Used by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) in the *AWS Glue Developer Guide*\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description of the job\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExecutionClass": "Indicates whether the job is run with a standard or flexible execution class\\. The standard execution class is ideal for time\\-sensitive workloads that require fast job startup and dedicated resources\\. \nThe flexible execution class is appropriate for time\\-insensitive jobs whose start and completion times may vary\\. \nOnly jobs with AWS Glue version 3\\.0 and above and command type `glueetl` will be allowed to set `ExecutionClass` to `FLEX`\\. The flexible execution class is available for Spark jobs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExecutionProperty": "The maximum number of concurrent runs that are allowed for this job\\. \n*Required*: No \n*Type*: [ExecutionProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-executionproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GlueVersion": "Glue version determines the versions of Apache Spark and Python that AWS Glue supports\\. The Python version indicates the version supported for jobs of type Spark\\. \nFor more information about the available AWS Glue versions and corresponding Spark and Python versions, see [Glue version](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) in the developer guide\\. \nJobs that are created without specifying a Glue version default to Glue 0\\.9\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LogUri": "This field is reserved for future use\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxCapacity": "The number of AWS Glue data processing units \\(DPUs\\) that can be allocated when this job runs\\. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory\\. \nDo not set `Max Capacity` if using `WorkerType` and `NumberOfWorkers`\\. \nThe value that can be allocated for `MaxCapacity` depends on whether you are running a Python shell job or an Apache Spark ETL job: \n+ When you specify a Python shell job \\(`JobCommand.Name`=\"pythonshell\"\\), you can allocate either 0\\.0625 or 1 DPU\\. The default is 0\\.0625 DPU\\.\n+ When you specify an Apache Spark ETL job \\(`JobCommand.Name`=\"glueetl\"\\), you can allocate from 2 to 100 DPUs\\. The default is 10 DPUs\\. This job type cannot have a fractional DPU allocation\\.\n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxRetries": "The maximum number of times to retry this job after a JobRun fails\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name you assign to this job definition\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "NonOverridableArguments": "Non\\-overridable arguments for this job, specified as name\\-value pairs\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NotificationProperty": "Specifies configuration properties of a notification\\. \n*Required*: No \n*Type*: [NotificationProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-notificationproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NumberOfWorkers": "The number of workers of a defined `workerType` that are allocated when a job runs\\. \nThe maximum number of workers you can define are 299 for `G.1X`, and 149 for `G.2X`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Role": "The name or Amazon Resource Name \\(ARN\\) of the IAM role associated with this job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -11116,7 +12365,7 @@ }, "AWS::Glue::Job JobCommand": { "Name": "The name of the job command\\. For an Apache Spark ETL job, this must be `glueetl`\\. For a Python shell job, it must be `pythonshell`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PythonVersion": "The Python version being used to execute a Python shell job\\. Allowed values are 2 or 3\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PythonVersion": "The Python version being used to execute a Python shell job\\. Allowed values are 3 or 3\\.9\\. Version 2 is deprecated\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ScriptLocation": "Specifies the Amazon Simple Storage Service \\(Amazon S3\\) path to a script that executes a job \\(required\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Glue::Job NotificationProperty": { @@ -11261,7 +12510,7 @@ "Name": "The name of the security configuration\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Glue::SecurityConfiguration CloudWatchEncryption": { - "CloudWatchEncryptionMode": "The encryption mode to use for CloudWatch data\\. \n*Required*: No \n*Type*: String \n*Allowed Values*: `DISABLED | SSE-KMS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CloudWatchEncryptionMode": "The encryption mode to use for CloudWatch data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KmsKeyArn": "The Amazon Resource Name \\(ARN\\) of the KMS key to be used to encrypt the data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Glue::SecurityConfiguration EncryptionConfiguration": { @@ -11270,15 +12519,15 @@ "S3Encryptions": "The encyption configuration for Amazon Simple Storage Service \\(Amazon S3\\) data\\. \n*Required*: No \n*Type*: [S3Encryptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Glue::SecurityConfiguration JobBookmarksEncryption": { - "JobBookmarksEncryptionMode": "The encryption mode to use for job bookmarks data\\. \n*Required*: No \n*Type*: String \n*Allowed Values*: `DISABLED | CSE-KMS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "JobBookmarksEncryptionMode": "The encryption mode to use for job bookmarks data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KmsKeyArn": "The Amazon Resource Name \\(ARN\\) of the KMS key to be used to encrypt the data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Glue::SecurityConfiguration S3Encryption": { "KmsKeyArn": "The Amazon Resource Name \\(ARN\\) of the KMS key to be used to encrypt the data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3EncryptionMode": "The encryption mode to use for Amazon S3 data\\. \n*Required*: No \n*Type*: String \n*Allowed Values*: `DISABLED | SSE-KMS | SSE-S3`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "S3EncryptionMode": "The encryption mode to use for Amazon S3 data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Glue::Table": { - "CatalogId": "The ID of the Data Catalog in which to create the `Table`\\. If none is supplied, the AWS account ID is used by default\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CatalogId": "The ID of the Data Catalog in which to create the `Table`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DatabaseName": "The name of the database where the table metadata resides\\. For Hive compatibility, this must be all lowercase\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TableInput": "A structure used to define a table\\. \n*Required*: Yes \n*Type*: [TableInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -11334,25 +12583,26 @@ "AWS::Glue::Table TableInput": { "Description": "A description of the table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The table name\\. For Hive compatibility, this is folded to lowercase when it is stored\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Owner": "The table owner\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Owner": "The table owner\\. Included for Apache Hive compatibility\\. Not used in the normal course of AWS Glue operations\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Parameters": "These key\\-value pairs define properties associated with the table\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PartitionKeys": "A list of columns by which the table is partitioned\\. Only primitive types are supported as partition keys\\. \nWhen you create a table used by Amazon Athena, and you do not specify any `partitionKeys`, you must at least set the value of `partitionKeys` to an empty list\\. For example: \n `\"PartitionKeys\": []` \n*Required*: No \n*Type*: List of [Column](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Retention": "The retention time for this table\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StorageDescriptor": "A storage descriptor containing information about the physical storage of this table\\. \n*Required*: No \n*Type*: [StorageDescriptor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TableType": "The type of this table \\(`EXTERNAL_TABLE`, `VIRTUAL_VIEW`, etc\\.\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TableType": "The type of this table\\. AWS Glue will create tables with the `EXTERNAL_TABLE` type\\. Other services, such as Athena, may create tables with additional table types\\. \n AWS Glue related table types: \nEXTERNAL\\_TABLE \nHive compatible attribute \\- indicates a non\\-Hive managed table\\. \nGOVERNED \nUsed by AWS Lake Formation\\. The AWS Glue Data Catalog understands `GOVERNED`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TargetTable": "A `TableIdentifier` structure that describes a target table for resource linking\\. \n*Required*: No \n*Type*: [TableIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ViewExpandedText": "If the table is a view, the expanded text of the view; otherwise `null`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ViewOriginalText": "If the table is a view, the original text of the view; otherwise `null`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ViewExpandedText": "Included for Apache Hive compatibility\\. Not used in the normal course of AWS Glue operations\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ViewOriginalText": "Included for Apache Hive compatibility\\. Not used in the normal course of AWS Glue operations\\. If the table is a `VIRTUAL_VIEW`, certain Athena configuration encoded in base64\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Glue::Trigger": { "Actions": "The actions initiated by this trigger\\. \n*Required*: Yes \n*Type*: List of [Action](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description of this trigger\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventBatchingCondition": "Batch condition that must be met \\(specified number of events received or batch time window expired\\) before EventBridge event trigger fires\\. \n*Required*: No \n*Type*: [EventBatchingCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-eventbatchingcondition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the trigger\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Predicate": "The predicate of this trigger, which defines when it will fire\\. \n*Required*: No \n*Type*: [Predicate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-predicate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Schedule": "A `cron` expression used to specify the schedule\\. For more information, see [Time\\-Based Schedules for Jobs and Crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) in the *AWS Glue Developer Guide*\\. For example, to run something every day at 12:15 UTC, specify `cron(15 12 * * ? *)`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StartOnCreation": "Set to true to start `SCHEDULED` and `CONDITIONAL` triggers when created\\. True is not supported for `ON_DEMAND` triggers\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags to use with this trigger\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Type": "The type of trigger that this is\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of trigger that this is\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "WorkflowName": "The name of the workflow associated with the trigger\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Glue::Trigger Action": { @@ -11370,6 +12620,10 @@ "LogicalOperator": "A logical operator\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "State": "The condition state\\. Currently, the values supported are `SUCCEEDED`, `STOPPED`, `TIMEOUT`, and `FAILED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Glue::Trigger EventBatchingCondition": { + "BatchSize": "Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BatchWindow": "Window of time in seconds after which EventBridge event trigger fires\\. Window starts when first event is received\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Glue::Trigger NotificationProperty": { "NotifyDelayAfter": "After a job run starts, the number of minutes to wait before sending a job run delay notification \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -11380,9 +12634,53 @@ "AWS::Glue::Workflow": { "DefaultRunProperties": "A collection of properties to be used as part of each execution of the workflow \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description of the workflow \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxConcurrentRuns": "You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs\\. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the workflow representing the flow \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The tags to use with this workflow\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Grafana::Workspace": { + "AccountAccessType": "Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization\\. If this is `ORGANIZATION`, the `workspaceOrganizationalUnits` parameter specifies which organizational units the workspace can access\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CURRENT_ACCOUNT | ORGANIZATION` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthenticationProviders": "Specifies whether this workspace uses SAML 2\\.0, AWS IAM Identity Center \\(successor to AWS Single Sign\\-On\\), or both to authenticate users for using the Grafana console within a workspace\\. For more information, see [User authentication in Amazon Managed Grafana](https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientToken": "A unique, case\\-sensitive, user\\-provided identifier to ensure the idempotency of the request\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[!-~]{1,64}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DataSources": "Specifies the AWS data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources\\. \nThis list is only used when the workspace was created through the AWS console, and the `permissionType` is `SERVICE_MANAGED`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The user\\-defined description of the workspace\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the workspace\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9-._~]{1,255}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NotificationDestinations": "The AWS notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OrganizationRoleName": "The name of the IAM role that is used to access resources through Organizations\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OrganizationalUnits": "Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PermissionType": "If this is `SERVICE_MANAGED`, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use AWS data sources and notification channels\\. \nIf this is `CUSTOMER_MANAGED`, you must manage those roles and permissions yourself\\. \nIf you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other AWS accounts in the organization, this parameter must be set to `CUSTOMER_MANAGED`\\. \nFor more information about converting between customer and service managed, see [Managing permissions for data sources and notification channels](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html)\\. For more information about the roles and permissions that must be managed for customer managed workspaces, see [Amazon Managed Grafana permissions and policies for AWS data sources and notification channels](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html) \n*Required*: No \n*Type*: String \n*Allowed values*: `CUSTOMER_MANAGED | SERVICE_MANAGED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleArn": "The IAM role that grants permissions to the AWS resources that the workspace will view data from\\. This role must already exist\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SamlConfiguration": "If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the `Admin` and `Editor` roles in the workspace\\. \n*Required*: No \n*Type*: [SamlConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StackSetName": "The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcConfiguration": "The configuration for connecting to data sources in a private VPC \\(Amazon Virtual Private Cloud\\)\\. \n*Required*: No \n*Type*: [VpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-vpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Grafana::Workspace AssertionAttributes": { + "Email": "The name of the attribute within the SAML assertion to use as the email names for SAML users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Groups": "The name of the attribute within the SAML assertion to use as the user full \"friendly\" names for user groups\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Login": "The name of the attribute within the SAML assertion to use as the login names for SAML users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the attribute within the SAML assertion to use as the user full \"friendly\" names for SAML users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Org": "The name of the attribute within the SAML assertion to use as the user full \"friendly\" names for the users' organizations\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Role": "The name of the attribute within the SAML assertion to use as the user roles\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Grafana::Workspace IdpMetadata": { + "Url": "The URL of the location containing the IdP metadata\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Xml": "The full IdP metadata, in XML format\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Grafana::Workspace RoleValues": { + "Admin": "A list of groups from the SAML assertion attribute to grant the Grafana `Admin` role to\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Editor": "A list of groups from the SAML assertion attribute to grant the Grafana `Editor` role to\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Grafana::Workspace SamlConfiguration": { + "AllowedOrganizations": "Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace\\. If this is empty, all organizations in the assertion attribute have access\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AssertionAttributes": "A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace\\. \n*Required*: No \n*Type*: [AssertionAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IdpMetadata": "A structure containing the identity provider \\(IdP\\) metadata used to integrate the identity provider with this workspace\\. \n*Required*: Yes \n*Type*: [IdpMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-idpmetadata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LoginValidityDuration": "How long a sign\\-on session by a SAML user is valid, before the user has to sign on again\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleValues": "A structure containing arrays that map group names in the SAML assertion to the Grafana `Admin` and `Editor` roles in the workspace\\. \n*Required*: No \n*Type*: [RoleValues](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-rolevalues.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Grafana::Workspace VpcConfiguration": { + "SecurityGroupIds": "The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect\\. Duplicates not allowed\\. \n*Array Members*: Minimum number of 1 items\\. Maximum number of 5 items\\. \n*Length*: Minimum length of 0\\. Maximum length of 255\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SubnetIds": "The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect\\. Duplicates not allowed\\. \n*Array Members*: Minimum number of 2 items\\. Maximum number of 6 items\\. \n*Length*: Minimum length of 0\\. Maximum length of 255\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Greengrass::ConnectorDefinition": { "InitialVersion": "The connector definition version to include when the connector definition is created\\. A connector definition version contains a list of [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connector.html) property types\\. \nTo associate a connector definition version after the connector definition is created, create an [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html) resource and specify the ID of this connector definition\\.\n*Required*: No \n*Type*: [ConnectorDefinitionVersion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connectordefinitionversion.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "The name of the connector definition\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -11716,11 +13014,11 @@ "Tags": "Application\\-specific metadata to attach to the component version\\. You can use tags in IAM policies to control access to AWS IoT Greengrass resources\\. You can also use tags to categorize your resources\\. For more information, see [Tag your AWS IoT Greengrass Version 2 resources](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in the *AWS IoT Greengrass V2 Developer Guide*\\. \nThis `Json` property type is processed as a map of key\\-value pairs\\. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates\\." }, "AWS::GreengrassV2::ComponentVersion ComponentDependencyRequirement": { - "DependencyType": "The type of this dependency\\. Choose from the following options: \n+ `SOFT` \u2013 The component doesn't restart if the dependency changes state\\.\n+ `HARD` \u2013 The component restarts if the dependency changes state\\.\nDefault: `HARD` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VersionRequirement": "The component version requirement for the component dependency\\. \nAWS IoT Greengrass uses semantic version constraints\\. For more information, see [Semantic Versioning](https://semver.org/)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DependencyType": "The type of this dependency\\. Choose from the following options: \n+ `SOFT` \u2013 The component doesn't restart if the dependency changes state\\.\n+ `HARD` \u2013 The component restarts if the dependency changes state\\.\nDefault: `HARD` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "VersionRequirement": "The component version requirement for the component dependency\\. \nAWS IoT Greengrass uses semantic version constraints\\. For more information, see [Semantic Versioning](https://semver.org/)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::GreengrassV2::ComponentVersion ComponentPlatform": { - "Attributes": "A dictionary of attributes for the platform\\. The software defines the `os` and `platform` by default\\. You can specify additional platform attributes for a core device when you deploy the Greengrass nucleus component\\. For more information, see the [Greengrass nucleus component](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Attributes": "A dictionary of attributes for the platform\\. The AWS IoT Greengrass Core software defines the `os` and `platform` by default\\. You can specify additional platform attributes for a core device when you deploy the AWS IoT Greengrass nucleus component\\. For more information, see the [AWS IoT Greengrass nucleus component](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "The friendly name of the platform\\. This name helps you identify the platform\\. \nIf you omit this parameter, AWS IoT Greengrass creates a friendly name from the `os` and `architecture` of the platform\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::GreengrassV2::ComponentVersion LambdaContainerParams": { @@ -11744,16 +13042,16 @@ "ExecArgs": "The list of arguments to pass to the Lambda function when it runs\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InputPayloadEncodingType": "The encoding type that the Lambda function supports\\. \nDefault: `json` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "LinuxProcessParams": "The parameters for the Linux process that contains the Lambda function\\. \n*Required*: No \n*Type*: [LambdaLinuxProcessParams](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdalinuxprocessparams.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MaxIdleTimeInSeconds": "The maximum amount of time in seconds that a non\\-pinned Lambda function can idle before the software stops its process\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MaxIdleTimeInSeconds": "The maximum amount of time in seconds that a non\\-pinned Lambda function can idle before the AWS IoT Greengrass Core software stops its process\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "MaxInstancesCount": "The maximum number of instances that a non\\-pinned Lambda function can run at the same time\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MaxQueueSize": "The maximum size of the message queue for the Lambda function component\\. The Greengrass core device stores messages in a FIFO \\(first\\-in\\-first\\-out\\) queue until it can run the Lambda function to consume each message\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Pinned": "Whether or not the Lambda function is pinned, or long\\-lived\\. \n+ A pinned Lambda function starts when the starts and keeps running in its own container\\.\n+ A non\\-pinned Lambda function starts only when it receives a work item and exists after it idles for `maxIdleTimeInSeconds`\\. If the function has multiple work items, the software creates multiple instances of the function\\.\nDefault: `true` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MaxQueueSize": "The maximum size of the message queue for the Lambda function component\\. The AWS IoT Greengrass core device stores messages in a FIFO \\(first\\-in\\-first\\-out\\) queue until it can run the Lambda function to consume each message\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Pinned": "Whether or not the Lambda function is pinned, or long\\-lived\\. \n+ A pinned Lambda function starts when the AWS IoT Greengrass Core starts and keeps running in its own container\\.\n+ A non\\-pinned Lambda function starts only when it receives a work item and exists after it idles for `maxIdleTimeInSeconds`\\. If the function has multiple work items, the AWS IoT Greengrass Core software creates multiple instances of the function\\.\nDefault: `true` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "StatusTimeoutInSeconds": "The interval in seconds at which a pinned \\(also known as long\\-lived\\) Lambda function component sends status updates to the Lambda manager component\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TimeoutInSeconds": "The maximum amount of time in seconds that the Lambda function can process a work item\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::GreengrassV2::ComponentVersion LambdaFunctionRecipeSource": { "ComponentDependencies": "The component versions on which this Lambda function component depends\\. \n*Required*: No \n*Type*: Map of [ComponentDependencyRequirement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-componentdependencyrequirement.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ComponentLambdaParameters": "The system and runtime parameters for the Lambda function as it runs on the Greengrass core device\\. \n*Required*: No \n*Type*: [LambdaExecutionParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ComponentLambdaParameters": "The system and runtime parameters for the Lambda function as it runs on the AWS IoT Greengrass core device\\. \n*Required*: No \n*Type*: [LambdaExecutionParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ComponentName": "The name of the component\\. \nDefaults to the name of the Lambda function\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ComponentPlatforms": "The platforms that the component version supports\\. \n*Required*: No \n*Type*: List of [ComponentPlatform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-componentplatform.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ComponentVersion": "The version of the component\\. \nDefaults to the version of the Lambda function as a semantic version\\. For example, if your function version is `3`, the component version becomes `3.0.0`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -11769,6 +13067,74 @@ "Permission": "The permission to access the volume: read/only \\(`ro`\\) or read/write \\(`rw`\\)\\. \nDefault: `ro` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SourcePath": "The path to the physical volume in the file system\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::GreengrassV2::Deployment": { + "Components": "The components to deploy\\. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component\\. \n*Required*: No \n*Type*: Map of [ComponentDeploymentSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DeploymentName": "The name of the deployment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DeploymentPolicies": "The deployment policies for the deployment\\. These policies define how the deployment updates components and handles failure\\. \n*Required*: No \n*Type*: [DeploymentPolicies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IotJobConfiguration": "The job configuration for the deployment configuration\\. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration\\. \n*Required*: No \n*Type*: [DeploymentIoTJobConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Application\\-specific metadata to attach to the deployment\\. You can use tags in IAM policies to control access to AWS IoT Greengrass resources\\. You can also use tags to categorize your resources\\. For more information, see [Tag your AWS IoT Greengrass Version 2 resources](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in the *AWS IoT Greengrass V2 Developer Guide*\\. \nThis `Json` property type is processed as a map of key\\-value pairs\\. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates\\.", + "TargetArn": "The ARN of the target AWS IoT thing or thing group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment ComponentConfigurationUpdate": { + "Merge": "A serialized JSON string that contains the configuration object to merge to target devices\\. The core device merges this configuration with the component's existing configuration\\. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration\\. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object\\. For more information, see [Merge configuration updates](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#merge-configuration-update) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Reset": "The list of configuration nodes to reset to default values on target devices\\. Use JSON pointers to specify each node to reset\\. JSON pointers start with a forward slash \\(`/`\\) and use forward slashes to separate the key for each level in the object\\. For more information, see the [JSON pointer specification](https://tools.ietf.org/html/rfc6901) and [Reset configuration updates](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#reset-configuration-update) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment ComponentDeploymentSpecification": { + "ComponentVersion": "The version of the component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ConfigurationUpdate": "The configuration updates to deploy for the component\\. You can define reset updates and merge updates\\. A reset updates the keys that you specify to the default configuration for the component\\. A merge updates the core device's component configuration with the keys and values that you specify\\. The AWS IoT Greengrass Core software applies reset updates before it applies merge updates\\. For more information, see [Update component configuration](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html)\\. \n*Required*: No \n*Type*: [ComponentConfigurationUpdate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentconfigurationupdate.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RunWith": "The system user and group that the software uses to run component processes on the core device\\. If you omit this parameter, the software uses the system user and group that you configure for the core device\\. For more information, see [Configure the user and group that run components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: [ComponentRunWith](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentrunwith.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment ComponentRunWith": { + "PosixUser": "The POSIX system user and \\(optional\\) group to use to run this component\\. Specify the user and group separated by a colon \\(`:`\\) in the following format: `user:group`\\. The group is optional\\. If you don't specify a group, the AWS IoT Greengrass Core software uses the primary user for the group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SystemResourceLimits": "The system resource limits to apply to this component's process on the core device\\. AWS IoT Greengrass supports this feature only on Linux core devices\\. \nIf you omit this parameter, the AWS IoT Greengrass Core software uses the default system resource limits that you configure on the AWS IoT Greengrass nucleus component\\. For more information, see [ Configure system resource limits for components ](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits)\\. \n*Required*: No \n*Type*: [SystemResourceLimits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-systemresourcelimits.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "WindowsUser": "The Windows user to use to run this component on Windows core devices\\. The user must exist on each Windows core device, and its name and password must be in the LocalSystem account's Credentials Manager instance\\. \nIf you omit this parameter, the AWS IoT Greengrass Core software uses the default Windows user that you configure on the AWS IoT Greengrass nucleus component\\. For more information, see [Configure the user and group that run components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment DeploymentComponentUpdatePolicy": { + "Action": "Whether or not to notify components and wait for components to become safe to update\\. Choose from the following options: \n+ `NOTIFY_COMPONENTS` \u2013 The deployment notifies each component before it stops and updates that component\\. Components can use the [SubscribeToComponentUpdates](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates) IPC operation to receive these notifications\\. Then, components can respond with the [DeferComponentUpdate](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate) IPC operation\\. For more information, see the [Create deployments](https://docs.aws.amazon.com/greengrass/v2/latest/developerguide/create-deployments.html) in the *AWS IoT Greengrass V2 Developer Guide*\\.\n+ `SKIP_NOTIFY_COMPONENTS` \u2013 The deployment doesn't notify components or wait for them to be safe to update\\.\nDefault: `NOTIFY_COMPONENTS` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TimeoutInSeconds": "The amount of time in seconds that each component on a device has to report that it's safe to update\\. If the component waits for longer than this timeout, then the deployment proceeds on the device\\. \nDefault: `60` \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment DeploymentConfigurationValidationPolicy": { + "TimeoutInSeconds": "The amount of time in seconds that a component can validate its configuration updates\\. If the validation time exceeds this timeout, then the deployment proceeds for the device\\. \nDefault: `30` \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment DeploymentIoTJobConfiguration": { + "AbortConfig": "The stop configuration for the job\\. This configuration defines when and how to stop a job rollout\\. \n*Required*: No \n*Type*: [IoTJobAbortConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "JobExecutionsRolloutConfig": "The rollout configuration for the job\\. This configuration defines the rate at which the job rolls out to the fleet of target devices\\. \n*Required*: No \n*Type*: [IoTJobExecutionsRolloutConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TimeoutConfig": "The timeout configuration for the job\\. This configuration defines the amount of time each device has to complete the job\\. \n*Required*: No \n*Type*: [IoTJobTimeoutConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobtimeoutconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment DeploymentPolicies": { + "ComponentUpdatePolicy": "The component update policy for the configuration deployment\\. This policy defines when it's safe to deploy the configuration to devices\\. \n*Required*: No \n*Type*: [DeploymentComponentUpdatePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ConfigurationValidationPolicy": "The configuration validation policy for the configuration deployment\\. This policy defines how long each component has to validate its configure updates\\. \n*Required*: No \n*Type*: [DeploymentConfigurationValidationPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentconfigurationvalidationpolicy.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FailureHandlingPolicy": "The failure handling policy for the configuration deployment\\. This policy defines what to do if the deployment fails\\. \nDefault: `ROLLBACK` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment IoTJobAbortConfig": { + "CriteriaList": "The list of criteria that define when and how to cancel the configuration deployment\\. \n*Required*: Yes \n*Type*: List of [IoTJobAbortCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortcriteria.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment IoTJobAbortCriteria": { + "Action": "The action to perform when the criteria are met\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FailureType": "The type of job deployment failure that can cancel a job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MinNumberOfExecutedThings": "The minimum number of things that receive the configuration before the job can cancel\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ThresholdPercentage": "The minimum percentage of `failureType` failures that occur before the job can cancel\\. \nThis parameter supports up to two digits after the decimal \\(for example, you can specify `10.9` or `10.99`, but not `10.999`\\)\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment IoTJobExecutionsRolloutConfig": { + "ExponentialRate": "The exponential rate to increase the job rollout rate\\. \n*Required*: No \n*Type*: [IoTJobExponentialRolloutRate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MaximumPerMinute": "The maximum number of devices that receive a pending job notification, per minute\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment IoTJobExponentialRolloutRate": { + "BaseRatePerMinute": "The minimum number of devices that receive a pending job notification, per minute, when the job starts\\. This parameter defines the initial rollout rate of the job\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IncrementFactor": "The exponential factor to increase the rollout rate for the job\\. \nThis parameter supports up to one digit after the decimal \\(for example, you can specify `1.5`, but not `1.55`\\)\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RateIncreaseCriteria": "The criteria to increase the rollout rate for the job\\. \n*Required*: Yes \n*Type*: [IoTJobRateIncreaseCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobrateincreasecriteria.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment IoTJobRateIncreaseCriteria": { + "NumberOfNotifiedThings": "The number of devices to receive the job notification before the rollout rate increases\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "NumberOfSucceededThings": "The number of devices to successfully run the configuration job before the rollout rate increases\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment IoTJobTimeoutConfig": { + "InProgressTimeoutInMinutes": "The amount of time, in minutes, that devices have to complete the job\\. The timer starts when the job status is set to `IN_PROGRESS`\\. If the job status doesn't change to a terminal state before the time expires, then the job status is set to `TIMED_OUT`\\. \nThe timeout interval must be between 1 minute and 7 days \\(10080 minutes\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::GreengrassV2::Deployment SystemResourceLimits": { + "Cpus": "The maximum amount of CPU time that a component's processes can use on the core device\\. A core device's total CPU time is equivalent to the device's number of CPU cores\\. For example, on a core device with 4 CPU cores, you can set this value to 2 to limit the component's processes to 50 percent usage of each CPU core\\. On a device with 1 CPU core, you can set this value to 0\\.25 to limit the component's processes to 25 percent usage of the CPU\\. If you set this value to a number greater than the number of CPU cores, the AWS IoT Greengrass Core software doesn't limit the component's CPU usage\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Memory": "The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on the core device\\. For more information, see [Configure system resource limits for components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::GroundStation::Config": { "ConfigData": "Object containing the parameters of a config\\. Only one subtype may be specified per config\\. See the subtype definitions for a description of each config subtype\\. \n*Required*: Yes \n*Type*: [ConfigData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the config object\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -11840,6 +13206,8 @@ "Polarization": "The polarization of the spectrum\\. Valid values are `\"RIGHT_HAND\"` and `\"LEFT_HAND\"`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GroundStation::DataflowEndpointGroup": { + "ContactPostPassDurationSeconds": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContactPrePassDurationSeconds": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EndpointDetails": "List of Endpoint Details, containing address and port for each endpoint\\. \n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html) of [EndpointDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Tags assigned to a resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -11877,10 +13245,12 @@ "AWS::GuardDuty::Detector": { "DataSources": "Describes which data sources will be enabled for the detector\\. \n*Required*: No \n*Type*: [CFNDataSourceConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfndatasourceconfigurations.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enable": "Specifies whether the detector is to be enabled on creation\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FindingPublishingFrequency": "Specifies how frequently updated findings are exported\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `FIFTEEN_MINUTES | ONE_HOUR | SIX_HOURS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "FindingPublishingFrequency": "Specifies how frequently updated findings are exported\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `FIFTEEN_MINUTES | ONE_HOUR | SIX_HOURS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The tags to be added to a new detector resource\\. Each tag consists of a key and an optional value, both of which you define\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GuardDuty::Detector CFNDataSourceConfigurations": { "Kubernetes": "Describes which Kuberentes data sources are enabled for a detector\\. \n*Required*: No \n*Type*: [CFNKubernetesConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnkubernetesconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MalwareProtection": "Describes whether Malware Protection will be enabled as a data source\\. \n*Required*: No \n*Type*: [CFNMalwareProtectionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnmalwareprotectionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3Logs": "Describes whether S3 data event logs are enabled as a data source\\. \n*Required*: No \n*Type*: [CFNS3LogsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfns3logsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GuardDuty::Detector CFNKubernetesAuditLogsConfiguration": { @@ -11889,23 +13259,37 @@ "AWS::GuardDuty::Detector CFNKubernetesConfiguration": { "AuditLogs": "Describes whether Kubernetes audit logs are enabled as a data source for the detector\\. \n*Required*: No \n*Type*: [CFNKubernetesAuditLogsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnkubernetesauditlogsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::GuardDuty::Detector CFNMalwareProtectionConfiguration": { + "ScanEc2InstanceWithFindings": "Describes the configuration of Malware Protection for EC2 instances with findings\\. \n*Required*: No \n*Type*: [CFNScanEc2InstanceWithFindingsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnscanec2instancewithfindingsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::GuardDuty::Detector CFNS3LogsConfiguration": { "Enable": "The status of S3 data event logs as a data source\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::GuardDuty::Detector CFNScanEc2InstanceWithFindingsConfiguration": { + "EbsVolumes": "Describes the configuration for scanning EBS volumes as data source\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::GuardDuty::Filter": { "Action": "Specifies the action that is to be applied to the findings that match the filter\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ARCHIVE | NOOP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "The description of the filter\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the filter\\. Valid special characters include period \\(\\.\\), underscore \\(\\_\\), dash \\(\\-\\), and whitespace\\. The new line character is considered to be an invalid input for description\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DetectorId": "The ID of the detector belonging to the GuardDuty account that you want to create a filter for\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FindingCriteria": "Represents the criteria to be used in the filter for querying findings\\. \n*Required*: Yes \n*Type*: [FindingCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-filter-findingcriteria.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the filter\\. Minimum length of 3\\. Maximum length of 64\\. Valid characters include alphanumeric characters, dot \\(\\.\\), underscore \\(\\_\\), and dash \\(\\-\\)\\. Spaces are not allowed\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Rank": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "The name of the filter\\. Valid characters include period \\(\\.\\), underscore \\(\\_\\), dash \\(\\-\\), and alphanumeric characters\\. A whitespace is considered to be an invalid character\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Rank": "Specifies the position of the filter in the list of current filters\\. Also specifies the order in which this filter is applied to the findings\\. The minimum value for this property is 1 and the maximum is 100\\. \nBy default, filters may not be created in the same order as they are ranked\\. To ensure that the filters are created in the expected order, you can use an optional attribute, [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html), with the following syntax: `\"DependsOn\":[ \"ObjectName\" ]`\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The tags to be added to a new filter resource\\. Each tag consists of a key and an optional value, both of which you define\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GuardDuty::Filter Condition": { "Eq": "Represents the equal condition to apply to a single field when querying for findings\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Equals": "Represents an *equal* **** condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "GreaterThan": "Represents a *greater than* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "GreaterThanOrEqual": "Represents a *greater than or equal* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Gt": "Represents a *greater than* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Gte": "Represents the greater than or equal condition to apply to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LessThan": "Represents a *less than* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LessThanOrEqual": "Represents a *less than or equal* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Lt": "Represents the less than condition to apply to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Lte": "Represents the less than or equal condition to apply to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Neq": "Represents the not equal condition to apply to a single field when querying for findings\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Neq": "Represents the not equal condition to apply to a single field when querying for findings\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NotEquals": "Represents a *not equal* **** condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GuardDuty::Filter FindingCriteria": { "Criterion": "Represents a map of finding properties that match specified conditions and values when querying findings\\. \nFor a mapping of JSON criterion to their console equivalent see [Finding criteria](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_filter-findings.html#filter_criteria)\\. The following are the available criterion: \n+ accountId\n+ region\n+ confidence\n+ id\n+ resource\\.accessKeyDetails\\.accessKeyId\n+ resource\\.accessKeyDetails\\.principalId\n+ resource\\.accessKeyDetails\\.userName\n+ resource\\.accessKeyDetails\\.userType\n+ resource\\.instanceDetails\\.iamInstanceProfile\\.id\n+ resource\\.instanceDetails\\.imageId\n+ resource\\.instanceDetails\\.instanceId\n+ resource\\.instanceDetails\\.outpostArn\n+ resource\\.instanceDetails\\.networkInterfaces\\.ipv6Addresses\n+ resource\\.instanceDetails\\.networkInterfaces\\.privateIpAddresses\\.privateIpAddress\n+ resource\\.instanceDetails\\.networkInterfaces\\.publicDnsName\n+ resource\\.instanceDetails\\.networkInterfaces\\.publicIp\n+ resource\\.instanceDetails\\.networkInterfaces\\.securityGroups\\.groupId\n+ resource\\.instanceDetails\\.networkInterfaces\\.securityGroups\\.groupName\n+ resource\\.instanceDetails\\.networkInterfaces\\.subnetId\n+ resource\\.instanceDetails\\.networkInterfaces\\.vpcId\n+ resource\\.instanceDetails\\.tags\\.key\n+ resource\\.instanceDetails\\.tags\\.value\n+ resource\\.resourceType\n+ service\\.action\\.actionType\n+ service\\.action\\.awsApiCallAction\\.api\n+ service\\.action\\.awsApiCallAction\\.callerType\n+ service\\.action\\.awsApiCallAction\\.errorCode\n+ service\\.action\\.awsApiCallAction\\.remoteIpDetails\\.city\\.cityName\n+ service\\.action\\.awsApiCallAction\\.remoteIpDetails\\.country\\.countryName\n+ service\\.action\\.awsApiCallAction\\.remoteIpDetails\\.ipAddressV4\n+ service\\.action\\.awsApiCallAction\\.remoteIpDetails\\.organization\\.asn\n+ service\\.action\\.awsApiCallAction\\.remoteIpDetails\\.organization\\.asnOrg\n+ service\\.action\\.awsApiCallAction\\.serviceName\n+ service\\.action\\.dnsRequestAction\\.domain\n+ service\\.action\\.networkConnectionAction\\.blocked\n+ service\\.action\\.networkConnectionAction\\.connectionDirection\n+ service\\.action\\.networkConnectionAction\\.localPortDetails\\.port\n+ service\\.action\\.networkConnectionAction\\.protocol\n+ service\\.action\\.networkConnectionAction\\.localIpDetails\\.ipAddressV4\n+ service\\.action\\.networkConnectionAction\\.remoteIpDetails\\.city\\.cityName\n+ service\\.action\\.networkConnectionAction\\.remoteIpDetails\\.country\\.countryName\n+ service\\.action\\.networkConnectionAction\\.remoteIpDetails\\.ipAddressV4\n+ service\\.action\\.networkConnectionAction\\.remoteIpDetails\\.organization\\.asn\n+ service\\.action\\.networkConnectionAction\\.remoteIpDetails\\.organization\\.asnOrg\n+ service\\.action\\.networkConnectionAction\\.remotePortDetails\\.port\n+ service\\.additionalInfo\\.threatListName\n+ service\\.archived", @@ -11916,7 +13300,8 @@ "DetectorId": "The unique ID of the detector of the GuardDuty account that you want to create an IPSet for\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Format": "The format of the file that contains the IPSet\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALIEN_VAULT | FIRE_EYE | OTX_CSV | PROOF_POINT | STIX | TXT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Location": "The URI of the file that contains the IPSet\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The user\\-friendly name to identify the IPSet\\. \n Allowed characters are alphanumerics, spaces, hyphens \\(\\-\\), and underscores \\(\\_\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "The user\\-friendly name to identify the IPSet\\. \n Allowed characters are alphanumeric, whitespace, dash \\(\\-\\), and underscores \\(\\_\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The tags to be added to a new IP set resource\\. Each tag consists of a key and an optional value, both of which you define\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::GuardDuty::Master": { "DetectorId": "The unique ID of the detector of the GuardDuty member account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -11936,7 +13321,8 @@ "DetectorId": "The unique ID of the detector of the GuardDuty account that you want to create a threatIntelSet for\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Format": "The format of the file that contains the ThreatIntelSet\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALIEN_VAULT | FIRE_EYE | OTX_CSV | PROOF_POINT | STIX | TXT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Location": "The URI of the file that contains the ThreatIntelSet\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "A user\\-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "A user\\-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The tags to be added to a new threat list resource\\. Each tag consists of a key and an optional value, both of which you define\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::HealthLake::FHIRDatastore": { "DatastoreName": "The user generated name for the Data Store\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -11945,6 +13331,10 @@ "SseConfiguration": "The server\\-side encryption key configuration for a customer provided encryption key specified for creating a Data Store\\. \n*Required*: No \n*Type*: [SseConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-healthlake-fhirdatastore-sseconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::HealthLake::FHIRDatastore CreatedAt": { + "Nanos": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Seconds": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::HealthLake::FHIRDatastore KmsEncryptionConfig": { "CmkType": "The type of customer\\-managed\\-key\\(CMK\\) used for encryption\\. The two types of supported CMKs are customer owned CMKs and Amazon owned CMKs\\. For more information on CMK types, see [KmsEncryptionConfig](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_KmsEncryptionConfig.html#HealthLake-Type-KmsEncryptionConfig-CmkType)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KmsKeyId": "The KMS encryption key id/alias used to encrypt the Data Store contents at rest\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `400` \n*Pattern*: `(arn:aws((https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/-us-gov.html)|(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/-iso.html)|(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/-iso.html-b)|(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/-cn.html))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\\d:)?(\\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" @@ -11999,17 +13389,17 @@ }, "AWS::IAM::Role": { "AssumeRolePolicyDocument": "The trust policy that is associated with this role\\. Trust policies define which entities can assume the role\\. You can associate only one trust policy with a role\\. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples)\\. For more information about the elements that you can use in an IAM policy, see [IAM Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *IAM User Guide*\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "A description of the role that you provide\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Pattern*: `[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "A description of the role that you provide\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ManagedPolicyArns": "A list of Amazon Resource Names \\(ARNs\\) of the IAM managed policies that you want to attach to the role\\. \nFor more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaxSessionDuration": "The maximum session duration \\(in seconds\\) that you want to set for the specified role\\. If you do not specify a value for this setting, the default maximum of one hour is applied\\. This setting can have a value from 1 hour to 12 hours\\. \nAnyone who assumes the role from the or API can use the `DurationSeconds` API parameter or the `duration-seconds` CLI parameter to request a longer session\\. The `MaxSessionDuration` setting determines the maximum duration that can be requested using the `DurationSeconds` parameter\\. If users don't specify a value for the `DurationSeconds` parameter, their security credentials are valid for one hour by default\\. This applies when you use the `AssumeRole*` API operations or the `assume-role*` CLI operations but does not apply when you use those operations to create a console URL\\. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `3600` \n*Maximum*: `43200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxSessionDuration": "The maximum session duration \\(in seconds\\) that you want to set for the specified role\\. If you do not specify a value for this setting, the default value of one hour is applied\\. This setting can have a value from 1 hour to 12 hours\\. \nAnyone who assumes the role from the AWS CLI or API can use the `DurationSeconds` API parameter or the `duration-seconds` AWS CLI parameter to request a longer session\\. The `MaxSessionDuration` setting determines the maximum duration that can be requested using the `DurationSeconds` parameter\\. If users don't specify a value for the `DurationSeconds` parameter, their security credentials are valid for one hour by default\\. This applies when you use the `AssumeRole*` API operations or the `assume-role*` AWS CLI operations but does not apply when you use those operations to create a console URL\\. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `3600` \n*Maximum*: `43200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Path": "The path to the role\\. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*\\. \nThis parameter is optional\\. If it is not included, it defaults to a slash \\(/\\)\\. \nThis parameter allows \\(through its [regex pattern](http://wikipedia.org/wiki/regex)\\) a string of characters consisting of either a forward slash \\(/\\) by itself or a string that must begin and end with forward slashes\\. In addition, it can contain any ASCII character from the \\! \\(`\\u0021`\\) through the DEL character \\(`\\u007F`\\), including most punctuation characters, digits, and upper and lowercased letters\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PermissionsBoundary": "The ARN of the policy used to set the permissions boundary for the role\\. \nFor more information about permissions boundaries, see [Permissions boundaries for IAM identities ](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Policies": "Adds or updates an inline policy document that is embedded in the specified IAM role\\. \nWhen you embed an inline policy in a role, the inline policy is used as part of the role's access \\(permissions\\) policy\\. The role's trust policy is created at the same time as the role\\. You can update a role's trust policy later\\. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html)\\. \nA role can also have an attached managed policy\\. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*\\. \nFor information about limits on the number of inline policies that you can embed with a role, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*\\. \nIf an external policy \\(such as `AWS::IAM::Policy` or `AWS::IAM::ManagedPolicy`\\) has a `Ref` to a role and if a resource \\(such as `AWS::ECS::Service`\\) also has a `Ref` to the same role, add a `DependsOn` attribute to the resource to make the resource depend on the external policy\\. This dependency ensures that the role's policy is available throughout the resource's lifecycle\\. For example, when you delete a stack with an `AWS::ECS::Service` resource, the `DependsOn` attribute ensures that AWS CloudFormation deletes the `AWS::ECS::Service` resource before deleting its role's policy\\.\n*Required*: No \n*Type*: List of [Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Policies": "Adds or updates an inline policy document that is embedded in the specified IAM role\\. \nWhen you embed an inline policy in a role, the inline policy is used as part of the role's access \\(permissions\\) policy\\. The role's trust policy is created at the same time as the role\\. You can update a role's trust policy later\\. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html)\\. \nA role can also have an attached managed policy\\. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*\\. \nFor information about limits on the number of inline policies that you can embed with a role, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*\\. \nIf an external policy \\(such as `AWS::IAM::Policy` or `AWS::IAM::ManagedPolicy`\\) has a `Ref` to a role and if a resource \\(such as `AWS::ECS::Service`\\) also has a `Ref` to the same role, add a `DependsOn` attribute to the resource to make the resource depend on the external policy\\. This dependency ensures that the role's policy is available throughout the resource's lifecycle\\. For example, when you delete a stack with an `AWS::ECS::Service` resource, the `DependsOn` attribute ensures that AWS CloudFormation deletes the `AWS::ECS::Service` resource before deleting its role's policy\\.\n*Required*: No \n*Type*: List of [Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleName": "A name for the IAM role, up to 64 characters in length\\. For valid values, see the `RoleName` parameter for the [https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *IAM User Guide*\\. \nThis parameter allows \\(per its [regex pattern](http://wikipedia.org/wiki/regex)\\) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces\\. You can also include any of the following characters: \\_\\+=,\\.@\\-\\. The role name must be unique within the account\\. Role names are not distinguished by case\\. For example, you cannot create roles named both \"Role1\" and \"role1\"\\. \nIf you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the role name\\. \nIf you specify a name, you must specify the `CAPABILITY_NAMED_IAM` value to acknowledge your template's capabilities\\. For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities)\\. \nNaming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions\\. To prevent this, we recommend using `Fn::Join` and `AWS::Region` to create a Region\\-specific name, as in the following example: `{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "A list of tags that are attached to the role\\. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IAM::Role Policy": { - "PolicyDocument": "The policy document\\. \n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `131072` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PolicyDocument": "The entire contents of the policy that defines permissions\\. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json)\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PolicyName": "The friendly name \\(not ARN\\) identifying the policy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\w+=,.@-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IAM::SAMLProvider": { @@ -12028,15 +13418,15 @@ "AWS::IAM::ServiceLinkedRole": { "AWSServiceName": "The service principal for the AWS service to which this role is attached\\. You use a string similar to a URL but without the http:// in front\\. For example: `elasticbeanstalk.amazonaws.com`\\. \nService principals are unique and case\\-sensitive\\. To find the exact service principal for your service\\-linked role, see [AWS services that work with IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) in the *IAM User Guide*\\. Look for the services that have **Yes **in the **Service\\-Linked Role** column\\. Choose the **Yes** link to view the service\\-linked role documentation for that service\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\w+=,.@-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "CustomSuffix": "A string that you provide, which is combined with the service\\-provided prefix to form the complete role name\\. If you make multiple requests for the same service, then you must supply a different `CustomSuffix` for each request\\. Otherwise the request fails with a duplicate role name error\\. For example, you could add `-1` or `-debug` to the suffix\\. \nSome services do not support the `CustomSuffix` parameter\\. If you provide an optional suffix and the operation fails, try the operation again without the suffix\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[\\w+=,.@-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Description": "The description of the role\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Pattern*: `[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Description": "The description of the role\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IAM::User": { "Groups": "A list of group names to which you want to add the user\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LoginProfile": "Creates a password for the specified IAM user\\. A password allows an IAM user to access AWS services through the AWS Management Console\\. \nYou can use the AWS CLI, the AWS API, or the **Users** page in the IAM console to create a password for any IAM user\\. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the **My Security Credentials** page in the AWS Management Console\\. \nFor more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: [LoginProfile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-loginprofile.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ManagedPolicyArns": "A list of Amazon Resource Names \\(ARNs\\) of the IAM managed policies that you want to attach to the user\\. \nFor more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Path": "The path for the user name\\. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*\\. \nThis parameter is optional\\. If it is not included, it defaults to a slash \\(/\\)\\. \nThis parameter allows \\(through its [regex pattern](http://wikipedia.org/wiki/regex)\\) a string of characters consisting of either a forward slash \\(/\\) by itself or a string that must begin and end with forward slashes\\. In addition, it can contain any ASCII character from the \\! \\(`\\u0021`\\) through the DEL character \\(`\\u007F`\\), including most punctuation characters, digits, and upper and lowercased letters\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PermissionsBoundary": "The ARN of the policy that is used to set the permissions boundary for the user\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Policies": "Adds or updates an inline policy document that is embedded in the specified IAM user\\. To view AWS::IAM::User snippets, see [Declaring an IAM User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user)\\. \nThe name of each policy for a role, user, or group must be unique\\. If you don't choose unique names, updates to the IAM identity will fail\\. \nFor information about limits on the number of inline policies that you can embed in a user, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: List of [Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PermissionsBoundary": "The ARN of the managed policy that is used to set the permissions boundary for the user\\. \nA permissions boundary policy defines the maximum permissions that identity\\-based policies can grant to an entity, but does not grant permissions\\. Permissions boundaries do not define the maximum permissions that a resource\\-based policy can grant to an entity\\. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*\\. \nFor more information about policy types, see [Policy types ](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Policies": "Adds or updates an inline policy document that is embedded in the specified IAM user\\. To view AWS::IAM::User snippets, see [Declaring an IAM User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user)\\. \nThe name of each policy for a role, user, or group must be unique\\. If you don't choose unique names, updates to the IAM identity will fail\\. \nFor information about limits on the number of inline policies that you can embed in a user, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: List of [Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A list of tags that you want to attach to the new user\\. Each tag consists of a key name and an associated value\\. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*\\. \nIf any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserName": "The name of the user to create\\. Do not include the path in this value\\. \nThis parameter allows \\(per its [regex pattern](http://wikipedia.org/wiki/regex)\\) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces\\. You can also include any of the following characters: \\_\\+=,\\.@\\-\\. The user name must be unique within the account\\. User names are not distinguished by case\\. For example, you cannot create users named both \"John\" and \"john\"\\. \nIf you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the user name\\. \nIf you specify a name, you must specify the `CAPABILITY_NAMED_IAM` value to acknowledge your template's capabilities\\. For more information, see [Acknowledging IAM Resources in AWS CloudFormation Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities)\\. \nNaming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions\\. To prevent this, we recommend using `Fn::Join` and `AWS::Region` to create a Region\\-specific name, as in the following example: `{\"Fn::Join\": [\"\", [{\"Ref\": \"AWS::Region\"}, {\"Ref\": \"MyResourceName\"}]]}`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -12045,7 +13435,7 @@ "PasswordResetRequired": "Specifies whether the user is required to set a new password on next sign\\-in\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IAM::User Policy": { - "PolicyDocument": "The policy document\\. \n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `131072` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PolicyDocument": "The entire contents of the policy that defines permissions\\. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json)\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PolicyName": "The friendly name \\(not ARN\\) identifying the policy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\w+=,.@-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IAM::UserToGroupAddition": { @@ -12064,16 +13454,17 @@ "Name": "Channel name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9-_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RecordingConfigurationArn": "The ARN of a RecordingConfiguration resource\\. An empty string indicates that recording is disabled for the channel\\. A RecordingConfiguration ARN indicates that recording is enabled using the specified recording configuration\\. See the [ RecordingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html) resource for more information and an example\\. \n*Default*: \"\" \\(empty string, recording is disabled\\) \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `128` \n*Pattern*: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Type": "The channel type, which determines the allowable resolution and bitrate\\. *If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately\\.* Valid values: \n+ `STANDARD`: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions\\. Resolution can be up to 1080p and bitrate can be up to 8\\.5 Mbps\\. Audio is transcoded only for renditions 360p and below; above that, audio is passed through\\.\n+ `BASIC`: delivers the original input to viewers\\. The viewer\u2019s video\\-quality choice is limited to the original input\\. Resolution can be up to 480p and bitrate can be up to 1\\.5 Mbps\\.\n*Default*: `STANDARD` \n*Required*: No \n*Type*: String \n*Allowed values*: `BASIC | STANDARD` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Type": "The channel type, which determines the allowable resolution and bitrate\\. *If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately\\.* Valid values: \n+ `STANDARD`: Video is transcoded: multiple qualities are generated from the original input to automatically give viewers the best experience for their devices and network conditions\\. Transcoding allows higher playback quality across a range of download speeds\\. Resolution can be up to 1080p and bitrate can be up to 8\\.5 Mbps\\. Audio is transcoded only for renditions 360p and below; above that, audio is passed through\\.\n+ `BASIC`: Video is transmuxed: Amazon IVS delivers the original input to viewers\\. The viewer\u2019s video\\-quality choice is limited to the original input\\. Resolution can be up to 1080p and bitrate can be up to 1\\.5 Mbps for 480p and up to 3\\.5 Mbps for resolutions between 480p and 1080p\\.\n*Default*: `STANDARD` \n*Required*: No \n*Type*: String \n*Allowed values*: `ADVANCED_HD | ADVANCED_SD | BASIC | STANDARD` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IVS::PlaybackKeyPair": { "Name": "Playback\\-key\\-pair name\\. The value does not need to be unique\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9-_]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PublicKeyMaterial": "The public portion of a customer\\-generated key pair\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PublicKeyMaterial": "The public portion of a customer\\-generated key pair\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IVS::RecordingConfiguration": { "DestinationConfiguration": "A destination configuration contains information about where recorded video will be stored\\. See the [ DestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-destinationconfiguration.html) property type for more information\\. \n*Required*: Yes \n*Type*: [DestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-destinationconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "Recording\\-configuration name\\. The value does not need to be unique\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9-_]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RecordingReconnectWindowSeconds": "If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together\\. \n*Default*: `0` \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `300` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ThumbnailConfiguration": "A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session\\. See the [ThumbnailConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thunbnailconfiguration.html) property type for more information\\. \n*Required*: No \n*Type*: [ThumbnailConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -12091,37 +13482,55 @@ "ChannelArn": "Channel ARN for the stream\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::IdentityStore::Group": { + "Description": "A string containing the description of the group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DisplayName": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IdentityStoreId": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IdentityStore::GroupMembership": { + "GroupId": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IdentityStoreId": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MemberId": "An object containing the identifier of a group member\\. Setting `MemberId`'s `UserId` field to a specific User's ID indicates we should consider that User as a group member\\. \n*Required*: Yes \n*Type*: [MemberId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-groupmembership-memberid.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IdentityStore::GroupMembership MemberId": { + "UserId": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::ImageBuilder::Component": { - "ChangeDescription": "A change description of the component\\. For example `initial version`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Data": "The data of the component\\. For example, `name: HelloWorldTestingDocument\\ndescription: This is hello world testing document.\\nschemaVersion: 1.0\\n\\nphases:\\n - name: test\\n steps:\\n - name: HelloWorldStep\\n action: ExecuteBash\\n inputs:\\n commands:\\n - echo \\\"Hello World! Test.\\\"\\n`\\. See Examples below for the schema for creating a component using Data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Description": "The description of the component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "KmsKeyId": "The KMS key identifier used to encrypt the component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ChangeDescription": "The change description of the component\\. Describes what change has been made in this version, or what makes this version different from other versions of this component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Data": "Component `data` contains inline YAML document content for the component\\. Alternatively, you can specify the `uri` of a YAML document file stored in Amazon S3\\. However, you cannot specify both properties\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16000` \n*Pattern*: `[^\\x00]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Description": "Describes the contents of the component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "KmsKeyId": "The ID of the KMS key that is used to encrypt this component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "The name of the component\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Platform": "The platform of the component\\. For example, `Windows`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Linux | Windows` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Platform": "The operating system platform of the component\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Linux | Windows` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SupportedOsVersions": "The operating system \\(OS\\) version supported by the component\\. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `25` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "The tags associated with the component\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "The tags that apply to the component\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Uri": "The `uri` of a YAML component document file\\. This must be an S3 URL \\(`s3://bucket/key`\\), and the requester must have permission to access the S3 bucket it points to\\. If you use Amazon S3, you can specify component content up to your service quota\\. \nAlternatively, you can specify the YAML document inline, using the component `data` property\\. You cannot specify both properties\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Version": "The component version\\. For example, `1.0.0`\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[0-9]+\\.[0-9]+\\.[0-9]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Version": "The component version\\. For example, `1.0.0`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ImageBuilder::ContainerRecipe": { - "Components": "Components for build and test that are included in the container recipe\\. \n*Required*: Yes \n*Type*: List of [ComponentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Components": "Build and test components that are included in the container recipe\\. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination\\. \n*Required*: Yes \n*Type*: List of [ComponentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ContainerType": "Specifies the type of container, such as Docker\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DOCKER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "The description of the container recipe\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DockerfileTemplateData": "Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside\\. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DockerfileTemplateUri": "The S3 URI for the Dockerfile that will be used to build your container image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ImageOsVersionOverride": "Specifies the operating system version for the source image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ImageOsVersionOverride": "Specifies the operating system version for the base image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InstanceConfiguration": "A group of options that can be used to configure an instance for building and testing container images\\. \n*Required*: No \n*Type*: [InstanceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-instanceconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KmsKeyId": "Identifies which KMS key is used to encrypt the container image for distribution to the target Region\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "The name of the container recipe\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ParentImage": "The base image for the container recipe\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PlatformOverride": "Specifies the operating system platform when you use a custom source image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PlatformOverride": "Specifies the operating system platform when you use a custom base image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Tags that are attached to the container recipe\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TargetRepository": "The destination repository for the container image\\. \n*Required*: Yes \n*Type*: [TargetContainerRepository](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-targetcontainerrepository.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Version": "The semantic version of the container recipe\\. \nThe semantic version has four nodes: \\.\\./\\. You can assign values for the first three, and can filter on all of them\\. \n **Assignment:** For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30\\-1, or 1073741823 for each node\\. Image Builder automatically assigns the build number to the fourth node\\. \n **Patterns:** You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign\\. For example, you might choose a software version pattern, such as 1\\.0\\.0, or a date, such as 2021\\.01\\.01\\. \n **Filtering:** With semantic versioning, you have the flexibility to use wildcards \\(x\\) to specify the most recent versions or nodes when selecting the base image or components for your recipe\\. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards\\.\n*Required*: Yes \n*Type*: String \n*Pattern*: `^[0-9]+\\.[0-9]+\\.[0-9]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "WorkingDirectory": "The working directory for use during build and test workflows\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ImageBuilder::ContainerRecipe ComponentConfiguration": { - "ComponentArn": "The Amazon Resource Name \\(ARN\\) of the component\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "ComponentArn": "The Amazon Resource Name \\(ARN\\) of the component\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Parameters": "A group of parameter settings that Image Builder uses to configure the component for a specific recipe\\. \n*Required*: No \n*Type*: List of [ComponentParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::ImageBuilder::ContainerRecipe ComponentParameter": { + "Name": "The name of the component parameter to set\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[^\\x00]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Value": "Sets the value for the named component parameter\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ImageBuilder::ContainerRecipe EbsInstanceBlockDeviceSpecification": { "DeleteOnTermination": "Use to configure delete on termination of the associated device\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -12153,30 +13562,78 @@ "Name": "The name of this distribution configuration\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The tags of this distribution configuration\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::ImageBuilder::DistributionConfiguration AmiDistributionConfiguration": { + "AmiTags": "The tags to apply to AMIs distributed to this Region\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the AMI distribution configuration\\. Minimum and maximum length are in characters\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsKeyId": "The KMS key identifier used to encrypt the distributed image\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LaunchPermissionConfiguration": "Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances\\. \n*Required*: No \n*Type*: [LaunchPermissionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the output AMI\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `127` \n*Pattern*: `^[-_A-Za-z0-9{][-_A-Za-z0-9\\s:{}\\.]+[-_A-Za-z0-9}]$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetAccountIds": "The ID of an account to which you want to distribute an image\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1536` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ImageBuilder::DistributionConfiguration ContainerDistributionConfiguration": { + "ContainerTags": "Tags that are attached to the container distribution configuration\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the container distribution configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetRepository": "The destination repository for the container distribution configuration\\. \n*Required*: No \n*Type*: [TargetContainerRepository](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-targetcontainerrepository.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::ImageBuilder::DistributionConfiguration Distribution": { - "AmiDistributionConfiguration": "The specific AMI settings, such as launch permissions and AMI tags\\. For details, see example schema below\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ContainerDistributionConfiguration": "Container distribution settings for encryption, licensing, and sharing in a specific Region\\. For details, see example schema below\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AmiDistributionConfiguration": "The specific AMI settings, such as launch permissions and AMI tags\\. For details, see example schema below\\. \n*Required*: No \n*Type*: [AmiDistributionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-amidistributionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContainerDistributionConfiguration": "Container distribution settings for encryption, licensing, and sharing in a specific Region\\. For details, see example schema below\\. \n*Required*: No \n*Type*: [ContainerDistributionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-containerdistributionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FastLaunchConfigurations": "The Windows faster\\-launching configurations to use for AMI distribution\\. \n*Required*: No \n*Type*: List of [FastLaunchConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html) \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LaunchTemplateConfigurations": "A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts\\. \n*Required*: No \n*Type*: List of [LaunchTemplateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchtemplateconfiguration.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LicenseConfigurationArns": "The License Manager Configuration to associate with the AMI in the specified Region\\. For more information, see the [ LicenseConfiguration API](https://docs.aws.amazon.com/license-manager/latest/APIReference/API_LicenseConfiguration.html)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Region": "The target Region for the Distribution Configuration\\. For example, `eu-west-1`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::ImageBuilder::DistributionConfiguration FastLaunchConfiguration": { + "AccountId": "The owner account ID for the fast\\-launch enabled Windows AMI\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[0-9]{12}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Enabled": "A Boolean that represents the current state of faster launching for the Windows AMI\\. Set to `true` to start using Windows faster launching, or `false` to stop using it\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LaunchTemplate": "The launch template that the fast\\-launch enabled Windows AMI uses when it launches Windows instances to create pre\\-provisioned snapshots\\. \n*Required*: No \n*Type*: [FastLaunchLaunchTemplateSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxParallelLaunches": "The maximum number of parallel instances that are launched for creating resources\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SnapshotConfiguration": "Configuration settings for managing the number of snapshots that are created from pre\\-provisioned instances for the Windows AMI when faster launching is enabled\\. \n*Required*: No \n*Type*: [FastLaunchSnapshotConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchsnapshotconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ImageBuilder::DistributionConfiguration FastLaunchLaunchTemplateSpecification": { + "LaunchTemplateId": "The ID of the launch template to use for faster launching for a Windows AMI\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^lt-[a-z0-9-_]{17}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LaunchTemplateName": "The name of the launch template to use for faster launching for a Windows AMI\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LaunchTemplateVersion": "The version of the launch template to use for faster launching for a Windows AMI\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ImageBuilder::DistributionConfiguration FastLaunchSnapshotConfiguration": { + "TargetResourceCount": "The number of pre\\-provisioned snapshots to keep on hand for a fast\\-launch enabled Windows AMI\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ImageBuilder::DistributionConfiguration LaunchPermissionConfiguration": { + "OrganizationArns": "The ARN for an AWS Organization that you want to share your AMI with\\. For more information, see [What is AWS Organizations?](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OrganizationalUnitArns": "The ARN for an AWS Organizations organizational unit \\(OU\\) that you want to share your AMI with\\. For more information about key concepts for AWS Organizations, see [AWS Organizations terminology and concepts](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UserGroups": "The name of the group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UserIds": "The AWS account ID\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1536` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::ImageBuilder::DistributionConfiguration LaunchTemplateConfiguration": { "AccountId": "The account ID that this configuration applies to\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[0-9]{12}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LaunchTemplateId": "Identifies the Amazon EC2 launch template to use\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^lt-[a-z0-9-_]{17}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SetDefaultVersion": "Set the specified Amazon EC2 launch template as the default launch template for the specified account\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::ImageBuilder::DistributionConfiguration TargetContainerRepository": { + "RepositoryName": "The name of the container repository where the output container image is stored\\. This name is prefixed by the repository location\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Service": "Specifies the service in which this image was registered\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ECR` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::ImageBuilder::Image": { "ContainerRecipeArn": "The Amazon Resource Name \\(ARN\\) of the container recipe that is used for this pipeline\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DistributionConfigurationArn": "The Amazon Resource Name \\(ARN\\) of the distribution configuration\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-9]+))(?:/[0-9]+)?)?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "EnhancedImageMetadataEnabled": "Collects additional information about the image being created, including the operating system \\(OS\\) version and package list\\. This information is used to enhance the overall experience of using EC2 Image Builder\\. Enabled by default\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EnhancedImageMetadataEnabled": "Indicates whether Image Builder collects additional information about the image, such as the operating system \\(OS\\) version and package list\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ImageRecipeArn": "The Amazon Resource Name \\(ARN\\) of the image recipe\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-9]+))(?:/[0-9]+)?)?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ImageScanningConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [ImageScanningConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagescanningconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ImageTestsConfiguration": "The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting\\. \n*Required*: No \n*Type*: [ImageTestsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagetestsconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InfrastructureConfigurationArn": "The Amazon Resource Name \\(ARN\\) of the infrastructure configuration associated with this image pipeline\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The tags of the image\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::ImageBuilder::Image EcrConfiguration": { + "ContainerTags": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RepositoryName": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::ImageBuilder::Image ImageScanningConfiguration": { + "EcrConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [EcrConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-ecrconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ImageScanningEnabled": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::ImageBuilder::Image ImageTestsConfiguration": { "ImageTestsEnabled": "Determines if tests should run after building the image\\. Image Builder defaults to enable tests to run following the image build, before image distribution\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "TimeoutMinutes": "The maximum time in minutes that tests are permitted to run\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `1440` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "TimeoutMinutes": "The maximum time in minutes that tests are permitted to run\\. \nThe timeoutMinutes attribute is not currently active\\. This value is ignored\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `1440` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ImageBuilder::ImagePipeline": { "ContainerRecipeArn": "The Amazon Resource Name \\(ARN\\) of the container recipe that is used for this pipeline\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -12184,6 +13641,7 @@ "DistributionConfigurationArn": "The Amazon Resource Name \\(ARN\\) of the distribution configuration associated with this image pipeline\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnhancedImageMetadataEnabled": "Collects additional information about the image being created, including the operating system \\(OS\\) version and package list\\. This information is used to enhance the overall experience of using EC2 Image Builder\\. Enabled by default\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ImageRecipeArn": "The Amazon Resource Name \\(ARN\\) of the image recipe associated with this image pipeline\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ImageScanningConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [ImageScanningConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-imagescanningconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ImageTestsConfiguration": "The configuration of the image tests that run after image creation to ensure the quality of the image that was created\\. \n*Required*: No \n*Type*: [ImageTestsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-imagetestsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InfrastructureConfigurationArn": "The Amazon Resource Name \\(ARN\\) of the infrastructure configuration associated with this image pipeline\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the image pipeline\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -12191,12 +13649,20 @@ "Status": "The status of the image pipeline\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags of this image pipeline\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::ImageBuilder::ImagePipeline EcrConfiguration": { + "ContainerTags": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RepositoryName": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ImageBuilder::ImagePipeline ImageScanningConfiguration": { + "EcrConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [EcrConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-ecrconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ImageScanningEnabled": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::ImageBuilder::ImagePipeline ImageTestsConfiguration": { "ImageTestsEnabled": "Defines if tests should be executed when building this image\\. For example, `true` or `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimeoutMinutes": "The maximum time in minutes that tests are permitted to run\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `1440` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TimeoutMinutes": "The maximum time in minutes that tests are permitted to run\\. \nThe timeoutMinutes attribute is not currently active\\. This value is ignored\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `1440` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ImageBuilder::ImagePipeline Schedule": { - "PipelineExecutionStartCondition": "The condition configures when the pipeline should trigger a new image build\\. When the `pipelineExecutionStartCondition` is set to `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE`, and you use semantic version filters on the source image or components in your image recipe, Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter\\. When it is set to `EXPRESSION_MATCH_ONLY`, it will build a new image every time the CRON expression matches the current time\\. For semantic version syntax, see [CreateComponent](https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html) in the * Image Builder API Reference*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE | EXPRESSION_MATCH_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PipelineExecutionStartCondition": "The condition configures when the pipeline should trigger a new image build\\. When the `pipelineExecutionStartCondition` is set to `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE`, and you use semantic version filters on the base image or components in your image recipe, Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter\\. When it is set to `EXPRESSION_MATCH_ONLY`, it will build a new image every time the CRON expression matches the current time\\. For semantic version syntax, see [CreateComponent](https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html) in the * Image Builder API Reference*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE | EXPRESSION_MATCH_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ScheduleExpression": "The cron expression determines how often EC2 Image Builder evaluates your `pipelineExecutionStartCondition`\\. \nFor information on how to format a cron expression in Image Builder, see [Use cron expressions in EC2 Image Builder](https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ImageBuilder::ImageRecipe": { @@ -12205,7 +13671,7 @@ "Components": "The components of the image recipe\\. Components are orchestration documents that define a sequence of steps for downloading, installing, configuring, and testing software packages\\. They also define validation and security hardening steps\\. A component is defined using a YAML document format\\. \n*Required*: Yes \n*Type*: List of [ComponentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-componentconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "The description of the image recipe\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "The name of the image recipe\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ParentImage": "The parent image of the image recipe\\. The string must be either an Image ARN \\(SemVers is ok\\) or an AMI ID\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ParentImage": "The parent image of the image recipe\\. The string must be either an Image ARN or an AMI ID\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The tags of the image recipe\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Version": "The semantic version of the image recipe\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[0-9]+\\.[0-9]+\\.[0-9]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "WorkingDirectory": "The working directory to be used during build and test workflows\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" @@ -12216,7 +13682,7 @@ }, "AWS::ImageBuilder::ImageRecipe ComponentConfiguration": { "ComponentArn": "The Amazon Resource Name \\(ARN\\) of the component\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Parameters": "A group of parameter settings that are used to configure the component for a specific recipe\\. \n*Required*: No \n*Type*: List of [ComponentParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-componentparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Parameters": "A group of parameter settings that Image Builder uses to configure the component for a specific recipe\\. \n*Required*: No \n*Type*: List of [ComponentParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-componentparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ImageBuilder::ImageRecipe ComponentParameter": { "Name": "The name of the component parameter to set\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[^\\x00]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -12257,7 +13723,7 @@ "TerminateInstanceOnFailure": "The terminate instance on failure configuration of the infrastructure configuration\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ImageBuilder::InfrastructureConfiguration InstanceMetadataOptions": { - "HttpPutResponseHopLimit": "Limit the number of hops that an instance metadata request can traverse to reach its destination\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HttpPutResponseHopLimit": "Limit the number of hops that an instance metadata request can traverse to reach its destination\\. The default is one hop\\. However, if HTTP tokens are required, container image builds need a minimum of two hops\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HttpTokens": "Indicates whether a signed token header is required for instance metadata retrieval requests\\. The values affect the response as follows: \n+ **required** \u2013 When you retrieve the IAM role credentials, version 2\\.0 credentials are returned in all cases\\.\n+ **optional** \u2013 You can include a signed token header in your request to retrieve instance metadata, or you can leave it out\\. If you include it, version 2\\.0 credentials are returned for the IAM role\\. Otherwise, version 1\\.0 credentials are returned\\.\nThe default setting is **optional**\\. \n*Required*: No \n*Type*: String \n*Pattern*: `optional|required` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ImageBuilder::InfrastructureConfiguration Logging": { @@ -12346,7 +13812,7 @@ "EndInclusive": "The port number the port range ends at\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::InspectorV2::Filter StringFilter": { - "Comparison": "The operator to use when comparing values in the filter \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Comparison": "The operator to use when comparing values in the filter\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Value": "The value to filter on\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoT1Click::Device": { @@ -12389,6 +13855,8 @@ "DeviceCertificateExpiringCheck": "Checks if a device certificate is expiring\\. This check applies to device certificates expiring within 30 days or that have expired\\. \n*Required*: No \n*Type*: [AuditCheckConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DeviceCertificateKeyQualityCheck": "Checks the quality of the device certificate key\\. The quality checks if the key is in a valid format, not expired, signed by a registered certificate authority, and if the key meets a minimum required size\\. \n*Required*: No \n*Type*: [AuditCheckConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DeviceCertificateSharedCheck": "Checks if multiple concurrent connections use the same X\\.509 certificate to authenticate with AWS IoT\\. \n*Required*: No \n*Type*: [AuditCheckConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IntermediateCaRevokedForActiveDeviceCertificatesCheck": "*Required*: No \n*Type*: [AuditCheckConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IoTPolicyPotentialMisConfigurationCheck": "*Required*: No \n*Type*: [AuditCheckConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IotPolicyOverlyPermissiveCheck": "Checks the permissiveness of a policy attached to an authenticated Amazon Cognito identity pool role\\. \n*Required*: No \n*Type*: [AuditCheckConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IotRoleAliasAllowsAccessToUnusedServicesCheck": "Checks if a role alias has access to services that haven't been used for the AWS IoT device in the last year\\. \n*Required*: No \n*Type*: [AuditCheckConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IotRoleAliasOverlyPermissiveCheck": "Checks if the temporary credentials provided by AWS IoT role aliases are overly permissive\\. \n*Required*: No \n*Type*: [AuditCheckConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -12408,16 +13876,31 @@ "AWS::IoT::Authorizer": { "AuthorizerFunctionArn": "The authorizer's Lambda function ARN\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AuthorizerName": "The authorizer name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "EnableCachingForHttp": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableCachingForHttp": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SigningDisabled": "Specifies whether AWS IoT validates the token signature in an authorization request\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Status": "The status of the authorizer\\. \nValid values: `ACTIVE` \\| `INACTIVE` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Metadata which can be used to manage the custom authorizer\\. \nFor URI Request parameters use format: \\.\\.\\.key1=value1&key2=value2\\.\\.\\. \nFor the CLI command\\-line parameter use format: &&tags \"key1=value1&key2=value2\\.\\.\\.\" \nFor the cli\\-input\\-json file use format: \"tags\": \"key1=value1&key2=value2\\.\\.\\.\"\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TokenKeyName": "The key used to extract the token from the HTTP headers\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TokenSigningPublicKeys": "The public keys used to validate the token signature returned by your custom authentication service\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::IoT::CACertificate": { + "AutoRegistrationStatus": "Whether the CA certificate is configured for auto registration of device certificates\\. Valid values are \"ENABLE\" and \"DISABLE\"\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CACertificatePem": "The certificate data in PEM format\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CertificateMode": "The mode of the CA\\. \nAll the device certificates that are registered using this CA will be registered in the same mode as the CA\\. For more information about certificate mode for device certificates, see [certificate mode](https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode)\\. \nValid values are \"DEFAULT\" and \"SNI\\_ONLY\"\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RegistrationConfig": "Information about the registration configuration\\. \n*Required*: No \n*Type*: [RegistrationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-cacertificate-registrationconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RemoveAutoRegistration": "If true, removes auto registration\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "The status of the CA certificate\\. \nValid values are \"ACTIVE\" and \"INACTIVE\"\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VerificationCertificatePem": "The private key verification certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoT::CACertificate RegistrationConfig": { + "RoleArn": "The ARN of the role\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TemplateBody": "The template body\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TemplateName": "The name of the provisioning template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::IoT::Certificate": { "CACertificatePem": "The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI\\_ONLY\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "CertificateMode": "Specifies which mode of certificate registration to use with this resource\\. Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI\\_ONLY with CertificatePem, and Default with CertificateSigningRequest\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CertificateMode": "Specifies which mode of certificate registration to use with this resource\\. Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI\\_ONLY with CertificatePem, and Default with CertificateSigningRequest\\. \n`DEFAULT`: A certificate in `DEFAULT` mode is either generated by AWS IoT Core or registered with an issuer certificate authority \\(CA\\)\\. Devices with certificates in `DEFAULT` mode aren't required to send the Server Name Indication \\(SNI\\) extension when connecting to AWS IoT Core\\. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to AWS IoT Core\\. \n`SNI_ONLY`: A certificate in `SNI_ONLY` mode is registered without an issuer CA\\. Devices with certificates in `SNI_ONLY` mode must send the SNI extension when connecting to AWS IoT Core\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "CertificatePem": "The certificate data in PEM format\\. Requires SNI\\_ONLY for the certificate mode or the accompanying CACertificatePem for registration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "CertificateSigningRequest": "The certificate signing request \\(CSR\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Status": "The status of the certificate\\. \nValid values are ACTIVE, INACTIVE, REVOKED, PENDING\\_TRANSFER, and PENDING\\_ACTIVATION\\. \nThe status value REGISTER\\_INACTIVE is deprecated and should not be used\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -12470,21 +13953,57 @@ "Values": "A list of the values of aggregation types\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoT::JobTemplate": { - "AbortConfig": "The criteria that determine when and how a job abort takes place\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AbortConfig": "The criteria that determine when and how a job abort takes place\\. \n*Required*: No \n*Type*: [AbortConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "A description of the job template\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Document": "The job document\\. \nRequired if you don't specify a value for `documentSource`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DocumentSource": "An S3 link to the job document to use in the template\\. Required if you don't specify a value for `document`\\. \nIf the job document resides in an S3 bucket, you must use a placeholder link when specifying the document\\. \nThe placeholder link is of the following form: \n `${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}` \nwhere *bucket* is your bucket name and *key* is the object in the bucket to which you are linking\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "JobArn": "The ARN of the job to use as the basis for the job template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "JobExecutionsRetryConfig": "Allows you to create the criteria to retry a job\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "JobExecutionsRolloutConfig": "Allows you to create a staged rollout of a job\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "JobExecutionsRetryConfig": "Allows you to create the criteria to retry a job\\. \n*Required*: No \n*Type*: [JobExecutionsRetryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsretryconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "JobExecutionsRolloutConfig": "Allows you to create a staged rollout of a job\\. \n*Required*: No \n*Type*: [JobExecutionsRolloutConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsrolloutconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "JobTemplateId": "A unique identifier for the job template\\. We recommend using a UUID\\. Alpha\\-numeric characters, \"\\-\", and \"\\_\" are valid for use here\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PresignedUrlConfig": "Configuration for pre\\-signed S3 URLs\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PresignedUrlConfig": "Configuration for pre\\-signed S3 URLs\\. \n*Required*: No \n*Type*: [PresignedUrlConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-presignedurlconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Metadata that can be used to manage the job template\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "TimeoutConfig": "Specifies the amount of time each device has to finish its execution of the job\\. A timer is started when the job execution status is set to `IN_PROGRESS`\\. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to `TIMED_OUT`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "TimeoutConfig": "Specifies the amount of time each device has to finish its execution of the job\\. A timer is started when the job execution status is set to `IN_PROGRESS`\\. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to `TIMED_OUT`\\. \n*Required*: No \n*Type*: [TimeoutConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-timeoutconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, - "AWS::IoT::Logging": { + "AWS::IoT::JobTemplate AbortConfig": { + "CriteriaList": "The list of criteria that determine when and how to abort the job\\. \n*Required*: Yes \n*Type*: List of [AbortCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoT::JobTemplate AbortCriteria": { + "Action": "The type of job action to take to initiate the job abort\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FailureType": "The type of job execution failures that can initiate a job abort\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MinNumberOfExecutedThings": "The minimum number of things which must receive job execution notifications before the job can be aborted\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ThresholdPercentage": "The minimum percentage of job execution failures that must occur to initiate the job abort\\. \n AWS IoT Core supports up to two digits after the decimal \\(for example, 10\\.9 and 10\\.99, but not 10\\.999\\)\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoT::JobTemplate ExponentialRolloutRate": { + "BaseRatePerMinute": "The minimum number of things that will be notified of a pending job, per minute at the start of job rollout\\. This parameter allows you to define the initial rate of rollout\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IncrementFactor": "The exponential factor to increase the rate of rollout for a job\\. \n AWS IoT Core supports up to one digit after the decimal \\(for example, 1\\.5, but not 1\\.55\\)\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RateIncreaseCriteria": "The criteria to initiate the increase in rate of rollout for a job\\. \n*Required*: Yes \n*Type*: [RateIncreaseCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-rateincreasecriteria.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoT::JobTemplate JobExecutionsRetryConfig": { + "RetryCriteriaList": "The list of criteria that determines how many retries are allowed for each failure type for a job\\. \n*Required*: No \n*Type*: List of [RetryCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-retrycriteria.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoT::JobTemplate JobExecutionsRolloutConfig": { + "ExponentialRolloutRate": "Allows you to create an exponential rate of rollout for a job\\. \n*Required*: No \n*Type*: [ExponentialRolloutRate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-exponentialrolloutrate.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MaximumPerMinute": "The maximum number of things that will be notified of a pending job, per minute\\. This parameter allows you to create a staged rollout\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoT::JobTemplate PresignedUrlConfig": { + "ExpiresInSec": "How long \\(in seconds\\) pre\\-signed URLs are valid\\. Valid values are 60 \\- 3600, the default value is 3600 seconds\\. Pre\\-signed URLs are generated when Jobs receives an MQTT request for the job document\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RoleArn": "The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored\\. The role must also grant permission for IoT to download the files\\. \nFor information about addressing the confused deputy problem, see [cross\\-service confused deputy prevention](https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html) in the * AWS IoT Core developer guide*\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoT::JobTemplate RateIncreaseCriteria": { + "NumberOfNotifiedThings": "The threshold for number of notified things that will initiate the increase in rate of rollout\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "NumberOfSucceededThings": "The threshold for number of succeeded things that will initiate the increase in rate of rollout\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoT::JobTemplate RetryCriteria": { + "FailureType": "The type of job execution failures that can initiate a job retry\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NumberOfRetries": "The number of retries allowed for a failure type for the job\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoT::JobTemplate TimeoutConfig": { + "InProgressTimeoutInMinutes": "Specifies the amount of time, in minutes, this device has to finish execution of this job\\. The timeout interval can be anywhere between 1 minute and 7 days \\(1 to 10080 minutes\\)\\. The in progress timer can't be updated and will apply to all job executions for the job\\. Whenever a job execution remains in the IN\\_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal `TIMED_OUT` status\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoT::Logging": { "AccountId": "The account ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DefaultLogLevel": "The default log level\\.Valid Values: `DEBUG | INFO | ERROR | WARN | DISABLED` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefaultLogLevel": "The default log level\\. Valid Values: `DEBUG | INFO | ERROR | WARN | DISABLED` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The role ARN used for the log\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoT::MitigationAction": { @@ -12522,7 +14041,7 @@ "Action": "The action that you want to apply to the device certificate\\. The only supported value is `DEACTIVATE`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoT::Policy": { - "PolicyDocument": "The JSON document that describes the policy\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PolicyDocument": "The JSON document that describes the policy\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PolicyName": "The policy name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::IoT::PolicyPrincipalAttachment": { @@ -12536,7 +14055,8 @@ "ProvisioningRoleArn": "The role ARN for the role associated with the fleet provisioning template\\. This IoT role grants permission to provision a device\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Metadata that can be used to manage the fleet provisioning template\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TemplateBody": "The JSON formatted contents of the fleet provisioning template version\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TemplateName": "The name of the fleet provisioning template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "TemplateName": "The name of the fleet provisioning template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TemplateType": "The type of the provisioning template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::IoT::ProvisioningTemplate ProvisioningHook": { "PayloadVersion": "The payload that was sent to the target function\\. The valid payload is `\"2020-04-01\"`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -12547,6 +14067,12 @@ "TargetName": "The target name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TargetType": "The target type\\. Valid Values: `DEFAULT | THING_GROUP` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::IoT::RoleAlias": { + "CredentialDurationSeconds": "The number of seconds for which the credential is valid\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleAlias": "The role alias\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RoleArn": "The role ARN\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::IoT::ScheduledAudit": { "DayOfMonth": "The day of the month on which the scheduled audit is run \\(if the `frequency` is \"MONTHLY\"\\)\\. If days 29\\-31 are specified, and the month does not have that many days, the audit takes place on the \"LAST\" day of the month\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DayOfWeek": "The day of the week on which the scheduled audit is run \\(if the `frequency` is \"WEEKLY\" or \"BIWEEKLY\"\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -12637,6 +14163,7 @@ "Kafka": "Send messages to an Amazon Managed Streaming for Apache Kafka \\(Amazon MSK\\) or self\\-managed Apache Kafka cluster\\. \n*Required*: No \n*Type*: [KafkaAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kafkaaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Kinesis": "Write data to an Amazon Kinesis stream\\. \n*Required*: No \n*Type*: [KinesisAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-kinesisaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Lambda": "Invoke a Lambda function\\. \n*Required*: No \n*Type*: [LambdaAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-lambdaaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Location": "Sends device location data to [Amazon Location Service](https://docs.aws.amazon.com/location/latest/developerguide/welcome.html)\\. \n*Required*: No \n*Type*: [LocationAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OpenSearch": "Write data to an Amazon OpenSearch Service domain\\. \n*Required*: No \n*Type*: [OpenSearchAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-opensearchaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Republish": "Publish to another MQTT topic\\. \n*Required*: No \n*Type*: [RepublishAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3": "Write to an Amazon S3 bucket\\. \n*Required*: No \n*Type*: [S3Action](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-s3action.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -12667,6 +14194,7 @@ "StateValue": "The value of the alarm state\\. Acceptable values are: OK, ALARM, INSUFFICIENT\\_DATA\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoT::TopicRule CloudwatchLogsAction": { + "BatchMode": "Indicates whether batches of log records will be extracted and uploaded into CloudWatch\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LogGroupName": "The CloudWatch log name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The IAM role that allows access to the CloudWatch log\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -12749,6 +14277,14 @@ "AWS::IoT::TopicRule LambdaAction": { "FunctionArn": "The ARN of the Lambda function\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::IoT::TopicRule LocationAction": { + "DeviceId": "The unique ID of the device providing the location data\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Latitude": "A string that evaluates to a double value that represents the latitude of the device's location\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Longitude": "A string that evaluates to a double value that represents the longitude of the device's location\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleArn": "The IAM role that grants permission to write to the Amazon Location resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Timestamp": "The time that the location data was sampled\\. The default value is the time the MQTT message was processed\\. \n*Required*: No \n*Type*: [Timestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestamp.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TrackerName": "The name of the tracker resource in Amazon Location in which the location is updated\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::IoT::TopicRule OpenSearchAction": { "Endpoint": "The endpoint of your OpenSearch domain\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Id": "The unique identifier for the document you are storing\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -12767,10 +14303,19 @@ "TableName": "The table where the message data will be written\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoT::TopicRule RepublishAction": { + "Headers": "MQTT Version 5\\.0 headers information\\. For more information, see [MQTT](https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html) in the IoT Core Developer Guide\\. \n*Required*: No \n*Type*: [RepublishActionHeaders](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Qos": "The Quality of Service \\(QoS\\) level to use when republishing messages\\. The default value is 0\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The ARN of the IAM role that grants access\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Topic": "The name of the MQTT topic\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::IoT::TopicRule RepublishActionHeaders": { + "ContentType": "A UTF\\-8 encoded string that describes the content of the publishing message\\. \nFor more information, see [ Content Type](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901118) in the MQTT Version 5\\.0 specification\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CorrelationData": "The base64\\-encoded binary data used by the sender of the request message to identify which request the response message is for\\. \nFor more information, see [ Correlation Data](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901115) in the MQTT Version 5\\.0 specification\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n This binary data must be base64\\-encoded\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MessageExpiry": "A user\\-defined integer value that represents the message expiry interval at the broker\\. If the messages haven't been sent to the subscribers within that interval, the message expires and is removed\\. The value of `messageExpiry` represents the number of seconds before it expires\\. For more information about the limits of `messageExpiry`, see [Message broker and protocol limits and quotas](https://docs.aws.amazon.com/general/latest/gr/iot-core.html#limits_iot) in the IoT Core Reference Guide\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PayloadFormatIndicator": "An `Enum` string value that indicates whether the payload is formatted as UTF\\-8\\. \nValid values are `UNSPECIFIED_BYTES` and `UTF8_DATA`\\. \nFor more information, see [ Payload Format Indicator](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111) from the MQTT Version 5\\.0 specification\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResponseTopic": "A UTF\\-8 encoded string that's used as the topic name for a response message\\. The response topic is used to describe the topic to which the receiver should publish as part of the request\\-response flow\\. The topic must not contain wildcard characters\\. \nFor more information, see [ Response Topic](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901114) in the MQTT Version 5\\.0 specification\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UserProperties": "An array of key\\-value pairs that you define in the MQTT5 header\\. \n*Required*: No \n*Type*: List of [UserProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-userproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::IoT::TopicRule S3Action": { "BucketName": "The Amazon S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CannedAcl": "The Amazon S3 canned ACL that controls access to the object identified by the object key\\. For more information, see [S3 canned ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -12797,8 +14342,11 @@ "RoleArn": "The ARN of the role that grants IoT permission to start execution of a state machine \\(\"Action\":\"states:StartExecution\"\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StateMachineName": "The name of the Step Functions state machine whose execution will be started\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::IoT::TopicRule Timestamp": { + "Unit": "The precision of the timestamp value that results from the expression described in `value`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "An expression that returns a long epoch time value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::IoT::TopicRule TimestreamAction": { - "BatchMode": "Whether to process the action as a batch\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DatabaseName": "The name of an Amazon Timestream database that has the table to write records into\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Dimensions": "Metadata attributes of the time series that are written in each measure record\\. \n*Required*: Yes \n*Type*: List of [TimestreamDimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestreamdimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The Amazon Resource Name \\(ARN\\) of the role that grants AWS IoT permission to write to the Timestream database table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -12821,6 +14369,10 @@ "RuleDisabled": "Specifies whether the rule is disabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Sql": "The SQL statement used to query the topic\\. For more information, see [AWS IoT SQL Reference](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html) in the * AWS IoT Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::IoT::TopicRule UserProperty": { + "Key": "A key to be specified in `UserProperty`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "A value to be specified in `UserProperty`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::IoT::TopicRuleDestination": { "HttpUrlProperties": "Properties of the HTTP URL\\. \n*Required*: No \n*Type*: [HttpUrlDestinationSummary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicruledestination-httpurldestinationsummary.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Status": "IN\\_PROGRESS \nA topic rule destination was created but has not been confirmed\\. You can set status to `IN_PROGRESS` by calling `UpdateTopicRuleDestination`\\. Calling `UpdateTopicRuleDestination` causes a new confirmation challenge to be sent to your confirmation endpoint\\. \nENABLED \nConfirmation was completed, and traffic to this destination is allowed\\. You can set status to `DISABLED` by calling `UpdateTopicRuleDestination`\\. \nDISABLED \nConfirmation was completed, and traffic to this destination is not allowed\\. You can set status to `ENABLED` by calling `UpdateTopicRuleDestination`\\. \nERROR \nConfirmation could not be completed; for example, if the confirmation timed out\\. You can call `GetTopicRuleDestination` for details about the error\\. You can set status to `IN_PROGRESS` by calling `UpdateTopicRuleDestination`\\. Calling `UpdateTopicRuleDestination` causes a new confirmation challenge to be sent to your confirmation endpoint\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -12843,7 +14395,7 @@ }, "AWS::IoTAnalytics::Channel ChannelStorage": { "CustomerManagedS3": "Used to store channel data in an S3 bucket that you manage\\. If customer managed storage is selected, the `retentionPeriod` parameter is ignored\\. You can't change the choice of S3 storage after the data store is created\\. \n*Required*: No \n*Type*: [CustomerManagedS3](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServiceManagedS3": "Used to store channel data in an S3 bucket managed by AWS IoT Analytics\\. You can't change the choice of S3 storage after the data store is created\\. \n*Required*: No \n*Type*: [ServiceManagedS3](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-servicemanageds3.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ServiceManagedS3": "Used to store channel data in an S3 bucket managed by AWS IoT Analytics\\. You can't change the choice of S3 storage after the data store is created\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoTAnalytics::Channel CustomerManagedS3": { "Bucket": "The name of the S3 bucket in which channel data is stored\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `^[a-zA-Z0-9.\\-_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -12984,10 +14536,10 @@ "AWS::IoTAnalytics::Datastore DatastoreStorage": { "CustomerManagedS3": "Use this to store data store data in an S3 bucket that you manage\\. The choice of service\\-managed or customer\\-managed S3 storage cannot be changed after creation of the data store\\. \n*Required*: No \n*Type*: [CustomerManagedS3](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IotSiteWiseMultiLayerStorage": "Use this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage\\. You can't change the choice of Amazon S3 storage after your data store is created\\. \n*Required*: No \n*Type*: [IotSiteWiseMultiLayerStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-iotsitewisemultilayerstorage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ServiceManagedS3": "Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service\\. The choice of service\\-managed or customer\\-managed S3 storage cannot be changed after creation of the data store\\. \n*Required*: No \n*Type*: [ServiceManagedS3](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-servicemanageds3.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ServiceManagedS3": "Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service\\. The choice of service\\-managed or customer\\-managed S3 storage cannot be changed after creation of the data store\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoTAnalytics::Datastore FileFormatConfiguration": { - "JsonConfiguration": "Contains the configuration information of the JSON format\\. \n*Required*: No \n*Type*: [JsonConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-jsonconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "JsonConfiguration": "Contains the configuration information of the JSON format\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ParquetConfiguration": "Contains the configuration information of the Parquet format\\. \n*Required*: No \n*Type*: [ParquetConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-parquetconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoTAnalytics::Datastore IotSiteWiseMultiLayerStorage": { @@ -13083,9 +14635,131 @@ "Next": "The next activity in the pipeline\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoTCoreDeviceAdvisor::SuiteDefinition": { - "SuiteDefinitionConfiguration": "The configuration of the Suite Definition\\. Listed below are the required elements of the `SuiteDefinitionConfiguration`\\. \n**devicePermissionRoleArn** \nThe device permission arn\\. \nThis is a required element\\. \n**Type:** String \n**devices** \nThe list of configured devices under test\\. For more information on devices under test, see [DeviceUnderTest](http://amazonaws.com/iot/latest/apireference/API_iotdeviceadvisor_DeviceUnderTest.html) \nNot a required element\\. \n**Type:** List of devices under test \n**intendedForQualification** \nThe tests intended for qualification in a suite\\. \nNot a required element\\. \n**Type:** Boolean \n**rootGroup** \nThe test suite root group\\. For more information on creating and using root groups see the [Device Advisor workflow](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html)\\. \nThis is a required element\\. \n**Type:** String \n**suiteDefinitionName** \nThe Suite Definition Configuration name\\. \nThis is a required element\\. \n**Type:** String\n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SuiteDefinitionConfiguration": "The configuration of the Suite Definition\\. Listed below are the required elements of the `SuiteDefinitionConfiguration`\\. \n**devicePermissionRoleArn** \nThe device permission arn\\. \nThis is a required element\\. \n**Type:** String \n**devices** \nThe list of configured devices under test\\. For more information on devices under test, see [DeviceUnderTest](http://amazonaws.com/iot/latest/apireference/API_iotdeviceadvisor_DeviceUnderTest.html) \nNot a required element\\. \n**Type:** List of devices under test \n**intendedForQualification** \nThe tests intended for qualification in a suite\\. \nNot a required element\\. \n**Type:** Boolean \n**rootGroup** \nThe test suite root group\\. For more information on creating and using root groups see the [Device Advisor workflow](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html)\\. \nThis is a required element\\. \n**Type:** String \n**suiteDefinitionName** \nThe Suite Definition Configuration name\\. \nThis is a required element\\. \n**Type:** String\n*Required*: Yes \n*Type*: [SuiteDefinitionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Metadata that can be used to manage the the Suite Definition\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::IoTCoreDeviceAdvisor::SuiteDefinition DeviceUnderTest": { + "CertificateArn": "Lists devices certificate ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ThingArn": "Lists devices thing ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTCoreDeviceAdvisor::SuiteDefinition SuiteDefinitionConfiguration": { + "DevicePermissionRoleArn": "Gets the device permission ARN\\. This is a required parameter\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Devices": "Gets the devices configured\\. \n*Required*: No \n*Type*: List of [DeviceUnderTest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-deviceundertest.html) \n*Maximum*: `2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IntendedForQualification": "Gets the tests intended for qualification in a suite\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RootGroup": "Gets the test suite root group\\. This is a required parameter\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SuiteDefinitionName": "Gets the suite definition name\\. This is a required parameter\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel": { + "AlarmCapabilities": "Contains the configuration information of alarm state changes\\. \n*Required*: No \n*Type*: [AlarmCapabilities](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AlarmEventActions": "Contains information about one or more alarm actions\\. \n*Required*: No \n*Type*: [AlarmEventActions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmeventactions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AlarmModelDescription": "The description of the alarm model\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AlarmModelName": "The name of the alarm model\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9_-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AlarmRule": "Defines when your alarm is invoked\\. \n*Required*: Yes \n*Type*: [AlarmRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Key": "An input attribute used as a key to create an alarm\\. AWS IoT Events routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^((`[\\w\\- ]+`)|([\\w\\-]+))(\\.((`[\\w- ]+`)|([\\w\\-]+)))*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RoleArn": "The ARN of the IAM role that allows the alarm to perform actions and access AWS resources\\. For more information, see [Amazon Resource Names \\(ARNs\\)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Severity": "A non\\-negative integer that reflects the severity level of the alarm\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "A list of key\\-value pairs that contain metadata for the alarm model\\. The tags help you manage the alarm model\\. For more information, see [Tagging your AWS IoT Events resources](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the * AWS IoT Events Developer Guide*\\. \nYou can create up to 50 tags for one alarm model\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel AcknowledgeFlow": { + "Enabled": "The value must be `TRUE` or `FALSE`\\. If `TRUE`, you receive a notification when the alarm state changes\\. You must choose to acknowledge the notification before the alarm state can return to `NORMAL`\\. If `FALSE`, you won't receive notifications\\. The alarm automatically changes to the `NORMAL` state when the input property value returns to the specified range\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel AlarmAction": { + "DynamoDB": "Defines an action to write to the Amazon DynamoDB table that you created\\. The standard action payload contains all the information about the detector model instance and the event that triggered the action\\. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html)\\. One column of the DynamoDB table receives all attribute\\-value pairs in the payload that you specify\\. \nYou must use expressions for all parameters in `DynamoDBAction`\\. The expressions accept literals, operators, functions, references, and substitution templates\\.", + "DynamoDBv2": "Defines an action to write to the Amazon DynamoDB table that you created\\. The default action payload contains all the information about the detector model instance and the event that triggered the action\\. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html)\\. A separate column of the DynamoDB table receives one attribute\\-value pair in the payload that you specify\\. \nYou must use expressions for all parameters in `DynamoDBv2Action`\\. The expressions accept literals, operators, functions, references, and substitution templates\\.", + "Firehose": "Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream\\. \n*Required*: No \n*Type*: [Firehose](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IotEvents": "Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action\\. \n*Required*: No \n*Type*: [IotEvents](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IotSiteWise": "Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise\\. \nYou must use expressions for all parameters in `IotSiteWiseAction`\\. The expressions accept literals, operators, functions, references, and substitutions templates\\.", + "IotTopicPublish": "Information required to publish the MQTT message through the AWS IoT message broker\\. \n*Required*: No \n*Type*: [IotTopicPublish](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Lambda": "Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action\\. \n*Required*: No \n*Type*: [Lambda](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Sns": "Property description not available\\. \n*Required*: No \n*Type*: [Sns](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Sqs": "Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue\\. \n*Required*: No \n*Type*: [Sqs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel AlarmCapabilities": { + "AcknowledgeFlow": "Specifies whether to get notified for alarm state changes\\. \n*Required*: No \n*Type*: [AcknowledgeFlow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-acknowledgeflow.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InitializationConfiguration": "Specifies the default alarm state\\. The configuration applies to all alarms that were created based on this alarm model\\. \n*Required*: No \n*Type*: [InitializationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-initializationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel AlarmEventActions": { + "AlarmActions": "Specifies one or more supported actions to receive notifications when the alarm state changes\\. \n*Required*: No \n*Type*: List of [AlarmAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel AlarmRule": { + "SimpleRule": "A rule that compares an input property value to a threshold value with a comparison operator\\. \n*Required*: No \n*Type*: [SimpleRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel AssetPropertyTimestamp": { + "OffsetInNanos": "The nanosecond offset converted from `timeInSeconds`\\. The valid range is between 0\\-999999999\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TimeInSeconds": "The timestamp, in seconds, in the Unix epoch format\\. The valid range is between 1\\-31556889864403199\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel AssetPropertyValue": { + "Quality": "The quality of the asset property value\\. The value must be `'GOOD'`, `'BAD'`, or `'UNCERTAIN'`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Timestamp": "The timestamp associated with the asset property value\\. The default is the current event time\\. \n*Required*: No \n*Type*: [AssetPropertyTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The value to send to an asset property\\. \n*Required*: Yes \n*Type*: [AssetPropertyVariant](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel AssetPropertyVariant": { + "BooleanValue": "The asset property value is a Boolean value that must be `'TRUE'` or `'FALSE'`\\. You must use an expression, and the evaluated result should be a Boolean value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DoubleValue": "The asset property value is a double\\. You must use an expression, and the evaluated result should be a double\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IntegerValue": "The asset property value is an integer\\. You must use an expression, and the evaluated result should be an integer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StringValue": "The asset property value is a string\\. You must use an expression, and the evaluated result should be a string\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel DynamoDB": { + "HashKeyField": "The name of the hash key \\(also called the partition key\\)\\. The `hashKeyField` value must match the partition key of the target DynamoDB table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HashKeyType": "The data type for the hash key \\(also called the partition key\\)\\. You can specify the following values: \n+ `'STRING'` \\- The hash key is a string\\.\n+ `'NUMBER'` \\- The hash key is a number\\.\nIf you don't specify `hashKeyType`, the default value is `'STRING'`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HashKeyValue": "The value of the hash key \\(also called the partition key\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Operation": "The type of operation to perform\\. You can specify the following values: \n+ `'INSERT'` \\- Insert data as a new item into the DynamoDB table\\. This item uses the specified hash key as a partition key\\. If you specified a range key, the item uses the range key as a sort key\\.\n+ `'UPDATE'` \\- Update an existing item of the DynamoDB table with new data\\. This item's partition key must match the specified hash key\\. If you specified a range key, the range key must match the item's sort key\\.\n+ `'DELETE'` \\- Delete an existing item of the DynamoDB table\\. This item's partition key must match the specified hash key\\. If you specified a range key, the range key must match the item's sort key\\.\nIf you don't specify this parameter, AWS IoT Events triggers the `'INSERT'` operation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Payload": "Information needed to configure the payload\\. \nBy default, AWS IoT Events generates a standard payload in JSON for any action\\. This action payload contains all attribute\\-value pairs that have the information about the detector model instance and the event triggered the action\\. To configure the action payload, you can use `contentExpression`\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PayloadField": "The name of the DynamoDB column that receives the action payload\\. \nIf you don't specify this parameter, the name of the DynamoDB column is `payload`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RangeKeyField": "The name of the range key \\(also called the sort key\\)\\. The `rangeKeyField` value must match the sort key of the target DynamoDB table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RangeKeyType": "The data type for the range key \\(also called the sort key\\), You can specify the following values: \n+ `'STRING'` \\- The range key is a string\\.\n+ `'NUMBER'` \\- The range key is number\\.\nIf you don't specify `rangeKeyField`, the default value is `'STRING'`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RangeKeyValue": "The value of the range key \\(also called the sort key\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TableName": "The name of the DynamoDB table\\. The `tableName` value must match the table name of the target DynamoDB table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel DynamoDBv2": { + "Payload": "Property description not available\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TableName": "The name of the DynamoDB table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel Firehose": { + "DeliveryStreamName": "The name of the Kinesis Data Firehose delivery stream where the data is written\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Payload": "You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Separator": "A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream\\. Valid values are: '\\\\n' \\(newline\\), '\\\\t' \\(tab\\), '\\\\r\\\\n' \\(Windows newline\\), ',' \\(comma\\)\\. \n*Required*: No \n*Type*: String \n*Pattern*: `([\\n\\t])|(\\r\\n)|(,)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel InitializationConfiguration": { + "DisabledOnInitialization": "The value must be `TRUE` or `FALSE`\\. If `FALSE`, all alarm instances created based on the alarm model are activated\\. The default value is `TRUE`\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel IotEvents": { + "InputName": "The name of the AWS IoT Events input where the data is sent\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Payload": "You can configure the action payload when you send a message to an AWS IoT Events input\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel IotSiteWise": { + "AssetId": "The ID of the asset that has the specified property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EntryId": "A unique identifier for this entry\\. You can use the entry ID to track which data entry causes an error in case of failure\\. The default is a new unique identifier\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PropertyAlias": "The alias of the asset property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PropertyId": "The ID of the asset property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PropertyValue": "The value to send to the asset property\\. This value contains timestamp, quality, and value \\(TQV\\) information\\. \n*Required*: No \n*Type*: [AssetPropertyValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel IotTopicPublish": { + "MqttTopic": "The MQTT topic of the message\\. You can use a string expression that includes variables \\(`$variable.`\\) and input values \\(`$input..`\\) as the topic string\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Payload": "You can configure the action payload when you publish a message to an AWS IoT Core topic\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel Lambda": { + "FunctionArn": "The ARN of the Lambda function that is executed\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Payload": "You can configure the action payload when you send a message to a Lambda function\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel Payload": { + "ContentExpression": "The content of the payload\\. You can use a string expression that includes quoted strings \\(`''`\\), variables \\(`$variable.`\\), input values \\(`$input..`\\), string concatenations, and quoted strings that contain `${}` as the content\\. The recommended maximum size of a content expression is 1 KB\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The value of the payload type can be either `STRING` or `JSON`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `JSON | STRING` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel SimpleRule": { + "ComparisonOperator": "The comparison operator\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `EQUAL | GREATER | GREATER_OR_EQUAL | LESS | LESS_OR_EQUAL | NOT_EQUAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InputProperty": "The value on the left side of the comparison operator\\. You can specify an AWS IoT Events input attribute as an input property\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Threshold": "The value on the right side of the comparison operator\\. You can enter a number or specify an AWS IoT Events input attribute\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel Sns": { + "Payload": "You can configure the action payload when you send a message as an Amazon SNS push notification\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetArn": "The ARN of the Amazon SNS target where the message is sent\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTEvents::AlarmModel Sqs": { + "Payload": "You can configure the action payload when you send a message to an Amazon SQS queue\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "QueueUrl": "The URL of the SQS queue where the data is written\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseBase64": "Set this to TRUE if you want the data to be base\\-64 encoded before it is written to the queue\\. Otherwise, set this to FALSE\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::IoTEvents::DetectorModel": { "DetectorModelDefinition": "Information that defines how a detector operates\\. \n*Required*: Yes \n*Type*: [DetectorModelDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-detectormodeldefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DetectorModelDescription": "A brief description of the detector model\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13242,15 +14916,184 @@ "RoleArn": "The ARN of the role that the web application assumes when it interacts with AWS IoT Core\\. \nThe name of the role must be in the form `FleetHub_random_string`\\.\nPattern: `^arn:[!-~]+$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A set of key/value pairs that you can use to manage the web application resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::IoTFleetWise::Campaign": { + "Action": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CollectionScheme": "Property description not available\\. \n*Required*: Yes \n*Type*: [CollectionScheme](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Compression": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DataExtraDimensions": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the campaign\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DiagnosticsMode": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ExpiryTime": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of a campaign\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z\\d\\-_:]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PostTriggerCollectionDuration": "Property description not available\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Priority": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SignalCatalogArn": "The ARN of the signal catalog associated with the campaign\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SignalsToCollect": "Property description not available\\. \n*Required*: No \n*Type*: List of [SignalInformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SpoolingMode": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StartTime": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetArn": "The ARN of a vehicle or fleet to which the campaign is deployed\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoTFleetWise::Campaign CollectionScheme": { + "ConditionBasedCollectionScheme": "Information about a collection scheme that uses a simple logical expression to recognize what data to collect\\. \n*Required*: No \n*Type*: [ConditionBasedCollectionScheme](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TimeBasedCollectionScheme": "Information about a collection scheme that uses a time period to decide how often to collect data\\. \n*Required*: No \n*Type*: [TimeBasedCollectionScheme](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedcollectionscheme.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoTFleetWise::Campaign ConditionBasedCollectionScheme": { + "ConditionLanguageVersion": "Specifies the version of the conditional expression language\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Expression": "The logical expression used to recognize what data to collect\\. For example, `$variable.Vehicle.OutsideAirTemperature >= 105.0`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MinimumTriggerIntervalMs": "The minimum duration of time between two triggering events to collect data, in milliseconds\\. \nIf a signal changes often, you might want to collect data at a slower rate\\.\n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TriggerMode": "Whether to collect data for all triggering events \\(`ALWAYS`\\)\\. Specify \\(`RISING_EDGE`\\), or specify only when the condition first evaluates to false\\. For example, triggering on \"AirbagDeployed\"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS | RISING_EDGE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoTFleetWise::Campaign SignalInformation": { + "MaxSampleCount": "The maximum number of samples to collect\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MinimumSamplingIntervalMs": "The minimum duration of time \\(in milliseconds\\) between two triggering events to collect data\\. \nIf a signal changes often, you might want to collect data at a slower rate\\.\n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the signal\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `150` \n*Pattern*: `[\\w|*|-]+(\\.[\\w|*|-]+)*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::Campaign TimeBasedCollectionScheme": { + "PeriodMs": "The time period \\(in milliseconds\\) to decide how often to collect data\\. For example, if the time period is `60000`, the Edge Agent software collects data once every minute\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoTFleetWise::DecoderManifest": { + "Description": "A brief description of the decoder manifest\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ModelManifestArn": "The ARN of a vehicle model \\(model manifest\\) associated with the decoder manifest\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the decoder manifest\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "NetworkInterfaces": "Property description not available\\. \n*Required*: No \n*Type*: List of [NetworkInterfacesItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SignalDecoders": "Property description not available\\. \n*Required*: No \n*Type*: List of [SignalDecodersItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-signaldecodersitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "The state of the decoder manifest\\. If the status is `ACTIVE`, the decoder manifest can't be edited\\. If the status is marked `DRAFT`, you can edit the decoder manifest\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | DRAFT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::DecoderManifest CanInterface": { + "Name": "The unique name of the interface\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProtocolName": "The name of the communication protocol for the interface\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProtocolVersion": "The version of the communication protocol for the interface\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::DecoderManifest CanSignal": { + "Factor": "A multiplier used to decode the CAN message\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsBigEndian": "Whether the byte ordering of a CAN message is big\\-endian\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsSigned": "Whether the message data is specified as a signed value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Length": "How many bytes of data are in the message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MessageId": "The ID of the message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the signal\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Offset": "Indicates where data appears in the CAN message\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartBit": "Indicates the beginning of the CAN message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::DecoderManifest NetworkInterfacesItems": { + "CanInterface": "Property description not available\\. \n*Required*: No \n*Type*: [CanInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InterfaceId": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ObdInterface": "Property description not available\\. \n*Required*: No \n*Type*: [ObdInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::DecoderManifest ObdInterface": { + "DtcRequestIntervalSeconds": "The maximum number message requests per diagnostic trouble code per second\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HasTransmissionEcu": "Whether the vehicle has a transmission control module \\(TCM\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the interface\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ObdStandard": "The standard OBD II PID\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PidRequestIntervalSeconds": "The maximum number message requests per second\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RequestMessageId": "The ID of the message requesting vehicle data\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseExtendedIds": "Whether to use extended IDs in the message\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::DecoderManifest ObdSignal": { + "BitMaskLength": "The number of bits to mask in a message\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BitRightShift": "The number of positions to shift bits in the message\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ByteLength": "The length of a message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Offset": "Indicates where data appears in the message\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Pid": "The diagnostic code used to request data from a vehicle for this signal\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PidResponseLength": "The length of the requested data\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Scaling": "A multiplier used to decode the message\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServiceMode": "The mode of operation \\(diagnostic service\\) in a message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartByte": "Indicates the beginning of the message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::DecoderManifest SignalDecodersItems": { + "CanSignal": "Property description not available\\. \n*Required*: No \n*Type*: [CanSignal](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FullyQualifiedName": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InterfaceId": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ObdSignal": "Property description not available\\. \n*Required*: No \n*Type*: [ObdSignal](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::Fleet": { + "Description": "A brief description of the fleet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Id": "The unique ID of the fleet\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z0-9:_-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SignalCatalogArn": "The ARN of the signal catalog associated with the fleet\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::ModelManifest": { + "Description": "A brief description of the vehicle model\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the vehicle model\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Nodes": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SignalCatalogArn": "The ARN of the signal catalog associated with the vehicle model\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "The state of the vehicle model\\. If the status is `ACTIVE`, the vehicle model can't be edited\\. If the status is `DRAFT`, you can edit the vehicle model\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | DRAFT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::SignalCatalog": { + "Description": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the signal catalog\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "NodeCounts": "Property description not available\\. \n*Required*: No \n*Type*: [NodeCounts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Nodes": "Property description not available\\. \n*Required*: No \n*Type*: List of [Node](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::SignalCatalog Actuator": { + "AllowedValues": "A list of possible values an actuator can take\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AssignedValue": "A specified value for the actuator\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataType": "The specified data type of the actuator\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BOOLEAN | BOOLEAN_ARRAY | DOUBLE | DOUBLE_ARRAY | FLOAT | FLOAT_ARRAY | INT16 | INT16_ARRAY | INT32 | INT32_ARRAY | INT64 | INT64_ARRAY | INT8 | INT8_ARRAY | STRING | STRING_ARRAY | UINT16 | UINT16_ARRAY | UINT32 | UINT32_ARRAY | UINT64 | UINT64_ARRAY | UINT8 | UINT8_ARRAY | UNIX_TIMESTAMP | UNIX_TIMESTAMP_ARRAY | UNKNOWN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "A brief description of the actuator\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FullyQualifiedName": "The fully qualified name of the actuator\\. For example, the fully qualified name of an actuator might be `Vehicle.Front.Left.Door.Lock`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Max": "The specified possible maximum value of an actuator\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Min": "The specified possible minimum value of an actuator\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Unit": "The scientific unit for the actuator\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::SignalCatalog Attribute": { + "AllowedValues": "A list of possible values an attribute can be assigned\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AssignedValue": "A specified value for the attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataType": "The specified data type of the attribute\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BOOLEAN | BOOLEAN_ARRAY | DOUBLE | DOUBLE_ARRAY | FLOAT | FLOAT_ARRAY | INT16 | INT16_ARRAY | INT32 | INT32_ARRAY | INT64 | INT64_ARRAY | INT8 | INT8_ARRAY | STRING | STRING_ARRAY | UINT16 | UINT16_ARRAY | UINT32 | UINT32_ARRAY | UINT64 | UINT64_ARRAY | UINT8 | UINT8_ARRAY | UNIX_TIMESTAMP | UNIX_TIMESTAMP_ARRAY | UNKNOWN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefaultValue": "The default value of the attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "A brief description of the attribute\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FullyQualifiedName": "The fully qualified name of the attribute\\. For example, the fully qualified name of an attribute might be `Vehicle.Body.Engine.Type`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Max": "The specified possible maximum value of the attribute\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Min": "The specified possible minimum value of the attribute\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Unit": "The scientific unit for the attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::SignalCatalog Branch": { + "Description": "A brief description of the branch\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FullyQualifiedName": "The fully qualified name of the branch\\. For example, the fully qualified name of a branch might be `Vehicle.Body.Engine`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::SignalCatalog Node": { + "Actuator": "Information about a node specified as an actuator\\. \nAn actuator is a digital representation of a vehicle device\\.\n*Required*: No \n*Type*: [Actuator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Attribute": "Information about a node specified as an attribute\\. \nAn attribute represents static information about a vehicle\\.\n*Required*: No \n*Type*: [Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Branch": "Information about a node specified as a branch\\. \nA group of signals that are defined in a hierarchical structure\\.\n*Required*: No \n*Type*: [Branch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Sensor": "Property description not available\\. \n*Required*: No \n*Type*: [Sensor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::SignalCatalog NodeCounts": { + "TotalActuators": "The total number of nodes in a vehicle network that represent actuators\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TotalAttributes": "The total number of nodes in a vehicle network that represent attributes\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TotalBranches": "The total number of nodes in a vehicle network that represent branches\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TotalNodes": "The total number of nodes in a vehicle network\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TotalSensors": "The total number of nodes in a vehicle network that represent sensors\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::SignalCatalog Sensor": { + "AllowedValues": "A list of possible values a sensor can take\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataType": "The specified data type of the sensor\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BOOLEAN | BOOLEAN_ARRAY | DOUBLE | DOUBLE_ARRAY | FLOAT | FLOAT_ARRAY | INT16 | INT16_ARRAY | INT32 | INT32_ARRAY | INT64 | INT64_ARRAY | INT8 | INT8_ARRAY | STRING | STRING_ARRAY | UINT16 | UINT16_ARRAY | UINT32 | UINT32_ARRAY | UINT64 | UINT64_ARRAY | UINT8 | UINT8_ARRAY | UNIX_TIMESTAMP | UNIX_TIMESTAMP_ARRAY | UNKNOWN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "A brief description of a sensor\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FullyQualifiedName": "The fully qualified name of the sensor\\. For example, the fully qualified name of a sensor might be `Vehicle.Body.Engine.Battery`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Max": "The specified possible maximum value of the sensor\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Min": "The specified possible minimum value of the sensor\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Unit": "The scientific unit of measurement for data collected by the sensor\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTFleetWise::Vehicle": { + "AssociationBehavior": "An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CreateIotThing | ValidateIotThingExists` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Attributes": "Static information about a vehicle in a key\\-value pair\\. For example: `\"engine Type\"` : `\"v6\"` \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DecoderManifestArn": "The Amazon Resource Name \\(ARN\\) of a decoder manifest associated with the vehicle to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ModelManifestArn": "The ARN of the vehicle model \\(model manifest\\) to create the vehicle from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Metadata which can be used to manage the vehicle\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::IoTSiteWise::AccessPolicy": { - "AccessPolicyIdentity": "The identity for this access policy\\. Choose an AWS SSO user, an AWS SSO group, or an IAM user\\. \n*Required*: Yes \n*Type*: [AccessPolicyIdentity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AccessPolicyIdentity": "The identity for this access policy\\. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user\\. \n*Required*: Yes \n*Type*: [AccessPolicyIdentity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AccessPolicyPermission": "The permission level for this access policy\\. Choose either a `ADMINISTRATOR` or `VIEWER`\\. Note that a project `ADMINISTRATOR` is also known as a project owner\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AccessPolicyResource": "The AWS IoT SiteWise Monitor resource for this access policy\\. Choose either a portal or a project\\. \n*Required*: Yes \n*Type*: [AccessPolicyResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoTSiteWise::AccessPolicy AccessPolicyIdentity": { "IamRole": "An IAM role identity\\. \n*Required*: No \n*Type*: [IamRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamrole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IamUser": "An IAM user identity\\. \n*Required*: No \n*Type*: [IamUser](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamuser.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "User": "The AWS SSO user to which this access policy maps\\. \n*Required*: No \n*Type*: [User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "User": "The IAM Identity Center user to which this access policy maps\\. \n*Required*: No \n*Type*: [User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoTSiteWise::AccessPolicy AccessPolicyResource": { "Portal": "The AWS IoT SiteWise Monitor portal for this access policy\\. \n*Required*: No \n*Type*: [Portal](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-portal.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13272,6 +15115,7 @@ "id": "The ID of the user\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoTSiteWise::Asset": { + "AssetDescription": "A description for the asset\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AssetHierarchies": "A list of asset hierarchies that each contain a `hierarchyLogicalId`\\. A hierarchy specifies allowed parent/child asset relationships\\. \n*Required*: No \n*Type*: List of [AssetHierarchy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AssetModelId": "The ID of the asset model from which to create the asset\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AssetName": "A unique, friendly name for the asset\\. \nThe maximum length is 256 characters with the pattern `[^\\u0000-\\u001F\\u007F]+`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13285,7 +15129,8 @@ "AWS::IoTSiteWise::Asset AssetProperty": { "Alias": "The property alias that identifies the property, such as an OPC\\-UA server data stream path \\(for example, `/company/windfarm/3/turbine/7/temperature`\\)\\. For more information, see [Mapping industrial data streams to asset properties](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) in the *AWS IoT SiteWise User Guide*\\. \nThe property alias must have 1\\-1000 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LogicalId": "The `LogicalID` of the asset property\\. \nThe maximum length is 256 characters, with the pattern `[^\\u0000-\\u001F\\u007F]+`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "NotificationState": "The MQTT notification state \\(enabled or disabled\\) for this asset property\\. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic\\. For more information, see [Interacting with other services](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) in the *AWS IoT SiteWise User Guide*\\. \nIf you omit this parameter, the notification state is set to `DISABLED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "NotificationState": "The MQTT notification state \\(`ENABLED` or `DISABLED`\\) for this asset property\\. When the notification state is `ENABLED`, AWS IoT SiteWise publishes property value updates to a unique MQTT topic\\. For more information, see [Interacting with other services](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) in the *AWS IoT SiteWise User Guide*\\. \nIf you omit this parameter, the notification state is set to `DISABLED`\\. \nYou must use all caps for the NotificationState parameter\\. If you use lower case letters, you will receive a schema validation error\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Unit": "The unit \\(such as `Newtons` or `RPM`\\) of the asset property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoTSiteWise::AssetModel": { "AssetModelCompositeModels": "The composite asset models that are part of this asset model\\. Composite asset models are asset models that contain specific properties\\. Each composite model has a type that defines the properties that the composite model supports\\. You can use composite asset models to define alarms on this asset model\\. \n*Required*: No \n*Type*: List of [AssetModelCompositeModel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13311,7 +15156,7 @@ "DataTypeSpec": "The data type of the structure for this property\\. This parameter exists on properties that have the `STRUCT` data type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LogicalId": "The `LogicalID` of the asset model property\\. \nThe maximum length is 256 characters, with the pattern `[^\\\\u0000-\\\\u001F\\\\u007F]+`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the asset model property\\. \nThe maximum length is 256 characters with the pattern `[^\\u0000-\\u001F\\u007F]+`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Type": "Contains a property type, which can be one of `attribute`, `measurement`, `metric`, or `transform`\\. \n*Required*: Yes \n*Type*: [PropertyType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "Contains a property type, which can be one of `Attribute`, `Measurement`, `Metric`, or `Transform`\\. \n*Required*: Yes \n*Type*: [PropertyType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Unit": "The unit of the asset model property, such as `Newtons` or `RPM`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoTSiteWise::AssetModel Attribute": { @@ -13375,15 +15220,19 @@ "CoreDeviceThingName": "The name of the AWS IoT thing for your AWS IoT Greengrass V2 core device\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::IoTSiteWise::Portal": { - "Alarms": "Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal\\. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range\\. For more information, see [Monitoring with alarms](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the * AWS IoT SiteWise Application Guide*\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Alarms": "Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal\\. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range\\. For more information, see [Monitoring with alarms](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the * AWS IoT SiteWise Application Guide*\\. \n*Required*: No \n*Type*: [Alarms](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NotificationSenderEmail": "The email address that sends alarm notifications\\. \nIf you use the [AWS IoT Events managed Lambda function](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) to manage your emails, you must [verify the sender email address in Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PortalAuthMode": "The service to use to authenticate users to the portal\\. Choose from the following options: \n+ `SSO` \u2013 The portal uses AWS Single Sign\\-On to authenticate users and manage user permissions\\. Before you can create a portal that uses AWS SSO, you must enable AWS SSO\\. For more information, see [Enabling AWS SSO](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) in the *AWS IoT SiteWise User Guide*\\. This option is only available in AWS Regions other than the China Regions\\.\n+ `IAM` \u2013 The portal uses AWS Identity and Access Management \\(IAM\\) to authenticate users and manage user permissions\\.\nYou can't change this value after you create a portal\\. \nDefault: `SSO` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PortalAuthMode": "The service to use to authenticate users to the portal\\. Choose from the following options: \n+ `SSO` \u2013 The portal uses AWS IAM Identity Center \\(successor to AWS Single Sign\\-On\\) to authenticate users and manage user permissions\\. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center\\. For more information, see [Enabling IAM Identity Center](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) in the *AWS IoT SiteWise User Guide*\\. This option is only available in AWS Regions other than the China Regions\\.\n+ `IAM` \u2013 The portal uses AWS Identity and Access Management \\(IAM\\) to authenticate users and manage user permissions\\.\nYou can't change this value after you create a portal\\. \nDefault: `SSO` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PortalContactEmail": "The AWS administrator's contact email address\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PortalDescription": "A description for the portal\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PortalName": "A friendly name for the portal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf\\. For more information, see [Using service roles for AWS IoT SiteWise Monitor](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) in the *AWS IoT SiteWise User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A list of key\\-value pairs that contain metadata for the portal\\. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the *AWS IoT SiteWise User Guide*\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::IoTSiteWise::Portal Alarms": { + "AlarmRoleArn": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NotificationLambdaArn": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::IoTSiteWise::Project": { "AssetIds": "A list that contains the IDs of each asset associated with the project\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PortalId": "The ID of the portal in which to create the project\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -13391,13 +15240,168 @@ "ProjectName": "A friendly name for the project\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A list of key\\-value pairs that contain metadata for the project\\. For more information, see [Tagging your AWS IoT SiteWise resources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) in the *AWS IoT SiteWise User Guide*\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, - "AWS::IoTThingsGraph::FlowTemplate": { - "CompatibleNamespaceVersion": "The version of the user's namespace against which the workflow was validated\\. Use this value in your system instance\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Definition": "A workflow's definition document\\. \n*Required*: Yes \n*Type*: [DefinitionDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotthingsgraph-flowtemplate-definitiondocument.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" - }, - "AWS::IoTThingsGraph::FlowTemplate DefinitionDocument": { - "Language": "The language used to define the entity\\. `GRAPHQL` is the only valid value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Text": "The GraphQL text that defines the entity\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AWS::IoTTwinMaker::ComponentType": { + "ComponentTypeId": "The ID of the component type\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Description": "The description of the component type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExtendsFrom": "The name of the parent component type that this component type extends\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Functions": "An object that maps strings to the functions in the component type\\. Each string in the mapping must be unique to this object\\. \nFor information on the FunctionResponse object see the [FunctionResponse](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_FunctionResponse.html) API reference\\. \n*Required*: No \n*Type*: Map of [Function](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-function.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsSingleton": "A boolean value that specifies whether an entity can have more than one component of this type\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PropertyDefinitions": "An object that maps strings to the property definitions in the component type\\. Each string in the mapping must be unique to this object\\. \nFor information about the PropertyDefinitionResponse object, see the [PropertyDefinitionResponse](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyDefinitionResponse.html) API reference\\. \n*Required*: No \n*Type*: Map of [PropertyDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PropertyGroups": "An object that maps strings to the property groups in the component type\\. Each string in the mapping must be unique to this object\\. \n*Required*: No \n*Type*: Map of [PropertyGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertygroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The ComponentType tags\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WorkspaceId": "The ID of the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoTTwinMaker::ComponentType DataConnector": { + "IsNative": "A boolean value that specifies whether the data connector is native to IoT TwinMaker\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Lambda": "The Lambda function associated with the data connector\\. \n*Required*: No \n*Type*: [LambdaFunction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-lambdafunction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::ComponentType DataType": { + "AllowedValues": "The allowed values for this data type\\. \n*Required*: No \n*Type*: List of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NestedType": "The nested type in the data type\\. \n*Required*: No \n*Type*: [DataType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-componenttype-datatype.html#aws-properties-iottwinmaker-componenttype-datatype) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Relationship": "A relationship that associates a component with another component\\. \n*Required*: No \n*Type*: [Relationship](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-relationship.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The underlying type of the data type\\. \nValid Values: `RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UnitOfMeasure": "The unit of measure used in this data type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::ComponentType DataValue": { + "BooleanValue": "A boolean value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DoubleValue": "A double value\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Expression": "An expression that produces the value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IntegerValue": "An integer value\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ListValue": "A list of multiple values\\. \n*Required*: No \n*Type*: List of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-componenttype-datavalue.html#aws-properties-iottwinmaker-componenttype-datavalue) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LongValue": "A long value\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MapValue": "An object that maps strings to multiple `DataValue` objects\\. \n*Required*: No \n*Type*: Map of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-componenttype-datavalue.html#aws-properties-iottwinmaker-componenttype-datavalue) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RelationshipValue": "A value that relates a component to another component\\. \n*Required*: No \n*Type*: [RelationshipValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-relationshipvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StringValue": "A string value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::ComponentType Error": { + "Code": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Message": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::ComponentType Function": { + "ImplementedBy": "The data connector\\. \n*Required*: No \n*Type*: [DataConnector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-dataconnector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RequiredProperties": "The required properties of the function\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Scope": "The scope of the function\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::ComponentType LambdaFunction": { + "Arn": "The Lambda function ARN\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::ComponentType PropertyDefinition": { + "Configurations": "A mapping that specifies configuration information about the property\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataType": "*Required*: No \n*Type*: [DataType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datatype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefaultValue": "A boolean value that specifies whether the property ID comes from an external data store\\. \n*Required*: No \n*Type*: [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsExternalId": "A boolean value that specifies whether the property ID comes from an external data store\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsRequiredInEntity": "A boolean value that specifies whether the property is required in an entity\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsStoredExternally": "A boolean value that specifies whether the property is stored externally\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsTimeSeries": "A boolean value that specifies whether the property consists of time series data\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::ComponentType PropertyGroup": { + "GroupType": "The group type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PropertyNames": "The property names\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::ComponentType Relationship": { + "RelationshipType": "The type of the relationship\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetComponentTypeId": "The ID of the target component type associated with this relationship\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::ComponentType RelationshipValue": { + "TargetComponentName": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetEntityId": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::ComponentType Status": { + "Error": "Property description not available\\. \n*Required*: No \n*Type*: [Error](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-error.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "State": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::Entity": { + "Components": "An object that maps strings to the components in the entity\\. Each string in the mapping must be unique to this object\\. \nFor information on the component object see the [component](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ComponentResponse.html) API reference\\. \n*Required*: No \n*Type*: Map of [Component](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the entity\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EntityId": "The entity ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EntityName": "The entity name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ParentEntityId": "The ID of the parent entity\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Metadata that you can use to manage the entity\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WorkspaceId": "The ID of the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoTTwinMaker::Entity Component": { + "ComponentName": "The name of the component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ComponentTypeId": "The ID of the ComponentType\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefinedIn": "The name of the property definition set in the request\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Properties": "An object that maps strings to the properties to set in the component type\\. Each string in the mapping must be unique to this object\\. \n*Required*: No \n*Type*: Map of [Property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-property.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PropertyGroups": "An object that maps strings to the property groups in the component type\\. Each string in the mapping must be unique to this object\\. \n*Required*: No \n*Type*: Map of [PropertyGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-propertygroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "The status of the component\\. \n*Required*: No \n*Type*: [Status](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-status.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::Entity DataType": { + "AllowedValues": "Property description not available\\. \n*Required*: No \n*Type*: List of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NestedType": "Property description not available\\. \n*Required*: No \n*Type*: [DataType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-entity-datatype.html#aws-properties-iottwinmaker-entity-datatype) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Relationship": "Property description not available\\. \n*Required*: No \n*Type*: [Relationship](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-relationship.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UnitOfMeasure": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::Entity DataValue": { + "BooleanValue": "A boolean value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DoubleValue": "A double value\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Expression": "An expression that produces the value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IntegerValue": "An integer value\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ListValue": "A list of multiple values\\. \n*Required*: No \n*Type*: List of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-entity-datavalue.html#aws-properties-iottwinmaker-entity-datavalue) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LongValue": "A long value\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MapValue": "An object that maps strings to multiple DataValue objects\\. \n*Required*: No \n*Type*: Map of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-entity-datavalue.html#aws-properties-iottwinmaker-entity-datavalue) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RelationshipValue": "A value that relates a component to another component\\. \n*Required*: No \n*Type*: [RelationshipValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-relationshipvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StringValue": "A string value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::Entity Definition": { + "Configuration": "Property description not available\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataType": "Property description not available\\. \n*Required*: No \n*Type*: [DataType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datatype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefaultValue": "Property description not available\\. \n*Required*: No \n*Type*: [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsExternalId": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsFinal": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsImported": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsInherited": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsRequiredInEntity": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsStoredExternally": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsTimeSeries": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::Entity Error": { + "Code": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Message": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::Entity Property": { + "Definition": "An object that specifies information about a property\\. \n*Required*: No \n*Type*: [Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-definition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "An object that contains information about a value for a time series property\\. \n*Required*: No \n*Type*: [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::Entity PropertyGroup": { + "GroupType": "The group type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PropertyNames": "The property names\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::Entity Relationship": { + "RelationshipType": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetComponentTypeId": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::Entity RelationshipValue": { + "TargetComponentName": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetEntityId": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::Entity Status": { + "Error": "The error message\\. \n*Required*: No \n*Type*: [Error](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-error.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "State": "The current state of the entity, component, component type, or workspace\\. \nValid Values: `CREATING | UPDATING | DELETING | ACTIVE | ERROR` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTTwinMaker::Scene": { + "Capabilities": "A list of capabilities that the scene uses to render\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContentLocation": "The relative path that specifies the location of the content definition file\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of this scene\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SceneId": "The scene ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "The ComponentType tags\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WorkspaceId": "The ID of the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoTTwinMaker::SyncJob": { + "SyncRole": "The SyncJob IAM role\\. This IAM role is used by the sync job to read from the syncSource, and create, update or delete the corresponding resources\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SyncSource": "The sync source\\. \nCurrently the only supported syncSoucre is `SITEWISE`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Metadata you can use to manage the SyncJob\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "WorkspaceId": "The ID of the workspace that contains the sync job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::IoTTwinMaker::Workspace": { + "Description": "The description of the workspace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Role": "The ARN of the execution role associated with the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3Location": "The ARN of the S3 bucket where resources associated with the workspace are stored\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Metadata that you can use to manage the workspace\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WorkspaceId": "The ID of the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::IoTWireless::Destination": { "Description": "The description of the new resource\\. Maximum length is 2048 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13415,6 +15419,7 @@ "AWS::IoTWireless::DeviceProfile LoRaWANDeviceProfile": { "ClassBTimeout": "The ClassBTimeout value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClassCTimeout": "The ClassCTimeout value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FactoryPresetFreqsList": "The list of values that make up the FactoryPresetFreqs value\\. \n*Required*: No \n*Type*: List of Integer \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MacVersion": "The MAC version \\(such as OTAA 1\\.1 or OTAA 1\\.0\\.3\\) to use with this device profile\\. \n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxDutyCycle": "The MaxDutyCycle value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxEirp": "The MaxEIRP value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13423,6 +15428,10 @@ "PingSlotPeriod": "The PingSlotPeriod value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `128` \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RegParamsRevision": "The version of regional parameters\\. \n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RfRegion": "The frequency band \\(RFRegion\\) value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RxDataRate2": "The RXDataRate2 value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RxDelay1": "The RXDelay1 value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RxDrOffset1": "The RXDROffset1 value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `7` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RxFreq2": "The RXFreq2 value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1000000` \n*Maximum*: `16700000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Supports32BitFCnt": "The Supports32BitFCnt value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SupportsClassB": "The SupportsClassB value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SupportsClassC": "The SupportsClassC value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13458,6 +15467,18 @@ "NumberOfDevicesRequested": "Number of devices that are requested to be associated with the multicast group\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RfRegion": "The frequency band \\(RFRegion\\) value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::IoTWireless::NetworkAnalyzerConfiguration": { + "Description": "The description of the resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "Name of the network analyzer configuration\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "The tags to attach to the specified resource\\. Tags are metadata that you can use to manage a resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TraceContent": "Trace content for your wireless gateway and wireless device resources\\. \n*Required*: No \n*Type*: [TraceContent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-networkanalyzerconfiguration-tracecontent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WirelessDevices": "Wireless device resources to add to the network analyzer configuration\\. Provide the `WirelessDeviceId` of the resource to add in the input array\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `250` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WirelessGateways": "Wireless gateway resources to add to the network analyzer configuration\\. Provide the `WirelessGatewayId` of the resource to add in the input array\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::IoTWireless::NetworkAnalyzerConfiguration TraceContent": { + "LogLevel": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WirelessDeviceFrameInfo": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::IoTWireless::PartnerAccount": { "PartnerAccountId": "The ID of the partner account to update\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Sidewalk": "The Sidewalk account credentials\\. \n*Required*: No \n*Type*: [SidewalkAccountInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-partneraccount-sidewalkaccountinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13466,6 +15487,11 @@ "AWS::IoTWireless::PartnerAccount SidewalkAccountInfo": { "AppServerPrivateKey": "The Sidewalk application server private key\\. The application server private key is a secret key, which you should handle in a similar way as you would an application password\\. You can protect the application server private key by storing the value in the AWS Secrets Manager and use the [secretsmanager](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) to reference this value\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4096` \n*Pattern*: `[a-fA-F0-9]{64}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::IoTWireless::PartnerAccount SidewalkAccountInfoWithFingerprint": { + "AmazonId": "The Sidewalk Amazon ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Arn": "The Amazon Resource Name \\(ARN\\) of the resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Fingerprint": "The fingerprint of the Sidewalk application server private key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `64` \n*Maximum*: `64` \n*Pattern*: `[a-fA-F0-9]{64}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::IoTWireless::PartnerAccount SidewalkUpdateAccount": { "AppServerPrivateKey": "The new Sidewalk application server private key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4096` \n*Pattern*: `[a-fA-F0-9]{64}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -13496,7 +15522,7 @@ "UlRatePolicy": "The ULRatePolicy value\\. \nThis property is `ReadOnly` and can't be inputted for create\\. It's returned with `Fn::GetAtt` \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoTWireless::TaskDefinition": { - "AutoCreateTasks": "Whether to automatically create tasks using this task definition for all gateways with the specified current version\\. If `false`, the task must me created by calling `CreateWirelessGatewayTask`\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AutoCreateTasks": "Whether to automatically create tasks using this task definition for all gateways with the specified current version\\. If `false`, the task must be created by calling `CreateWirelessGatewayTask`\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the new resource\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags are an array of key\\-value pairs to attach to the specified resource\\. Tags can have a minimum of 0 and a maximum of 50 items\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Update": "Information about the gateways to update\\. \n*Required*: No \n*Type*: [UpdateWirelessGatewayTaskCreate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-taskdefinition-updatewirelessgatewaytaskcreate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -13573,32 +15599,33 @@ "LoRaWAN": "The gateway configuration information to use to create the wireless gateway\\. \n*Required*: Yes \n*Type*: [LoRaWANGateway](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessgateway-lorawangateway.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the new resource\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags are an array of key\\-value pairs to attach to the specified resource\\. Tags can have a minimum of 0 and a maximum of 50 items\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ThingArn": "The ARN of the thing to associate with the wireless gateway\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ThingArn": "The ARN of the thing to associate with the wireless gateway\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ThingName": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::IoTWireless::WirelessGateway LoRaWANGateway": { "GatewayEui": "The gateway's EUI value\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^(([0-9A-Fa-f]{2}-){7}|([0-9A-Fa-f]{2}:){7}|([0-9A-Fa-f]{2}\\s){7}|([0-9A-Fa-f]{2}){7})([0-9A-Fa-f]{2})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RfRegion": "The frequency band \\(RFRegion\\) value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::KMS::Alias": { - "AliasName": "Specifies the alias name\\. This value must begin with `alias/` followed by a name, such as `alias/ExampleAlias`\\. \nIf you change the value of a `Replacement` property, such as `AliasName`, the existing alias is deleted and a new alias is created for the specified KMS key\\. This change can disrupt applications that use the alias\\. It can also allow or deny access to a KMS key affected by attribute\\-based access control \\(ABAC\\)\\.\nThe alias must be string of 1\\-256 characters\\. It can contain only alphanumeric characters, forward slashes \\(/\\), underscores \\(\\_\\), and dashes \\(\\-\\)\\. The alias name cannot begin with `alias/aws/`\\. The `alias/aws/` prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)\\. \n*Pattern*: `alias/^[a-zA-Z0-9/_-]+$` \n*Minimum*: `1` \n*Maximum*: `256` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AliasName": "Specifies the alias name\\. This value must begin with `alias/` followed by a name, such as `alias/ExampleAlias`\\. \nIf you change the value of the `AliasName` property, the existing alias is deleted and a new alias is created for the specified KMS key\\. This change can disrupt applications that use the alias\\. It can also allow or deny access to a KMS key affected by attribute\\-based access control \\(ABAC\\)\\.\nThe alias must be string of 1\\-256 characters\\. It can contain only alphanumeric characters, forward slashes \\(/\\), underscores \\(\\_\\), and dashes \\(\\-\\)\\. The alias name cannot begin with `alias/aws/`\\. The `alias/aws/` prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)\\. \n*Pattern*: `^alias/[a-zA-Z0-9/_-]+$` \n*Minimum*: `1` \n*Maximum*: `256` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TargetKeyId": "Associates the alias with the specified [customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk)\\. The KMS key must be in the same AWS account and Region\\. \nA valid key ID is required\\. If you supply a null or empty string value, this operation returns an error\\. \nFor help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *AWS Key Management Service Developer Guide*\\. \nSpecify the key ID or the key ARN of the KMS key\\. \nFor example: \n+ Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab` \n+ Key ARN: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` \nTo get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::KMS::Key": { "Description": "A description of the KMS key\\. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EnableKeyRotation": "Enables automatic rotation of the key material for the specified KMS key\\. By default, automatic key rotation is not enabled\\. \nAWS KMS does not support automatic key rotation on asymmetric KMS keys\\. For asymmetric KMS keys, omit the `EnableKeyRotation` property or set it to `false`\\. \nWhen you enable automatic rotation, AWS KMS automatically creates new key material for the KMS key 365 days after the enable \\(or reenable\\) date and every 365 days thereafter\\. AWS KMS retains all key material until you delete the KMS key\\. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *AWS Key Management Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableKeyRotation": "Enables automatic rotation of the key material for the specified KMS key\\. By default, automatic key rotation is not enabled\\. \nAWS KMS supports automatic rotation only for symmetric encryption KMS keys \\(`KeySpec` = `SYMMETRIC_DEFAULT`\\)\\. For asymmetric KMS keys and HMAC KMS keys, omit the `EnableKeyRotation` property or set it to `false`\\. \nTo enable automatic key rotation of the key material for a multi\\-Region KMS key, set `EnableKeyRotation` to `true` on the primary key \\(created by using `AWS::KMS::Key`\\)\\. AWS KMS copies the rotation status to all replica keys\\. For details, see [Rotating multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *AWS Key Management Service Developer Guide*\\. \nWhen you enable automatic rotation, AWS KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter\\. AWS KMS retains all key material until you delete the KMS key\\. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *AWS Key Management Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "Specifies whether the KMS key is enabled\\. Disabled KMS keys cannot be used in cryptographic operations\\. \nWhen `Enabled` is `true`, the *key state* of the KMS key is `Enabled`\\. When `Enabled` is `false`, the key state of the KMS key is `Disabled`\\. The default value is `true`\\. \nThe actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations\\. \nFor information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KeyPolicy": "The key policy that authorizes use of the KMS key\\. The key policy must conform to the following rules\\. \n+ The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key\\. This reduces the risk that the KMS key becomes unmanageable\\. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the * *AWS Key Management Service Developer Guide* *\\.\n+ Each statement in the key policy must contain one or more principals\\. The principals in the key policy must exist and be visible to AWS KMS\\. When you create a new AWS principal \\(for example, an IAM user or role\\), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS\\. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide*\\.\n+ The key policy size limit is 32 kilobytes \\(32768 bytes\\)\\.\nIf you are unsure of which policy to use, consider the *default key policy*\\. This is the key policy that AWS KMS applies to KMS keys that are created by using the CreateKey API with no specified key policy\\. It gives the AWS account that owns the key permission to perform all operations on the key\\. It also allows you write IAM policies to authorize access to the key\\. For details, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *AWS Key Management Service Developer Guide*\\. \n*Minimum*: `1` \n*Maximum*: `32768` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KeySpec": "Specifies the type of KMS key to create\\. The default value, `SYMMETRIC_DEFAULT`, creates a KMS key with a 256\\-bit symmetric key for encryption and decryption\\. For help choosing a key spec for your KMS key, see [How to choose Your KMS key configuration](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *AWS Key Management Service Developer Guide*\\. \nThe `KeySpec` property determines whether the KMS key contains a symmetric key or an asymmetric key pair\\. It also determines the encryption algorithms or signing algorithms that the KMS key supports\\. You can't change the `KeySpec` after the KMS key is created\\. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy\\. For more information, see [kms:EncryptionAlgorithm](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm) or [kms:Signing Algorithm](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm) in the *AWS Key Management Service Developer Guide*\\. \nIf you change the `KeySpec` of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified `KeySpec` value\\. While the scheduled deletion is pending, you can't use the existing KMS key\\. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted\\.\n[AWS services that are integrated with AWS KMS](http://aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric KMS keys to protect your data\\. These services do not support asymmetric KMS keys\\. For help determining whether a KMS key is symmetric or asymmetric, see [Identifying Symmetric and Asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *AWS Key Management Service Developer Guide*\\.\nAWS KMS supports the following key specs for KMS keys: \n+ Symmetric key \\(default\\)\n + `SYMMETRIC_DEFAULT` \\(AES\\-256\\-GCM\\)\n+ Asymmetric RSA key pairs\n + `RSA_2048`\n + `RSA_3072`\n + `RSA_4096`\n+ Asymmetric NIST\\-recommended elliptic curve key pairs\n + `ECC_NIST_P256` \\(secp256r1\\)\n + `ECC_NIST_P384` \\(secp384r1\\)\n + `ECC_NIST_P521` \\(secp521r1\\)\n+ Other asymmetric elliptic curve key pairs\n + `ECC_SECG_P256K1` \\(secp256k1\\), commonly used for cryptocurrencies\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "KeyUsage": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key\\. The default value is `ENCRYPT_DECRYPT`\\. This property is required only for asymmetric KMS keys\\. You can't change the `KeyUsage` value after the KMS key is created\\. \nIf you change the `KeyUsage` of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified `KeyUsage` value\\. While the scheduled deletion is pending, you can't use the existing KMS key\\. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted\\.\nSelect only one valid value\\. \n+ For symmetric KMS keys, omit the property or specify `ENCRYPT_DECRYPT`\\.\n+ For asymmetric KMS keys with RSA key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY`\\.\n+ For asymmetric KMS keys with ECC key material, specify `SIGN_VERIFY`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ENCRYPT_DECRYPT | SIGN_VERIFY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MultiRegion": "Creates a multi\\-Region primary key that you can replicate in other AWS Regions\\. \nIf you change the `MultiRegion` property of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified `Multi-Region` value\\. While the scheduled deletion is pending, you can't use the existing KMS key\\. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted\\.\nFor a multi\\-Region key, set to this property to `true`\\. For a single\\-Region key, omit this property or set it to `false`\\. The default value is `false`\\. \n*Multi\\-Region keys* are an AWS KMS feature that lets you create multiple interoperable KMS keys in different AWS Regions\\. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross\\-Region call or exposing the plaintext data\\. For more information, see [Multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide*\\. \nYou can create a symmetric or asymmetric multi\\-Region key, and you can create a multi\\-Region key with imported key material\\. However, you cannot create a multi\\-Region key in a custom key store\\. \nTo create a replica of this primary key in a different AWS Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region\\. Specify the key ARN of this primary key\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "KeyPolicy": "The key policy that authorizes use of the KMS key\\. The key policy must conform to the following rules\\. \n+ The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key\\. This reduces the risk that the KMS key becomes unmanageable\\. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the * *AWS Key Management Service Developer Guide* *\\.\n+ Each statement in the key policy must contain one or more principals\\. The principals in the key policy must exist and be visible to AWS KMS\\. When you create a new AWS principal \\(for example, an IAM user or role\\), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS\\. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide*\\.\nIf you are unsure of which policy to use, consider the *default key policy*\\. This is the key policy that AWS KMS applies to KMS keys that are created by using the CreateKey API with no specified key policy\\. It gives the AWS account that owns the key permission to perform all operations on the key\\. It also allows you write IAM policies to authorize access to the key\\. For details, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *AWS Key Management Service Developer Guide*\\. \nA key policy document can include only the following characters: \n+ Printable ASCII characters\n+ Printable characters in the Basic Latin and Latin\\-1 Supplement character set\n+ The tab \\(`\\u0009`\\), line feed \\(`\\u000A`\\), and carriage return \\(`\\u000D`\\) special characters\n*Minimum*: `1` \n*Maximum*: `32768` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KeySpec": "Specifies the type of KMS key to create\\. The default value, `SYMMETRIC_DEFAULT`, creates a KMS key with a 256\\-bit symmetric key for encryption and decryption\\. In China Regions, `SYMMETRIC_DEFAULT` creates a 128\\-bit symmetric key that uses SM4 encryption\\. You can't change the `KeySpec` value after the KMS key is created\\. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *AWS Key Management Service Developer Guide*\\. \nThe `KeySpec` property determines the type of key material in the KMS key and the algorithms that the KMS key supports\\. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy\\. For more information, see [AWS KMS condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *AWS Key Management Service Developer Guide*\\. \nIf you change the value of the `KeySpec` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html)\\. This prevents you from accidentally deleting a KMS key by changing an immutable property value\\.\n[AWS services that are integrated with AWS KMS](http://aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data\\. These services do not support encryption with asymmetric KMS keys\\. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *AWS Key Management Service Developer Guide*\\.\n AWS KMS supports the following key specs for KMS keys: \n+ Symmetric encryption key \\(default\\)\n + `SYMMETRIC_DEFAULT` \\(AES\\-256\\-GCM\\)\n+ HMAC keys \\(symmetric\\)\n + `HMAC_224` \n + `HMAC_256` \n + `HMAC_384` \n + `HMAC_512` \n+ Asymmetric RSA key pairs\n + `RSA_2048` \n + `RSA_3072` \n + `RSA_4096` \n+ Asymmetric NIST\\-recommended elliptic curve key pairs\n + `ECC_NIST_P256` \\(secp256r1\\)\n + `ECC_NIST_P384` \\(secp384r1\\)\n + `ECC_NIST_P521` \\(secp521r1\\)\n+ Other asymmetric elliptic curve key pairs\n + `ECC_SECG_P256K1` \\(secp256k1\\), commonly used for cryptocurrencies\\.\n+ SM2 key pairs \\(China Regions only\\)\n + `SM2`\n*Required*: No \n*Type*: String \n*Allowed values*: `ECC_NIST_P256 | ECC_NIST_P384 | ECC_NIST_P521 | ECC_SECG_P256K1 | HMAC_224 | HMAC_256 | HMAC_384 | HMAC_512 | RSA_2048 | RSA_3072 | RSA_4096 | SM2 | SYMMETRIC_DEFAULT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "KeyUsage": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key\\. The default value is `ENCRYPT_DECRYPT`\\. This property is required for asymmetric KMS keys and HMAC KMS keys\\. You can't change the `KeyUsage` value after the KMS key is created\\. \nIf you change the value of the `KeyUsage` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html)\\. This prevents you from accidentally deleting a KMS key by changing an immutable property value\\.\nSelect only one valid value\\. \n+ For symmetric encryption KMS keys, omit the property or specify `ENCRYPT_DECRYPT`\\.\n+ For asymmetric KMS keys with RSA key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY`\\.\n+ For asymmetric KMS keys with ECC key material, specify `SIGN_VERIFY`\\.\n+ For asymmetric KMS keys with SM2 \\(China Regions only\\) key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY`\\.\n+ For HMAC KMS keys, specify `GENERATE_VERIFY_MAC`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ENCRYPT_DECRYPT | GENERATE_VERIFY_MAC | SIGN_VERIFY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MultiRegion": "Creates a multi\\-Region primary key that you can replicate in other AWS Regions\\. You can't change the `MultiRegion` value after the KMS key is created\\. \nFor a list of AWS Regions in which multi\\-Region keys are supported, see [Multi\\-Region keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide*\\. \nIf you change the value of the `MultiRegion` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html)\\. This prevents you from accidentally deleting a KMS key by changing an immutable property value\\.\nFor a multi\\-Region key, set to this property to `true`\\. For a single\\-Region key, omit this property or set it to `false`\\. The default value is `false`\\. \n*Multi\\-Region keys* are an AWS KMS feature that lets you create multiple interoperable KMS keys in different AWS Regions\\. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross\\-Region call or exposing the plaintext data\\. For more information, see [Multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide*\\. \nYou can create a symmetric encryption, HMAC, or asymmetric multi\\-Region KMS key, and you can create a multi\\-Region key with imported key material\\. However, you cannot create a multi\\-Region key in a custom key store\\. \nTo create a replica of this primary key in a different AWS Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region\\. Specify the key ARN of this primary key\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PendingWindowInDays": "Specifies the number of days in the waiting period before AWS KMS deletes a KMS key that has been removed from a CloudFormation stack\\. Enter a value between 7 and 30 days\\. The default value is 30 days\\. \nWhen you remove a KMS key from a CloudFormation stack, AWS KMS schedules the KMS key for deletion and starts the mandatory waiting period\\. The `PendingWindowInDays` property determines the length of waiting period\\. During the waiting period, the key state of KMS key is `Pending Deletion` or `Pending Replica Deletion`, which prevents the KMS key from being used in cryptographic operations\\. When the waiting period expires, AWS KMS permanently deletes the KMS key\\. \nAWS KMS will not delete a [multi\\-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys\\. If you remove a multi\\-Region primary key from a CloudFormation stack, its key state changes to `PendingReplicaDeletion` so it cannot be replicated or used in cryptographic operations\\. This state can persist indefinitely\\. When the last of its replica keys is deleted, the key state of the primary key changes to `PendingDeletion` and the waiting period specified by `PendingWindowInDays` begins\\. When this waiting period expires, AWS KMS deletes the primary key\\. For details, see [Deleting multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide*\\. \nYou cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period\\. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key\\. To cancel deletion of a KMS key, use the AWS KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation\\. \nFor information about the `Pending Deletion` and `Pending Replica Deletion` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide*\\. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide*\\. \n*Minimum*: 7 \n*Maximum*: 30 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Assigns one or more tags to the replica key\\. \nTagging or untagging a KMS key can allow or deny permission to the KMS key\\. For details, see [ABAC for AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide*\\.\nFor information about tags in AWS KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *AWS Key Management Service Developer Guide*\\. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::KMS::ReplicaKey": { "Description": "A description of the KMS key\\. \nThe default value is an empty string \\(no description\\)\\. \nThe description is not a shared property of multi\\-Region keys\\. You can specify the same description or a different description for each key in a set of related multi\\-Region keys\\. AWS Key Management Service does not synchronize this property\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "Specifies whether the replica key is enabled\\. Disabled KMS keys cannot be used in cryptographic operations\\. \nWhen `Enabled` is `true`, the *key state* of the KMS key is `Enabled`\\. When `Enabled` is `false`, the key state of the KMS key is `Disabled`\\. The default value is `true`\\. \nThe actual key state of the replica might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations\\. Also, while the replica key is being created, its key state is `Creating`\\. When the process is complete, the key state of the replica key changes to `Enabled`\\. \nFor information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KeyPolicy": "The key policy that authorizes use of the replica key\\. \nThe key policy is not a shared property of multi\\-Region keys\\. You can specify the same key policy or a different key policy for each key in a set of related multi\\-Region keys\\. AWS KMS does not synchronize this property\\. \nThe key policy must conform to the following rules\\. \n+ The key policy must give the caller [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) permission on the KMS key\\. This reduces the risk that the KMS key becomes unmanageable\\. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the * *AWS Key Management Service Developer Guide* *\\.\n+ Each statement in the key policy must contain one or more principals\\. The principals in the key policy must exist and be visible to AWS KMS\\. When you create a new AWSprincipal \\(for example, an IAM user or role\\), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS\\. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide*\\.\n+ The key policy size limit is 32 kilobytes \\(32768 bytes\\)\\.\n*Minimum*: `1` \n*Maximum*: `32768` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PendingWindowInDays": "Specifies the number of days in the waiting period before AWS KMS deletes a replica key that has been removed from a CloudFormation stack\\. Enter a value between 7 and 30 days\\. The default value is 30 days\\. \nWhen you remove a replica key from a CloudFormation stack, AWS KMS schedules the replica key for deletion and starts the mandatory waiting period\\. The `PendingWindowInDays` property determines the length of waiting period\\. During the waiting period, the key state of replica key is `Pending Deletion`, which prevents it from being used in cryptographic operations\\. When the waiting period expires, AWS KMS permanently deletes the replica key\\. \nYou cannot use a CloudFormation template to cancel deletion of the replica after you remove it from the stack, regardless of the waiting period\\. However, if you specify a replica key in your template that is based on the same primary key as the original replica key, CloudFormation creates a new replica key with the same key ID, key material, and other shared properties of the original replica key\\. This new replica key can decrypt ciphertext that was encrypted under the original replica key, or any related multi\\-Region key\\. \nFor detailed information about deleting multi\\-Region keys, see [Deleting multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide*\\. \nFor information about the `PendingDeletion` key state, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide*\\. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide*\\. \n*Minimum*: 7 \n*Maximum*: 30 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KeyPolicy": "The key policy that authorizes use of the replica key\\. \nThe key policy is not a shared property of multi\\-Region keys\\. You can specify the same key policy or a different key policy for each key in a set of related multi\\-Region keys\\. AWS KMS does not synchronize this property\\. \nThe key policy must conform to the following rules\\. \n+ The key policy must give the caller [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) permission on the KMS key\\. This reduces the risk that the KMS key becomes unmanageable\\. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the * *AWS Key Management Service Developer Guide* *\\.\n+ Each statement in the key policy must contain one or more principals\\. The principals in the key policy must exist and be visible to AWS KMS\\. When you create a new AWSprincipal \\(for example, an IAM user or role\\), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS\\. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide*\\.\nA key policy document can include only the following characters: \n+ Printable ASCII characters from the space character \\(`\\u0020`\\) through the end of the ASCII character range\\.\n+ Printable characters in the Basic Latin and Latin\\-1 Supplement character set \\(through `\\u00FF`\\)\\.\n+ The tab \\(`\\u0009`\\), line feed \\(`\\u000A`\\), and carriage return \\(`\\u000D`\\) special characters\n*Minimum*: `1` \n*Maximum*: `32768` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PendingWindowInDays": "Specifies the number of days in the waiting period before AWS KMS deletes a replica key that has been removed from a CloudFormation stack\\. Enter a value between 7 and 30 days\\. The default value is 30 days\\. \nWhen you remove a replica key from a CloudFormation stack, AWS KMS schedules the replica key for deletion and starts the mandatory waiting period\\. The `PendingWindowInDays` property determines the length of waiting period\\. During the waiting period, the key state of replica key is `Pending Deletion`, which prevents it from being used in cryptographic operations\\. When the waiting period expires, AWS KMS permanently deletes the replica key\\. \nIf the KMS key is a multi\\-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted\\. Otherwise, the waiting period begins immediately\\. \nYou cannot use a CloudFormation template to cancel deletion of the replica after you remove it from the stack, regardless of the waiting period\\. However, if you specify a replica key in your template that is based on the same primary key as the original replica key, CloudFormation creates a new replica key with the same key ID, key material, and other shared properties of the original replica key\\. This new replica key can decrypt ciphertext that was encrypted under the original replica key, or any related multi\\-Region key\\. \nFor detailed information about deleting multi\\-Region keys, see [Deleting multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide*\\. \nFor information about the `PendingDeletion` key state, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide*\\. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide*\\. \n*Minimum*: 7 \n*Maximum*: 30 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PrimaryKeyArn": "Specifies the multi\\-Region primary key to replicate\\. The primary key must be in a different AWS Region of the same AWS partition\\. You can create only one replica of a given primary key in each AWS Region \\. \nIf you change the `PrimaryKeyArn` value of a replica key, the existing replica key is scheduled for deletion and a new replica key is created based on the specified primary key\\. While it is scheduled for deletion, the existing replica key becomes unusable\\. You can cancel the scheduled deletion of the key outside of CloudFormation\\. \nHowever, if you inadvertently delete a replica key, you can decrypt ciphertext encrypted by that replica key by using any related multi\\-Region key\\. If necessary, you can recreate the replica in the same Region after the previous one is completely deleted\\. For details, see [Deleting multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide*\nSpecify the key ARN of an existing multi\\-Region primary key\\. For example, `arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Assigns one or more tags to the replica key\\. \nTagging or untagging a KMS key can allow or deny permission to the KMS key\\. For details, see [ABAC for AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *AWS Key Management Service Developer Guide*\\.\nTags are not a shared property of multi\\-Region keys\\. You can specify the same tags or different tags for each key in a set of related multi\\-Region keys\\. AWS KMS does not synchronize this property\\. \nEach tag consists of a tag key and a tag value\\. Both the tag key and the tag value are required, but the tag value can be an empty \\(null\\) string\\. You cannot have more than one tag on a KMS key with the same tag key\\. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one\\. \nWhen you assign tags to an AWSresource, AWSgenerates a cost allocation report with usage and costs aggregated by tags\\. Tags can also be used to control access to a KMS key\\. For details, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -13612,7 +15639,7 @@ "KafkaClusterEncryptionInTransit": "Details of encryption in transit to the Apache Kafka cluster\\. \n*Required*: Yes \n*Type*: [KafkaClusterEncryptionInTransit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-kafkaclusterencryptionintransit.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KafkaConnectVersion": "The version of Kafka Connect\\. It has to be compatible with both the Apache Kafka cluster's version and the plugins\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "LogDelivery": "The settings for delivering connector logs to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: [LogDelivery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-logdelivery.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Plugins": "Specifies which plugins were used for this connector\\. \n*Required*: Yes \n*Type*: List of [Plugin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-plugin.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Plugins": "Specifies which plugin to use for the connector\\. You must specify a single\\-element list\\. Amazon MSK Connect does not currently support specifying multiple plugins\\. \n*Required*: Yes \n*Type*: List of [Plugin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-plugin.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ServiceExecutionRoleArn": "The Amazon Resource Name \\(ARN\\) of the IAM role used by the connector to access Amazon Web Services resources\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "WorkerConfiguration": "The worker configurations that are in use with the connector\\. \n*Required*: No \n*Type*: [WorkerConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -13687,15 +15714,15 @@ "S3": "Details about delivering logs to Amazon S3\\. \n*Required*: No \n*Type*: [S3LogDelivery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-s3logdelivery.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Kendra::DataSource": { - "CustomDocumentEnrichmentConfiguration": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [CustomDocumentEnrichmentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DataSourceConfiguration": "Configuration information for an Amazon Kendra data source\\. The contents of the configuration depend on the type of data source\\. You can only specify one type of data source in the configuration\\. Choose from one of the following data sources\\. \n+ Amazon S3\n+ Confluence\n+ Custom\n+ Database\n+ Microsoft OneDrive\n+ Microsoft SharePoint \n+ Salesforce\n+ ServiceNow\nYou can't specify the `Configuration` parameter when the `Type` parameter is set to `CUSTOM`\\. \nThe `Configuration` parameter is required for all other data sources\\. \n*Required*: No \n*Type*: [DataSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "A description of the data source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IndexId": "The identifier of the index that should be associated with this data source\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomDocumentEnrichmentConfiguration": "Configuration information for altering document metadata and content during the document ingestion process\\. \n*Required*: No \n*Type*: [CustomDocumentEnrichmentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataSourceConfiguration": "Configuration information for an Amazon Kendra data source\\. The contents of the configuration depend on the type of data source\\. You can only specify one type of data source in the configuration\\. \nYou can't specify the `Configuration` parameter when the `Type` parameter is set to `CUSTOM`\\. \nThe `Configuration` parameter is required for all other data sources\\. \n*Required*: No \n*Type*: [DataSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "A description for the data source connector\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IndexId": "The identifier of the index you want to use with the data source connector\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the data source\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000` \n*Pattern*: `[a-zA-Z0-9][a-zA-Z0-9_-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The Amazon Resource Name \\(ARN\\) of a role with permission to access the data source\\. \nYou can't specify the `RoleArn` parameter when the `Type` parameter is set to `CUSTOM`\\. \nThe `RoleArn` parameter is required for all other data sources\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Schedule": "Sets the frequency that Amazon Kendra checks the documents in your data source and updates the index\\. If you don't set a schedule, Amazon Kendra doesn't periodically update the index\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs to apply to this resource \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Type": "The type of the data source\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONFLUENCE | CUSTOM | DATABASE | FSX | GOOGLEDRIVE | ONEDRIVE | S3 | SALESFORCE | SERVICENOW | SHAREPOINT | SLACK | WEBCRAWLER | WORKDOCS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Type": "The type of the data source\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALFRESCO | BOX | CONFLUENCE | CUSTOM | DATABASE | FSX | GITHUB | GOOGLEDRIVE | JIRA | ONEDRIVE | QUIP | S3 | SALESFORCE | SERVICENOW | SHAREPOINT | SLACK | TEMPLATE | WEBCRAWLER | WORKDOCS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Kendra::DataSource AccessControlListConfiguration": { "KeyPath": "Path to the AWS S3 bucket that contains the access control list files\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -13706,13 +15733,13 @@ "AWS::Kendra::DataSource ColumnConfiguration": { "ChangeDetectingColumns": "One to five columns that indicate when a document in the database has changed\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DocumentDataColumnName": "The column that contains the contents of the document\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DocumentIdColumnName": "The column that provides the document's unique identifier\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DocumentIdColumnName": "The column that provides the document's identifier\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DocumentTitleColumnName": "The column that contains the title of the document\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FieldMappings": "An array of objects that map database column names to the corresponding fields in an index\\. You must first create the fields in the index using the [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateIndex.html) operation\\. \n*Required*: No \n*Type*: List of [DataSourceToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::DataSource ConfluenceAttachmentConfiguration": { "AttachmentFieldMappings": "Maps attributes or field names of Confluence attachments to Amazon Kendra index field names\\. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields\\. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. The Confluence data source field names must exist in your Confluence custom metadata\\. \nIf you specify the `AttachentFieldMappings` parameter, you must specify at least one field mapping\\. \n*Required*: No \n*Type*: List of [ConfluenceAttachmentToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmenttoindexfieldmapping.html) \n*Maximum*: `11` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CrawlAttachments": "Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CrawlAttachments": "`TRUE` to index attachments of pages and blogs in Confluence\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::DataSource ConfluenceAttachmentToIndexFieldMapping": { "DataSourceFieldName": "The name of the field in the data source\\. \nYou must first create the index field using the `UpdateIndex` API\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AUTHOR | CONTENT_TYPE | CREATED_DATE | DISPLAY_URL | FILE_SIZE | ITEM_TYPE | PARENT_ID | SPACE_KEY | SPACE_NAME | URL | VERSION` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13730,17 +15757,17 @@ "AWS::Kendra::DataSource ConfluenceConfiguration": { "AttachmentConfiguration": "Configuration information for indexing attachments to Confluence blogs and pages\\. \n*Required*: No \n*Type*: [ConfluenceAttachmentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceattachmentconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BlogConfiguration": "Configuration information for indexing Confluence blogs\\. \n*Required*: No \n*Type*: [ConfluenceBlogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluenceblogconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ExclusionPatterns": ">A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence\\. Content that matches the patterns are excluded from the index\\. Content that doesn't match the patterns is included in the index\\. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExclusionPatterns": "A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence\\. Content that matches the patterns are excluded from the index\\. Content that doesn't match the patterns is included in the index\\. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InclusionPatterns": "A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence\\. Content that matches the patterns are included in the index\\. Content that doesn't match the patterns is excluded from the index\\. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PageConfiguration": "Configuration information for indexing Confluence pages\\. \n*Required*: No \n*Type*: [ConfluencePageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepageconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretArn": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the key\\-value pairs required to connect to your Confluence server\\. The secret must contain a JSON structure with the following keys: \n+ username\u2014The user name or email address of a user with administrative privileges for the Confluence server\\.\n+ password\u2014The password associated with the user logging in to the Confluence server\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretArn": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the user name and password required to connect to the Confluence instance\\. If you use Confluence Cloud, you use a generated API token as the password\\. \nYou can also provide authentication credentials in the form of a personal access token\\. For more information, see [Using a Confluence data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServerUrl": "The URL of your Confluence instance\\. Use the full URL of the server\\. For example, *https://server\\.example\\.com:port/*\\. You can also use an IP address, for example, *https://192\\.168\\.1\\.113/*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `^(https?|ftp|file):\\/\\/([^\\s]*)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SpaceConfiguration": "Configuration information for indexing Confluence spaces\\. \n*Required*: No \n*Type*: [ConfluenceSpaceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespaceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Version": "Specifies the version of the Confluence installation that you are connecting to\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CLOUD | SERVER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Version": "The version or the type of Confluence installation to connect to\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CLOUD | SERVER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcConfiguration": "Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence\\. For more information, see [Configuring a VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html)\\. \n*Required*: No \n*Type*: [DataSourceVpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcevpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::DataSource ConfluencePageConfiguration": { - "PageFieldMappings": ">Maps attributes or field names of Confluence pages to Amazon Kendra index field names\\. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields\\. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. The Confluence data source field names must exist in your Confluence custom metadata\\. \nIf you specify the `PageFieldMappings` parameter, you must specify at least one field mapping\\. \n*Required*: No \n*Type*: List of [ConfluencePageToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html) \n*Maximum*: `12` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "PageFieldMappings": "Maps attributes or field names of Confluence pages to Amazon Kendra index field names\\. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields\\. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. The Confluence data source field names must exist in your Confluence custom metadata\\. \nIf you specify the `PageFieldMappings` parameter, you must specify at least one field mapping\\. \n*Required*: No \n*Type*: List of [ConfluencePageToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html) \n*Maximum*: `12` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::DataSource ConfluencePageToIndexFieldMapping": { "DataSourceFieldName": "The name of the field in the data source\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AUTHOR | CONTENT_STATUS | CREATED_DATE | DISPLAY_URL | ITEM_TYPE | LABELS | MODIFIED_DATE | PARENT_ID | SPACE_KEY | SPACE_NAME | URL | VERSION` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13748,8 +15775,8 @@ "IndexFieldName": "The name of the index field to map to the Confluence data source field\\. The index field type must match the Confluence field type\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `30` \n*Pattern*: `^\\P{C}*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::DataSource ConfluenceSpaceConfiguration": { - "CrawlArchivedSpaces": "Specifies whether Amazon Kendra should index archived spaces\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CrawlPersonalSpaces": "Specifies whether Amazon Kendra should index personal spaces\\. Users can add restrictions to items in personal spaces\\. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results\\. For more information, see [Filtering on user context](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CrawlArchivedSpaces": "`TRUE` to index archived spaces\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CrawlPersonalSpaces": "`TRUE` to index personal spaces\\. You can add restrictions to items in personal spaces\\. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results\\. For more information, see [Filtering on user context](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExcludeSpaces": "A list of space keys of Confluence spaces\\. If you include a key, the blogs, documents, and attachments in the space are not indexed\\. If a space is in both the `ExcludeSpaces` and the `IncludeSpaces` list, the space is excluded\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeSpaces": "A list of space keys for Confluence spaces\\. If you include a key, the blogs, documents, and attachments in the space are indexed\\. Spaces that aren't in the list aren't indexed\\. A space in the list must exist\\. Otherwise, Amazon Kendra logs an error when the data source is synchronized\\. If a space is in both the `IncludeSpaces` and the `ExcludeSpaces` list, the space is excluded\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SpaceFieldMappings": "Maps attributes or field names of Confluence spaces to Amazon Kendra index field names\\. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields\\. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. The Confluence data source field names must exist in your Confluence custom metadata\\. \nIf you specify the `SpaceFieldMappings` parameter, you must specify at least one field mapping\\. \n*Required*: No \n*Type*: List of [ConfluenceSpaceToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencespacetoindexfieldmapping.html) \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -13814,7 +15841,7 @@ "AWS::Kendra::DataSource DocumentAttributeValue": { "DateValue": "A date expressed as an ISO 8601 string\\. \nIt is important for the time zone to be included in the ISO 8601 date\\-time format\\. For example, 2012\\-03\\-25T12:30:10\\+01:00 is the ISO 8601 date\\-time format for March 25th 2012 at 12:30PM \\(plus 10 seconds\\) in Central European Time\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LongValue": "A long integer value\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StringListValue": "A list of strings\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StringListValue": "A list of strings\\. The default maximum length or number of strings is 10\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StringValue": "A string, such as \"department\"\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::DataSource DocumentsMetadataConfiguration": { @@ -13840,12 +15867,12 @@ "Target": "Configuration of the target document attribute or metadata field when ingesting documents into Amazon Kendra\\. You can also include a value\\. \n*Required*: No \n*Type*: [DocumentAttributeTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-documentattributetarget.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::DataSource OneDriveConfiguration": { - "DisableLocalGroups": "A Boolean value that specifies whether local groups are disabled \\(`True`\\) or enabled \\(`False`\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DisableLocalGroups": "`TRUE` to disable local groups information\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExclusionPatterns": "A list of regular expression patterns to exclude certain documents in your OneDrive\\. Documents that match the patterns are excluded from the index\\. Documents that don't match the patterns are included in the index\\. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index\\. \nThe pattern is applied to the file name\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FieldMappings": "A list of `DataSourceToIndexFieldMapping` objects that map OneDrive data source attributes or field names to Amazon Kendra index field names\\. To create custom fields, use the `UpdateIndex` API before you map to OneDrive fields\\. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. The OneDrive data source field names must exist in your OneDrive custom metadata\\. \n*Required*: No \n*Type*: List of [DataSourceToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InclusionPatterns": "A list of regular expression patterns to include certain documents in your OneDrive\\. Documents that match the patterns are included in the index\\. Documents that don't match the patterns are excluded from the index\\. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index\\. \nThe pattern is applied to the file name\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OneDriveUsers": "A list of user accounts whose documents should be indexed\\. \n*Required*: Yes \n*Type*: [OneDriveUsers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-onedriveusers.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretArn": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive\\. The user named should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretArn": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive\\. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TenantDomain": "The Azure Active Directory domain of the organization\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\\.)+[a-z]{2,}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::DataSource OneDriveUsers": { @@ -13881,7 +15908,7 @@ "ExcludeAttachmentFilePatterns": "A list of regular expression patterns to exclude certain documents in your Salesforce\\. Documents that match the patterns are excluded from the index\\. Documents that don't match the patterns are included in the index\\. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index\\. \nThe pattern is applied to the name of the attached file\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeAttachmentFilePatterns": "A list of regular expression patterns to include certain documents in your Salesforce\\. Documents that match the patterns are included in the index\\. Documents that don't match the patterns are excluded from the index\\. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index\\. \nThe pattern is applied to the name of the attached file\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KnowledgeArticleConfiguration": "Configuration information for the knowledge article types that Amazon Kendra indexes\\. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both\\. \n*Required*: No \n*Type*: [SalesforceKnowledgeArticleConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforceknowledgearticleconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretArn": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance\\. The secret must contain a JSON structure with the following keys: \n+ authenticationUrl \\- The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token\\. \n+ consumerKey \\- The application public key generated when you created your Salesforce application\\.\n+ consumerSecret \\- The application private key generated when you created your Salesforce application\\.\n+ password \\- The password associated with the user logging in to the Salesforce instance\\.\n+ securityToken \\- The token associated with the user account logging in to the Salesforce instance\\.\n+ username \\- The user name of the user logging in to the Salesforce instance\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretArn": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance\\. The secret must contain a JSON structure with the following keys: \n+ authenticationUrl \\- The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token\\. \n+ consumerKey \\- The application public key generated when you created your Salesforce application\\.\n+ consumerSecret \\- The application private key generated when you created your Salesforce application\\.\n+ password \\- The password associated with the user logging in to the Salesforce instance\\.\n+ securityToken \\- The token associated with the user logging in to the Salesforce instance\\.\n+ username \\- The user name of the user logging in to the Salesforce instance\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServerUrl": "The instance URL for the Salesforce site that you want to index\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `^(https?|ftp|file):\\/\\/([^\\s]*)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StandardObjectAttachmentConfiguration": "Configuration information for processing attachments to Salesforce standard objects\\. \n*Required*: No \n*Type*: [SalesforceStandardObjectAttachmentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectattachmentconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StandardObjectConfigurations": "Configuration of the Salesforce standard objects that Amazon Kendra indexes\\. \n*Required*: No \n*Type*: List of [SalesforceStandardObjectConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-salesforcestandardobjectconfiguration.html) \n*Maximum*: `17` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -13913,15 +15940,15 @@ "Name": "The name of the standard object\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ACCOUNT | CAMPAIGN | CASE | CONTACT | CONTRACT | DOCUMENT | GROUP | IDEA | LEAD | OPPORTUNITY | PARTNER | PRICEBOOK | PRODUCT | PROFILE | SOLUTION | TASK | USER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::DataSource ServiceNowConfiguration": { - "AuthenticationType": "The type of authentication used to connect to the ServiceNow instance\\. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the `SecretArn` field\\. When you choose `OAUTH2`, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to\\. \nWhen you use `OAUTH2` authentication, you must generate a token and a client secret using the ServiceNow console\\. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HTTP_BASIC | OAUTH2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthenticationType": "The type of authentication used to connect to the ServiceNow instance\\. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the `SecretArn` field\\. If you choose `OAUTH2`, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password\\. \nWhen you use `OAUTH2` authentication, you must generate a token and a client secret using the ServiceNow console\\. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HTTP_BASIC | OAUTH2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HostUrl": "The ServiceNow instance that the data source connects to\\. The host endpoint should look like the following: *\\{instance\\}\\.service\\-now\\.com\\.* \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `^(?!(^(https?|ftp|file):\\/\\/))[a-z0-9-]+(\\.service-now\\.com)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KnowledgeArticleConfiguration": "Configuration information for crawling knowledge articles in the ServiceNow site\\. \n*Required*: No \n*Type*: [ServiceNowKnowledgeArticleConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretArn": "The Amazon Resource Name \\(ARN\\) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretArn": "The Amazon Resource Name \\(ARN\\) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance\\. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret\\. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceCatalogConfiguration": "Configuration information for crawling service catalogs in the ServiceNow site\\. \n*Required*: No \n*Type*: [ServiceNowServiceCatalogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowservicecatalogconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServiceNowBuildVersion": "The identifier of the release that the ServiceNow host is running\\. If the host is not running the `LONDON` release, use `OTHERS`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `LONDON | OTHERS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::DataSource ServiceNowKnowledgeArticleConfiguration": { - "CrawlAttachments": "Indicates whether Amazon Kendra should index attachments to knowledge articles\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CrawlAttachments": "`TRUE` to index attachments to knowledge articles\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DocumentDataFieldName": "The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_.]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DocumentTitleFieldName": "The name of the ServiceNow field that is mapped to the index document title field\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_.]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExcludeAttachmentFilePatterns": "A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow\\. Item that match the patterns are excluded from the index\\. Items that don't match the patterns are included in the index\\. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index\\. \nThe regex is applied to the field specified in the `PatternTargetField`\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13930,7 +15957,7 @@ "IncludeAttachmentFilePatterns": "A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow\\. Item that match the patterns are included in the index\\. Items that don't match the patterns are excluded from the index\\. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index\\. \nThe regex is applied to the field specified in the `PatternTargetField`\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::DataSource ServiceNowServiceCatalogConfiguration": { - "CrawlAttachments": "Indicates whether Amazon Kendra should crawl attachments to the service catalog items\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CrawlAttachments": "`TRUE` to index attachments to service catalog items\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DocumentDataFieldName": "The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_.]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DocumentTitleFieldName": "The name of the ServiceNow field that is mapped to the index document title field\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_.]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExcludeAttachmentFilePatterns": "A list of regular expression patterns to exclude certain attachments of catalogs in your ServiceNow\\. Item that match the patterns are excluded from the index\\. Items that don't match the patterns are included in the index\\. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index\\. \nThe regex is applied to the file name of the attachment\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13938,16 +15965,16 @@ "IncludeAttachmentFilePatterns": "A list of regular expression patterns to include certain attachments of catalogs in your ServiceNow\\. Item that match the patterns are included in the index\\. Items that don't match the patterns are excluded from the index\\. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index\\. \nThe regex is applied to the file name of the attachment\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::DataSource SharePointConfiguration": { - "CrawlAttachments": "`TRUE` to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, `FALSE`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DisableLocalGroups": "A Boolean value that specifies whether local groups are disabled \\(`True`\\) or enabled \\(`False`\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CrawlAttachments": "`TRUE` to index document attachments\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DisableLocalGroups": "`TRUE` to disable local groups information\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DocumentTitleFieldName": "The Microsoft SharePoint attribute field that contains the title of the document\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_.]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExclusionPatterns": "A list of regular expression patterns\\. Documents that match the patterns are excluded from the index\\. Documents that don't match the patterns are included in the index\\. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index\\. \nThe regex is applied to the display URL of the SharePoint document\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FieldMappings": "A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index\\. You must first create the index fields using the [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateIndex.html) operation before you map SharePoint attributes\\. For more information, see [Mapping Data Source Fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. \n*Required*: No \n*Type*: List of [DataSourceToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InclusionPatterns": "A list of regular expression patterns to include certain documents in your SharePoint\\. Documents that match the patterns are included in the index\\. Documents that don't match the patterns are excluded from the index\\. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index\\. \nThe regex is applied to the display URL of the SharePoint document\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretArn": "The Amazon Resource Name \\(ARN\\) of credentials stored in AWS Secrets Manager\\. The credentials should be a user/password pair\\. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials\\. For more information, see [Using a Microsoft SharePoint Data Source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html)\\. For more information about AWS Secrets Manager see [ What Is AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) in the * AWS Secrets Manager * user guide\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SharePointVersion": "The version of Microsoft SharePoint that you are using as a data source\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SHAREPOINT_2013 | SHAREPOINT_2016 | SHAREPOINT_ONLINE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FieldMappings": "A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields\\. You must first create the index fields using the [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateIndex.html) operation before you map SharePoint attributes\\. For more information, see [Mapping Data Source Fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. \n*Required*: No \n*Type*: List of [DataSourceToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InclusionPatterns": "A list of regular expression patterns to include certain documents in your SharePoint\\. Documents that match the patterns are included in the index\\. Documents that don't match the patterns are excluded from the index\\. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index\\. \nThe regex applies to the display URL of the SharePoint document\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretArn": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance\\. For more information, see [Microsoft SharePoint](https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SharePointVersion": "The version of Microsoft SharePoint that you use\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SHAREPOINT_2013 | SHAREPOINT_2016 | SHAREPOINT_2019 | SHAREPOINT_ONLINE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SslCertificateS3Path": "Information required to find a specific file in an Amazon S3 bucket\\. \n*Required*: No \n*Type*: [S3Path](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3path.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Urls": "The URLs of the Microsoft SharePoint site that contains the documents that should be indexed\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Urls": "The Microsoft SharePoint site URLs for the documents you want to index\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UseChangeLog": "`TRUE` to use the SharePoint change log to determine which documents require updating in the index\\. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcConfiguration": "Provides information for connecting to an Amazon VPC\\. \n*Required*: No \n*Type*: [DataSourceVpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcevpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -13963,7 +15990,7 @@ "Port": "The port number of the website host you want to connect to using authentication credentials\\. \nFor example, the port for https://a\\.example\\.com/page1\\.html is 443, the standard port for HTTPS\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::DataSource WebCrawlerConfiguration": { - "AuthenticationConfiguration": "Configuration information required to connect to websites using authentication\\. \nYou can connect to websites using basic authentication of user name and password\\. \nYou must provide the website host name and port number\\. For example, the host name of https://a\\.example\\.com/page1\\.html is \"a\\.example\\.com\" and the port is 443, the standard port for HTTPS\\. You use a secret in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) to store your authentication credentials\\. \n*Required*: No \n*Type*: [WebCrawlerAuthenticationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerauthenticationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthenticationConfiguration": "Configuration information required to connect to websites using authentication\\. \nYou can connect to websites using basic authentication of user name and password\\. You use a secret in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) to store your authentication credentials\\. \nYou must provide the website host name and port number\\. For example, the host name of https://a\\.example\\.com/page1\\.html is \"a\\.example\\.com\" and the port is 443, the standard port for HTTPS\\. \n*Required*: No \n*Type*: [WebCrawlerAuthenticationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerauthenticationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CrawlDepth": "Specifies the number of levels in a website that you want to crawl\\. \nThe first level begins from the website seed or starting point URL\\. For example, if a website has 3 levels \u2013 index level \\(i\\.e\\. seed in this example\\), sections level, and subsections level \u2013 and you are only interested in crawling information up to the sections level \\(i\\.e\\. levels 0\\-1\\), you can set your depth to 1\\. \nThe default crawl depth is set to 2\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxContentSizePerPageInMegaBytes": "The maximum size \\(in MB\\) of a webpage or attachment to crawl\\. \nFiles larger than this size \\(in MB\\) are skipped/not crawled\\. \nThe default maximum size of a webpage or attachment is set to 50 MB\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxLinksPerPage": "The maximum number of URLs on a webpage to include when crawling a website\\. This number is per webpage\\. \nAs a website\u2019s webpages are crawled, any URLs the webpages link to are also crawled\\. URLs on a webpage are crawled in order of appearance\\. \nThe default maximum links per page is 100\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13993,7 +16020,7 @@ "UseChangeLog": "`TRUE` to use the Amazon WorkDocs change log to determine which documents require updating in the index\\. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::Faq": { - "Description": "A description of the FAQ\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Description": "A description for the FAQ\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FileFormat": "The format of the input file\\. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes\\. \n The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter\\. \nValid values are: \n+ `CSV`\n+ `CSV_WITH_HEADER`\n+ `JSON`\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "IndexId": "The identifier of the index that contains the FAQ\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "The name that you assigned the FAQ when you created or updated the FAQ\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z0-9][a-zA-Z0-9_-]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -14006,24 +16033,24 @@ "Key": "The name of the file\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Kendra::Index": { - "CapacityUnits": "Specifies capacity units configured for your index\\. You can add and remove capacity units to tune an index to your requirements\\. You can set capacity units only for Enterprise edition indexes\\. \n*Required*: No \n*Type*: [CapacityUnitsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "A description of the index\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CapacityUnits": "Property description not available\\. \n*Required*: No \n*Type*: [CapacityUnitsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "A description for the index\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DocumentMetadataConfigurations": "Specifies the properties of an index field\\. You can add either a custom or a built\\-in field\\. You can add and remove built\\-in fields at any time\\. When a built\\-in field is removed it's configuration reverts to the default for the field\\. Custom fields can't be removed from an index after they are added\\. \n*Required*: No \n*Type*: List of [DocumentMetadataConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Edition": "Indicates whether the index is a enterprise edition index or a developer edition index\\. Valid values are `DEVELOPER_EDITION` and `ENTERPRISE_EDITION`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DEVELOPER_EDITION | ENTERPRISE_EDITION` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Edition": "Indicates whether the index is a Enterprise Edition index or a Developer Edition index\\. Valid values are `DEVELOPER_EDITION` and `ENTERPRISE_EDITION`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DEVELOPER_EDITION | ENTERPRISE_EDITION` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "The name of the index\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000` \n*Pattern*: `[a-zA-Z0-9][a-zA-Z0-9_-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics\\. This is also the role used when you use the [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/dg/BatchPutDocument.html) operation to index documents from an Amazon S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServerSideEncryptionConfiguration": "The identifier of the AWS KMS customer managed key \\(CMK\\) to use to encrypt data indexed by Amazon Kendra\\. Amazon Kendra doesn't support asymmetric CMKs\\. \n*Required*: No \n*Type*: [ServerSideEncryptionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-serversideencryptionconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UserContextPolicy": "The user context policy\\. \nATTRIBUTE\\_FILTER \n+ All indexed content is searchable and displayable for all users\\. If there is an access control list, it is ignored\\. You can filter on user and group attributes\\.\nUSER\\_TOKEN \n+ Enables SSO and token\\-based user access control\\. All documents with no access control and all documents accessible to the user will be searchable and displayable\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UserContextPolicy": "The user context policy\\. \nATTRIBUTE\\_FILTER \n+ All indexed content is searchable and displayable for all users\\. If you want to filter search results on user context, you can use the attribute filters of `_user_id` and `_group_ids` or you can provide user and group information in `UserContext`\\.\nUSER\\_TOKEN \n+ Enables token\\-based user access control to filter search results on user context\\. All documents with no access control and all documents accessible to the user will be searchable and displayable\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserTokenConfigurations": "Defines the type of user token used for the index\\. \n*Required*: No \n*Type*: List of [UserTokenConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-usertokenconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::Index CapacityUnitsConfiguration": { - "QueryCapacityUnits": "The amount of extra query capacity for an index and [GetQuerySuggestions](https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) capacity\\. \nA single extra capacity unit for an index provides 0\\.1 queries per second or approximately 8,000 queries per day\\. \n `GetQuerySuggestions` capacity is five times the provisioned query capacity for an index, or the base capacity of 2\\.5 calls per second, whichever is higher\\. For example, the base capacity for an index is 0\\.1 queries per second, and `GetQuerySuggestions` capacity has a base of 2\\.5 calls per second\\. If you add another 0\\.1 queries per second to total 0\\.2 queries per second for an index, the `GetQuerySuggestions` capacity is 2\\.5 calls per second \\(higher than five times 0\\.2 queries per second\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StorageCapacityUnits": "The amount of extra storage capacity for an index\\. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "QueryCapacityUnits": "The amount of extra query capacity for an index and [GetQuerySuggestions](https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) capacity\\. \nA single extra capacity unit for an index provides 0\\.1 queries per second or approximately 8,000 queries per day\\. You can add up to 100 extra capacity units\\. \n `GetQuerySuggestions` capacity is five times the provisioned query capacity for an index, or the base capacity of 2\\.5 calls per second, whichever is higher\\. For example, the base capacity for an index is 0\\.1 queries per second, and `GetQuerySuggestions` capacity has a base of 2\\.5 calls per second\\. If you add another 0\\.1 queries per second to total 0\\.2 queries per second for an index, the `GetQuerySuggestions` capacity is 2\\.5 calls per second \\(higher than five times 0\\.2 queries per second\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StorageCapacityUnits": "The amount of extra storage capacity for an index\\. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first\\. You can add up to 100 extra capacity units\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::Index DocumentMetadataConfiguration": { "Name": "The name of the index field\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `30` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Relevance": "Provides manual tuning parameters to determine how the field affects the search results\\. \n*Required*: No \n*Type*: [Relevance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Relevance": "Provides tuning parameters to determine how the field affects the search results\\. \n*Required*: No \n*Type*: [Relevance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Search": "Provides information about how the field is used during a search\\. \n*Required*: No \n*Type*: [Search](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-search.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Type": "The data type of the index field\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DATE_VALUE | LONG_VALUE | STRING_LIST_VALUE | STRING_VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -14045,24 +16072,33 @@ "Freshness": "Indicates that this field determines how \"fresh\" a document is\\. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is \"fresher\" than document 2\\. You can only set the `Freshness` field on one `DATE` type field\\. Only applies to `DATE` fields\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Importance": "The relative importance of the field in the search\\. Larger numbers provide more of a boost than smaller numbers\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RankOrder": "Determines how values should be interpreted\\. \nWhen the `RankOrder` field is `ASCENDING`, higher numbers are better\\. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1\\. \nWhen the `RankOrder` field is `DESCENDING`, lower numbers are better\\. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task\\. \nOnly applies to `LONG` and `DOUBLE` fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ASCENDING | DESCENDING` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ValueImportanceItems": "An array of key\\-value pairs that contains an array of values that should be given a different boost when they appear in the search result list\\. For example, if you are boosting query terms that match the department field in the result, query terms that match the department field are boosted in the result\\. You can add entries from the department field to boost documents with those values higher\\. \nFor example, you can add entries to the map with names of departments\\. If you add \"HR\", 5 and \"Legal\",3 those departments are given special attention when they appear in the metadata of a document\\. \n*Required*: No \n*Type*: List of [ValueImportanceItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-valueimportanceitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ValueImportanceItems": "An array of key\\-value pairs for different boosts when they appear in the search result list\\. For example, if you want to boost query terms that match the \"department\" field in the result, query terms that match this field are boosted in the result\\. You can add entries from the department field to boost documents with those values higher\\. \nFor example, you can add entries to the map with names of departments\\. If you add \"HR\", 5 and \"Legal\",3 those departments are given special attention when they appear in the metadata of a document\\. \n*Required*: No \n*Type*: List of [ValueImportanceItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-valueimportanceitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::Index Search": { "Displayable": "Determines whether the field is returned in the query response\\. The default is `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Facetable": "Indicates that the field can be used to create search facets, a count of results for each value in the field\\. The default is `false` \\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Searchable": "Determines whether the field is used in the search\\. If the `Searchable` field is `true`, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search\\. The default is `true` for string fields and `false` for number and date fields\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Sortable": "Indicates that the field can be used to sort the search results\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Sortable": "Determines whether the field can be used to sort the results of a query\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::Index ServerSideEncryptionConfiguration": { - "KmsKeyId": "The identifier of the AWS KMScustomer master key \\(CMK\\)\\. Amazon Kendra doesn't support asymmetric CMKs\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "KmsKeyId": "The identifier of the AWS KMS key\\. Amazon Kendra doesn't support asymmetric keys\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Kendra::Index UserTokenConfiguration": { "JsonTokenTypeConfiguration": "Information about the JSON token type configuration\\. \n*Required*: No \n*Type*: [JsonTokenTypeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jsontokentypeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "JwtTokenTypeConfiguration": "Information about the JWT token type configuration\\. \n*Required*: No \n*Type*: [JwtTokenTypeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-jwttokentypeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kendra::Index ValueImportanceItem": { - "Key": "The document metadata value that receives the search boost\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Value": "The boost value that a document receives when the key is part of the metadata of a document\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Key": "The document metadata value used for the search boost\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The boost value for a document when the key is part of the metadata of a document\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::KendraRanking::ExecutionPlan": { + "CapacityUnits": "You can set additional capacity units to meet the needs of your rescore execution plan\\. You are given a single capacity unit by default\\. If you want to use the default capacity, you don't set additional capacity units\\. For more information on the default capacity and additional capacity units, see [Adjusting capacity](https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html)\\. \n*Required*: No \n*Type*: [CapacityUnitsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendraranking-executionplan-capacityunitsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "A description for the rescore execution plan\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1000` \n*Pattern*: `^\\P{C}*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "A name for the rescore execution plan\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000` \n*Pattern*: `[a-zA-Z0-9][a-zA-Z0-9_-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "A list of key\\-value pairs that identify or categorize your rescore execution plan\\. You can also use tags to help control access to the rescore execution plan\\. Tag keys and values can consist of Unicode letters, digits, white space\\. They can also consist of underscore, period, colon, equal, plus, and asperand\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::KendraRanking::ExecutionPlan CapacityUnitsConfiguration": { + "RescoreCapacityUnits": "The amount of extra capacity for your rescore execution plan\\. \nA single extra capacity unit for a rescore execution plan provides 0\\.01 rescore requests per second\\. You can add up to 1000 extra capacity units\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Kinesis::Stream": { "Name": "The name of the Kinesis stream\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the stream name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -14081,7 +16117,7 @@ }, "AWS::Kinesis::StreamConsumer": { "ConsumerName": "The name of the consumer is something you choose when you register the consumer\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StreamARN": "The ARN of the stream with which you registered the consumer\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:aws.*:kinesis:.*:\\d{12}:stream/.+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "StreamARN": "The ARN of the stream with which you registered the consumer\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:aws.*:kinesis:.*:\\d{12}:stream/\\S+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::KinesisAnalytics::Application": { "ApplicationCode": "One or more SQL statements that read input data, transform it, and generate output\\. For example, you can write a SQL statement that reads data from one in\\-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in\\-application stream using pumps\\. For more information about the typical pattern, see [Application Code](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html)\\. \nYou can provide such series of SQL statements, where output of one statement can be used as the input for the next statement\\. You store intermediate results by creating in\\-application streams and pumps\\. \nNote that the application code must create the streams with names specified in the `Outputs`\\. For example, if your `Outputs` defines output streams named `ExampleOutputStream1` and `ExampleOutputStream2`, then your application code must create these streams\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `102400` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -14208,9 +16244,11 @@ "AWS::KinesisAnalyticsV2::Application": { "ApplicationConfiguration": "Use this parameter to configure the application\\. \n*Required*: No \n*Type*: [ApplicationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ApplicationDescription": "The description of the application\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ApplicationMaintenanceConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [ApplicationMaintenanceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationmaintenanceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ApplicationMode": "To create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`\\. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `INTERACTIVE | STREAMING` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ApplicationName": "The name of the application\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "RuntimeEnvironment": "The runtime environment for the application\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FLINK-1_11 | FLINK-1_13 | FLINK-1_6 | FLINK-1_8 | SQL-1_0 | ZEPPELIN-FLINK-1_0 | ZEPPELIN-FLINK-2_0` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RunConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [RunConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-runconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RuntimeEnvironment": "The runtime environment for the application\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FLINK-1_11 | FLINK-1_13 | FLINK-1_15 | FLINK-1_6 | FLINK-1_8 | SQL-1_0 | ZEPPELIN-FLINK-1_0 | ZEPPELIN-FLINK-2_0` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ServiceExecutionRole": "Specifies the IAM role that the application uses to access external resources\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A list of one or more tags to assign to the application\\. A tag is a key\\-value pair that identifies an application\\. Note that the maximum number of application tags includes system tags\\. The maximum number of user\\-defined application tags is 50\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -14224,8 +16262,16 @@ "EnvironmentProperties": "Describes execution properties for a Flink\\-based Kinesis Data Analytics application\\. \n*Required*: No \n*Type*: [EnvironmentProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-environmentproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FlinkApplicationConfiguration": "The creation and update parameters for a Flink\\-based Kinesis Data Analytics application\\. \n*Required*: No \n*Type*: [FlinkApplicationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkapplicationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SqlApplicationConfiguration": "The creation and update parameters for a SQL\\-based Kinesis Data Analytics application\\. \n*Required*: No \n*Type*: [SqlApplicationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-sqlapplicationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcConfigurations": "The array of descriptions of VPC configurations available to the application\\. \n*Required*: No \n*Type*: List of [VpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-vpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ZeppelinApplicationConfiguration": "The configuration parameters for a Kinesis Data Analytics Studio notebook\\. \n*Required*: No \n*Type*: [ZeppelinApplicationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-zeppelinapplicationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::KinesisAnalyticsV2::Application ApplicationMaintenanceConfiguration": { + "ApplicationMaintenanceWindowStartTime": "Specifies the start time of the maintence window\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::KinesisAnalyticsV2::Application ApplicationRestoreConfiguration": { + "ApplicationRestoreType": "Specifies how the application should be restored\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `RESTORE_FROM_CUSTOM_SNAPSHOT | RESTORE_FROM_LATEST_SNAPSHOT | SKIP_RESTORE_FROM_SNAPSHOT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SnapshotName": "The identifier of an existing snapshot of application state to use to restart an application\\. The application uses this value if `RESTORE_FROM_CUSTOM_SNAPSHOT` is specified for the `ApplicationRestoreType`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::KinesisAnalyticsV2::Application ApplicationSnapshotConfiguration": { "SnapshotsEnabled": "Describes whether snapshots are enabled for a Flink\\-based Kinesis Data Analytics application\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -14263,6 +16309,9 @@ "MonitoringConfiguration": "Describes configuration parameters for Amazon CloudWatch logging for an application\\. \n*Required*: No \n*Type*: [MonitoringConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-monitoringconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ParallelismConfiguration": "Describes parameters for how an application executes multiple tasks simultaneously\\. \n*Required*: No \n*Type*: [ParallelismConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-parallelismconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::KinesisAnalyticsV2::Application FlinkRunConfiguration": { + "AllowNonRestoredState": "When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program\\. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data\\. For more information, see [ Allowing Non\\-Restored State](https://ci.apache.org/projects/flink/flink-docs-release-1.8/ops/state/savepoints.html#allowing-non-restored-state) in the [Apache Flink documentation](https://ci.apache.org/projects/flink/flink-docs-release-1.8/)\\. \nThis value defaults to `false`\\. If you update your application without specifying this parameter, `AllowNonRestoredState` will be set to `false`, even if it was previously set to `true`\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::KinesisAnalyticsV2::Application GlueDataCatalogConfiguration": { "DatabaseARN": "The Amazon Resource Name \\(ARN\\) of the database\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -14319,7 +16368,7 @@ }, "AWS::KinesisAnalyticsV2::Application PropertyGroup": { "PropertyGroupId": "Describes the key of an application execution property key\\-value pair\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PropertyMap": "Describes the value of an application execution property key\\-value pair\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "PropertyMap": "Describes the value of an application execution property key\\-value pair\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::KinesisAnalyticsV2::Application RecordColumn": { "Mapping": "A reference to the data element in the streaming input or the reference data source\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -14330,18 +16379,26 @@ "MappingParameters": "When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format \\(such as JSON, CSV, or record fields delimited by some delimiter\\) on the streaming source\\. \n*Required*: No \n*Type*: [MappingParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-mappingparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RecordFormatType": "The type of record format\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CSV | JSON` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::KinesisAnalyticsV2::Application RunConfiguration": { + "ApplicationRestoreConfiguration": "Describes the restore behavior of a restarting application\\. \n*Required*: No \n*Type*: [ApplicationRestoreConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationrestoreconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FlinkRunConfiguration": "Describes the starting parameters for a Flink\\-based Kinesis Data Analytics application\\. \n*Required*: No \n*Type*: [FlinkRunConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkrunconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::KinesisAnalyticsV2::Application S3ContentBaseLocation": { - "BasePath": "The base path for the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `[a-zA-Z0-9/!-_.*'()]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BasePath": "The base path for the S3 bucket\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `[a-zA-Z0-9/!-_.*'()]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BucketARN": "The Amazon Resource Name \\(ARN\\) of the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::KinesisAnalyticsV2::Application S3ContentLocation": { - "BucketARN": "The Amazon Resource Name \\(ARN\\) for the S3 bucket containing the application code\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FileKey": "The file key for the object containing the application code\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BucketARN": "The Amazon Resource Name \\(ARN\\) for the S3 bucket containing the application code\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FileKey": "The file key for the object containing the application code\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ObjectVersion": "The version of the object containing the application code\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::KinesisAnalyticsV2::Application SqlApplicationConfiguration": { "Inputs": "The array of [Input](https://docs.aws.amazon.com/kinesisanalytics/latest/apiv2/API_Input.html) objects describing the input streams used by the application\\. \n*Required*: No \n*Type*: List of [Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-input.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::KinesisAnalyticsV2::Application VpcConfiguration": { + "SecurityGroupIds": "The array of [SecurityGroup](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html) IDs used by the VPC configuration\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SubnetIds": "The array of [Subnet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) IDs used by the VPC configuration\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `16` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::KinesisAnalyticsV2::Application ZeppelinApplicationConfiguration": { "CatalogConfiguration": "The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook\\. \n*Required*: No \n*Type*: [CatalogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-catalogconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomArtifactsConfiguration": "A list of `CustomArtifactConfiguration` objects\\. \n*Required*: No \n*Type*: List of [CustomArtifactConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-customartifactconfiguration.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -14420,6 +16477,7 @@ "FileKey": "The object key name containing the reference data\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::KinesisFirehose::DeliveryStream": { + "AmazonOpenSearchServerlessDestinationConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [AmazonOpenSearchServerlessDestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AmazonopensearchserviceDestinationConfiguration": "The destination in Amazon OpenSearch Service\\. You can specify only one destination\\. \n*Required*: Conditional \n*Type*: [AmazonopensearchserviceDestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DeliveryStreamEncryptionConfigurationInput": "Specifies the type and Amazon Resource Name \\(ARN\\) of the CMK to use for Server\\-Side Encryption \\(SSE\\)\\. \n*Required*: No \n*Type*: [DeliveryStreamEncryptionConfigurationInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DeliveryStreamName": "The name of the delivery stream\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -14433,6 +16491,25 @@ "SplunkDestinationConfiguration": "The configuration of a destination in Splunk for the delivery stream\\. \n*Required*: No \n*Type*: [SplunkDestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A set of tags to assign to the delivery stream\\. A tag is a key\\-value pair that you can define and assign to AWS resources\\. Tags are metadata\\. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream\\. For more information about tags, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the AWS Billing and Cost Management User Guide\\. \nYou can specify up to 50 tags when creating a delivery stream\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::KinesisFirehose::DeliveryStream AmazonOpenSearchServerlessBufferingHints": { + "IntervalInSeconds": "Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination\\. The default value is 300 \\(5 minutes\\)\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `900` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SizeInMBs": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination\\. The default value is 5\\. \nWe recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds\\. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::KinesisFirehose::DeliveryStream AmazonOpenSearchServerlessDestinationConfiguration": { + "BufferingHints": "The buffering options\\. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used\\. \n*Required*: No \n*Type*: [AmazonOpenSearchServerlessBufferingHints](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CloudWatchLoggingOptions": "Property description not available\\. \n*Required*: No \n*Type*: [CloudWatchLoggingOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CollectionEndpoint": "The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `https:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IndexName": "The Serverless offering for Amazon OpenSearch Service index name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `80` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProcessingConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [ProcessingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RetryOptions": "The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service\\. The default value is 300 \\(5 minutes\\)\\. \n*Required*: No \n*Type*: [AmazonOpenSearchServerlessRetryOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleARN": "The Amazon Resource Name \\(ARN\\) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `arn:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3BackupMode": "Defines how documents should be delivered to Amazon S3\\. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService\\-failed/ appended to the key prefix\\. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService\\-failed/ appended to the prefix\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AllDocuments | FailedDocumentsOnly` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3Configuration": "Property description not available\\. \n*Required*: Yes \n*Type*: [S3DestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::KinesisFirehose::DeliveryStream AmazonOpenSearchServerlessRetryOptions": { + "DurationInSeconds": "After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery \\(including the first attempt\\)\\. After this time has elapsed, the failed documents are written to Amazon S3\\. Default value is 300 seconds \\(5 minutes\\)\\. A value of 0 \\(zero\\) results in no retries\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `7200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::KinesisFirehose::DeliveryStream AmazonopensearchserviceBufferingHints": { "IntervalInSeconds": "Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination\\. The default value is 300 \\(5 minutes\\)\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `900` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SizeInMBs": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination\\. The default value is 5\\. We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds\\. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -14602,7 +16679,7 @@ "Type": "The type of processor\\. Valid values: `Lambda`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AppendDelimiterToRecord | Lambda | MetadataExtraction | RecordDeAggregation` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::KinesisFirehose::DeliveryStream ProcessorParameter": { - "ParameterName": "The name of the parameter\\. Currently the following default values are supported: 3 for `NumberOfRetries`, 60 for the `BufferIntervalInSeconds`, and 3 for the `BufferSizeInMBs`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BufferIntervalInSeconds | BufferSizeInMBs | Delimiter | JsonParsingEngine | LambdaArn | MetadataExtractionQuery | NumberOfRetries | RoleArn | SubRecordType` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ParameterName": "The name of the parameter\\. Currently the following default values are supported: 3 for `NumberOfRetries` and 60 for the `BufferIntervalInSeconds`\\. The `BufferSizeInMBs` ranges between 0\\.2 MB and up to 3MB\\. The default buffering hint is 1MB for all destinations, except Splunk\\. For Splunk, the default buffering hint is 256 KB\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BufferIntervalInSeconds | BufferSizeInMBs | Delimiter | JsonParsingEngine | LambdaArn | MetadataExtractionQuery | NumberOfRetries | RoleArn | SubRecordType` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ParameterValue": "The parameter value\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `5120` \n*Pattern*: `^(?!\\s*$).+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::KinesisFirehose::DeliveryStream RedshiftDestinationConfiguration": { @@ -14679,8 +16756,25 @@ "Name": "The name of the stream\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::LakeFormation::DataCellsFilter": { + "ColumnNames": "An array of UTF\\-8 strings\\. A list of column names\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ColumnWildcard": "A wildcard with exclusions\\. You must specify either a `ColumnNames` list or the `ColumnWildCard`\\. \n*Required*: No \n*Type*: [ColumnWildcard](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-columnwildcard.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DatabaseName": "UTF\\-8 string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nA database in the Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "UTF\\-8 string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nThe name given by the user to the data filter cell\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RowFilter": "A PartiQL predicate\\. \n*Required*: No \n*Type*: [RowFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-rowfilter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TableCatalogId": "Catalog id string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nThe ID of the catalog to which the table belongs\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TableName": "UTF\\-8 string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nA table in the database\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::DataCellsFilter ColumnWildcard": { + "ExcludedColumnNames": "Excludes column names\\. Any column with this name will be excluded\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::DataCellsFilter RowFilter": { + "AllRowsWildcard": "A wildcard for all rows\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FilterExpression": "A filter expression\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::LakeFormation::DataLakeSettings": { - "Admins": "A list of AWS Lake Formation principals\\. \n*Required*: No \n*Type*: [Admins](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-admins.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Admins": "A list of AWS Lake Formation principals\\. \n*Required*: No \n*Type*: [Admins](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datalakesettings-admins.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TrustedResourceOwners": "An array of UTF\\-8 strings\\. \nA list of the resource\\-owning account IDs that the caller's account can use to share their user access details \\(user ARNs\\)\\. The user ARNs can be logged in the resource owner's CloudTrail log\\. You may want to specify this property when you are in a high\\-trust boundary, such as the same team or company\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::LakeFormation::DataLakeSettings DataLakePrincipal": { "DataLakePrincipalIdentifier": "An identifier for the Lake Formation principal\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -14688,7 +16782,7 @@ "AWS::LakeFormation::Permissions": { "DataLakePrincipal": "The AWS Lake Formation principal\\. \n*Required*: Yes \n*Type*: [DataLakePrincipal](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalakeprincipal.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Permissions": "The permissions granted or revoked\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PermissionsWithGrantOption": "Indicates whether to grant the ability to grant permissions \\(as a subset of permissions granted\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PermissionsWithGrantOption": "Indicates the ability to grant permissions \\(as a subset of permissions granted\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Resource": "A structure for the resource\\. \n*Required*: Yes \n*Type*: [Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-resource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::LakeFormation::Permissions ColumnWildcard": { @@ -14698,37 +16792,137 @@ "DataLakePrincipalIdentifier": "An identifier for the Lake Formation principal\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::LakeFormation::Permissions DataLocationResource": { - "CatalogId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3Resource": "Currently not supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CatalogId": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3Resource": "The Amazon Resource Name \\(ARN\\) that uniquely identifies the data location resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::LakeFormation::Permissions DatabaseResource": { - "CatalogId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CatalogId": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the database resource\\. Unique to the Data Catalog\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::LakeFormation::Permissions Resource": { "DataLocationResource": "A structure for a data location object where permissions are granted or revoked\\. \n*Required*: No \n*Type*: [DataLocationResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-datalocationresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DatabaseResource": "A structure for the database object\\. \n*Required*: No \n*Type*: [DatabaseResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-databaseresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TableResource": "A structure for the table object\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: No \n*Type*: [TableResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tableresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TableWithColumnsResource": "Currently not supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [TableWithColumnsResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TableWithColumnsResource": "A structure for a table with columns object\\. This object is only used when granting a SELECT permission\\. \n*Required*: No \n*Type*: [TableWithColumnsResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::LakeFormation::Permissions TableResource": { - "CatalogId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CatalogId": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DatabaseName": "The name of the database for the table\\. Unique to a Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TableWildcard": "An empty object representing all tables under a database\\. If this field is specified instead of the `Name` field, all tables under `DatabaseName` will have permission changes applied\\. \n*Required*: No \n*Type*: [TableWildcard](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewildcard.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::LakeFormation::Permissions TableWithColumnsResource": { - "CatalogId": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CatalogId": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ColumnNames": "The list of column names for the table\\. At least one of `ColumnNames` or `ColumnWildcard` is required\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ColumnWildcard": "A wildcard specified by a `ColumnWildcard` object\\. At least one of `ColumnNames` or `ColumnWildcard` is required\\. \n*Required*: No \n*Type*: [ColumnWildcard](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-columnwildcard.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DatabaseName": "The name of the database for the table with columns resource\\. Unique to the Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the table resource\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::LakeFormation::PrincipalPermissions": { + "Catalog": "The identifier for the Data Catalog\\. By default, the account ID\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Permissions": "The permissions granted or revoked\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PermissionsWithGrantOption": "Indicates the ability to grant permissions \\(as a subset of permissions granted\\)\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Principal": "The principal to be granted a permission\\. \n*Required*: Yes \n*Type*: [DataLakePrincipal](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalakeprincipal.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Resource": "The resource to be granted or revoked permissions\\. \n*Required*: Yes \n*Type*: [Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::PrincipalPermissions ColumnWildcard": { + "ExcludedColumnNames": "Excludes column names\\. Any column with this name will be excluded\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::PrincipalPermissions DataCellsFilterResource": { + "DatabaseName": "A database in the Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name given by the user to the data filter cell\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TableCatalogId": "The ID of the catalog to which the table belongs\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TableName": "The name of the table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::PrincipalPermissions DataLakePrincipal": { + "DataLakePrincipalIdentifier": "An identifier for the AWS Lake Formation principal\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::PrincipalPermissions DataLocationResource": { + "CatalogId": "The identifier for the Data Catalog where the location is registered with AWS Lake Formation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ResourceArn": "The Amazon Resource Name \\(ARN\\) that uniquely identifies the data location resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::PrincipalPermissions DatabaseResource": { + "CatalogId": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the database resource\\. Unique to the Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::PrincipalPermissions LFTag": { + "TagKey": "The key\\-name for the LF\\-tag\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TagValues": "A list of possible values of the corresponding `TagKey` of an LF\\-tag key\\-value pair\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::PrincipalPermissions LFTagKeyResource": { + "CatalogId": "The identifier for the Data Catalog where the location is registered with Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TagKey": "The key\\-name for the LF\\-tag\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TagValues": "A list of possible values for the corresponding `TagKey` of an LF\\-tag key\\-value pair\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::PrincipalPermissions LFTagPolicyResource": { + "CatalogId": "The identifier for the Data Catalog\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Expression": "A list of LF\\-tag conditions that apply to the resource's LF\\-tag policy\\. \n*Required*: Yes \n*Type*: List of [LFTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftag.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ResourceType": "The resource type for which the LF\\-tag policy applies\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::PrincipalPermissions Resource": { + "Catalog": "The identifier for the Data Catalog\\. By default, the account ID\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DataCellsFilter": "A data cell filter\\. \n*Required*: No \n*Type*: [DataCellsFilterResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DataLocation": "The location of an Amazon S3 path where permissions are granted or revoked\\. \n*Required*: No \n*Type*: [DataLocationResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalocationresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Database": "The database for the resource\\. Unique to the Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database permissions to a principal\\. \n*Required*: No \n*Type*: [DatabaseResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-databaseresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "LFTag": "The LF\\-tag key and values attached to a resource\\. \n*Required*: No \n*Type*: [LFTagKeyResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "LFTagPolicy": "A list of LF\\-tag conditions that define a resource's LF\\-tag policy\\. \n*Required*: No \n*Type*: [LFTagPolicyResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Table": "The table for the resource\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: No \n*Type*: [TableResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TableWithColumns": "The table with columns for the resource\\. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3\\. \n*Required*: No \n*Type*: [TableWithColumnsResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::PrincipalPermissions TableResource": { + "CatalogId": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DatabaseName": "The name of the database for the table\\. Unique to a Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TableWildcard": "A wildcard object representing every table under a database\\. \nAt least one of `TableResource$Name` or `TableResource$TableWildcard` is required\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::PrincipalPermissions TableWithColumnsResource": { + "CatalogId": "The identifier for the Data Catalog where the location is registered with AWS Lake Formation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ColumnNames": "The list of column names for the table\\. At least one of `ColumnNames` or `ColumnWildcard` is required\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ColumnWildcard": "A wildcard specified by a `ColumnWildcard` object\\. At least one of `ColumnNames` or `ColumnWildcard` is required\\. \n*Required*: No \n*Type*: [ColumnWildcard](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-columnwildcard.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DatabaseName": "The name of the database for the table with columns resource\\. Unique to the Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the table resource\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::LakeFormation::Resource": { "ResourceArn": "The Amazon Resource Name \\(ARN\\) of the resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The IAM role that registered a resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UseServiceLinkedRole": "Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::LakeFormation::Tag": { + "CatalogId": "Catalog id string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nThe identifier for the Data Catalog\\. By default, the account ID\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TagKey": "UTF\\-8 string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nThe key\\-name for the LF\\-tag\\. \nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TagValues": "An array of UTF\\-8 strings, not less than 1 or more than 50 strings\\. \n A list of possible values of the corresponding `TagKey` of an LF\\-tag key\\-value pair\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::LakeFormation::TagAssociation": { + "LFTags": "A structure containing an LF\\-tag key\\-value pair\\. \n*Required*: Yes \n*Type*: List of [LFTagPair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Resource": "UTF\\-8 string \\(valid values: `DATABASE | TABLE`\\)\\. \nThe resource for which the LF\\-tag policy applies\\. \n*Required*: Yes \n*Type*: [Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-resource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::TagAssociation DatabaseResource": { + "CatalogId": "The identifier for the Data Catalog\\. By default, it should be the account ID of the caller\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the database resource\\. Unique to the Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::TagAssociation LFTagPair": { + "CatalogId": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TagKey": "The key\\-name for the LF\\-tag\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TagValues": "A list of possible values of the corresponding `TagKey` of an LF\\-tag key\\-value pair\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::TagAssociation Resource": { + "Catalog": "The identifier for the Data Catalog\\. By default, the account ID\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Database": "The database for the resource\\. Unique to the Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database permissions to a principal\\. \n*Required*: No \n*Type*: [DatabaseResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-databaseresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Table": "The table for the resource\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: No \n*Type*: [TableResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tableresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TableWithColumns": "The table with columns for the resource\\. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3\\. \n*Required*: No \n*Type*: [TableWithColumnsResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tablewithcolumnsresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::TagAssociation TableResource": { + "CatalogId": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DatabaseName": "The name of the database for the table\\. Unique to a Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TableWildcard": "A wildcard object representing every table under a database\\.This is an object with no properties that effectively behaves as a true or false depending on whether not it is passed as a parameter\\. The valid inputs for a property with this type in either yaml or json is null or \\{\\}\\. \nAt least one of `TableResource$Name` or `TableResource$TableWildcard` is required\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::LakeFormation::TagAssociation TableWithColumnsResource": { + "CatalogId": "A wildcard object representing every table under a database\\. \nAt least one of TableResource$Name or TableResource$TableWildcard is required\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ColumnNames": "The list of column names for the table\\. At least one of `ColumnNames` or `ColumnWildcard` is required\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DatabaseName": "The name of the database for the table with columns resource\\. Unique to the Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the table resource\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::Lambda::Alias": { "Description": "A description of the alias\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FunctionName": "The name of the Lambda function\\.", @@ -14877,9 +17071,9 @@ "LocalMountPath": "The path where the function can access the file system, starting with `/mnt/`\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `160` \n*Pattern*: `^/mnt/[a-zA-Z0-9-_.]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lambda::Function ImageConfig": { - "Command": "Specifies parameters that you want to pass in with ENTRYPOINT\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EntryPoint": "Specifies the entry point to their application, which is typically the location of the runtime executable\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "WorkingDirectory": "Specifies the working directory\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Command": "Specifies parameters that you want to pass in with ENTRYPOINT\\. You can specify a maximum of 1,500 parameters in the list\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EntryPoint": "Specifies the entry point to their application, which is typically the location of the runtime executable\\. You can specify a maximum of 1,500 string entries in the list\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WorkingDirectory": "Specifies the working directory\\. The length of the directory string cannot exceed 1,000 characters\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lambda::Function RuntimeManagementConfig": { "RuntimeVersionArn": "The ARN of the runtime version you want the function to use\\. \nThis is only required if you're using the **Manual** runtime update mode\\.\n*Required*: No \n*Type*: String \n*Minimum*: `26` \n*Maximum*: `2048` \n*Pattern*: `^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/-gov.html)|(-iso(b?)))?-[a-z]+-\\d{1}::runtime:.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -14957,40 +17151,40 @@ "BotFileS3Location": "The Amazon S3 location of files used to import a bot\\. The files must be in the import format specified in [JSON format for importing and exporting](https://docs.aws.amazon.com/lexv2/latest/dg/import-export-format.html) in the *Amazon Lex developer guide\\.* \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BotLocales": "A list of locales for the bot\\. \n*Required*: No \n*Type*: List of [BotLocale](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botlocale.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BotTags": "A list of tags to add to the bot\\. You can only add tags when you import a bot\\. You can't use the `UpdateBot` operation to update tags\\. To update tags, use the `TagResource` operation\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DataPrivacy": "Provides information on additional privacy protections Amazon Lex should use with the bot's data\\. \n*Required*: Yes \n*Type*: [DataPrivacy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dataprivacy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataPrivacy": "Property description not available\\. \n*Required*: Yes \n*Type*: [DataPrivacy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dataprivacy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "The description of the version\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IdleSessionTTLInSeconds": "The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot\\. \nA user interaction remains active for the amount of time specified\\. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout\\. \nYou can specify between 60 \\(1 minute\\) and 86,400 \\(24 hours\\) seconds\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the field to filter the list of bots\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BotLocaleName` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the bot locale\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The Amazon Resource Name \\(ARN\\) of the IAM role used to build and run the bot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TestBotAliasSettings": "Specifies configuration settings for the alias used to test the bot\\. If the `TestBotAliasSettings` property is not specified, the settings are configured with default values\\. \n*Required*: No \n*Type*: [TestBotAliasSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-testbotaliassettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TestBotAliasTags": "A list of tags to add to the test alias for a bot\\. You can only add tags when you import a bot\\. You can't use the `UpdateAlias` operation to update tags\\. To update tags on the test alias, use the `TagResource` operation\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot AdvancedRecognitionSetting": { - "AudioRecognitionStrategy": "Specifies that Amazon Lex should use slot values as a custom vocabulary when recognizing user utterances\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AudioRecognitionStrategy": "Enables using the slot values as a custom vocabulary for recognizing user utterances\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot AllowedInputTypes": { - "AllowAudioInput": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AllowDTMFInput": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AllowAudioInput": "Indicates whether audio input is allowed\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AllowDTMFInput": "Indicates whether DTMF input is allowed\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot AudioAndDTMFInputSpecification": { - "AudioSpecification": "Property description not available\\. \n*Required*: No \n*Type*: [AudioSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiospecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DTMFSpecification": "Property description not available\\. \n*Required*: No \n*Type*: [DTMFSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dtmfspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StartTimeoutMs": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AudioSpecification": "Specifies the settings on audio input\\. \n*Required*: No \n*Type*: [AudioSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiospecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DTMFSpecification": "Specifies the settings on DTMF input\\. \n*Required*: No \n*Type*: [DTMFSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dtmfspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartTimeoutMs": "Time for which a bot waits before assuming that the customer isn't going to speak or press a key\\. This timeout is shared between Audio and DTMF inputs\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot AudioLogDestination": { "S3Bucket": "Specifies the Amazon S3 bucket where the audio files are stored\\. \n*Required*: Yes \n*Type*: [S3BucketLogDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-s3bucketlogdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot AudioLogSetting": { "Destination": "Specifies the location of the audio log files collected when conversation logging is enabled for a bot\\. \n*Required*: Yes \n*Type*: [AudioLogDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiologdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Enabled": "Specifies whether audio logging is enabled for the bot\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Enabled": "Determines whether audio logging in enabled for the bot\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot AudioSpecification": { - "EndTimeoutMs": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaxLengthMs": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "EndTimeoutMs": "Time for which a bot waits after the customer stops speaking to assume the utterance is finished\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxLengthMs": "Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot BotAliasLocaleSettings": { - "CodeHookSpecification": "Specifies the Lambda function to use in this locale\\. \n*Required*: No \n*Type*: [CodeHookSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-codehookspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Enabled": "Specifies whether the locale is enabled for the bot\\. If the value is false, the locale isn't available for use\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CodeHookSpecification": "Specifies the Lambda function that should be used in the locale\\. \n*Required*: No \n*Type*: [CodeHookSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-codehookspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Enabled": "Determines whether the locale is enabled for the bot\\. If the value is `false`, the locale isn't available for use\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot BotAliasLocaleSettingsItem": { "BotAliasLocaleSetting": "Specifies locale settings for a locale\\. \n*Required*: Yes \n*Type*: [BotAliasLocaleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botaliaslocalesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -15001,38 +17195,38 @@ "Description": "A description of the bot locale\\. Use this to help identify the bot locale in lists\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Intents": "One or more intents defined for the locale\\. \n*Required*: No \n*Type*: List of [Intent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LocaleId": "The identifier of the language and locale that the bot will be used in\\. The string must match one of the supported locales\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "NluConfidenceThreshold": "Determines the threshold where Amazon Lex will insert the AMAZON\\.FallbackIntent, AMAZON\\.KendraSearchIntent, or both when returning alternative intents\\. You must configure an AMAZON\\.FallbackIntent\\. AMAZON\\.KendraSearchIntent is only inserted if it is configured for the bot\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NluConfidenceThreshold": "Determines the threshold where Amazon Lex will insert the `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents\\. You must configure an `AMAZON.FallbackIntent`\\. `AMAZON.KendraSearchIntent` is only inserted if it is configured for the bot\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SlotTypes": "One or more slot types defined for the locale\\. \n*Required*: No \n*Type*: List of [SlotType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slottype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VoiceSettings": "Identifies the Amazon Polly voice used for audio interaction with the user\\. \n*Required*: No \n*Type*: [VoiceSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-voicesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "VoiceSettings": "Defines settings for using an Amazon Polly voice to communicate with a user\\. \n*Required*: No \n*Type*: [VoiceSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-voicesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot Button": { - "Text": "The text that appears on the button\\. Use this to tell the user the value that is returned when they choose this button\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Text": "The text that appears on the button\\. Use this to tell the user what value is returned when they choose this button\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Value": "The value returned to Amazon Lex when the user chooses this button\\. This must be one of the slot values configured for the slot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot CloudWatchLogGroupLogDestination": { - "CloudWatchLogGroupArn": "Specifies the Amazon Resource Name \\(ARN\\) of the log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LogPrefix": "Specifies the prefix of the log stream name within the log group that you specified\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CloudWatchLogGroupArn": "The Amazon Resource Name \\(ARN\\) of the log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LogPrefix": "The prefix of the log stream name within the log group that you specified \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot CodeHookSpecification": { "LambdaCodeHook": "Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot\\. \n*Required*: Yes \n*Type*: [LambdaCodeHook](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-lambdacodehook.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot Condition": { - "ExpressionString": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ExpressionString": "The expression string that is evaluated\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot ConditionalBranch": { - "Condition": "Property description not available\\. \n*Required*: Yes \n*Type*: [Condition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-condition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "NextStep": "Property description not available\\. \n*Required*: Yes \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Response": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Condition": "Contains the expression to evaluate\\. If the condition is true, the branch's actions are taken\\. \n*Required*: Yes \n*Type*: [Condition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-condition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the branch\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NextStep": "The next step in the conversation\\. \n*Required*: Yes \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Response": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot ConditionalSpecification": { - "ConditionalBranches": "Property description not available\\. \n*Required*: Yes \n*Type*: List of [ConditionalBranch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalbranch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DefaultBranch": "Property description not available\\. \n*Required*: Yes \n*Type*: [DefaultConditionalBranch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-defaultconditionalbranch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IsActive": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ConditionalBranches": "A list of conditional branches\\. A conditional branch is made up of a condition, a response and a next step\\. The response and next step are executed when the condition is true\\. \n*Required*: Yes \n*Type*: List of [ConditionalBranch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalbranch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefaultBranch": "The conditional branch that should be followed when the conditions for other branches are not satisfied\\. A conditional branch is made up of a condition, a response and a next step\\. \n*Required*: Yes \n*Type*: [DefaultConditionalBranch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-defaultconditionalbranch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsActive": "Determines whether a conditional branch is active\\. When `IsActive` is false, the conditions are not evaluated\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot ConversationLogSettings": { - "AudioLogSettings": "Specifies the Amazon S3 settings for logging audio to an S3 bucket\\. \n*Required*: No \n*Type*: List of [AudioLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiologsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TextLogSettings": "Specifies settings to enable text conversation logs\\. You specify the Amazon CloudWatch Logs log group and whether logs should be stored for an alias\\. \n*Required*: No \n*Type*: List of [TextLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textlogsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AudioLogSettings": "The Amazon S3 settings for logging audio to an S3 bucket\\. \n*Required*: No \n*Type*: List of [AudioLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiologsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TextLogSettings": "The Amazon CloudWatch Logs settings for logging text and metadata\\. \n*Required*: No \n*Type*: List of [TextLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textlogsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot CustomPayload": { "Value": "The string that is sent to your application\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -15045,62 +17239,62 @@ "Weight": "Specifies the degree to which the phrase recognition is boosted\\. The default value is 1\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot DTMFSpecification": { - "DeletionCharacter": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EndCharacter": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EndTimeoutMs": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaxLength": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DeletionCharacter": "The DTMF character that clears the accumulated DTMF digits and immediately ends the input\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EndCharacter": "The DTMF character that immediately ends input\\. If the user does not press this character, the input ends after the end timeout\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EndTimeoutMs": "How long the bot should wait after the last DTMF character input before assuming that the input has concluded\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxLength": "The maximum number of DTMF digits allowed in an utterance\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot DataPrivacy": { - "ChildDirected": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ChildDirected": "For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act \\(COPPA\\) by specifying `true` or `false` in the `childDirected` field\\. By specifying `true` in the `childDirected` field, you confirm that your use of Amazon Lex **is** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA\\. By specifying `false` in the `childDirected` field, you confirm that your use of Amazon Lex **is not** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA\\. You may not specify a default value for the `childDirected` field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA\\. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA\\. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the [Amazon Lex FAQ](http://aws.amazon.com/lex/faqs#data-security)\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot DefaultConditionalBranch": { - "NextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Response": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "NextStep": "The next step in the conversation\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Response": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot DialogAction": { - "SlotToElicit": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SuppressNextMessage": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Type": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SlotToElicit": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SuppressNextMessage": "When true the next message for the intent is not used\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The action that the bot should execute\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot DialogCodeHookInvocationSetting": { - "EnableCodeHookInvocation": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InvocationLabel": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IsActive": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PostCodeHookSpecification": "Property description not available\\. \n*Required*: Yes \n*Type*: [PostDialogCodeHookInvocationSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "EnableCodeHookInvocation": "Indicates whether a Lambda function should be invoked for the dialog\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InvocationLabel": "A label that indicates the dialog step from which the dialog code hook is happening\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsActive": "Determines whether a dialog code hook is used when the intent is activated\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PostCodeHookSpecification": "Contains the responses and actions that Amazon Lex takes after the Lambda function is complete\\. \n*Required*: Yes \n*Type*: [PostDialogCodeHookInvocationSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot DialogCodeHookSetting": { - "Enabled": "Indicates whether an intent uses the dialog code hook during a conversation with a user\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Enabled": "Enables the dialog code hook so that it processes user requests\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot DialogState": { - "DialogAction": "Property description not available\\. \n*Required*: No \n*Type*: [DialogAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Intent": "Property description not available\\. \n*Required*: No \n*Type*: [IntentOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SessionAttributes": "Property description not available\\. \n*Required*: No \n*Type*: List of [SessionAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sessionattribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DialogAction": "Defines the action that the bot executes at runtime when the conversation reaches this step\\. \n*Required*: No \n*Type*: [DialogAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Intent": "Override settings to configure the intent state\\. \n*Required*: No \n*Type*: [IntentOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SessionAttributes": "Map of key/value pairs representing session\\-specific context information\\. It contains application information passed between Amazon Lex and a client application\\. \n*Required*: No \n*Type*: List of [SessionAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sessionattribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot ElicitationCodeHookInvocationSetting": { - "EnableCodeHookInvocation": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InvocationLabel": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "EnableCodeHookInvocation": "Indicates whether a Lambda function should be invoked for the dialog\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InvocationLabel": "A label that indicates the dialog step from which the dialog code hook is happening\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot ExternalSourceSetting": { "GrammarSlotTypeSetting": "Settings required for a slot type based on a grammar that you provide\\. \n*Required*: No \n*Type*: [GrammarSlotTypeSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-grammarslottypesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot FulfillmentCodeHookSetting": { - "Enabled": "Indicates whether a Lambda function should be invoked for fulfill a specific intent\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Enabled": "Indicates whether a Lambda function should be invoked to fulfill a specific intent\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FulfillmentUpdatesSpecification": "Provides settings for update messages sent to the user for long\\-running Lambda fulfillment functions\\. Fulfillment updates can be used only with streaming conversations\\. \n*Required*: No \n*Type*: [FulfillmentUpdatesSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentupdatesspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IsActive": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsActive": "Determines whether the fulfillment code hook is used\\. When `active` is false, the code hook doesn't run\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PostFulfillmentStatusSpecification": "Provides settings for messages sent to the user for after the Lambda fulfillment function completes\\. Post\\-fulfillment messages can be sent for both streaming and non\\-streaming conversations\\. \n*Required*: No \n*Type*: [PostFulfillmentStatusSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postfulfillmentstatusspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot FulfillmentStartResponseSpecification": { "AllowInterrupt": "Determines whether the user can interrupt the start message while it is playing\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DelayInSeconds": "The delay between when the Lambda fulfillment function starts running and the start message is played\\. If the Lambda function returns before the delay is over, the start message isn't played\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MessageGroups": "One to 5 message groups that contain start messages\\. Amazon Lex chooses one of the messages to play to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "MessageGroups": "1 \\- 5 message groups that contain start messages\\. Amazon Lex chooses one of the messages to play to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot FulfillmentUpdateResponseSpecification": { "AllowInterrupt": "Determines whether the user can interrupt an update message while it is playing\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FrequencyInSeconds": "The frequency that a message is sent to the user\\. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user\\. If the fulfillment Lambda function returns before the first period ends, an update message is not played to the user\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MessageGroups": "One to 5 message groups that contain update messages\\. Amazon Lex chooses one of the messages to play to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "FrequencyInSeconds": "The frequency that a message is sent to the user\\. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user\\. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MessageGroups": "1 \\- 5 message groups that contain update messages\\. Amazon Lex chooses one of the messages to play to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot FulfillmentUpdatesSpecification": { - "Active": "Determines whether fulfillment updates are sent to the user\\. When this field is true, updates are sent\\. \nIf the active field is set to true, the `startResponse`, `updateResponse`, and `timeoutInSeconds` fields are required\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Active": "Determines whether fulfillment updates are sent to the user\\. When this field is true, updates are sent\\. \nIf the `active` field is set to true, the `startResponse`, `updateResponse`, and `timeoutInSeconds` fields are required\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StartResponse": "Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running\\. \n*Required*: No \n*Type*: [FulfillmentStartResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentstartresponsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TimeoutInSeconds": "The length of time that the fulfillment Lambda function should run before it times out\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UpdateResponse": "Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running\\. \n*Required*: No \n*Type*: [FulfillmentUpdateResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentupdateresponsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -15109,21 +17303,21 @@ "Source": "The source of the grammar used to create the slot type\\. \n*Required*: No \n*Type*: [GrammarSlotTypeSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-grammarslottypesource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot GrammarSlotTypeSource": { - "KmsKeyArn": "The AWS Key Management Service key required to decrypt the contents of the grammar, if any\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3BucketName": "The name of the S3 bucket that contains the grammar source\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3ObjectKey": "The path to the grammar in the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "KmsKeyArn": "The AWS KMS key required to decrypt the contents of the grammar, if any\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3BucketName": "The name of the Amazon S3 bucket that contains the grammar source\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3ObjectKey": "The path to the grammar in the Amazon S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot ImageResponseCard": { - "Buttons": "A list of buttons that should be displayed on the response card\\. The arrangement of the buttons is determined by the platform that displays the buttons\\. \n*Required*: No \n*Type*: List of [Button](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-button.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Buttons": "A list of buttons that should be displayed on the response card\\. The arrangement of the buttons is determined by the platform that displays the button\\. \n*Required*: No \n*Type*: List of [Button](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-button.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ImageUrl": "The URL of an image to display on the response card\\. The image URL must be publicly available so that the platform displaying the response card has access to the image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Subtitle": "The subtitle to display on the response card\\. The format of the subtitle is determined by the platform displaying the response card\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Title": "The title to display on the response card\\. The format of the title is determined by the platform displaying the response card\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot InitialResponseSetting": { - "CodeHook": "Property description not available\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Conditional": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InitialResponse": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "NextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CodeHook": "Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Conditional": "Provides a list of conditional branches\\. Branches are evaluated in the order that they are entered in the list\\. The first branch with a condition that evaluates to true is executed\\. The last branch in the list is the default branch\\. The default branch should not have any condition expression\\. The default branch is executed if no other branch has a matching condition\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InitialResponse": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NextStep": "The next step in the conversation\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot InputContext": { "Name": "The name of the context\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -15132,11 +17326,11 @@ "Description": "A description of the intent\\. Use the description to help identify the intent in lists\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DialogCodeHook": "Specifies that Amazon Lex invokes the alias Lambda function for each user input\\. You can invoke this Lambda function to personalize user interaction\\. \n*Required*: No \n*Type*: [DialogCodeHookSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehooksetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FulfillmentCodeHook": "Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment\\. You can invoke this function to complete the bot's transaction with the user\\. \n*Required*: No \n*Type*: [FulfillmentCodeHookSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentcodehooksetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InitialResponseSetting": "Property description not available\\. \n*Required*: No \n*Type*: [InitialResponseSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-initialresponsesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InitialResponseSetting": "Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots\\. \n*Required*: No \n*Type*: [InitialResponseSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-initialresponsesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InputContexts": "A list of contexts that must be active for this intent to be considered by Amazon Lex\\. \n*Required*: No \n*Type*: List of [InputContext](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-inputcontext.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IntentClosingSetting": "Sets the response that Amazon Lex sends to the user when the intent is closed\\. \n*Required*: No \n*Type*: [IntentClosingSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentclosingsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IntentConfirmationSetting": "Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent\\. If the user answers \"no,\" the settings contain a statement that is sent to the user to end the intent\\. \n*Required*: No \n*Type*: [IntentConfirmationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KendraConfiguration": "Configuration information required to use the AMAZON\\.KendraSearchIntent intent to connect to an Amazon Kendra index\\. The AMAZON\\.KendraSearchIntent intent is called when Amazon Lex can't determine another intent to invoke\\. \n*Required*: No \n*Type*: [KendraConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KendraConfiguration": "Provides configuration information for the `AMAZON.KendraSearchIntent` intent\\. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance\\. \n*Required*: No \n*Type*: [KendraConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the intent\\. Intent names must be unique within the locale that contains the intent and can't match the name of any built\\-in intent\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OutputContexts": "A list of contexts that the intent activates when it is fulfilled\\. \n*Required*: No \n*Type*: List of [OutputContext](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-outputcontext.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ParentIntentSignature": "A unique identifier for the built\\-in intent to base this intent on\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -15146,53 +17340,53 @@ }, "AWS::Lex::Bot IntentClosingSetting": { "ClosingResponse": "The response that Amazon Lex sends to the user when the intent is complete\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Conditional": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IsActive": "Specifies whether an intent's closing response is used\\. When this field is false, the closing response isn't sent to the user and no closing input from the user is used\\. If the IsActive field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "NextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Conditional": "A list of conditional branches associated with the intent's closing response\\. These branches are executed when the `nextStep` attribute is set to `EvalutateConditional`\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsActive": "Specifies whether an intent's closing response is used\\. When this field is false, the closing response isn't sent to the user\\. If the `IsActive` field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NextStep": "Specifies the next step that the bot executes after playing the intent's closing response\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot IntentConfirmationSetting": { - "CodeHook": "Property description not available\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ConfirmationConditional": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ConfirmationNextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ConfirmationResponse": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeclinationConditional": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeclinationNextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeclinationResponse": "When the user answers \"no\" to the question defined in PromptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ElicitationCodeHook": "Property description not available\\. \n*Required*: No \n*Type*: [ElicitationCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FailureConditional": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FailureNextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FailureResponse": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IsActive": "Specifies whether the intent's confirmation is sent to the user\\. When this field is false, confirmation and declination responses aren't sent and processing continues as if the responses aren't present\\. If the active field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PromptSpecification": "Prompts the user to confirm the intent\\. This question should have a yes or no answer\\. \n*Required*: Yes \n*Type*: [PromptSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CodeHook": "The `DialogCodeHookInvocationSetting` object associated with intent's confirmation step\\. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is `InvokeDialogCodeHook`\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConfirmationConditional": "A list of conditional branches to evaluate after the intent is closed\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConfirmationNextStep": "Specifies the next step that the bot executes when the customer confirms the intent\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConfirmationResponse": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeclinationConditional": "A list of conditional branches to evaluate after the intent is declined\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeclinationNextStep": "Specifies the next step that the bot executes when the customer declines the intent\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeclinationResponse": "When the user answers \"no\" to the question defined in `promptSpecification`, Amazon Lex responds with this response to acknowledge that the intent was canceled\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ElicitationCodeHook": "The `DialogCodeHookInvocationSetting` used when the code hook is invoked during confirmation prompt retries\\. \n*Required*: No \n*Type*: [ElicitationCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailureConditional": "Provides a list of conditional branches\\. Branches are evaluated in the order that they are entered in the list\\. The first branch with a condition that evaluates to true is executed\\. The last branch in the list is the default branch\\. The default branch should not have any condition expression\\. The default branch is executed if no other branch has a matching condition\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailureNextStep": "The next step to take in the conversation if the confirmation step fails\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailureResponse": "Specifies a list of message groups that Amazon Lex uses to respond the user input when the intent confirmation fails\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsActive": "Specifies whether the intent's confirmation is sent to the user\\. When this field is false, confirmation and declination responses aren't sent\\. If the `IsActive` field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PromptSpecification": "Prompts the user to confirm the intent\\. This question should have a yes or no answer\\. \nAmazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment\\. For example, with the `OrderPizza` intent, you might want to confirm that the order is correct before placing it\\. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information\\. \n*Required*: Yes \n*Type*: [PromptSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot IntentOverride": { - "Name": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Slots": "Property description not available\\. \n*Required*: No \n*Type*: List of [SlotValueOverrideMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverridemap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "The name of the intent\\. Only required when you're switching intents\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Slots": "A map of all of the slot value overrides for the intent\\. The name of the slot maps to the value of the slot\\. Slots that are not included in the map aren't overridden\\. \n*Required*: No \n*Type*: List of [SlotValueOverrideMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverridemap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot KendraConfiguration": { - "KendraIndex": "The Amazon Resource Name \\(ARN\\) of the Amazon Kendra index that you want the AMAZON\\.KendraSearchIntent intent to search\\. The index must be in the same account and Region as the Amazon Lex bot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "QueryFilterString": "A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query\\. The filter is in the format defined by Amazon Kendra\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "QueryFilterStringEnabled": "Determines whether the AMAZON\\.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "KendraIndex": "The Amazon Resource Name \\(ARN\\) of the Amazon Kendra index that you want the `AMAZON.KendraSearchIntent` intent to search\\. The index must be in the same account and Region as the Amazon Lex bot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "QueryFilterString": "A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query\\. The filter is in the format defined by Amazon Kendra\\. For more information, see [Filtering queries](https://docs.aws.amazon.com/kendra/latest/dg/filtering.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "QueryFilterStringEnabled": "Determines whether the `AMAZON.KendraSearchIntent` intent uses a custom query string to query the Amazon Kendra index\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot LambdaCodeHook": { - "CodeHookInterfaceVersion": "Specifies the version of the request\\-response that you want Amazon Lex to use to invoke your Lambda function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LambdaArn": "Specifies the Amazon Resource Name \\(ARN\\) of the Lambda function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CodeHookInterfaceVersion": "The version of the request\\-response that you want Amazon Lex to use to invoke your Lambda function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LambdaArn": "The Amazon Resource Name \\(ARN\\) of the Lambda function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot Message": { "CustomPayload": "A message in a custom format defined by the client application\\. \n*Required*: No \n*Type*: [CustomPayload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-custompayload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ImageResponseCard": "A message that defines a response card that the client application can show to the user\\. \n*Required*: No \n*Type*: [ImageResponseCard](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-imageresponsecard.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PlainTextMessage": "A message in plain text format\\. \n*Required*: No \n*Type*: [PlainTextMessage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-plaintextmessage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SSMLMessage": "A message in Speech Synthesis Markup Language \\(SSML\\) format\\. \n*Required*: No \n*Type*: [SSMLMessage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-ssmlmessage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SSMLMessage": "A message in Speech Synthesis Markup Language \\(SSML\\)\\. \n*Required*: No \n*Type*: [SSMLMessage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-ssmlmessage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot MessageGroup": { "Message": "The primary message that Amazon Lex should send to the user\\. \n*Required*: Yes \n*Type*: [Message](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-message.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Variations": "Message variations to send to the user\\. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user\\. \n*Required*: No \n*Type*: List of [Message](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-message.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot MultipleValuesSetting": { - "AllowMultipleValues": "Indicates whether a slot can return multiple values\\. When true, the slot may return more than one value in a response\\. When false, the slot returns only a single value\\. If AllowMultipleValues is not set, the default value is false\\. \nMulti\\-value slots are only available in the en\\-US locale\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AllowMultipleValues": "Indicates whether a slot can return multiple values\\. When `true`, the slot may return more than one value in a response\\. When `false`, the slot returns only a single value\\. \nMulti\\-value slots are only available in the en\\-US locale\\. If you set this value to `true` in any other locale, Amazon Lex throws a `ValidationException`\\. \nIf the `allowMutlipleValues` is not set, the default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot ObfuscationSetting": { - "ObfuscationSettingType": "Value that determines whether Amazon Lex obscures slot values in conversation logs\\. The default is to obscure the values\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ObfuscationSettingType": "Value that determines whether Amazon Lex obscures slot values in conversation logs\\. The default is to obscure the values\\. The valid values are `None` and `DefaultObfuscation.` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot OutputContext": { "Name": "The name of the output context\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -15203,48 +17397,48 @@ "Value": "The message to send to the user\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot PostDialogCodeHookInvocationSpecification": { - "FailureConditional": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FailureNextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FailureResponse": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SuccessConditional": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SuccessNextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SuccessResponse": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimeoutConditional": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimeoutNextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimeoutResponse": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "FailureConditional": "A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailureNextStep": "Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailureResponse": "Specifies a list of message groups that Amazon Lex uses to respond the user input when the code hook fails\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SuccessConditional": "A list of conditional branches to evaluate after the dialog code hook finishes successfully\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SuccessNextStep": "Specifics the next step the bot runs after the dialog code hook finishes successfully\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SuccessResponse": "Specifies a list of message groups that Amazon Lex uses to respond when the code hook succeeds\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TimeoutConditional": "A list of conditional branches to evaluate if the code hook times out\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TimeoutNextStep": "Specifies the next step that the bot runs when the code hook times out\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TimeoutResponse": "Specifies a list of message groups that Amazon Lex uses to respond to the user input when the code hook times out\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot PostFulfillmentStatusSpecification": { - "FailureConditional": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FailureNextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailureConditional": "A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailureNextStep": "Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FailureResponse": "Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn't successful\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SuccessConditional": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SuccessNextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SuccessConditional": "A list of conditional branches to evaluate after the fulfillment code hook finishes successfully\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SuccessNextStep": "Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SuccessResponse": "Specifies a list of message groups that Amazon Lex uses to respond when the fulfillment is successful\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimeoutConditional": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimeoutNextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TimeoutConditional": "A list of conditional branches to evaluate if the fulfillment code hook times out\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TimeoutNextStep": "Specifies the next step that the bot runs when the fulfillment code hook times out\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TimeoutResponse": "Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn't completed within the timeout period\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot PromptAttemptSpecification": { - "AllowInterrupt": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AllowedInputTypes": "Property description not available\\. \n*Required*: Yes \n*Type*: [AllowedInputTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-allowedinputtypes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AudioAndDTMFInputSpecification": "Property description not available\\. \n*Required*: No \n*Type*: [AudioAndDTMFInputSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audioanddtmfinputspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TextInputSpecification": "Property description not available\\. \n*Required*: No \n*Type*: [TextInputSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textinputspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AllowInterrupt": "Indicates whether the user can interrupt a speech prompt attempt from the bot\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AllowedInputTypes": "Indicates the allowed input types of the prompt attempt\\. \n*Required*: Yes \n*Type*: [AllowedInputTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-allowedinputtypes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AudioAndDTMFInputSpecification": "Specifies the settings on audio and DTMF input\\. \n*Required*: No \n*Type*: [AudioAndDTMFInputSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audioanddtmfinputspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TextInputSpecification": "Specifies the settings on text input\\. \n*Required*: No \n*Type*: [TextInputSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textinputspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot PromptSpecification": { "AllowInterrupt": "Indicates whether the user can interrupt a speech prompt from the bot\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaxRetries": "The maximum number of times the bot tries to elicit a response from the user using this prompt \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MessageGroupsList": "A collection of responses that Amazon Lex can send to the user\\. Amazon Lex chooses the actual response to send at runtime\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MessageSelectionStrategy": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PromptAttemptsSpecification": "Property description not available\\. \n*Required*: No \n*Type*: Map of [PromptAttemptSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptattemptspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "MaxRetries": "The maximum number of times the bot tries to elicit a response from the user using this prompt\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MessageGroupsList": "A collection of messages that Amazon Lex can send to the user\\. Amazon Lex chooses the actual message to send at runtime\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MessageSelectionStrategy": "Indicates how a message is selected from a message group among retries\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PromptAttemptsSpecification": "Specifies the advanced settings on each attempt of the prompt\\. \n*Required*: No \n*Type*: Map of [PromptAttemptSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptattemptspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot ResponseSpecification": { "AllowInterrupt": "Indicates whether the user can interrupt a speech response from Amazon Lex\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MessageGroupsList": "A collection of responses that Amazon Lex can send to the user\\. Amazon Lex chooses the actual response to send at runtime\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot S3BucketLogDestination": { - "KmsKeyArn": "Specifies the Amazon Resource Name \\(ARN\\) of an AWS Key Management Service key for encrypting audio log files stored in an Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LogPrefix": "Specifies the Amazon S3 prefix to assign to audio log files\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3BucketArn": "Specifies the Amazon Resource Name \\(ARN\\) of the Amazon S3 bucket where audio files are stored\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "KmsKeyArn": "The Amazon Resource Name \\(ARN\\) of an AWS Key Management Service \\(KMS\\) key for encrypting audio log files stored in an Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LogPrefix": "The S3 prefix to assign to audio log files\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3BucketArn": "The Amazon Resource Name \\(ARN\\) of an Amazon S3 bucket where audio log files are stored\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot S3Location": { "S3Bucket": "The S3 bucket name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -15255,35 +17449,35 @@ "Value": "The SSML text that defines the prompt\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot SampleUtterance": { - "Utterance": "The sample utterance that Amazon Lex uses to build its machine\\-learning model to recognize intents\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Utterance": "A sample utterance that invokes an intent or respond to a slot elicitation prompt\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot SampleValue": { "Value": "The value that can be used for a slot type\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot SentimentAnalysisSettings": { - "DetectSentiment": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DetectSentiment": "Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot SessionAttribute": { - "Key": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Value": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Key": "The name of the session attribute\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The session\\-specific context information for the session attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot Slot": { - "Description": "A description of the slot type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MultipleValuesSetting": "Determines whether the slot can return multiple values to the application\\. \n*Required*: No \n*Type*: [MultipleValuesSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-multiplevaluessetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the slot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the slot\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MultipleValuesSetting": "Indicates whether a slot can return multiple values\\. \n*Required*: No \n*Type*: [MultipleValuesSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-multiplevaluessetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name given to the slot\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^([0-9a-zA-Z][_-]?)+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ObfuscationSetting": "Determines whether the contents of the slot are obfuscated in Amazon CloudWatch Logs logs\\. Use obfuscated slots to protect information such as personally identifiable information \\(PII\\) in logs\\. \n*Required*: No \n*Type*: [ObfuscationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-obfuscationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SlotTypeName": "The name of the slot type that this slot is based on\\. The slot type defines the acceptable values for the slot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ValueElicitationSetting": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ OriginalValue \\- Returns the value entered by the user, if the user value is similar to a slot value\\.\n+ TopResolution \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the valueSelectionStrategy, the default is OriginalValue\\. \n*Required*: Yes \n*Type*: [SlotValueElicitationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueelicitationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ValueElicitationSetting": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ ORIGINAL\\_VALUE \\- Returns the value entered by the user, if the user value is similar to a slot value\\.\n+ TOP\\_RESOLUTION \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`\\. \n*Required*: Yes \n*Type*: [SlotValueElicitationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueelicitationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot SlotCaptureSetting": { - "CaptureConditional": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CaptureNextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CaptureResponse": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CodeHook": "Property description not available\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ElicitationCodeHook": "Property description not available\\. \n*Required*: No \n*Type*: [ElicitationCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FailureConditional": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FailureNextStep": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FailureResponse": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CaptureConditional": "A list of conditional branches to evaluate after the slot value is captured\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CaptureNextStep": "Specifies the next step that the bot runs when the slot value is captured before the code hook times out\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CaptureResponse": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CodeHook": "Code hook called after Amazon Lex successfully captures a slot value\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ElicitationCodeHook": "Code hook called when Amazon Lex doesn't capture a slot value\\. \n*Required*: No \n*Type*: [ElicitationCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailureConditional": "A list of conditional branches to evaluate when the slot value isn't captured\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailureNextStep": "Specifies the next step that the bot runs when the slot value code is not recognized\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailureResponse": "Specifies a list of message groups that Amazon Lex uses to respond the user input when the slot fails to be captured\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot SlotDefaultValue": { "DefaultValue": "The default value to use when a user doesn't provide a value for a slot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -15299,46 +17493,46 @@ "Description": "A description of the slot type\\. Use the description to help identify the slot type in lists\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExternalSourceSetting": "Sets the type of external information used to create the slot type\\. \n*Required*: No \n*Type*: [ExternalSourceSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-externalsourcesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the slot type\\. A slot type name must be unique withing the account\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ParentSlotTypeSignature": "The built\\-in slot type used as a parent of this slot type\\. When you define a parent slot type, the new slot type has the configuration of the parent lot type\\. \nOnly AMAZON\\.AlphaNumeric is supported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ParentSlotTypeSignature": "The built\\-in slot type used as a parent of this slot type\\. When you define a parent slot type, the new slot type has the configuration of the parent lot type\\. \nOnly `AMAZON.AlphaNumeric` is supported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SlotTypeValues": "A list of SlotTypeValue objects that defines the values that the slot type can take\\. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for the slot\\. \n*Required*: No \n*Type*: List of [SlotTypeValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slottypevalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ValueSelectionSetting": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ OriginalValue \\- Returns the value entered by the user, if the user value is similar to a slot value\\.\n+ TopResolution \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the valueSelectionStrategy, the default is OriginalValue\\. \n*Required*: No \n*Type*: [SlotValueSelectionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueselectionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ValueSelectionSetting": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ `ORIGINAL_VALUE` \\- Returns the value entered by the user, if the user value is similar to the slot value\\.\n+ `TOP_RESOLUTION` \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`\\. \n*Required*: No \n*Type*: [SlotValueSelectionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueselectionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot SlotTypeValue": { "SampleValue": "The value of the slot type entry\\. \n*Required*: Yes \n*Type*: [SampleValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-samplevalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Synonyms": "Additional values related to the slot type entry\\. \n*Required*: No \n*Type*: List of [SampleValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-samplevalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot SlotValue": { - "InterpretedValue": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "InterpretedValue": "The value that Amazon Lex determines for the slot\\. The actual value depends on the setting of the value selection strategy for the bot\\. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the `resolvedValues` list\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot SlotValueElicitationSetting": { "DefaultValueSpecification": "A list of default values for a slot\\. Default values are used when Amazon Lex hasn't determined a value for a slot\\. You can specify default values from context variables, session attributes, and defined values\\. \n*Required*: No \n*Type*: [SlotDefaultValueSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotdefaultvaluespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PromptSpecification": "The prompt that Amazon Lex uses to elicit the slot value from the user\\. \n*Required*: No \n*Type*: [PromptSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SampleUtterances": "If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy\\. This is optional\\. In most cases Amazon Lex is capable of understanding user utterances\\. \n*Required*: No \n*Type*: List of [SampleUtterance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sampleutterance.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SlotCaptureSetting": "Property description not available\\. \n*Required*: No \n*Type*: [SlotCaptureSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SampleUtterances": "If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy\\. This is optional\\. In most cases, Amazon Lex is capable of understanding user utterances\\. \n*Required*: No \n*Type*: List of [SampleUtterance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sampleutterance.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SlotCaptureSetting": "Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user\\. \n*Required*: No \n*Type*: [SlotCaptureSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SlotConstraint": "Specifies whether the slot is required or optional\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "WaitAndContinueSpecification": "Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input\\. \n*Required*: No \n*Type*: [WaitAndContinueSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-waitandcontinuespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "WaitAndContinueSpecification": "Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input\\. \n*Required*: No \n*Type*: [WaitAndContinueSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-waitandcontinuespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot SlotValueOverride": { - "Shape": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Value": "Property description not available\\. \n*Required*: No \n*Type*: [SlotValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Values": "Property description not available\\. \n*Required*: No \n*Type*: List of [SlotValueOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-lex-bot-slotvalueoverride.html#aws-properties-lex-bot-slotvalueoverride) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Shape": "When the shape value is `List`, it indicates that the `values` field contains a list of slot values\\. When the value is `Scalar`, it indicates that the `value` field contains a single value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The current value of the slot\\. \n*Required*: No \n*Type*: [SlotValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Values": "A list of one or more values that the user provided for the slot\\. For example, for a slot that elicits pizza toppings, the values might be \"pepperoni\" and \"pineapple\\.\" \n*Required*: No \n*Type*: List of [SlotValueOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-lex-bot-slotvalueoverride.html#aws-properties-lex-bot-slotvalueoverride) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot SlotValueOverrideMap": { - "SlotName": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SlotValueOverride": "Property description not available\\. \n*Required*: No \n*Type*: [SlotValueOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SlotName": "The name of the slot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SlotValueOverride": "The SlotValueOverride object to which the slot name will be mapped\\. \n*Required*: No \n*Type*: [SlotValueOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot SlotValueRegexFilter": { - "Pattern": "A regular expression used to validate the value of a slot\\. \nUse a standard regular expression\\. Amazon Lex supports the following characters in the regular expression: \n+ A\\-Z, a\\-z\n+ 0\\-9\n+ Unicode characters \\(\"\\\\u\"\\)\nRepresent Unicode characters with four digits, for example \"\\]u0041\" or \"\\\\u005A\"\\. \nThe following regular expression operators are not supported: \n+ Infinite repeaters: \\*, \\+, or \\{x,\\} with no upper bound\n+ Wild card \\(\\.\\)\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Pattern": "A regular expression used to validate the value of a slot\\. \n Use a standard regular expression\\. Amazon Lex supports the following characters in the regular expression: \n+ A\\-Z, a\\-z\n+ 0\\-9\n+ Unicode characters \\(\"\\\\u\"\\)\n Represent Unicode characters with four digits, for example \"\\\\u0041\" or \"\\\\u005A\"\\. \n The following regular expression operators are not supported: \n+ Infinite repeaters: \\*, \\+, or \\{x,\\} with no upper bound\\.\n+ Wild card \\(\\.\\)\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot SlotValueSelectionSetting": { - "AdvancedRecognitionSetting": "Specifies settings that enable advanced recognition settings for slot values\\. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances\\. \n*Required*: No \n*Type*: [AdvancedRecognitionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-advancedrecognitionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdvancedRecognitionSetting": "Provides settings that enable advanced recognition settings for slot values\\. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances\\. \n*Required*: No \n*Type*: [AdvancedRecognitionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-advancedrecognitionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RegexFilter": "A regular expression used to validate the value of a slot\\. \n*Required*: No \n*Type*: [SlotValueRegexFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueregexfilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResolutionStrategy": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ ORIGINAL_VALUE \\- Returns the value entered by the user, if the user value is similar to a slot value\\.\n+ TOP_RESOLUTION \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the valueSelectionStrategy, the default is OriginalValue\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ResolutionStrategy": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ `ORIGINAL_VALUE` \\- Returns the value entered by the user, if the user value is similar to the slot value\\.\n+ `TOP_RESOLUTION` \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot StillWaitingResponseSpecification": { "AllowInterrupt": "Indicates that the user can interrupt the response by speaking while the message is being played\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FrequencyInSeconds": "How often a message should be sent to the user\\. Minimum of 1 second, maximum of 5 minutes\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MessageGroupsList": "A collection of responses that Amazon Lex can send to the user\\. Amazon Lex chooses the actual response to send at runtime\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MessageGroupsList": "One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TimeoutInSeconds": "If Amazon Lex waits longer than this length of time for a response, it will stop sending messages\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot TestBotAliasSettings": { @@ -15348,27 +17542,27 @@ "SentimentAnalysisSettings": "Specifies whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances\\. \n*Required*: No \n*Type*: [SentimentAnalysisSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sentimentanalysissettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot TextInputSpecification": { - "StartTimeoutMs": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "StartTimeoutMs": "Time for which a bot waits before re\\-prompting a customer for text input\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot TextLogDestination": { - "CloudWatch": "Specifies the Amazon CloudWatch Logs log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: [CloudWatchLogGroupLogDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-cloudwatchloggrouplogdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CloudWatch": "Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: [CloudWatchLogGroupLogDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-cloudwatchloggrouplogdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot TextLogSetting": { "Destination": "Specifies the Amazon CloudWatch Logs destination log group for conversation text logs\\. \n*Required*: Yes \n*Type*: [TextLogDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textlogdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Enabled": "Specifies whether conversation logs should be stored for an alias\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Enabled": "Determines whether conversation logs should be stored for an alias\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot VoiceSettings": { - "Engine": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VoiceId": "The Amazon Polly voice used for voice interaction with the user\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Engine": "Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user\\. For more information, see the [`engine` parameter of the `SynthesizeSpeech` operation](https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine) in the *Amazon Polly developer guide*\\. \nIf you do not specify a value, the default is `standard`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VoiceId": "The identifier of the Amazon Polly voice to use\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::Bot WaitAndContinueSpecification": { "ContinueResponse": "The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation\\. \n*Required*: Yes \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IsActive": "Specifies whether the bot will wait for a user to respond\\. When this field is false, wait and continue responses for a slot aren't used and the bot expects an appropriate response within the configured timeout\\. If the IsActive field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IsActive": "Specifies whether the bot will wait for a user to respond\\. When this field is false, wait and continue responses for a slot aren't used\\. If the `IsActive` field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StillWaitingResponse": "A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user\\. \n*Required*: No \n*Type*: [StillWaitingResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-stillwaitingresponsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WaitingResponse": "The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue\\. \n*Required*: Yes \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::BotAlias": { - "BotAliasLocaleSettings": "Maps configuration information to a specific locale\\. You can use this parameter to specify a specific Lambda function to run different functions in different locales\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettings.html) of [BotAliasLocaleSettingsItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettingsitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BotAliasLocaleSettings": "Property description not available\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettings.html) of [BotAliasLocaleSettingsItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettingsitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BotAliasName": "The name of the bot alias\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^([0-9a-zA-Z][_-]?)+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BotAliasTags": "An array of key\\-value pairs to apply to this resource\\. \nYou can only add tags when you specify an alias\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BotId": "The unique identifier of the bot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -15386,7 +17580,7 @@ }, "AWS::Lex::BotAlias BotAliasLocaleSettings": { "CodeHookSpecification": "Specifies the Lambda function that should be used in the locale\\. \n*Required*: No \n*Type*: [CodeHookSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-codehookspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Enabled": "Determines whether the locale is enabled for the bot\\. If the value is false, the locale isn't available for use\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Enabled": "Determines whether the locale is enabled for the bot\\. If the value is `false`, the locale isn't available for use\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::BotAlias BotAliasLocaleSettingsItem": { "BotAliasLocaleSetting": "Specifies settings that are unique to a locale\\. \n*Required*: Yes \n*Type*: [BotAliasLocaleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -15394,7 +17588,7 @@ }, "AWS::Lex::BotAlias CloudWatchLogGroupLogDestination": { "CloudWatchLogGroupArn": "The Amazon Resource Name \\(ARN\\) of the log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LogPrefix": "The prefix of the log stream name within the log group that you specified\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "LogPrefix": "The prefix of the log stream name within the log group that you specified \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::BotAlias CodeHookSpecification": { "LambdaCodeHook": "Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot\\. \n*Required*: Yes \n*Type*: [LambdaCodeHook](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-lambdacodehook.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -15408,12 +17602,12 @@ "LambdaArn": "The Amazon Resource Name \\(ARN\\) of the Lambda function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::BotAlias S3BucketLogDestination": { - "KmsKeyArn": "The Amazon Resource Name \\(ARN\\) of an AWS Key Management Service key for encrypting audio log files stored in an S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsKeyArn": "The Amazon Resource Name \\(ARN\\) of an AWS Key Management Service \\(KMS\\) key for encrypting audio log files stored in an Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LogPrefix": "The S3 prefix to assign to audio log files\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3BucketArn": "The Amazon Resource Name \\(ARN\\) of an Amazon S3 bucket where audio log files are stored\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::BotAlias SentimentAnalysisSettings": { - "DetectSentiment": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DetectSentiment": "Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lex::BotAlias TextLogDestination": { "CloudWatch": "Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: [CloudWatchLogGroupLogDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-cloudwatchloggrouplogdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -15443,7 +17637,7 @@ "GrantName": "Grant name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HomeRegion": "Home Region of the grant\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LicenseArn": "License ARN\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Principals": "The grant principals\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Principals": "The grant principals\\. You can specify one of the following as an Amazon Resource Name \\(ARN\\): \n+ An AWS account, which includes only the account specified\\.\n+ An organizational unit \\(OU\\), which includes all accounts in the OU\\.\n+ An organization, which will include all accounts across your organization\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Status": "Granted license status\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::LicenseManager::License": { @@ -15610,6 +17804,10 @@ "AWS::Lightsail::Disk AutoSnapshotAddOn": { "SnapshotTimeOfDay": "The daily time when an automatic snapshot will be created\\. \nConstraints: \n+ Must be in `HH:00` format, and in an hourly increment\\.\n+ Specified in Coordinated Universal Time \\(UTC\\)\\.\n+ The snapshot will be automatically created between the time specified and up to 45 minutes after\\.\n*Required*: No \n*Type*: String \n*Pattern*: `^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Lightsail::Disk Location": { + "AvailabilityZone": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RegionName": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Lightsail::Distribution": { "BundleId": "The ID of the bundle applied to the distribution\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CacheBehaviorSettings": "An object that describes the cache behavior settings of the distribution\\. \n*Required*: No \n*Type*: [CacheSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-distribution-cachesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -15664,7 +17862,9 @@ "Hardware": "The hardware properties for the instance, such as the vCPU count, attached disks, and amount of RAM\\. \nThe instance restarts when performing an attach disk or detach disk request\\. This resets the public IP address of your instance if a static IP isn't attached to it\\.\n*Required*: No \n*Type*: [Hardware](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-hardware.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "InstanceName": "The name of the instance\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\w[\\w\\-]*\\w` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KeyPairName": "The name of the key pair to use for the instance\\. \nIf no key pair name is specified, the Regional Lightsail default key pair is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Location": "The location for the instance, such as the AWS Region and Availability Zone\\. \nThe `Location` property is read\\-only and should not be specified in a create instance or update instance request\\.\n*Required*: No \n*Type*: [Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-location.html) \n*Update requires*: Updates are not supported\\.", "Networking": "The public ports and the monthly amount of data transfer allocated for the instance\\. \n*Required*: No \n*Type*: [Networking](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-networking.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "State": "The status code and the state \\(for example, `running`\\) of the instance\\. \nThe `State` property is read\\-only and should not be specified in a create instance or update instance request\\.\n*Required*: No \n*Type*: [State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-state.html) \n*Update requires*: Updates are not supported\\.", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide*\\. \nThe `Value` of `Tags` is optional for Lightsail resources\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserData": "The optional launch script for the instance\\. \nSpecify a launch script to configure an instance with additional user data\\. For example, you might want to specify `apt-get -y update` as a launch script\\. \nDepending on the blueprint of your instance, the command to get software on your instance varies\\. Amazon Linux and CentOS use `yum`, Debian and Ubuntu use `apt-get`, and FreeBSD uses `pkg`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -15725,12 +17925,14 @@ "LoadBalancerName": "The name of the load balancer\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\w[\\w\\-]*\\w` \n*Update requires*: Updates are not supported\\.", "SessionStickinessEnabled": "A Boolean value indicating whether session stickiness is enabled\\. \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\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide*\\. \nThe `Value` of `Tags` is optional for Lightsail resources\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide*\\. \nThe `Value` of `Tags` is optional for Lightsail resources\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TlsPolicyName": "The name of the TLS security policy for the load balancer\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\w[\\w\\-]*\\w` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Lightsail::LoadBalancerTlsCertificate": { "CertificateAlternativeNames": "An array of alternative domain names and subdomain names for your SSL/TLS certificate\\. \nIn addition to the primary domain name, you can have up to nine alternative domain names\\. Wildcards \\(such as `*.example.com`\\) are not supported\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: Updates are not supported\\.", "CertificateDomainName": "The domain name for the SSL/TLS certificate\\. For example, `example.com` or `www.example.com`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: Updates are not supported\\.", "CertificateName": "The name of the SSL/TLS certificate\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "HttpsRedirectionEnabled": "A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IsAttached": "A Boolean value indicating whether the SSL/TLS certificate is attached to a Lightsail load balancer\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LoadBalancerName": "The name of the load balancer that the SSL/TLS certificate is attached to\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\w[\\w\\-]*\\w` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -15739,34 +17941,32 @@ "StaticIpName": "The name of the static IP\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Location::GeofenceCollection": { - "CollectionName": "The name for the geofence collection\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CollectionName": "A custom name for the geofence collection\\. \nRequirements: \n+ Contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\. \n+ Must be a unique geofence collection name\\.\n+ No spaces allowed\\. For example, `ExampleGeofenceCollection`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "An optional description for the geofence collection\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "KmsKeyId": "A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html)\\. Enter a key ID, key ARN, alias name, or alias ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PricingPlan": "No longer used\\. If included, the only allowed value is `RequestBasedUsage`\\. \n*Allowed Values*: `RequestBasedUsage` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PricingPlanDataSource": "This parameter is no longer used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "KmsKeyId": "A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html)\\. Enter a key ID, key ARN, alias name, or alias ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Location::Map": { - "Configuration": "Specifies the map style selected from an available data provider\\. \n*Required*: Yes \n*Type*: [MapConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-map-mapconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Configuration": "Specifies the `MapConfiguration`, including the map style, for the map resource that you create\\. The map style defines the look of maps and the data provider for your map resource\\. \n*Required*: Yes \n*Type*: [MapConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-map-mapconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "An optional description for the map resource\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MapName": "The name for the map resource\\. \nRequirements: \n+ Must contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique map resource name\\.\n+ No spaces allowed\\. For example, `ExampleMap`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MapName": "The name for the map resource\\. \nRequirements: \n+ Must contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\. \n+ Must be a unique map resource name\\. \n+ No spaces allowed\\. For example, `ExampleMap`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PricingPlan": "No longer used\\. If included, the only allowed value is `RequestBasedUsage`\\. \n*Allowed Values*: `RequestBasedUsage` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Location::Map MapConfiguration": { - "Style": "Specifies the map style selected from an available data provider\\. \nValid styles: `VectorEsriStreets`, `VectorEsriTopographic`, `VectorEsriNavigation`, `VectorEsriDarkGrayCanvas`, `VectorEsriLightGrayCanvas`, `VectorHereBerlin`\\. \nWhen using HERE as your data provider, and selecting the Style `VectorHereBerlin`, you may not use HERE Technologies maps for Asset Management\\. See the [AWS Service Terms](http://aws.amazon.com/service-terms/) for Amazon Location Service\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Style": "Specifies the map style selected from an available data provider\\. \nValid [Esri map styles](https://docs.aws.amazon.com/location/latest/developerguide/esri.html): \n+ `VectorEsriDarkGrayCanvas` \u2013 The Esri Dark Gray Canvas map style\\. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content\\. \n+ `RasterEsriImagery` \u2013 The Esri Imagery map style\\. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide\\. \n+ `VectorEsriLightGrayCanvas` \u2013 The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content\\. \n+ `VectorEsriTopographic` \u2013 The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style\\.\n+ `VectorEsriStreets` \u2013 The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style\\. The vector tile layer is similar in content and style to the World Street Map raster map\\.\n+ `VectorEsriNavigation` \u2013 The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices\\.\nValid [HERE Technologies map styles](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html): \n+ `VectorHereContrast` \u2013 The HERE Contrast \\(Berlin\\) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering\\.\n**Note** \nThe `VectorHereContrast` style has been renamed from `VectorHereBerlin`\\. `VectorHereBerlin` has been deprecated, but will continue to work in applications that use it\\.\n+ `VectorHereExplore` \u2013 A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features\\. It also now includes a fully designed map of Japan\\.\n+ `VectorHereExploreTruck` \u2013 A global map containing truck restrictions and attributes \\(e\\.g\\. width / height / HAZMAT\\) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics\\.\n+ `RasterHereExploreSatellite` \u2013 A global map containing high resolution satellite imagery\\.\n+ `HybridHereExploreSatellite` \u2013 A global map displaying the road network, street names, and city labels over satellite imagery\\. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved\\.\n**Note** \nHybrid styles use both vector and raster tiles when rendering the map that you see\\. This means that more tiles are retrieved than when using either vector or raster tiles alone\\. Your charges will include all tiles retrieved\\.\nValid [GrabMaps map styles](https://docs.aws.amazon.com/location/latest/developerguide/grab.html): \n+ `VectorGrabStandardLight` \u2013 The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia\\.\n+ `VectorGrabStandardDark` \u2013 The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia\\.\nGrab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific \\(Singapore\\) Region \\(`ap-southeast-1`\\)\\. For more information, see [GrabMaps countries and area covered](https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area)\\.\nValid [Open Data \\(Preview\\) map styles](https://docs.aws.amazon.com/location/latest/developerguide/open-data.html): \n+ `VectorOpenDataStandardLight` \u2013 The Open Data Standard Light \\(preview\\) map style provides a detailed basemap for the world suitable for website and mobile application use\\. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries\\.\n**Important** \nOpen Data maps is in preview\\. We may add, change, or remove features before announcing general availability\\. For more information, see [Open Data is in preview release](https://docs.aws.amazon.com/location/latest/developerguide/open-data.html#open-data-preview)\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Location::PlaceIndex": { - "DataSource": "Specifies the data provider of geospatial data\\. \nThis field is case\\-sensitive\\. Enter the valid values as shown\\. For example, entering `HERE` will return an error\\.\nValid values include: \n+ `Esri`\n+ `Here`\n**Important** \nPlace index resources using HERE as a data provider can't be used to [store](https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html) results for locations in Japan\\. For more information, see the [AWS Service Terms](http://aws.amazon.com/service-terms/) for Amazon Location Service\\.\nFor additional details on data providers, see the [Amazon Location Service data providers page](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DataSourceConfiguration": "Specifies the data storage option for requesting Places\\. \n*Required*: No \n*Type*: [DataSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-placeindex-datasourceconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DataSource": "Specifies the geospatial data provider for the new place index\\. \nThis field is case\\-sensitive\\. Enter the valid values as shown\\. For example, entering `HERE` returns an error\\.\nValid values include: \n+ `Esri` \u2013 For additional information about [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s coverage in your region of interest, see [Esri details on geocoding coverage](https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm)\\.\n+ `Grab` \u2013 Grab provides place index functionality for Southeast Asia\\. For additional information about [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/grab.html)' coverage, see [GrabMaps countries and areas covered](https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area)\\.\n+ `Here` \u2013 For additional information about [HERE Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)' coverage in your region of interest, see [HERE details on goecoding coverage](https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html)\\.\n**Important** \nIf you specify HERE Technologies \\(`Here`\\) as the data provider, you may not [store results](https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html) for locations in Japan\\. For more information, see the [AWS Service Terms](http://aws.amazon.com/service-terms/) for Amazon Location Service\\.\nFor additional information , see [Data providers](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) on the *Amazon Location Service Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DataSourceConfiguration": "Specifies the data storage option requesting Places\\. \n*Required*: No \n*Type*: [DataSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-placeindex-datasourceconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "The optional description for the place index resource\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "IndexName": "The name of the place index resource\\. \nRequirements: \n+ Contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique place index resource name\\.\n+ No spaces allowed\\. For example, `ExamplePlaceIndex`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IndexName": "The name of the place index resource\\. \nRequirements: \n+ Contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique place index resource name\\.\n+ No spaces allowed\\. For example, `ExamplePlaceIndex`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PricingPlan": "No longer used\\. If included, the only allowed value is `RequestBasedUsage`\\. \n*Allowed Values*: `RequestBasedUsage` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Location::PlaceIndex DataSourceConfiguration": { - "IntendedUse": "Specifies how the results of an operation will be stored by the caller\\. \nValid values include: \n+ `SingleUse` specifies that the results won't be stored\\.\n+ `Storage` specifies that the result can be cached or stored in a database\\.\n**Important** \nPlace index resources using HERE as a data provider can't be configured to store results for locations in Japan when choosing `Storage` for the `IntendedUse` parameter\\.\nDefault value: `SingleUse` \n*Required*: No \n*Type*: String \n*Allowed values*: `SingleUse | Storage` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "IntendedUse": "Specifies how the results of an operation will be stored by the caller\\. \nValid values include: \n+ `SingleUse` specifies that the results won't be stored\\. \n+ `Storage` specifies that the result can be cached or stored in a database\\.\nDefault value: `SingleUse` \n*Required*: No \n*Type*: String \n*Allowed values*: `SingleUse | Storage` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Location::RouteCalculator": { - "CalculatorName": "The name of the route calculator resource\\. \nRequirements: \n+ Can use alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\) , hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique route calculator resource name\\.\n+ No spaces allowed\\. For example, `ExampleRouteCalculator`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DataSource": "Specifies the data provider of traffic and road network data\\. \nThis field is case\\-sensitive\\. Enter the valid values as shown\\. For example, entering `HERE` returns an error\\.\nValid values include: \n+ `Esri`\n+ `Here`\nFor more information about data providers, see the [Amazon Location Service data providers page](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CalculatorName": "The name of the route calculator resource\\. \nRequirements: \n+ Can use alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\) , hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique Route calculator resource name\\.\n+ No spaces allowed\\. For example, `ExampleRouteCalculator`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DataSource": "Specifies the data provider of traffic and road network data\\. \nThis field is case\\-sensitive\\. Enter the valid values as shown\\. For example, entering `HERE` returns an error\\.\nValid values include: \n+ `Esri` \u2013 For additional information about [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s coverage in your region of interest, see [Esri details on street networks and traffic coverage](https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm)\\.", "Description": "The optional description for the route calculator resource\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PricingPlan": "No longer used\\. If included, the only allowed value is `RequestBasedUsage`\\. \n*Allowed Values*: `RequestBasedUsage` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -15775,23 +17975,24 @@ "KmsKeyId": "A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html)\\. Enter a key ID, key ARN, alias name, or alias ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PositionFiltering": "Specifies the position filtering for the tracker resource\\. \nValid values: \n+ `TimeBased` \\- Location updates are evaluated against linked geofence collections, but not every location update is stored\\. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID\\. \n+ `DistanceBased` \\- If the device has moved less than 30 m \\(98\\.4 ft\\), location updates are ignored\\. Location updates within this area are neither evaluated against linked geofence collections, nor stored\\. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through\\. Distance\\-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map\\. \n+ `AccuracyBased` \\- If the device has moved less than the measured accuracy, location updates are ignored\\. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m\\. Ignored location updates are neither evaluated against linked geofence collections, nor stored\\. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations\\. \nThis field is optional\\. If not specified, the default value is `TimeBased`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AccuracyBased | DistanceBased | TimeBased` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PricingPlan": "No longer used\\. If included, the only allowed value is `RequestBasedUsage`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `MobileAssetManagement | MobileAssetTracking | RequestBasedUsage` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PricingPlanDataSource": "This parameter is no longer used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PricingPlanDataSource": "This parameter is no longer used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TrackerName": "The name for the tracker resource\\. \nRequirements: \n+ Contain only alphanumeric characters \\(A\\-Z, a\\-z, 0\\-9\\) , hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique tracker resource name\\.\n+ No spaces allowed\\. For example, `ExampleTracker`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Location::TrackerConsumer": { - "ConsumerArn": "The Amazon Resource Name \\(ARN\\) for the geofence collection that consumes the tracker resource updates\\. \n+ Format example: `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`\n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1600` \n*Pattern*: `^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ConsumerArn": "The Amazon Resource Name \\(ARN\\) for the geofence collection to be associated to tracker resource\\. Used when you need to specify a resource across all AWS\\. \n+ Format example: `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`\n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1600` \n*Pattern*: `^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TrackerName": "The name for the tracker resource\\. \nRequirements: \n+ Contain only alphanumeric characters \\(A\\-Z, a\\-z, 0\\-9\\) , hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique tracker resource name\\.\n+ No spaces allowed\\. For example, `ExampleTracker`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Logs::Destination": { "DestinationName": "The name of the destination\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[^:*]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DestinationPolicy": "An IAM policy document that governs which AWS accounts can create subscription filters against this destination\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DestinationPolicy": "An IAM policy document that governs which AWS accounts can create subscription filters against this destination\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The ARN of an IAM role that permits CloudWatch Logs to send data to the specified AWS resource\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TargetArn": "The Amazon Resource Name \\(ARN\\) of the physical target where the log events are delivered \\(for example, a Kinesis stream\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Logs::LogGroup": { + "DataProtectionPolicy": "Creates a data protection policy and assigns it to the log group\\. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data\\. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks\\. \nFor more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KmsKeyId": "The Amazon Resource Name \\(ARN\\) of the AWS KMS key to use when encrypting log data\\. \nTo associate an AWS KMS key with the log group, specify the ARN of that KMS key here\\. If you do so, ingested data is encrypted using this key\\. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs\\. This enables CloudWatch Logs to decrypt this data whenever it is requested\\. \nIf you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an `InvalidParameterException` error\\. \nLog group data is always encrypted in CloudWatch Logs\\. If you omit this key, the encryption does not use AWS KMS\\. For more information, see [ Encrypt log data in CloudWatch Logs using AWS Key Management Service](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html) \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LogGroupName": "The name of the log group\\. If you don't specify a name, AWS CloudFormation generates a unique ID for the log group\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "RetentionInDays": "The number of days to retain the log events in the specified log group\\. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653\\. \nTo set a log group to never have log events expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RetentionInDays": "The number of days to retain the log events in the specified log group\\. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653\\. \nTo set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs to apply to the log group\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Logs::LogStream": { @@ -15799,15 +18000,22 @@ "LogStreamName": "The name of the log stream\\. The name must be unique within the log group\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[^:*]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Logs::MetricFilter": { + "FilterName": "The name of the metric filter\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[^:*]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FilterPattern": "A filter pattern for extracting metric data out of ingested log events\\. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LogGroupName": "The name of an existing log group that you want to associate with this metric filter\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "MetricTransformations": "The metric transformations\\. \n*Required*: Yes \n*Type*: List of [MetricTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-metrictransformation.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Logs::MetricFilter Dimension": { + "Key": "The name for the CloudWatch metric dimension that the metric filter creates\\. \nDimension names must contain only ASCII characters, must include at least one non\\-whitespace character, and cannot start with a colon \\(:\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The log event field that will contain the value for this dimension\\. This dimension will only be published for a metric if the value is found in the log event\\. For example, `$.eventType` for JSON log events, or `$server` for space\\-delimited log events\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Logs::MetricFilter MetricTransformation": { "DefaultValue": "\\(Optional\\) The value to emit when a filter pattern does not match a log event\\. This value can be null\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Dimensions": "The fields to use as dimensions for the metric\\. One metric filter can include as many as three dimensions\\. \nMetrics extracted from log events are charged as custom metrics\\. To prevent unexpected high charges, do not specify high\\-cardinality fields such as `IPAddress` or `requestID` as dimensions\\. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric\\. \nCloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time\\. This helps to prevent accidental high charges\\. \nYou can also set up a billing alarm to alert you if your charges are higher than expected\\. For more information, see [ Creating a Billing Alarm to Monitor Your Estimated AWS Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html)\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-dimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MetricName": "The name of the CloudWatch metric\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MetricNamespace": "A custom namespace to contain your metric in CloudWatch\\. Use namespaces to group together metrics that are similar\\. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `[^:*$]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MetricValue": "The value that is published to the CloudWatch metric\\. For example, if you're counting the occurrences of a particular term like `Error`, specify 1 for the metric value\\. If you're counting the number of bytes transferred, reference the value that is in the log event by using $ followed by the name of the field that you specified in the filter pattern, such as `$.size`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "MetricValue": "The value that is published to the CloudWatch metric\\. For example, if you're counting the occurrences of a particular term like `Error`, specify 1 for the metric value\\. If you're counting the number of bytes transferred, reference the value that is in the log event by using $\\. followed by the name of the field that you specified in the filter pattern, such as `$.size`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Unit": "The unit to assign to the metric\\. If you omit this, the unit is set as `None`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Bits | Bits/Second | Bytes | Bytes/Second | Count | Count/Second | Gigabits | Gigabits/Second | Gigabytes | Gigabytes/Second | Kilobits | Kilobits/Second | Kilobytes | Kilobytes/Second | Megabits | Megabits/Second | Megabytes | Megabytes/Second | Microseconds | Milliseconds | None | Percent | Seconds | Terabits | Terabits/Second | Terabytes | Terabytes/Second` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Logs::QueryDefinition": { "LogGroupNames": "Use this parameter if you want the query to query only certain log groups\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -15820,14 +18028,16 @@ }, "AWS::Logs::SubscriptionFilter": { "DestinationArn": "The Amazon Resource Name \\(ARN\\) of the destination\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Distribution": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FilterName": "The name of the subscription filter\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[^:*]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FilterPattern": "The filtering expressions that restrict what gets delivered to the destination AWS resource\\. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "LogGroupName": "The log group to associate with the subscription filter\\. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RoleArn": "The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream\\. You don't need to provide the ARN when you are working with a logical destination for cross\\-account delivery\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::LookoutEquipment::InferenceScheduler": { "DataDelayOffsetInMinutes": "A period of time \\(in minutes\\) by which inference on the data is delayed after the data starts\\. For instance, if an offset delay time of five minutes was selected, inference will not begin on the data until the first data measurement after the five minute mark\\. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket\\. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DataInputConfiguration": "Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DataOutputConfiguration": "Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataInputConfiguration": "Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location\\. \n*Required*: Yes \n*Type*: [DataInputConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-datainputconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataOutputConfiguration": "Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output\\. \n*Required*: Yes \n*Type*: [DataOutputConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-dataoutputconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DataUploadFrequency": "How often data is uploaded to the source S3 bucket for the input data\\. This value is the length of time between data uploads\\. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real\\-time data to the source bucket once every 5 minutes\\. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data\\. In this example, it starts once every 5 minutes\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `PT10M | PT15M | PT1H | PT30M | PT5M` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InferenceSchedulerName": "The name of the inference scheduler\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `200` \n*Pattern*: `^[0-9a-zA-Z_-]{1,200}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ModelName": "The name of the ML model used for the inference scheduler\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `200` \n*Pattern*: `^[0-9a-zA-Z_-]{1,200}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -15835,6 +18045,27 @@ "ServerSideKmsKeyId": "Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Any tags associated with the inference scheduler\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::LookoutEquipment::InferenceScheduler DataInputConfiguration": { + "InferenceInputNameConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [InputNameConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-inputnameconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InputTimeZoneOffset": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3InputConfiguration": "Property description not available\\. \n*Required*: Yes \n*Type*: [S3InputConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-s3inputconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::LookoutEquipment::InferenceScheduler DataOutputConfiguration": { + "KmsKeyId": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3OutputConfiguration": "Property description not available\\. \n*Required*: Yes \n*Type*: [S3OutputConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-s3outputconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::LookoutEquipment::InferenceScheduler InputNameConfiguration": { + "ComponentTimestampDelimiter": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TimestampFormat": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::LookoutEquipment::InferenceScheduler S3InputConfiguration": { + "Bucket": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Prefix": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::LookoutEquipment::InferenceScheduler S3OutputConfiguration": { + "Bucket": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Prefix": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::LookoutMetrics::Alert": { "Action": "Action that will be triggered when there is an alert\\. \n*Required*: Yes \n*Type*: [Action](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-alert-action.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "AlertDescription": "A description of the alert\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -15899,15 +18130,15 @@ "MetricSetFrequency": "The frequency with which the source data will be analyzed for anomalies\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MetricSetName": "The name of the dataset\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MetricSource": "Contains information about how the source data should be interpreted\\. \n*Required*: Yes \n*Type*: [MetricSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-metricsource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Offset": "After an interval ends, the amount of seconds that the detector waits before importing data\\. Offset is only supported for S3 and Redshift datasources\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Offset": "After an interval ends, the amount of seconds that the detector waits before importing data\\. Offset is only supported for S3, Redshift, Athena and datasources\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TimestampColumn": "Contains information about the column used for tracking time in your source data\\. \n*Required*: No \n*Type*: [TimestampColumn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-timestampcolumn.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Timezone": "The time zone in which your source data was recorded\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::LookoutMetrics::AnomalyDetector MetricSource": { - "AppFlowConfig": "An object containing information about the AppFlow configuration\\. \n*Required*: No \n*Type*: [AppFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-appflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CloudwatchConfig": "An object containing information about the Amazon CloudWatch monitoring configuration\\. \n*Required*: No \n*Type*: [CloudwatchConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-cloudwatchconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RDSSourceConfig": "An object containing information about the Amazon Relational Database Service \\(RDS\\) configuration\\. \n*Required*: No \n*Type*: [RDSSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RedshiftSourceConfig": "An object containing information about the Amazon Redshift database configuration\\. \n*Required*: No \n*Type*: [RedshiftSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AppFlowConfig": "Details about an AppFlow datasource\\. \n*Required*: No \n*Type*: [AppFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-appflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CloudwatchConfig": "Details about an Amazon CloudWatch monitoring datasource\\. \n*Required*: No \n*Type*: [CloudwatchConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-cloudwatchconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RDSSourceConfig": "Details about an Amazon Relational Database Service \\(RDS\\) datasource\\. \n*Required*: No \n*Type*: [RDSSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RedshiftSourceConfig": "Details about an Amazon Redshift database datasource\\. \n*Required*: No \n*Type*: [RedshiftSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3SourceConfig": "Contains information about the configuration of the S3 bucket that contains source files\\. \n*Required*: No \n*Type*: [S3SourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-s3sourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::LookoutMetrics::AnomalyDetector RDSSourceConfig": { @@ -15947,6 +18178,48 @@ "AWS::LookoutVision::Project": { "ProjectName": "The name of the project\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9][a-zA-Z0-9_\\-]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::M2::Application": { + "Definition": "The application definition for a particular application\\. You can specify either inline JSON or an Amazon S3 bucket location\\. \nFor information about application definitions, see the [AWS Mainframe Modernization User Guide](https://docs.aws.amazon.com/m2/latest/userguide/applications-m2-definition.html)\\. \n*Required*: Yes \n*Type*: [Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-application-definition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the application\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EngineType": "The type of the target platform for this application\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `bluage | microfocus` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "KmsKeyId": "The identifier of a customer managed key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the application\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::M2::Application Definition": { + "Content": "The content of the application definition\\. This is a JSON object that contains the resource configuration/definitions that identify an application\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `65000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3Location": "The S3 bucket that contains the application definition\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\S{1,2000}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::M2::Environment": { + "Description": "The description of the runtime environment\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EngineType": "The target platform for the runtime environment\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `bluage | microfocus` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EngineVersion": "The version of the runtime engine\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\S{1,10}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HighAvailabilityConfig": "Defines the details of a high availability configuration\\. \n*Required*: No \n*Type*: [HighAvailabilityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-highavailabilityconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InstanceType": "The instance type of the runtime environment\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,20}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsKeyId": "The identifier of a customer managed key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the runtime environment\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PreferredMaintenanceWindow": "Configures the maintenance window you want for the runtime environment\\. If you do not provide a value, a random system\\-generated value will be assigned\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\S{1,50}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PubliclyAccessible": "Specifies whether the runtime environment is publicly accessible\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SecurityGroupIds": "The list of security groups for the VPC associated with this runtime environment\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StorageConfigurations": "Defines the storage configuration for a runtime environment\\. \n*Required*: No \n*Type*: List of [StorageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-storageconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SubnetIds": "The list of subnets associated with the VPC for this runtime environment\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::M2::Environment EfsStorageConfiguration": { + "FileSystemId": "The file system identifier\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,200}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MountPoint": "The mount point for the file system\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,200}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::M2::Environment FsxStorageConfiguration": { + "FileSystemId": "The file system identifier\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,200}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MountPoint": "The mount point for the file system\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,200}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::M2::Environment HighAvailabilityConfig": { + "DesiredCapacity": "The number of instances in a high availability configuration\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::M2::Environment StorageConfiguration": { + "Efs": "Defines the storage configuration for an Amazon EFS file system\\. \n*Required*: No \n*Type*: [EfsStorageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-efsstorageconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Fsx": "Defines the storage configuration for an Amazon FSx file system\\. \n*Required*: No \n*Type*: [FsxStorageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-fsxstorageconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::MSK::BatchScramSecret": { "ClusterArn": "The Amazon Resource Name \\(ARN\\) of the MSK cluster\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SecretArnList": "A list of Amazon Secrets Manager secret ARNs\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -15963,6 +18236,7 @@ "LoggingInfo": "You can configure your Amazon MSK cluster to send broker logs to different destination types\\. This is a container for the configuration details related to broker logs\\. \n*Required*: No \n*Type*: [LoggingInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-logginginfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NumberOfBrokerNodes": "The number of broker nodes you want in the Amazon MSK cluster\\. You can submit an update to increase the number of broker nodes in a cluster\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OpenMonitoring": "The settings for open monitoring\\. \n*Required*: No \n*Type*: [OpenMonitoring](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-openmonitoring.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StorageMode": "This controls storage mode for supported storage tiers\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A map of key:value pairs to apply to this resource\\. Both key and value are of type String\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::MSK::Cluster BrokerLogs": { @@ -15972,11 +18246,11 @@ }, "AWS::MSK::Cluster BrokerNodeGroupInfo": { "BrokerAZDistribution": "This parameter is currently not in use\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ClientSubnets": "The list of subnets to connect to in the client virtual private cloud \\(VPC\\)\\. Amazon creates elastic network interfaces inside these subnets\\. Client applications use elastic network interfaces to produce and consume data\\. \nSpecify exactly two subnets if you are using the US West \\(N\\. California\\) Region\\. For other Regions where Amazon MSK is available, you can specify either two or three subnets\\. The subnets that you specify must be in distinct Availability Zones\\. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify\\. \nClient subnets can't be in Availability Zone us\\-east\\-1e\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ClientSubnets": "The list of subnets to connect to in the client virtual private cloud \\(VPC\\)\\. Amazon creates elastic network interfaces inside these subnets\\. Client applications use elastic network interfaces to produce and consume data\\. \nIf you use the US West \\(N\\. California\\) Region, specify exactly two subnets\\. For other Regions where Amazon MSK is available, you can specify either two or three subnets\\. The subnets that you specify must be in distinct Availability Zones\\. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify\\. \nClient subnets can't occupy the Availability Zone with ID `use1-az3`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ConnectivityInfo": "Information about the cluster's connectivity setting\\. \n*Required*: No \n*Type*: [ConnectivityInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-connectivityinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InstanceType": "The type of Amazon EC2 instances to use for brokers\\. The following instance types are allowed: kafka\\.m5\\.large, kafka\\.m5\\.xlarge, kafka\\.m5\\.2xlarge, kafka\\.m5\\.4xlarge, kafka\\.m5\\.8xlarge, kafka\\.m5\\.12xlarge, kafka\\.m5\\.16xlarge, and kafka\\.m5\\.24xlarge\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InstanceType": "The type of Amazon EC2 instances to use for brokers\\. The following instance types are allowed: kafka\\.m5\\.large, kafka\\.m5\\.xlarge, kafka\\.m5\\.2xlarge, kafka\\.m5\\.4xlarge, kafka\\.m5\\.8xlarge, kafka\\.m5\\.12xlarge, kafka\\.m5\\.16xlarge, kafka\\.m5\\.24xlarge, and kafka\\.t3\\.small\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityGroups": "The security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster\\. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC\\. If you specify security groups that were shared with you, you must ensure that you have permissions to them\\. Specifically, you need the `ec2:DescribeSecurityGroups` permission\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StorageInfo": "Contains information about storage volumes attached to MSK broker nodes\\. \n*Required*: No \n*Type*: [StorageInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-storageinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "StorageInfo": "Contains information about storage volumes attached to Amazon MSK broker nodes\\. \n*Required*: No \n*Type*: [StorageInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-storageinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MSK::Cluster ClientAuthentication": { "Sasl": "Details for ClientAuthentication using SASL\\. \n*Required*: No \n*Type*: [Sasl](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-sasl.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -15992,7 +18266,8 @@ "Revision": "The revision of the Amazon MSK configuration to use\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MSK::Cluster ConnectivityInfo": { - "PublicAccess": "Specifies whether the cluster's brokers are accessible from the internet\\. Public access is off by default\\. \n*Required*: No \n*Type*: [PublicAccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-publicaccess.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "PublicAccess": "Specifies whether the cluster's brokers are accessible from the internet\\. Public access is off by default\\. \n*Required*: No \n*Type*: [PublicAccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-publicaccess.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcConnectivity": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [VpcConnectivity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MSK::Cluster EBSStorageInfo": { "ProvisionedThroughput": "Specifies whether provisioned throughput is turned on and the volume throughput target\\. \n*Required*: No \n*Type*: [ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-provisionedthroughput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -16061,15 +18336,54 @@ "AWS::MSK::Cluster Unauthenticated": { "Enabled": "Unauthenticated is enabled or not\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::MSK::Cluster VpcConnectivity": { + "ClientAuthentication": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [VpcConnectivityClientAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityclientauthentication.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MSK::Cluster VpcConnectivityClientAuthentication": { + "Sasl": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConnectivitySasl](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivitysasl.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tls": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConnectivityTls](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivitytls.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MSK::Cluster VpcConnectivityIam": { + "Enabled": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MSK::Cluster VpcConnectivitySasl": { + "Iam": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConnectivityIam](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityiam.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Scram": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConnectivityScram](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityscram.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MSK::Cluster VpcConnectivityScram": { + "Enabled": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MSK::Cluster VpcConnectivityTls": { + "Enabled": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::MSK::Configuration": { "Description": "The description of the configuration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KafkaVersionsList": "A list of the versions of Apache Kafka with which you can use this MSK configuration\\. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this list\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Name": "The name of the configuration\\. Configuration names are strings that match the regex \"^\\[0\\-9A\\-Za\\-z\\]\\[0\\-9A\\-Za\\-z\\-\\]\\{0,\\}$\"\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the configuration\\. Configuration names are strings that match the regex \"^\\[0\\-9A\\-Za\\-z\\]\\[0\\-9A\\-Za\\-z\\-\\]\\{0,\\}$\"\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ServerProperties": "Contents of the `server.properties` file\\. When using the API, you must ensure that the contents of the file are base64 encoded\\. When using the console, the SDK, or the CLI, the contents of `server.properties` can be in plaintext\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::MSK::ServerlessCluster": { + "ClientAuthentication": "Specifies client authentication information for the serverless cluster\\. \n*Required*: Yes \n*Type*: [ClientAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-clientauthentication.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ClusterName": "The name of the serverless cluster\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "A map of key:value pairs to apply to this serverless cluster\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "VpcConfigs": "VPC configuration information\\. \n*Required*: Yes \n*Type*: List of [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-vpcconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::MSK::ServerlessCluster ClientAuthentication": { + "Sasl": "Details for client authentication using SASL\\. To turn on SASL, you must also turn on `EncryptionInTransit` by setting `inCluster` to true\\. You must set `clientBroker` to either `TLS` or `TLS_PLAINTEXT`\\. If you choose `TLS_PLAINTEXT`, then you must also set `unauthenticated` to true\\. \n*Required*: Yes \n*Type*: [Sasl](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-sasl.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::MSK::ServerlessCluster Iam": { + "Enabled": "SASL/IAM authentication is enabled or not\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::MSK::ServerlessCluster Sasl": { + "Iam": "Details for client authentication using IAM\\. \n*Required*: Yes \n*Type*: [Iam](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-iam.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::MSK::ServerlessCluster VpcConfig": { + "SecurityGroups": "Specifies up to five security groups that control inbound and outbound traffic for the serverless cluster\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SubnetIds": "A list of subnets in at least two different Availability Zones that host your client applications\\. We recommend that you specify a backup subnet in a different Availability Zone for failover in case of an outage\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::MWAA::Environment": { "AirflowConfigurationOptions": "A list of key\\-value pairs containing the Airflow configuration options for your environment\\. For example, `core.default_timezone: utc`\\. To learn more, see [Apache Airflow configuration options](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AirflowVersion": "The version of Apache Airflow to use for the environment\\. If no value is specified, defaults to the latest version\\. Valid values: `2.0.2`, `1.10.12`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AirflowVersion": "The version of Apache Airflow to use for the environment\\. If no value is specified, defaults to the latest version\\. Valid values: `2.0.2`, `1.10.12`, `2.2.2`, and `2.4.3`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DagS3Path": "The relative path to the DAGs folder on your Amazon S3 bucket\\. For example, `dags`\\. To learn more, see [Adding or updating DAGs](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnvironmentClass": "The environment class type\\. Valid values: `mw1.small`, `mw1.medium`, `mw1.large`\\. To learn more, see [Amazon MWAA environment class](https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExecutionRoleArn": "The Amazon Resource Name \\(ARN\\) of the execution role in IAM that allows MWAA to access AWS resources in your environment\\. For example, `arn:aws:iam::123456789:role/my-execution-role`\\. To learn more, see [Amazon MWAA Execution role](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -16083,7 +18397,7 @@ "PluginsS3Path": "The relative path to the `plugins.zip` file on your Amazon S3 bucket\\. For example, `plugins.zip`\\. To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RequirementsS3ObjectVersion": "The version of the requirements\\.txt file on your Amazon S3 bucket\\. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RequirementsS3Path": "The relative path to the `requirements.txt` file on your Amazon S3 bucket\\. For example, `requirements.txt`\\. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Schedulers": "The number of schedulers that you want to run in your environment\\. Valid values: \n+ **v2\\.0\\.2** \\- Accepts between 2 to 5\\. Defaults to 2\\.\n+ **v1\\.10\\.12** \\- Accepts 1\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Schedulers": "The number of schedulers that you want to run in your environment\\. Valid values: \n+ **v2** \\- Accepts between 2 to 5\\. Defaults to 2\\.\n+ **v1** \\- Accepts 1\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourceBucketArn": "The Amazon Resource Name \\(ARN\\) of the Amazon S3 bucket where your DAG code and supporting files are stored\\. For example, `arn:aws:s3:::my-airflow-bucket-unique-name`\\. To learn more, see [Create an Amazon S3 bucket for Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The key\\-value tag pairs associated to your environment\\. For example, `\"Environment\": \"Staging\"`\\. To learn more, see [Tagging](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WebserverAccessMode": "The Apache Airflow *Web server* access mode\\. To learn more, see [Apache Airflow access modes](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html)\\. Valid values: `PRIVATE_ONLY` or `PUBLIC_ONLY`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -16105,31 +18419,53 @@ "SecurityGroupIds": "A list of one or more security group IDs\\. Accepts up to 5 security group IDs\\. A security group must be attached to the same VPC as the subnets\\. To learn more, see [Security in your VPC on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SubnetIds": "A list of subnet IDs\\. **Required** to create an environment\\. Must be private subnets in two different availability zones\\. A subnet must be attached to the same VPC as the security group\\. To learn more, see [About networking on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::Macie::AllowList": { + "Criteria": "The criteria that specify the text or text pattern to ignore\\. The criteria can be the location and name of an Amazon S3 object that lists specific text to ignore \\(`S3WordsList`\\), or a regular expression \\(`Regex`\\) that defines a text pattern to ignore\\. \n*Required*: Yes \n*Type*: [Criteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-allowlist-criteria.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "A custom description of the allow list\\. The description can contain 1\\-512 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "A custom name for the allow list\\. The name can contain 1\\-128 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "An array of key\\-value pairs to apply to the allow list\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Macie::AllowList Criteria": { + "Regex": "The regular expression \\(*regex*\\) that defines the text pattern to ignore\\. The expression can contain 1\\-512 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3WordsList": "The location and name of an Amazon S3 object that lists specific text to ignore\\. \n*Required*: No \n*Type*: [S3WordsList](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-allowlist-s3wordslist.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Macie::AllowList S3WordsList": { + "BucketName": "The full name of the S3 bucket that contains the object\\. This value correlates to the `Name` field of a bucket's properties in Amazon S3\\. \nThis value is case sensitive\\. In addition, don't use wildcard characters or specify partial values for the name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ObjectKey": "The full name of the S3 object\\. This value correlates to the `Key` field of an object's properties in Amazon S3\\. If the name includes a path, include the complete path\\. For example, `AllowLists/Macie/MyList.txt`\\. \nThis value is case sensitive\\. In addition, don't use wildcard characters or specify partial values for the name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Macie::CustomDataIdentifier": { - "Description": "The description of the custom data identifier\\. The description can contain as many as 512 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "IgnoreWords": "An array that lists specific character sequences \\(ignore words\\) to exclude from the results\\. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it\\. The array can contain as many as 10 ignore words\\. Each ignore word can contain 4\\-90 characters\\. Ignore words are case sensitive\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Keywords": "An array that lists specific character sequences \\(keywords\\), one of which must be within proximity \\(`MaximumMatchDistance`\\) of the regular expression to match\\. The array can contain as many as 50 keywords\\. Each keyword can contain 3\\-90 characters\\. Keywords aren't case sensitive\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MaximumMatchDistance": "The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the `Keywords` array\\. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern\\. The distance can be 1\\-300 characters\\. The default value is 50\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Name": "A custom name for the custom data identifier\\. The name can contain as many as 128 characters\\. \nWe strongly recommend that you avoid including any sensitive data in the name of a custom data identifier\\. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Regex": "The regular expression \\(*regex*\\) that defines the pattern to match\\. The expression can contain as many as 512 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Description": "A custom description of the custom data identifier\\. The description can contain 1\\-512 characters\\. \nAvoid including sensitive data in the description\\. Users of the account might be able to see the description, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IgnoreWords": "An array of character sequences \\(*ignore words*\\) to exclude from the results\\. If text matches the regular expression \\(`Regex`\\) but it contains a string in this array, Amazon Macie ignores the text and doesn't include it in the results\\. \nThe array can contain 1\\-10 ignore words\\. Each ignore word can contain 4\\-90 UTF\\-8 characters\\. Ignore words are case sensitive\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Keywords": "An array of character sequences \\(*keywords*\\), one of which must precede and be in proximity \\(`MaximumMatchDistance`\\) of the regular expression \\(`Regex`\\) to match\\. \nThe array can contain 1\\-50 keywords\\. Each keyword can contain 3\\-90 UTF\\-8 characters\\. Keywords aren't case sensitive\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MaximumMatchDistance": "The maximum number of characters that can exist between the end of at least one complete character sequence specified by the `Keywords` array and the end of text that matches the regular expression \\(`Regex`\\)\\. If a complete keyword precedes all the text that matches the regular expression and the keyword is within the specified distance, Amazon Macie includes the result\\. \nThe distance can be 1\\-300 characters\\. The default value is 50\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "A custom name for the custom data identifier\\. The name can contain 1\\-128 characters\\. \nAvoid including sensitive data in the name of a custom data identifier\\. Users of the account might be able to see the name, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Regex": "The regular expression \\(*regex*\\) that defines the text pattern to match\\. The expression can contain 1\\-512 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Macie::FindingsFilter": { - "Action": "The action to perform on findings that meet the filter criteria \\(`FindingCriteria`\\)\\. Valid values are: \n+ ARCHIVE \\- Suppress \\(automatically archive\\) the findings\\.\n+ NOOP \\- Don't perform any action on the findings\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Description": "A custom description of the filter\\. The description can contain as many as 512 characters\\. \nWe strongly recommend that you avoid including any sensitive data in the description of a filter\\. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Action": "The action to perform on findings that match the filter criteria \\(`FindingCriteria`\\)\\. Valid values are: \n+ `ARCHIVE` \\- Suppress \\(automatically archive\\) the findings\\.\n+ `NOOP` \\- Don't perform any action on the findings\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "A custom description of the findings filter\\. The description can contain 1\\-512 characters\\. \nAvoid including sensitive data in the description\\. Users of the account might be able to see the description, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FindingCriteria": "The criteria to use to filter findings\\. \n*Required*: Yes \n*Type*: [FindingCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-findingsfilter-findingcriteria.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "A custom name for the filter\\. The name must contain at least 3 characters and can contain as many as 64 characters\\. \nWe strongly recommend that you avoid including any sensitive data in the name of a filter\\. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Position": "The position of the filter in the list of saved filters on the Amazon Macie console\\. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "A custom name for the findings filter\\. The name can contain 3\\-64 characters\\. \nAvoid including sensitive data in the name\\. Users of the account might be able to see the name, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Position": "The position of the findings filter in the list of saved filters on the Amazon Macie console\\. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Macie::FindingsFilter CriterionAdditionalProperties": { + "eq": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "gt": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "gte": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "lt": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "lte": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "neq": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Macie::FindingsFilter FindingCriteria": { - "Criterion": "Specifies a condition that defines the property, operator, and value to use to filter the results\\. \n*Required*: No \n*Type*: [Criterion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-findingsfilter-criterion.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Criterion": "Specifies a condition that defines the property, operator, and one or more values to use to filter the results\\. \n*Required*: No \n*Type*: Map of [CriterionAdditionalProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-findingsfilter-criterionadditionalproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Macie::FindingsFilter FindingsFilterListItem": { - "Id": "The unique identifier for the filter\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The custom name of the filter\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Id": "The unique identifier for the findings filter\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The custom name of the findings filter\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Macie::Session": { - "FindingPublishingFrequency": "The frequency with which Amazon Macie publishes updates to policy findings for an account\\. This includes publishing updates to AWS Security Hub and Amazon EventBridge \\(formerly called Amazon CloudWatch Events\\)\\. Valid values are: \n+ FIFTEEN\\_MINUTES\n+ ONE\\_HOUR\n+ SIX\\_HOURS\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Status": "The `MacieStatus` of the `Session`\\. Valid values include `ENABLED` and `PAUSED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "FindingPublishingFrequency": "Specifies how often Amazon Macie publishes updates to policy findings for the account\\. This includes publishing updates to AWS Security Hub and Amazon EventBridge \\(formerly Amazon CloudWatch Events\\)\\. Valid values are: \n+ FIFTEEN\\_MINUTES\n+ ONE\\_HOUR\n+ SIX\\_HOURS\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "The status of Amazon Macie for the account\\. Valid values are: `ENABLED`, start or resume all Macie activities for the account; and, `PAUSED`, suspend all Macie activities for the account\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ManagedBlockchain::Member": { "InvitationId": "The unique identifier of the invitation to join the network sent to the account that creates the member\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -16138,7 +18474,7 @@ "NetworkId": "The unique identifier of the network to which the member belongs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ManagedBlockchain::Member ApprovalThresholdPolicy": { - "ProposalDurationInHours": "The duration from the time that a proposal is created until it expires\\. If members cast neither the required number of `YES` votes to approve the proposal nor the number of `NO` votes required to reject it before the duration expires, the proposal is `EXPIRED` and `ProposalActions` are not carried out\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `168` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProposalDurationInHours": "The duration from the time that a proposal is created until it expires\\. If members cast neither the required number of `YES` votes to approve the proposal nor the number of `NO` votes required to reject it before the duration expires, the proposal is `EXPIRED` and `ProposalActions` aren't carried out\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `168` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ThresholdComparator": "Determines whether the vote percentage must be greater than the `ThresholdPercentage` or must be greater than or equal to the `ThreholdPercentage` to be approved\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GREATER_THAN | GREATER_THAN_OR_EQUAL_TO` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ThresholdPercentage": "The percentage of votes among all members that must be `YES` for a proposal to be approved\\. For example, a `ThresholdPercentage` value of `50` indicates 50%\\. The `ThresholdComparator` determines the precise comparison\\. If a `ThresholdPercentage` value of `50` is specified on a network with 10 members, along with a `ThresholdComparator` value of `GREATER_THAN`, this indicates that 6 `YES` votes are required for the proposal to be approved\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -16173,7 +18509,7 @@ }, "AWS::ManagedBlockchain::Node": { "MemberId": "The unique identifier of the member to which the node belongs\\. Applies only to Hyperledger Fabric\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "NetworkId": "The unique identifier of the network for the node\\. \nEthereum public networks have the following `NetworkId`s: \n+ `n-ethereum-mainnet` \n+ `n-ethereum-rinkeby` \n+ `n-ethereum-ropsten` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NetworkId": "The unique identifier of the network for the node\\. \nEthereum public networks have the following `NetworkId`s: \n+ `n-ethereum-mainnet` \n+ `n-ethereum-goerli` \n+ `n-ethereum-rinkeby` \n+ `n-ethereum-ropsten` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NodeConfiguration": "Configuration properties of a peer node\\. \n*Required*: Yes \n*Type*: [NodeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-node-nodeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ManagedBlockchain::Node NodeConfiguration": { @@ -16198,7 +18534,9 @@ "Url": "The URL from the API Gateway proxy that you set up to talk to your key server\\. This parameter is required for SPEKE encryption and is not valid for static key encryption\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaConnect::Flow FailoverConfig": { - "RecoveryWindow": "The size of the buffer \\(delay\\) that the service maintains\\. A larger buffer means a longer delay in transmitting the stream, but more room for error correction\\. A smaller buffer means a shorter delay, but less room for error correction\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailoverMode": "The type of failover you choose for this flow\\. MERGE combines the source streams into a single stream, allowing graceful recovery from any single\\-source loss\\. FAILOVER allows switching between different streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RecoveryWindow": "The size of the buffer \\(delay\\) that the service maintains\\. A larger buffer means a longer delay in transmitting the stream, but more room for error correction\\. A smaller buffer means a shorter delay, but less room for error correction\\. You can choose a value from 100\\-500 ms\\. If you keep this field blank, the service uses the default value of 200 ms\\. This setting only applies when Failover Mode is set to MERGE\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourcePriority": "The priority you want to assign to a source\\. You can have a primary stream and a backup stream or two equally prioritized streams\\. This setting only applies when Failover Mode is set to FAILOVER\\. \n*Required*: No \n*Type*: [SourcePriority](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-sourcepriority.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "State": "The state of source failover on the flow\\. If the state is disabled, the flow can have only one source\\. If the state is enabled, the flow can have one or two sources\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaConnect::Flow Source": { @@ -16211,13 +18549,20 @@ "MaxLatency": "The maximum latency in milliseconds for a RIST or Zixi\\-based source\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MinLatency": "The minimum latency in milliseconds for SRT\\-based streams\\. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection\\. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Protocol": "The protocol that is used by the source\\. For a full list of available protocols, see: [Source protocols](https://docs.aws.amazon.com/mediaconnect/latest/api/v1-flows-flowarn-source.html#v1-flows-flowarn-source-prop-setsourcerequest-protocol) in the *AWS Elemental MediaConnect API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Protocol": "The protocol that is used by the source\\. AWS CloudFormation does not currently support CDI or ST 2110 JPEG XS source protocols\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SenderControlPort": "The port that the flow uses to send outbound requests to initiate connection with the sender\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SenderIpAddress": "The IP address that the flow communicates with to initiate connection with the sender\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourceArn": "The ARN of the source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourceIngestPort": "The port that the flow will be listening on for incoming content\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceListenerAddress": "Source IP or domain name for SRT\\-caller protocol\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceListenerPort": "Source port for SRT\\-caller protocol\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StreamId": "The stream ID that you want to use for the transport\\. This parameter applies only to Zixi\\-based streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcInterfaceName": "The name of the VPC interface that the source content comes from\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WhitelistCidr": "The range of IP addresses that are allowed to contribute content to your source\\. Format the IP addresses as a Classless Inter\\-Domain Routing \\(CIDR\\) block; for example, 10\\.0\\.0\\.0/16\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::MediaConnect::Flow SourcePriority": { + "PrimarySource": "The name of the source you choose as the primary source for this flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::MediaConnect::FlowEntitlement": { "DataTransferSubscriberFeePercent": "The percentage of the entitlement data transfer fee that you want the subscriber to be responsible for\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "A description of the entitlement\\. This description appears only on the MediaConnect console and is not visible outside of the current AWS account\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -16243,15 +18588,15 @@ "Description": "A description of the output\\. This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Destination": "The IP address where you want to send the output\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Encryption": "The encryption credentials that you want to use for the output\\. \n*Required*: No \n*Type*: [Encryption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-encryption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FlowArn": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaxLatency": "The maximum latency in milliseconds for Zixi\\-based streams\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FlowArn": "The Amazon Resource Name \\(ARN\\) of the flow this output is attached to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxLatency": "The maximum latency in milliseconds\\. This parameter applies only to RIST\\-based, Zixi\\-based, and Fujitsu\\-based streams\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MinLatency": "The minimum latency in milliseconds for SRT\\-based streams\\. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection\\. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the VPC interface\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Port": "The port to use when MediaConnect distributes content to the output\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Protocol": "The protocol to use for the output\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RemoteId": "The identifier that is assigned to the Zixi receiver\\. This parameter applies only to outputs that use Zixi pull\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SmoothingLatency": "The smoothing latency in milliseconds for RIST, RTP, and RTP\\-FEC streams\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StreamId": "The stream ID that you want to use for the transport\\. This parameter applies only to Zixi\\-based streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StreamId": "The stream ID that you want to use for this transport\\. This parameter applies only to Zixi and SRT caller\\-based streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcInterfaceAttachment": "The VPC interface that you want to send your output to\\. \n*Required*: No \n*Type*: [VpcInterfaceAttachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowoutput-vpcinterfaceattachment.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaConnect::FlowOutput Encryption": { @@ -16267,13 +18612,13 @@ "Decryption": "The type of encryption that is used on the content ingested from the source\\. \n*Required*: No \n*Type*: [Encryption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flowsource-encryption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description of the source\\. This description is not visible outside of the current AWS account\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EntitlementArn": "The ARN of the entitlement that allows you to subscribe to the flow\\. The entitlement is set by the content originator, and the ARN is generated as part of the originator's flow\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FlowArn": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FlowArn": "The Amazon Resource Name \\(ARN\\) of the flow this source is connected to\\. The flow must have Failover enabled to add an additional source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IngestPort": "The port that the flow listens on for incoming content\\. If the protocol of the source is Zixi, the port must be set to 2088\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxBitrate": "The maximum bitrate for RIST, RTP, and RTP\\-FEC streams\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxLatency": "The maximum latency in milliseconds\\. This parameter applies only to RIST\\-based, Zixi\\-based, and Fujitsu\\-based streams\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the source\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Protocol": "The protocol that the source uses to deliver the content to MediaConnect\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StreamId": "The stream ID that you want to use for the transport\\. This parameter applies only to Zixi\\-based streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Protocol": "The protocol that the source uses to deliver the content to MediaConnect\\. Adding additional sources to an existing flow requires Failover to be enabled\\. When you enable Failover, the additional source must use the same protocol as the existing source\\. Only the following protocols support failover: Zixi\\-push, RTP\\-FEC, RTP, and RIST\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StreamId": "The stream ID that you want to use for this transport\\. This parameter applies only to Zixi and SRT caller\\-based streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcInterfaceName": "The name of the VPC interface that you want to send your output to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WhitelistCidr": "The range of IP addresses that are allowed to contribute content to your source\\. Format the IP addresses as a Classless Inter\\-Domain Routing \\(CIDR\\) block; for example, 10\\.0\\.0\\.0/16\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -16829,7 +19174,7 @@ "Mode": "If \"vod,\" all segments are indexed and kept permanently in the destination and manifest\\. If \"live,\" only the number segments specified in keepSegments and indexNSegments are kept\\. Newer segments replace older segments, which might prevent players from rewinding all the way to the beginning of the channel\\. VOD mode uses HLS EXT\\-X\\-PLAYLIST\\-TYPE of EVENT while the channel is running, converting it to a \"VOD\" type manifest on completion of the stream\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OutputSelection": "MANIFESTSANDSEGMENTS: Generates manifests \\(the master manifest, if applicable, and media manifests\\) for this output group\\. SEGMENTSONLY: Doesn't generate any manifests for this output group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ProgramDateTime": "Includes or excludes the EXT\\-X\\-PROGRAM\\-DATE\\-TIME tag in \\.m3u8 manifest files\\. The value is calculated as follows: Either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ProgramDateTimeClock": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProgramDateTimeClock": "Specifies the algorithm used to drive the HLS EXT\\-X\\-PROGRAM\\-DATE\\-TIME clock\\. Options include: INITIALIZE\\_FROM\\_OUTPUT\\_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment\\. SYSTEM\\_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment\\. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ProgramDateTimePeriod": "The period of insertion of the EXT\\-X\\-PROGRAM\\-DATE\\-TIME entry, in seconds\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RedundantManifest": "ENABLED: The master manifest \\(\\.m3u8 file\\) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline\\. This feature allows a playout device that supports stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale\\. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines\\. DISABLED: The master manifest \\(\\.m3u8 file\\) for each pipeline includes information about its own pipeline only\\. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed\\. MediaPackage regenerates the manifests it serves to players, so a redundant manifest from MediaLive is irrelevant\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SegmentLength": "The length of the MPEG\\-2 Transport Stream segments to create, in seconds\\. Note that segments will end on the next keyframe after this number of seconds, so the actual segment length might be longer\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -16910,7 +19255,7 @@ "FilterStrength": "Adjusts the magnitude of filtering from 1 \\(minimal\\) to 5 \\(strongest\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InputFilter": "Turns on the filter for this input\\. MPEG\\-2 inputs have the deblocking filter enabled by default\\. 1\\) auto \\- filtering is applied depending on input type/quality 2\\) disabled \\- no filtering is applied to the input 3\\) forced \\- filtering is applied regardless of the input type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NetworkInputSettings": "Information about how to connect to the upstream system\\. \n*Required*: No \n*Type*: [NetworkInputSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-networkinputsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Scte35Pid": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Scte35Pid": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Smpte2038DataPreference": "Specifies whether to extract applicable ancillary data from a SMPTE\\-2038 source in this input\\. Applicable data types are captions, timecode, AFD, and SCTE\\-104 messages\\. \\- PREFER: Extract from SMPTE\\-2038 if present in this input, otherwise extract from another source \\(if any\\)\\. \\- IGNORE: Never extract any ancillary data from SMPTE\\-2038\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourceEndBehavior": "The loop input if it is a file\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VideoSelector": "Information about one video to extract from the input\\. \n*Required*: No \n*Type*: [VideoSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-videoselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -17301,8 +19646,8 @@ "Id": "Unique identifier that you assign to the asset\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PackagingGroupId": "The ID of the packaging group associated with this asset\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResourceId": "Unique identifier for this asset, as it's configured in the key provider service\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SourceArn": "The ARN for the source content in Amazon S3\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SourceRoleArn": "The ARN for the IAM role that provides AWS Elemental MediaPackage access to the Amazon S3 bucket where the source content is stored\\. Valid format: arn:aws:iam::\\{accountID\\}:role/\\{name\\} \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceArn": "The ARN for the source content in Amazon S3\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceRoleArn": "The ARN for the IAM role that provides AWS Elemental MediaPackage access to the Amazon S3 bucket where the source content is stored\\. Valid format: arn:aws:iam::\\{accountID\\}:role/\\{name\\} \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags to assign to the asset\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::Asset EgressEndpoint": { @@ -17311,17 +19656,27 @@ }, "AWS::MediaPackage::Channel": { "Description": "Any descriptive information that you want to add to the channel for future identification purposes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EgressAccessLogs": "Configures egress access logs\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EgressAccessLogs": "Configures egress access logs\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HlsIngest": "Property description not available\\. \n*Required*: No \n*Type*: [HlsIngest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-hlsingest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Id": "Unique identifier that you assign to the channel\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "IngressAccessLogs": "Configures ingress access logs\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IngressAccessLogs": "Configures ingress access logs\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags to assign to the channel\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::MediaPackage::Channel HlsIngest": { + "ingestEndpoints": "Property description not available\\. \n*Required*: No \n*Type*: List of [IngestEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-ingestendpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MediaPackage::Channel IngestEndpoint": { + "Id": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Password": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Url": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Username": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::MediaPackage::Channel LogConfiguration": { - "LogGroupName": "Sets a custom Amazon CloudWatch log group name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "LogGroupName": "Sets a custom Amazon CloudWatch log group name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::OriginEndpoint": { "Authorization": "Parameters for CDN authorization\\. \n*Required*: No \n*Type*: [Authorization](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-authorization.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ChannelId": "The ID of the channel associated with this endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ChannelId": "The ID of the channel associated with this endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CmafPackage": "Parameters for Common Media Application Format \\(CMAF\\) packaging\\. \n*Required*: No \n*Type*: [CmafPackage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-cmafpackage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DashPackage": "Parameters for DASH packaging\\. \n*Required*: No \n*Type*: [DashPackage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashpackage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "Any descriptive information that you want to add to the endpoint for future identification purposes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -17329,19 +19684,20 @@ "Id": "The manifest ID is required and must be unique within the OriginEndpoint\\. The ID can't be changed after the endpoint is created\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ManifestName": "A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MssPackage": "Parameters for Microsoft Smooth Streaming packaging\\. \n*Required*: No \n*Type*: [MssPackage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-msspackage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Origination": "Controls video origination from this endpoint\\. \n+ **ALLOW** \\- enables this endpoint to serve content to requesting devices\\.\n+ **DENY** \\- prevents this endpoint from serving content\\. Denying origination is helpful for harvesting live\\-to\\-VOD assets\\. For more information about harvesting and origination, see [Live\\-to\\-VOD Requirements](https://docs.aws.amazon.com/mediapackage/latest/ug/ltov-reqmts.html)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StartoverWindowSeconds": "Maximum duration \\(seconds\\) of content to retain for startover playback\\. Omit this attribute or enter `0` to indicate that startover playback is disabled for this endpoint\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Origination": "Controls video origination from this endpoint\\. \nValid values: \n+ **ALLOW** \\- enables this endpoint to serve content to requesting devices\\.\n+ **DENY** \\- prevents this endpoint from serving content\\. Denying origination is helpful for harvesting live\\-to\\-VOD assets\\. For more information about harvesting and origination, see [Live\\-to\\-VOD Requirements](https://docs.aws.amazon.com/mediapackage/latest/ug/ltov-reqmts.html)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartoverWindowSeconds": "Maximum duration \\(seconds\\) of content to retain for startover playback\\. Omit this attribute or enter `0` to indicate that startover playback is disabled for this endpoint\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags to assign to the endpoint\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TimeDelaySeconds": "Minimum duration \\(seconds\\) of delay to enforce on the playback of live content\\. Omit this attribute or enter `0` to indicate that there is no time delay in effect for this endpoint \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TimeDelaySeconds": "Minimum duration \\(seconds\\) of delay to enforce on the playback of live content\\. Omit this attribute or enter `0` to indicate that there is no time delay in effect for this endpoint\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Whitelist": "The IP addresses that can access this endpoint\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::OriginEndpoint Authorization": { - "CdnIdentifierSecret": "The Amazon Resource Name \\(ARN\\) for the secret in AWS Secrets Manager that your Content Distribution Network \\(CDN\\) uses for authorization to access your endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsRoleArn": "The Amazon Resource Name \\(ARN\\) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CdnIdentifierSecret": "The Amazon Resource Name \\(ARN\\) for the secret in AWS Secrets Manager that your Content Delivery Network \\(CDN\\) uses for authorization to access your endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretsRoleArn": "The Amazon Resource Name \\(ARN\\) for the IAM role that allows AWS Elemental MediaPackage to communicate with AWS Secrets Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::OriginEndpoint CmafEncryption": { - "ConstantInitializationVector": "An optional 128\\-bit, 16\\-byte hex value represented by a 32\\-character string, used in conjunction with the key for encrypting blocks\\. If you don't specify a value, then MediaPackage creates the constant initialization vector \\(IV\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KeyRotationIntervalSeconds": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConstantInitializationVector": "An optional 128\\-bit, 16\\-byte hex value represented by a 32\\-character string, used in conjunction with the key for encrypting blocks\\. If you don't specify a value, then AWS Elemental MediaPackage creates the constant initialization vector \\(IV\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EncryptionMethod": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KeyRotationIntervalSeconds": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SpekeKeyProvider": "Parameters for the SPEKE key provider\\. \n*Required*: Yes \n*Type*: [SpekeKeyProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-spekekeyprovider.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::OriginEndpoint CmafPackage": { @@ -17349,40 +19705,45 @@ "HlsManifests": "A list of HLS manifest configurations that are available from this endpoint\\. \n*Required*: No \n*Type*: List of [HlsManifest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsmanifest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SegmentDurationSeconds": "Duration \\(in seconds\\) of each segment\\. Actual segments are rounded to the nearest multiple of the source segment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SegmentPrefix": "An optional custom string that is prepended to the name of each segment\\. If not specified, the segment prefix defaults to the ChannelId\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StreamSelection": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "StreamSelection": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::OriginEndpoint DashEncryption": { - "KeyRotationIntervalSeconds": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KeyRotationIntervalSeconds": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SpekeKeyProvider": "Parameters for the SPEKE key provider\\. \n*Required*: Yes \n*Type*: [SpekeKeyProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-spekekeyprovider.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::OriginEndpoint DashPackage": { - "AdTriggers": "Specifies the SCTE\\-35 message types that MediaPackage treats as ad markers in the output manifest\\. \n Valid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **PROVIDER\\_ADVERTISEMENT**\\.\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **SPLICE\\_INSERT**\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AdsOnDeliveryRestrictions": "The flags on SCTE\\-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdTriggers": "Specifies the SCTE\\-35 message types that AWS Elemental MediaPackage treats as ad markers in the output manifest\\. \nValid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **PROVIDER\\_ADVERTISEMENT**\\.\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **SPLICE\\_INSERT**\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdsOnDeliveryRestrictions": "The flags on SCTE\\-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in AWS Elemental MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Encryption": "Parameters for encrypting content\\. \n*Required*: No \n*Type*: [DashEncryption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-dashencryption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ManifestLayout": "Determines the position of some tags in the manifest\\. \nOptions: \n+ **FULL** \\- elements like `SegmentTemplate` and `ContentProtection` are included in each `Representation`\\.\n+ **COMPACT** \\- duplicate elements are combined and presented at the `AdaptationSet` level\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeIframeOnlyStream": "This applies only to stream sets with a single video track\\. When true, the stream set includes an additional I\\-frame trick\\-play only stream, along with the other tracks\\. If false, this extra stream is not included\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ManifestLayout": "Determines the position of some tags in the manifest\\. \nValid values: \n+ **FULL** \\- Elements like `SegmentTemplate` and `ContentProtection` are included in each `Representation`\\.\n+ **COMPACT** \\- Duplicate elements are combined and presented at the `AdaptationSet` level\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ManifestWindowSeconds": "Time window \\(in seconds\\) contained in each manifest\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MinBufferTimeSeconds": "Minimum amount of content \\(measured in seconds\\) that a player must keep available in the buffer\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MinUpdatePeriodSeconds": "Minimum amount of time \\(in seconds\\) that the player should wait before requesting updates to the manifest\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PeriodTriggers": "Controls whether MediaPackage produces single\\-period or multi\\-period DASH manifests\\. For more information about periods, see [Multi\\-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html)\\. \nValid values: \n+ **ADS** \\- MediaPackage will produce multi\\-period DASH manifests\\. Periods are created based on the SCTE\\-35 ad markers present in the input manifest\\.\n+ *No value* \\- MediaPackage will produce single\\-period DASH manifests\\. This is the default setting\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Profile": "DASH profile for the output, such as HbbTV\\. \nValid values: \n+ **NONE** \\- the output doesn't use a DASH profile\\.\n+ **HBBTV\\_1\\_5** \\- the output is HbbTV\\-compliant\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SegmentDurationSeconds": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SegmentTemplateFormat": "Determines the type of variable used in the `media` URL of the `SegmentTemplate` tag in the manifest\\. Also specifies if segment timeline information is included in `SegmentTimeline` or `SegmentTemplate`\\. \n+ **NUMBER\\_WITH\\_TIMELINE** \\- The `$Number$` variable is used in the `media` URL\\. The value of this variable is the sequential number of the segment\\. A full `SegmentTimeline` object is presented in each `SegmentTemplate`\\.\n+ **NUMBER\\_WITH\\_DURATION** \\- The `$Number$` variable is used in the `media` URL and a `duration` attribute is added to the segment template\\. The `SegmentTimeline` object is removed from the representation\\.\n+ **TIME\\_WITH\\_TIMELINE** \\- The `$Time$` variable is used in the `media` URL\\. The value of this variable is the timestamp of when the segment starts\\. A full `SegmentTimeline` object is presented in each `SegmentTemplate`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PeriodTriggers": "Controls whether AWS Elemental MediaPackage produces single\\-period or multi\\-period DASH manifests\\. For more information about periods, see [Multi\\-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html)\\. \nValid values: \n+ **ADS** \\- AWS Elemental MediaPackage will produce multi\\-period DASH manifests\\. Periods are created based on the SCTE\\-35 ad markers present in the input manifest\\.\n+ *No value* \\- AWS Elemental MediaPackage will produce single\\-period DASH manifests\\. This is the default setting\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Profile": "The DASH profile for the output\\. \nValid values: \n+ **NONE** \\- The output doesn't use a DASH profile\\.\n+ **HBBTV\\_1\\_5** \\- The output is compliant with HbbTV v1\\.5\\.\n+ **DVB\\_DASH\\_2014** \\- The output is compliant with DVB\\-DASH 2014\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SegmentDurationSeconds": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SegmentTemplateFormat": "Determines the type of variable used in the `media` URL of the `SegmentTemplate` tag in the manifest\\. Also specifies if segment timeline information is included in `SegmentTimeline` or `SegmentTemplate`\\. \nValid values: \n+ **NUMBER\\_WITH\\_TIMELINE** \\- The `$Number$` variable is used in the `media` URL\\. The value of this variable is the sequential number of the segment\\. A full `SegmentTimeline` object is presented in each `SegmentTemplate`\\.\n+ **NUMBER\\_WITH\\_DURATION** \\- The `$Number$` variable is used in the `media` URL and a `duration` attribute is added to the segment template\\. The `SegmentTimeline` object is removed from the representation\\.\n+ **TIME\\_WITH\\_TIMELINE** \\- The `$Time$` variable is used in the `media` URL\\. The value of this variable is the timestamp of when the segment starts\\. A full `SegmentTimeline` object is presented in each `SegmentTemplate`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StreamSelection": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SuggestedPresentationDelaySeconds": "Amount of time \\(in seconds\\) that the player should be from the live point at the end of the manifest\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UtcTiming": "Determines the type of UTC timing included in the DASH Media Presentation Description \\(MPD\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UtcTimingUri": "Specifies the value attribute of the UTC timing field when utcTiming is set to HTTP\\-ISO or HTTP\\-HEAD\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "UtcTiming": "Determines the type of UTC timing included in the DASH Media Presentation Description \\(MPD\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UtcTimingUri": "Specifies the value attribute of the UTC timing field when utcTiming is set to HTTP\\-ISO or HTTP\\-HEAD\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MediaPackage::OriginEndpoint EncryptionContractConfiguration": { + "PresetSpeke20Audio": "A collection of audio encryption presets\\. \nValue description: \n+ `PRESET-AUDIO-1` \\- Use one content key to encrypt all of the audio tracks in your stream\\.\n+ `PRESET-AUDIO-2` \\- Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks\\.\n+ `PRESET-AUDIO-3` \\- Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels\\.\n+ `SHARED` \\- Use the same content key for all of the audio and video tracks in your stream\\.\n+ `UNENCRYPTED` \\- Don't encrypt any of the audio tracks in your stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PresetSpeke20Video": "A collection of video encryption presets\\. \nValue description: \n+ `PRESET-VIDEO-1` \\- Use one content key to encrypt all of the video tracks in your stream\\.\n+ `PRESET-VIDEO-2` \\- Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks\\.\n+ `PRESET-VIDEO-3` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-4` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `PRESET-VIDEO-5` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `PRESET-VIDEO-6` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-7` \\- Use one content key to encrypt all of the SD\\+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-8` \\- Use one content key to encrypt all of the SD\\+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `SHARED` \\- Use the same content key for all of the video and audio tracks in your stream\\.\n+ `UNENCRYPTED` \\- Don't encrypt any of the video tracks in your stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::OriginEndpoint HlsEncryption": { "ConstantInitializationVector": "A 128\\-bit, 16\\-byte hex value represented by a 32\\-character string, used with the key for encrypting blocks\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EncryptionMethod": "HLS encryption type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KeyRotationIntervalSeconds": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RepeatExtXKey": "Repeat the `EXT-X-KEY `directive for every media segment\\. This might result in an increase in client requests to the DRM server\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EncryptionMethod": "HLS encryption type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KeyRotationIntervalSeconds": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RepeatExtXKey": "Repeat the `EXT-X-KEY `directive for every media segment\\. This might result in an increase in client requests to the DRM server\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SpekeKeyProvider": "Parameters for the SPEKE key provider\\. \n*Required*: Yes \n*Type*: [SpekeKeyProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-spekekeyprovider.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::OriginEndpoint HlsManifest": { - "AdMarkers": "Controls how ad markers are included in the packaged endpoint\\. Valid values are `none`, `passthrough`, or `scte35_enhanced`\\. \n+ **NONE** \\- omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AdTriggers": "Specifies the SCTE\\-35 message types that MediaPackage treats as ad markers in the output manifest\\. \nValid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_ADVERTISEMENT**\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\n+ **SPLICE\\_INSERT**\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AdsOnDeliveryRestrictions": "The flags on SCTE\\-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdMarkers": "Controls how ad markers are included in the packaged endpoint\\. \nValid values: \n+ **NONE** \\- Omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- Creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- Generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdTriggers": "Specifies the SCTE\\-35 message types that AWS Elemental MediaPackage treats as ad markers in the output manifest\\. \nValid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_ADVERTISEMENT**\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\n+ **SPLICE\\_INSERT**\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdsOnDeliveryRestrictions": "The flags on SCTE\\-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in AWS Elemental MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Id": "The manifest ID is required and must be unique within the OriginEndpoint\\. The ID can't be changed after the endpoint is created\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeIframeOnlyStream": "Applies to stream sets with a single video track only\\. When true, the stream set includes an additional I\\-frame only stream, along with the other tracks\\. If false, this extra stream is not included\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ManifestName": "A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint\\. The manifestName on the HLSManifest object overrides the manifestName that you provided on the originEndpoint object\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -17392,15 +19753,16 @@ "Url": "The URL that's used to request this manifest from this endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::OriginEndpoint HlsPackage": { - "AdMarkers": "Controls how ad markers are included in the packaged endpoint\\. Valid values are `none`, `passthrough`, or `scte35_enhanced`\\. \n+ **NONE** \\- omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AdTriggers": "Specifies the SCTE\\-35 message types that MediaPackage treats as ad markers in the output manifest\\. \n Valid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_ADVERTISEMENT**\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\n+ **SPLICE\\_INSERT**\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AdsOnDeliveryRestrictions": "The flags on SCTE\\-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdMarkers": "Controls how ad markers are included in the packaged endpoint\\. \nValid values: \n+ **NONE** \\- Omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- Creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- Generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdTriggers": "Specifies the SCTE\\-35 message types that AWS Elemental MediaPackage treats as ad markers in the output manifest\\. \nValid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_ADVERTISEMENT**\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\n+ **SPLICE\\_INSERT**\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdsOnDeliveryRestrictions": "The flags on SCTE\\-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in AWS Elemental MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Encryption": "Parameters for encrypting content\\. \n*Required*: No \n*Type*: [HlsEncryption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-hlsencryption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IncludeIframeOnlyStream": "Only applies to stream sets with a single video track\\. When true, the stream set includes an additional I\\-frame only stream, along with the other tracks\\. If false, this extra stream is not included\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeDvbSubtitles": "When enabled, MediaPackage passes through digital video broadcasting \\(DVB\\) subtitles into the output\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeIframeOnlyStream": "Only applies to stream sets with a single video track\\. When true, the stream set includes an additional I\\-frame only stream, along with the other tracks\\. If false, this extra stream is not included\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PlaylistType": "When specified as either `event` or `vod`, a corresponding `EXT-X-PLAYLIST-TYPE` entry is included in the media playlist\\. Indicates if the playlist is live\\-to\\-VOD content\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PlaylistWindowSeconds": "Time window \\(in seconds\\) contained in each parent manifest\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ProgramDateTimeIntervalSeconds": "Inserts `EXT-X-PROGRAM-DATE-TIME` tags in the output manifest at the interval that you specify\\. Additionally, ID3Timed metadata messages are generated every 5 seconds starting when the content was ingested\\. \nIrrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output\\. \nOmit this attribute or enter `0` to indicate that the `EXT-X-PROGRAM-DATE-TIME` tags are not included in the manifest\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SegmentDurationSeconds": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SegmentDurationSeconds": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StreamSelection": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UseAudioRenditionGroup": "When true, AWS Elemental MediaPackage bundles all audio tracks in a rendition group\\. All other tracks in the stream can be used with any audio rendition from the group\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -17411,13 +19773,14 @@ "Encryption": "Parameters for encrypting content\\. \n*Required*: No \n*Type*: [MssEncryption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-mssencryption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ManifestWindowSeconds": "Time window \\(in seconds\\) contained in each manifest\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SegmentDurationSeconds": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StreamSelection": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "StreamSelection": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::OriginEndpoint SpekeKeyProvider": { - "CertificateArn": "The Amazon Resource Name \\(ARN\\) for the certificate that you imported to AWS Certificate Manager to add content key encryption to this endpoint\\. For this feature to work, your DRM key provider must support content key encryption\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResourceId": "Unique identifier for this endpoint, as it is configured in the key provider service\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CertificateArn": "The Amazon Resource Name \\(ARN\\) for the certificate that you imported to AWS Certificate Manager to add content key encryption to this endpoint\\. For this feature to work, your DRM key provider must support content key encryption\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EncryptionContractConfiguration": "Use `encryptionContractConfiguration` to configure one or more content encryption keys for your endpoints that use SPEKE Version 2\\.0\\. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream\\. To configure the encryption contract, specify which audio and video encryption presets to use\\. \n*Required*: No \n*Type*: [EncryptionContractConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-encryptioncontractconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceId": "Unique identifier for this endpoint, as it is configured in the key provider service\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The ARN for the IAM role that's granted by the key provider to provide access to the key provider API\\. This role must have a trust policy that allows AWS Elemental MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL\\. Valid format: arn:aws:iam::\\{accountID\\}:role/\\{name\\} \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SystemIds": "List of unique identifiers for the DRM systems to use, as defined in the CPIX specification\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SystemIds": "List of unique identifiers for the DRM systems to use, as defined in the CPIX specification\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Url": "URL for the key provider\u2019s key retrieval API endpoint\\. Must start with https://\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::OriginEndpoint StreamSelection": { @@ -17430,7 +19793,7 @@ "DashPackage": "Parameters for DASH\\-ISO packaging\\. \n*Required*: No \n*Type*: [DashPackage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashpackage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HlsPackage": "Parameters for Apple HLS packaging\\. \n*Required*: No \n*Type*: [HlsPackage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlspackage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Id": "Unique identifier that you assign to the packaging configuration\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MssPackage": "Parameters for Microsoft Smooth Streaming packaging\\. \n*Required*: No \n*Type*: [MssPackage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-msspackage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MssPackage": "Parameters for Microsoft Smooth Streaming packaging\\. \n*Required*: No \n*Type*: [MssPackage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-msspackage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PackagingGroupId": "The ID of the packaging group associated with this packaging configuration\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags to assign to the packaging configuration\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -17440,7 +19803,7 @@ "AWS::MediaPackage::PackagingConfiguration CmafPackage": { "Encryption": "Parameters for encrypting content\\. \n*Required*: No \n*Type*: [CmafEncryption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-cmafencryption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HlsManifests": "A list of HLS manifest configurations that are available from this endpoint\\. \n*Required*: Yes \n*Type*: List of [HlsManifest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IncludeEncoderConfigurationInSegments": "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set \\(SPS\\), Picture Parameter Set \\(PPS\\), and Video Parameter Set \\(VPS\\) metadata in every video segment instead of in the init fragment\\. This lets you use different SPS/PPS/VPS settings for your assets during content playback\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeEncoderConfigurationInSegments": "When includeEncoderConfigurationInSegments is set to true, AWS Elemental MediaPackage places your encoder's Sequence Parameter Set \\(SPS\\), Picture Parameter Set \\(PPS\\), and Video Parameter Set \\(VPS\\) metadata in every video segment instead of in the init fragment\\. This lets you use different SPS/PPS/VPS settings for your assets during content playback\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SegmentDurationSeconds": "Duration \\(in seconds\\) of each segment\\. Actual segments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::PackagingConfiguration DashEncryption": { @@ -17451,23 +19814,29 @@ "ManifestName": "A short string that's appended to the end of the endpoint URL to create a unique path to this packaging configuration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MinBufferTimeSeconds": "Minimum amount of content \\(measured in seconds\\) that a player must keep available in the buffer\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Profile": "The DASH profile type\\. When set to **HBBTV\\_1\\_5**, the content is compliant with HbbTV 1\\.5\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StreamSelection": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ScteMarkersSource": "The source of scte markers used\\. \nValue description: \n+ `SEGMENTS` \\- The scte markers are sourced from the segments of the ingested content\\.\n+ `MANIFEST` \\- the scte markers are sourced from the manifest of the ingested content\\. The MANIFEST value is compatible with source HLS playlists using the SCTE\\-35 Enhanced syntax \\(`EXT-OATCLS-SCTE35` tags\\)\\. SCTE\\-35 Elemental and SCTE\\-35 Daterange syntaxes are not supported with this option\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StreamSelection": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::PackagingConfiguration DashPackage": { "DashManifests": "A list of DASH manifest configurations that are available from this endpoint\\. \n*Required*: Yes \n*Type*: List of [DashManifest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashmanifest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Encryption": "Parameters for encrypting content\\. \n*Required*: No \n*Type*: [DashEncryption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-dashencryption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IncludeEncoderConfigurationInSegments": "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set \\(SPS\\), Picture Parameter Set \\(PPS\\), and Video Parameter Set \\(VPS\\) metadata in every video segment instead of in the init fragment\\. This lets you use different SPS/PPS/VPS settings for your assets during content playback\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PeriodTriggers": "Controls whether MediaPackage produces single\\-period or multi\\-period DASH manifests\\. For more information about periods, see [Multi\\-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html)\\. \nValid values: \n+ **ADS** \\- MediaPackage will produce multi\\-period DASH manifests\\. Periods are created based on the SCTE\\-35 ad markers present in the input manifest\\.\n+ *No value* \\- MediaPackage will produce single\\-period DASH manifests\\. This is the default setting\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeEncoderConfigurationInSegments": "When includeEncoderConfigurationInSegments is set to true, AWS Elemental MediaPackage places your encoder's Sequence Parameter Set \\(SPS\\), Picture Parameter Set \\(PPS\\), and Video Parameter Set \\(VPS\\) metadata in every video segment instead of in the init fragment\\. This lets you use different SPS/PPS/VPS settings for your assets during content playback\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeIframeOnlyStream": "This applies only to stream sets with a single video track\\. When true, the stream set includes an additional I\\-frame trick\\-play only stream, along with the other tracks\\. If false, this extra stream is not included\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PeriodTriggers": "Controls whether AWS Elemental MediaPackage produces single\\-period or multi\\-period DASH manifests\\. For more information about periods, see [Multi\\-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html)\\. \nValid values: \n+ **ADS** \\- AWS Elemental MediaPackage will produce multi\\-period DASH manifests\\. Periods are created based on the SCTE\\-35 ad markers present in the input manifest\\.\n+ *No value* \\- AWS Elemental MediaPackage will produce single\\-period DASH manifests\\. This is the default setting\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SegmentDurationSeconds": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source segment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SegmentTemplateFormat": "Determines the type of SegmentTemplate included in the Media Presentation Description \\(MPD\\)\\. When set to **NUMBER\\_WITH\\_TIMELINE**, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs\\. When set to **TIME\\_WITH\\_TIMELINE**, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs\\. When set to **NUMBER\\_WITH\\_DURATION**, only a duration is included in each SegmentTemplate, with $Number$ media URLs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::MediaPackage::PackagingConfiguration EncryptionContractConfiguration": { + "PresetSpeke20Audio": "A collection of audio encryption presets\\. \nValue description: \n+ `PRESET-AUDIO-1` \\- Use one content key to encrypt all of the audio tracks in your stream\\.\n+ `PRESET-AUDIO-2` \\- Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks\\.\n+ `PRESET-AUDIO-3` \\- Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels\\.\n+ `SHARED` \\- Use the same content key for all of the audio and video tracks in your stream\\.\n+ `UNENCRYPTED` \\- Don't encrypt any of the audio tracks in your stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PresetSpeke20Video": "A collection of video encryption presets\\. \nValue description: \n+ `PRESET-VIDEO-1` \\- Use one content key to encrypt all of the video tracks in your stream\\.\n+ `PRESET-VIDEO-2` \\- Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks\\.\n+ `PRESET-VIDEO-3` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-4` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `PRESET-VIDEO-5` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `PRESET-VIDEO-6` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-7` \\- Use one content key to encrypt all of the SD\\+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-8` \\- Use one content key to encrypt all of the SD\\+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `SHARED` \\- Use the same content key for all of the video and audio tracks in your stream\\.\n+ `UNENCRYPTED` \\- Don't encrypt any of the video tracks in your stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::MediaPackage::PackagingConfiguration HlsEncryption": { - "ConstantInitializationVector": "A 128\\-bit, 16\\-byte hex value represented by a 32\\-character string, used with the key for encrypting blocks\\. If you don't specify a constant initialization vector \\(IV\\), MediaPackage periodically rotates the IV\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EncryptionMethod": "HLS encryption type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConstantInitializationVector": "A 128\\-bit, 16\\-byte hex value represented by a 32\\-character string, used with the key for encrypting blocks\\. If you don't specify a constant initialization vector \\(IV\\), AWS Elemental MediaPackage periodically rotates the IV\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EncryptionMethod": "HLS encryption type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SpekeKeyProvider": "Parameters for the SPEKE key provider\\. \n*Required*: Yes \n*Type*: [SpekeKeyProvider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-spekekeyprovider.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::PackagingConfiguration HlsManifest": { - "AdMarkers": "This setting controls ad markers in the packaged content\\. **NONE** omits SCTE\\-35 ad markers from the output\\. **PASSTHROUGH** copies SCTE\\-35 ad markers from the source content to the output\\. **SCTE35\\_ENHANCED** generates ad markers and blackout tags in the output, based on SCTE\\-35 messages in the source content\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdMarkers": "This setting controls ad markers in the packaged content\\. \nValid values: \n+ **NONE** \\- Omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- Creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- Generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeIframeOnlyStream": "Applies to stream sets with a single video track only\\. When enabled, the output includes an additional I\\-frame only stream, along with the other tracks\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ManifestName": "A short string that's appended to the end of the endpoint URL to create a unique path to this packaging configuration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ProgramDateTimeIntervalSeconds": "Inserts `EXT-X-PROGRAM-DATE-TIME` tags in the output manifest at the interval that you specify\\. Additionally, ID3Timed metadata messages are generated every 5 seconds starting when the content was ingested\\. \nIrrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output\\. \nOmit this attribute or enter `0` to indicate that the `EXT-X-PROGRAM-DATE-TIME` tags are not included in the manifest\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -17477,6 +19846,7 @@ "AWS::MediaPackage::PackagingConfiguration HlsPackage": { "Encryption": "Parameters for encrypting content\\. \n*Required*: No \n*Type*: [HlsEncryption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsencryption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HlsManifests": "A list of HLS manifest configurations that are available from this endpoint\\. \n*Required*: Yes \n*Type*: List of [HlsManifest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-hlsmanifest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludeDvbSubtitles": "When enabled, MediaPackage passes through digital video broadcasting \\(DVB\\) subtitles into the output\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SegmentDurationSeconds": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UseAudioRenditionGroup": "When true, AWS Elemental MediaPackage bundles all audio tracks in a rendition group\\. All other tracks in the stream can be used with any audio rendition from the group\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -17490,16 +19860,17 @@ "AWS::MediaPackage::PackagingConfiguration MssPackage": { "Encryption": "Parameters for encrypting content\\. \n*Required*: No \n*Type*: [MssEncryption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-mssencryption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MssManifests": "A list of Microsoft Smooth manifest configurations that are available from this endpoint\\. \n*Required*: Yes \n*Type*: List of [MssManifest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-mssmanifest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SegmentDurationSeconds": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SegmentDurationSeconds": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::PackagingConfiguration SpekeKeyProvider": { + "EncryptionContractConfiguration": "Use `encryptionContractConfiguration` to configure one or more content encryption keys for your endpoints that use SPEKE Version 2\\.0\\. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream\\. To configure the encryption contract, specify which audio and video encryption presets to use\\. \n*Required*: No \n*Type*: [EncryptionContractConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-encryptioncontractconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The ARN for the IAM role that's granted by the key provider to provide access to the key provider API\\. Valid format: arn:aws:iam::\\{accountID\\}:role/\\{name\\} \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SystemIds": "List of unique identifiers for the DRM systems to use, as defined in the CPIX specification\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SystemIds": "List of unique identifiers for the DRM systems to use, as defined in the CPIX specification\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Url": "URL for the key provider's key retrieval API endpoint\\. Must start with https://\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::PackagingConfiguration StreamSelection": { - "MaxVideoBitsPerSecond": "The upper limit of the bitrates that this endpoint serves\\. If the video track exceeds this threshold, then AWS Elemental MediaPackage excludes it from output\\. If you don't specify a value, it defaults to 2147483647 bits per second\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MinVideoBitsPerSecond": "The lower limit of the bitrates that this endpoint serves\\. If the video track is below this threshold, then AWS Elemental MediaPackage excludes it from output\\. If you don't specify a value, it defaults to 0 bits per second\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxVideoBitsPerSecond": "The upper limit of the bitrates that this endpoint serves\\. If the video track exceeds this threshold, then AWS Elemental MediaPackage excludes it from output\\. If you don't specify a value, it defaults to 2147483647 bits per second\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MinVideoBitsPerSecond": "The lower limit of the bitrates that this endpoint serves\\. If the video track is below this threshold, then AWS Elemental MediaPackage excludes it from output\\. If you don't specify a value, it defaults to 0 bits per second\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StreamOrder": "Order in which the different video bitrates are presented to the player\\. \nValid values: **ORIGINAL**, **VIDEO\\_BITRATE\\_ASCENDING**, **VIDEO\\_BITRATE\\_DESCENDING**\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::PackagingGroup": { @@ -17510,7 +19881,7 @@ }, "AWS::MediaPackage::PackagingGroup Authorization": { "CdnIdentifierSecret": "The Amazon Resource Name \\(ARN\\) for the secret in AWS Secrets Manager that is used for CDN authorization\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretsRoleArn": "The Amazon Resource Name \\(ARN\\) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SecretsRoleArn": "The Amazon Resource Name \\(ARN\\) for the IAM role that allows AWS Elemental MediaPackage to communicate with AWS Secrets Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaPackage::PackagingGroup LogConfiguration": { "LogGroupName": "Sets a custom Amazon CloudWatch log group name for egress logs\\. If a log group name isn't specified, the default name is used: /aws/MediaPackage/EgressAccessLogs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -17520,9 +19891,9 @@ "ContainerName": "The name for the container\\. The name must be from 1 to 255 characters\\. Container names must be unique to your AWS account within a specific region\\. As an example, you could create a container named `movies` in every region, as long as you don\u2019t have an existing container with that name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\w-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "CorsPolicy": "Sets the cross\\-origin resource sharing \\(CORS\\) configuration on a container so that the container can service cross\\-origin requests\\. For example, you might want to enable a request whose origin is http://www\\.example\\.com to access your AWS Elemental MediaStore container at my\\.example\\.container\\.com by using the browser's XMLHttpRequest capability\\. \nTo enable CORS on a container, you attach a CORS policy to the container\\. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container\\. The policy can contain up to 398,000 characters\\. You can add up to 100 rules to a CORS policy\\. If more than one rule applies, the service uses the first applicable rule listed\\. \nTo learn more about CORS, see [Cross\\-Origin Resource Sharing \\(CORS\\) in AWS Elemental MediaStore](https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy.html)\\. \n*Required*: No \n*Type*: List of [CorsRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-corsrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LifecyclePolicy": "Writes an object lifecycle policy to a container\\. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy\\. It takes up to 20 minutes for the change to take effect\\. \nFor information about how to construct an object lifecycle policy, see [Components of an Object Lifecycle Policy](https://docs.aws.amazon.com/mediastore/latest/ug/policies-object-lifecycle-components.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MetricPolicy": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [MetricPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-metricpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MetricPolicy": "Property description not available\\. \n*Required*: No \n*Type*: [MetricPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-metricpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Policy": "Creates an access policy for the specified container to restrict the users and clients that can access it\\. For information about the data that is included in an access policy, see the [AWS Identity and Access Management User Guide](https://docs.aws.amazon.com/iam/)\\. \nFor this release of the REST API, you can create only one policy for a container\\. If you enter `PutContainerPolicy` twice, the second command modifies the existing policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Tags": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::MediaStore::Container CorsRule": { "AllowedHeaders": "Specifies which headers are allowed in a preflight `OPTIONS` request through the `Access-Control-Request-Headers` header\\. Each header name that is specified in `Access-Control-Request-Headers` must have a corresponding entry in the rule\\. Only the headers that were requested are sent back\\. \nThis element can contain only one wildcard character \\(\\*\\)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -17539,6 +19910,53 @@ "ObjectGroup": "A path or file name that defines which objects to include in the group\\. Wildcards \\(\\*\\) are acceptable\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `900` \n*Pattern*: `/?(?:[A-Za-z0-9_=:\\.\\-\\~\\*]+/){0,10}(?:[A-Za-z0-9_=:\\.\\-\\~\\*]+)?/?` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ObjectGroupName": "A name that allows you to refer to the object group\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `30` \n*Pattern*: `[a-zA-Z0-9_]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::MediaTailor::PlaybackConfiguration": { + "AdDecisionServerUrl": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AvailSuppression": "Property description not available\\. \n*Required*: No \n*Type*: [AvailSuppression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Bumper": "Property description not available\\. \n*Required*: No \n*Type*: [Bumper](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-bumper.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CdnConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [CdnConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-cdnconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConfigurationAliases": "The player parameters and aliases used as dynamic variables during session initialization\\. For more information, see [Domain Variables](https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html)\\. \n*Required*: No \n*Type*: Map of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DashConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [DashConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HlsConfiguration": "The configuration for HLS content\\. \n*Required*: No \n*Type*: [HlsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-hlsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LivePreRollConfiguration": "Property description not available\\. \n*Required*: No \n*Type*: [LivePreRollConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ManifestProcessingRules": "Property description not available\\. \n*Required*: No \n*Type*: [ManifestProcessingRules](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestprocessingrules.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PersonalizationThresholdSeconds": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SlateAdUrl": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TranscodeProfileName": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VideoContentSourceUrl": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MediaTailor::PlaybackConfiguration AdMarkerPassthrough": { + "Enabled": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MediaTailor::PlaybackConfiguration AvailSuppression": { + "Mode": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MediaTailor::PlaybackConfiguration Bumper": { + "EndUrl": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartUrl": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MediaTailor::PlaybackConfiguration CdnConfiguration": { + "AdSegmentUrlPrefix": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContentSegmentUrlPrefix": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MediaTailor::PlaybackConfiguration DashConfiguration": { + "ManifestEndpointPrefix": "The URL generated by MediaTailor to initiate a playback session\\. The session uses server\\-side reporting\\. This setting is ignored in PUT operations\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MpdLocation": "The setting that controls whether MediaTailor includes the Location tag in DASH manifests\\. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects\\. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client\\-side reporting or your players support sticky HTTP redirects\\. Valid values are `DISABLED` and `EMT_DEFAULT`\\. The `EMT_DEFAULT` setting enables the inclusion of the tag and is the default value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OriginManifestType": "The setting that controls whether MediaTailor handles manifests from the origin server as multi\\-period manifests or single\\-period manifests\\. If your origin server produces single\\-period manifests, set this to `SINGLE_PERIOD`\\. The default setting is `MULTI_PERIOD`\\. For multi\\-period manifests, omit this setting or set it to `MULTI_PERIOD`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MediaTailor::PlaybackConfiguration HlsConfiguration": { + "ManifestEndpointPrefix": "The URL that is used to initiate a playback session for devices that support Apple HLS\\. The session uses server\\-side reporting\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MediaTailor::PlaybackConfiguration LivePreRollConfiguration": { + "AdDecisionServerUrl": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxDurationSeconds": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::MediaTailor::PlaybackConfiguration ManifestProcessingRules": { + "AdMarkerPassthrough": "Property description not available\\. \n*Required*: No \n*Type*: [AdMarkerPassthrough](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-admarkerpassthrough.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::MemoryDB::ACL": { "ACLName": "The name of the Access Control List\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -17547,13 +19965,15 @@ "AWS::MemoryDB::Cluster": { "ACLName": "The name of the Access Control List to associate with the cluster\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Pattern*: `[a-zA-Z][a-zA-Z0-9\\-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AutoMinorVersionUpgrade": "When set to true, the cluster will automatically receive minor engine version upgrades after launch\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClusterEndpoint": "The cluster's configuration endpoint\\. \n*Required*: No \n*Type*: [Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-cluster-endpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClusterName": "The name of the cluster\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DataTiering": "Enables data tiering\\. Data tiering is only supported for replication groups using the r6gd node type\\. This parameter must be set to true when using r6gd nodes\\. For more information, see [Data tiering](https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "A description of the cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EngineVersion": "The Redis engine version used by the cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FinalSnapshotName": "The user\\-supplied name of a final cluster snapshot\\. This is the unique name that identifies the snapshot\\. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KmsKeyId": "The ID of the KMS key used to encrypt the cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "MaintenanceWindow": "Specifies the weekly time range during which maintenance on the cluster is performed\\. It is specified as a range in the format `ddd:hh24:mi-ddd:hh24:mi` \\(24H Clock UTC\\)\\. The minimum maintenance window is a 60 minute period\\. \n*Pattern*: `ddd:hh24:mi-ddd:hh24:mi` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "NodeType": "The cluster's [node type](https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.supportedtypes.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NodeType": "The cluster's node type\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NumReplicasPerShard": "The number of replicas to apply to each shard\\. \n*Default value*: `1` \n*Maximum value*: `5` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NumShards": "The number of shards in the cluster\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ParameterGroupName": "The name of the parameter group used by the cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -17588,10 +20008,14 @@ }, "AWS::MemoryDB::User": { "AccessString": "Access permissions string used for this user\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AuthenticationMode": "Denotes whether the user requires a password to authenticate\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthenticationMode": "Denotes whether the user requires a password to authenticate\\. \n**Example:**", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserName": "The name of the user\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::MemoryDB::User AuthenticationMode": { + "Passwords": "The password\\(s\\) used for authentication \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "Indicates whether the user requires a password to authenticate\\. All newly\\-created users require a password\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `password` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Neptune::DBCluster": { "AssociatedRoles": "Provides a list of the Amazon Identity and Access Management \\(IAM\\) roles that are associated with the DB cluster\\. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf\\. \n*Required*: No \n*Type*: List of [DBClusterRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptune-dbcluster-dbclusterrole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AvailabilityZones": "Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -17622,7 +20046,7 @@ }, "AWS::Neptune::DBClusterParameterGroup": { "Description": "Provides the customer\\-specified description for this DB cluster parameter group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Family": "Must be `neptune1`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Family": "Must be `neptune1` for engine versions prior to [1\\.2\\.0\\.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html), or `neptune1.2` for engine version `1.2.0.0` and higher\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "Provides the name of the DB cluster parameter group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Parameters": "The parameters to set for this DB cluster parameter group\\. \nThe parameters are expressed as a JSON object consisting of key\\-value pairs\\. \nIf you update the parameters, some interruption may occur depending on which parameters you update\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags that you want to attach to this parameter group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -17632,7 +20056,7 @@ "AutoMinorVersionUpgrade": "Indicates that minor version patches are applied automatically\\. \nWhen updating this property, some interruptions may occur\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AvailabilityZone": "Specifies the name of the Availability Zone the DB instance is located in\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DBClusterIdentifier": "If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DBInstanceClass": "Contains the name of the compute and memory capacity class of the DB instance\\. \nIf you update this property, some interruptions may occur\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DBInstanceClass": "Contains the name of the compute and memory capacity class of the DB instance\\. \nIf you update this property, some interruptions may occur\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "DBInstanceIdentifier": "Contains a user\\-supplied database identifier\\. This identifier is the unique key that identifies a DB instance\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DBParameterGroupName": "The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template\\. If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption\\. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DBSnapshotIdentifier": "This parameter is not supported\\. \n `AWS::Neptune::DBInstance` does not support restoring from snapshots\\. \n `AWS::Neptune::DBCluster` does support restoring from snapshots\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -17642,7 +20066,7 @@ }, "AWS::Neptune::DBParameterGroup": { "Description": "Provides the customer\\-specified description for this DB parameter group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Family": "Must be `neptune1`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Family": "Must be `neptune1` for engine versions prior to [1\\.2\\.0\\.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html), or `neptune1.2` for engine version `1.2.0.0` and higher\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "Provides the name of the DB parameter group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Parameters": "The parameters to set for this DB parameter group\\. \nThe parameters are expressed as a JSON object consisting of key\\-value pairs\\. \nChanges to dynamic parameters are applied immediately\\. During an update, if you have static parameters \\(whether they were changed or not\\), it triggers AWS CloudFormation to reboot the associated DB instance without failover\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags that you want to attach to this parameter group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -17665,6 +20089,7 @@ "VpcId": "The unique identifier of the VPC where the firewall is in use\\. You can't change the VPC of a firewall after you create the firewall\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^vpc-[0-9a-f]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::NetworkFirewall::Firewall SubnetMapping": { + "IPAddressType": "The subnet's IP address type\\. You can't change the IP address type after you create the subnet\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DUALSTACK | IPV4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SubnetId": "The unique identifier for the subnet\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NetworkFirewall::FirewallPolicy": { @@ -17696,9 +20121,14 @@ "Dimensions": "*Required*: Yes \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-dimension.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NetworkFirewall::FirewallPolicy StatefulEngineOptions": { - "RuleOrder": "Indicates how to manage the order of stateful rule evaluation for the policy\\. `DEFAULT_ACTION_ORDER` is the default behavior\\. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings\\. For more information, see [Evaluation order for stateful rules](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) in the * AWS Network Firewall Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEFAULT_ACTION_ORDER | STRICT_ORDER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "RuleOrder": "Indicates how to manage the order of stateful rule evaluation for the policy\\. `DEFAULT_ACTION_ORDER` is the default behavior\\. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings\\. For more information, see [Evaluation order for stateful rules](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) in the * AWS Network Firewall Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEFAULT_ACTION_ORDER | STRICT_ORDER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StreamExceptionPolicy": "Configures how Network Firewall processes traffic when a network connection breaks midstream\\. Network connections can break due to disruptions in external networks or within the firewall itself\\. \n+ `DROP` \\- Network Firewall fails closed and drops all subsequent traffic going to the firewall\\. This is the default behavior\\.\n+ `CONTINUE` \\- Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break\\. This impacts the behavior of rules that depend on this context\\. For example, if you have a stateful rule to `drop http` traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP\\. However, this behavior is rule dependent\u2014a TCP\\-layer rule using a `flow:stateless` rule would still match, as would the `aws:drop_strict` default action\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | DROP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::NetworkFirewall::FirewallPolicy StatefulRuleGroupOverride": { + "Action": "The action that changes the rule group from `DROP` to `ALERT`\\. This only applies to managed rule groups\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DROP_TO_ALERT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NetworkFirewall::FirewallPolicy StatefulRuleGroupReference": { + "Override": "The action that allows the policy owner to override the behavior of the rule group within a policy\\. \n*Required*: No \n*Type*: [StatefulRuleGroupOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Priority": "An integer setting that indicates the order in which to run the stateful rule groups in a single [AWS::NetworkFirewall::FirewallPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html)\\. This setting only applies to firewall policies that specify the `STRICT_ORDER` rule order in the stateful engine options settings\\. \nNetwork Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting\\. You must ensure that the priority settings are unique within each policy\\. \nYou can change the priority settings of your rule groups at any time\\. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResourceArn": "The Amazon Resource Name \\(ARN\\) of the stateful rule group\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^arn:aws.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -17731,7 +20161,7 @@ "PublishMetricAction": "Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet\\. This setting defines a CloudWatch dimension value to be published\\. \nYou can pair this custom action with any of the standard stateless rule actions\\. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection\\. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it\\. \n*Required*: No \n*Type*: [PublishMetricAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-publishmetricaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NetworkFirewall::RuleGroup Address": { - "AddressDefinition": "Specify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^([a-fA-F\\d:\\.]+($|/\\d{1,3}))$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AddressDefinition": "Specify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4 and IPv6\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^([a-fA-F\\d:\\.]+($|/\\d{1,3}))$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NetworkFirewall::RuleGroup CustomAction": { "ActionDefinition": "The custom action associated with the action name\\. \n*Required*: Yes \n*Type*: [ActionDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-actiondefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -17741,16 +20171,19 @@ "Value": "The value to use in the custom metric dimension\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9-_ ]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NetworkFirewall::RuleGroup Header": { - "Destination": "The destination IP address or address range to inspect for, in CIDR notation\\. To match with any address, specify `ANY`\\. \nSpecify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Destination": "The destination IP address or address range to inspect for, in CIDR notation\\. To match with any address, specify `ANY`\\. \nSpecify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4 and IPv6\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DestinationPort": "The destination port to inspect for\\. You can specify an individual port, for example `1994` and you can specify a port range, for example `1990:1994`\\. To match with any port, specify `ANY`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Direction": "The direction of traffic flow to inspect\\. If set to `ANY`, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source\\. If set to `FORWARD`, the inspection only matches traffic going from the source to the destination\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ANY | FORWARD` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Protocol": "The protocol to inspect for\\. To specify all, you can use `IP`, because all traffic on AWS and on the internet is IP\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DCERPC | DHCP | DNS | FTP | HTTP | ICMP | IKEV2 | IMAP | IP | KRB5 | MSN | NTP | SMB | SMTP | SSH | TCP | TFTP | TLS | UDP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Source": "The source IP address or address range to inspect for, in CIDR notation\\. To match with any address, specify `ANY`\\. \nSpecify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Source": "The source IP address or address range to inspect for, in CIDR notation\\. To match with any address, specify `ANY`\\. \nSpecify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4 and IPv6\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourcePort": "The source port to inspect for\\. You can specify an individual port, for example `1994` and you can specify a port range, for example `1990:1994`\\. To match with any port, specify `ANY`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NetworkFirewall::RuleGroup IPSet": { "Definition": "The list of IP addresses and address ranges, in CIDR notation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::NetworkFirewall::RuleGroup IPSetReference": { + "ReferenceArn": "The Amazon Resource Name \\(ARN\\) of the resource to include in the [AWS::NetworkFirewall::RuleGroup IPSetReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-networkfirewall-rulegroup-ipsetreference.html#aws-properties-networkfirewall-rulegroup-ipsetreference)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^arn:aws.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::NetworkFirewall::RuleGroup MatchAttributes": { "DestinationPorts": "The destination ports to inspect for\\. If not specified, this matches with any destination port\\. This setting is only used for protocols 6 \\(TCP\\) and 17 \\(UDP\\)\\. \nYou can specify individual ports, for example `1994` and you can specify port ranges, for example `1990:1994`\\. \n*Required*: No \n*Type*: List of [PortRange](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portrange.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Destinations": "The destination IP addresses and address ranges to inspect for, in CIDR notation\\. If not specified, this matches with any destination address\\. \n*Required*: No \n*Type*: List of [Address](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-address.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -17769,11 +20202,15 @@ "AWS::NetworkFirewall::RuleGroup PublishMetricAction": { "Dimensions": "*Required*: Yes \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-dimension.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::NetworkFirewall::RuleGroup ReferenceSets": { + "IPSetReferences": "The IP set references to use in the stateful rule group\\. \n*Required*: No \n*Type*: Map of [IPSetReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ipsetreference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::NetworkFirewall::RuleGroup RuleDefinition": { "Actions": "The actions to take on a packet that matches one of the stateless rule definition's match attributes\\. You must specify a standard action and you can add custom actions\\. \nNetwork Firewall only forwards a packet for stateful rule inspection if you specify `aws:forward_to_sfe` for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify `aws:forward_to_sfe` for the `StatelessDefaultActions` setting for the [AWS::NetworkFirewall::FirewallPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html)\\.\nFor every rule, you must specify exactly one of the following standard actions\\. \n+ **aws:pass** \\- Discontinues all inspection of the packet and permits it to go to its intended destination\\.\n+ **aws:drop** \\- Discontinues all inspection of the packet and blocks it from going to its intended destination\\.\n+ **aws:forward\\_to\\_sfe** \\- Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection\\. \nAdditionally, you can specify a custom action\\. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this `Actions` setting\\. \nTo provide more than one action in this setting, separate the settings with a comma\\. For example, if you have a publish metrics custom action that you've named `MyMetricsAction`, then you could specify the standard action `aws:pass` combined with the custom action using `[\u201caws:pass\u201d, \u201cMyMetricsAction\u201d]`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MatchAttributes": "Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection\\. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags\\. \n*Required*: Yes \n*Type*: [MatchAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NetworkFirewall::RuleGroup RuleGroup": { + "ReferenceSets": "The reference sets for the stateful rule group\\. \n*Required*: No \n*Type*: [ReferenceSets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-referencesets.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RuleVariables": "Settings that are available for use in the rules in the rule group\\. You can only use these for stateful rule groups\\. \n*Required*: No \n*Type*: [RuleVariables](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulevariables.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RulesSource": "The stateful rules or stateless rules for the rule group\\. \n*Required*: Yes \n*Type*: [RulesSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StatefulRuleOptions": "Additional options governing how Network Firewall handles stateful rules\\. The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings\\. \n*Required*: No \n*Type*: [StatefulRuleOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulruleoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -17789,7 +20226,7 @@ "AWS::NetworkFirewall::RuleGroup RulesSource": { "RulesSourceList": "Stateful inspection criteria for a domain list rule group\\. \n*Required*: No \n*Type*: [RulesSourceList](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RulesString": "Stateful inspection criteria, provided in Suricata compatible intrusion prevention system \\(IPS\\) rules\\. Suricata is an open\\-source network IPS that includes a standard rule\\-based language for network traffic inspection\\. \nThese rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `2000000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StatefulRules": "An array of individual stateful rules inspection criteria to be used together in a stateful rule group\\. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options\\. For information about the Suricata `Rules` format, see [Rules Format](https://suricata.readthedocs.io/en/suricata-5.0.0/rules/intro.html#)\\. \n*Required*: No \n*Type*: List of [StatefulRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StatefulRules": "An array of individual stateful rules inspection criteria to be used together in a stateful rule group\\. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options\\. For information about the Suricata `Rules` format, see [Rules Format](https://suricata.readthedocs.io/rules/intro.html#)\\. \n*Required*: No \n*Type*: List of [StatefulRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StatelessRulesAndCustomActions": "Stateless inspection criteria to be used in a stateless rule group\\. \n*Required*: No \n*Type*: [StatelessRulesAndCustomActions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrulesandcustomactions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NetworkFirewall::RuleGroup RulesSourceList": { @@ -17798,7 +20235,7 @@ "Targets": "The domains that you want to inspect for in your traffic flows\\. Valid domain specifications are the following: \n+ Explicit names\\. For example, `abc.example.com` matches only the domain `abc.example.com`\\.\n+ Names that use a domain wildcard, which you indicate with an initial '`.`'\\. For example,`.example.com` matches `example.com` and matches all subdomains of `example.com`, such as `abc.example.com` and `www.example.com`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NetworkFirewall::RuleGroup StatefulRule": { - "Action": "Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria\\. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow\\. \nThe actions for a stateful rule are defined as follows: \n+ **PASS** \\- Permits the packets to go to the intended destination\\.\n+ **DROP** \\- Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the firewall's [AWS::NetworkFirewall::LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html)\\. \n+ **ALERT** \\- Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the firewall's [AWS::NetworkFirewall::LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html)\\.", + "Action": "Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria\\. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow\\. \nThe actions for a stateful rule are defined as follows: \n+ **PASS** \\- Permits the packets to go to the intended destination\\.\n+ **DROP** \\- Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the [AWS::NetworkFirewall::Firewall](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html) [AWS::NetworkFirewall::LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html)\\. \n+ **ALERT** \\- Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the [AWS::NetworkFirewall::Firewall](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html) [AWS::NetworkFirewall::LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html)\\.", "Header": "The stateful inspection criteria for this rule, used to inspect traffic flows\\. \n*Required*: Yes \n*Type*: [Header](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RuleOptions": "Additional settings for a stateful rule, provided as keywords and settings\\. \n*Required*: Yes \n*Type*: List of [RuleOption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruleoption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -17817,6 +20254,61 @@ "Flags": "Used in conjunction with the `Masks` setting to define the flags that must be set and flags that must not be set in order for the packet to match\\. This setting can only specify values that are also specified in the `Masks` setting\\. \nFor the flags that are specified in the masks setting, the following must be true for the packet to match: \n+ The ones that are set in this flags setting must be set in the packet\\. \n+ The ones that are not set in this flags setting must also not be set in the packet\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Masks": "The set of flags to consider in the inspection\\. To inspect all flags in the valid values list, leave this with no setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::NetworkManager::ConnectAttachment": { + "CoreNetworkId": "The ID of the core network where the Connect attachment is located\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EdgeLocation": "The Region where the edge is located\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Options": "Options for connecting an attachment\\. \n*Required*: Yes \n*Type*: [ConnectAttachmentOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectattachment-connectattachmentoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TransportAttachmentId": "The ID of the transport attachment\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `50` \n*Pattern*: `^attachment-([0-9a-f]{8,17})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::NetworkManager::ConnectAttachment ConnectAttachmentOptions": { + "Protocol": "The protocol used for the attachment connection\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GRE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::NetworkManager::ConnectAttachment ProposedSegmentChange": { + "AttachmentPolicyRuleNumber": "The rule number in the policy document that applies to this change\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SegmentName": "The name of the segment to change\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The list of key\\-value tags that changed for the segment\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::NetworkManager::ConnectPeer": { + "BgpOptions": "Property description not available\\. \n*Required*: No \n*Type*: [BgpOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-bgpoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ConnectAttachmentId": "The ID of the attachment to connect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `50` \n*Pattern*: `^attachment-([0-9a-f]{8,17})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CoreNetworkAddress": "The IP address of a core network\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InsideCidrBlocks": "The inside IP addresses used for a Connect peer configuration\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PeerAddress": "The IP address of the Connect peer\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "The list of key\\-value tags associated with the Connect peer\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::NetworkManager::ConnectPeer BgpOptions": { + "PeerAsn": "The Peer ASN of the BGP\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::NetworkManager::ConnectPeer ConnectPeerBgpConfiguration": { + "CoreNetworkAddress": "The address of a core network\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CoreNetworkAsn": "The ASN of the Coret Network\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PeerAddress": "The address of a core network Connect peer\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PeerAsn": "The ASN of the Connect peer\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::NetworkManager::ConnectPeer ConnectPeerConfiguration": { + "BgpConfigurations": "The Connect peer BGP configurations\\. \n*Required*: No \n*Type*: List of [ConnectPeerBgpConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerbgpconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CoreNetworkAddress": "The IP address of a core network\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InsideCidrBlocks": "The inside IP addresses used for a Connect peer configuration\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PeerAddress": "The IP address of the Connect peer\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Protocol": "The protocol used for a Connect peer configuration\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GRE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::NetworkManager::CoreNetwork": { + "Description": "The description of a core network\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "GlobalNetworkId": "The ID of the global network that your core network is a part of\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PolicyDocument": "Describes a core network policy\\. For more information, see [Core network policies](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-policy-changesets.html)\\. \nIf you update the policy document, CloudFormation will apply the core network change set generated from the updated policy document, and then set it as the LIVE policy\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The list of key\\-value tags associated with a core network\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::NetworkManager::CoreNetwork CoreNetworkEdge": { + "Asn": "The ASN of a core network edge\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EdgeLocation": "The Region where a core network edge is located\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InsideCidrBlocks": "The inside IP addresses used for core network edges\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::NetworkManager::CoreNetwork CoreNetworkSegment": { + "EdgeLocations": "The Regions where the edges are located\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of a core network segment\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SharedSegments": "The shared segments of a core network\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::NetworkManager::CustomerGatewayAssociation": { "CustomerGatewayArn": "The Amazon Resource Name \\(ARN\\) of the customer gateway\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DeviceId": "The ID of the device\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -17872,10 +20364,41 @@ "Latitude": "The latitude\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Longitude": "The longitude\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::NetworkManager::SiteToSiteVpnAttachment": { + "CoreNetworkId": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpnConnectionArn": "The ARN of the site\\-to\\-site VPN attachment\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:vpn-connection\\/vpn-[0-9a-f]{8,17}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::NetworkManager::SiteToSiteVpnAttachment ProposedSegmentChange": { + "AttachmentPolicyRuleNumber": "The rule number in the policy document that applies to this change\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SegmentName": "The name of the segment to change\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The list of key\\-value tags that changed for the segment\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::NetworkManager::TransitGatewayPeering": { + "CoreNetworkId": "The ID of the core network\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "The list of key\\-value tags associated with the peering\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TransitGatewayArn": "The ARN of the transit gateway\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::NetworkManager::TransitGatewayRegistration": { "GlobalNetworkId": "The ID of the global network\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TransitGatewayArn": "The Amazon Resource Name \\(ARN\\) of the transit gateway\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::NetworkManager::VpcAttachment": { + "CoreNetworkId": "The core network ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Options": "Options for creating the VPC attachment\\. \n*Required*: No \n*Type*: [VpcOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-vpcoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SubnetArns": "The subnet ARNs\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The tags associated with the VPC attachment\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcArn": "The ARN of the VPC attachment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::NetworkManager::VpcAttachment ProposedSegmentChange": { + "AttachmentPolicyRuleNumber": "The rule number in the policy document that applies to this change\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SegmentName": "The name of the segment to change\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The list of key\\-value tags that changed for the segment\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::NetworkManager::VpcAttachment VpcOptions": { + "ApplianceModeSupport": "Indicates whether appliance mode is supported\\. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Ipv6Support": "Indicates whether IPv6 is supported\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::NimbleStudio::LaunchProfile": { "Description": "A human\\-readable description of the launch profile\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Ec2SubnetIds": "Unique identifiers for a collection of EC2 subnets\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -17887,21 +20410,34 @@ "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::NimbleStudio::LaunchProfile StreamConfiguration": { - "ClipboardMode": "Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AutomaticTerminationMode": "Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a `STOPPED` state\\. \n+ When `ACTIVATED`, the streaming session is scheduled for termination after being in the `STOPPED` state for the time specified in `maxStoppedSessionLengthInMinutes`\\.\n+ When `DEACTIVATED`, the streaming session can remain in the `STOPPED` state indefinitely\\.\nThis parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED`\\. When allowed, the default value for this parameter is `DEACTIVATED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClipboardMode": "Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Ec2InstanceTypes": "The EC2 instance types that users can select from when launching a streaming session with this launch profile\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxSessionLengthInMinutes": "The length of time, in minutes, that a streaming session can be active before it is stopped or terminated\\. After this point, Nimble Studio automatically terminates or stops the session\\. The default length of time is 690 minutes, and the maximum length of time is 30 days\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaxStoppedSessionLengthInMinutes": "Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state\\. The default value is 0\\. The maximum value is 5760\\. \nIf the value is missing or set to 0, your sessions can\u2019t be stopped\\. If you then call `StopStreamingSession`, the session fails\\. If the time that a session stays in the READY state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be terminated \\(instead of stopped\\)\\. \nIf the value is set to a positive number, the session can be stopped\\. You can call `StopStreamingSession` to stop sessions in the READY state\\. If the time that a session stays in the READY state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be stopped \\(instead of terminated\\)\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SessionStorage": "\\(Optional\\) The upload storage for a streaming session\\. \n*Required*: No \n*Type*: [StreamConfigurationSessionStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionstorage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "StreamingImageIds": "The streaming images that users can select from when launching a streaming session with this launch profile\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "MaxStoppedSessionLengthInMinutes": "Integer that determines if you can start and stop your sessions and how long a session can stay in the `STOPPED` state\\. The default value is 0\\. The maximum value is 5760\\. \nThis field is allowed only when `sessionPersistenceMode` is `ACTIVATED` and `automaticTerminationMode` is `ACTIVATED`\\. \nIf the value is set to 0, your sessions can\u2019t be `STOPPED`\\. If you then call `StopStreamingSession`, the session fails\\. If the time that a session stays in the `READY` state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be terminated \\(instead of `STOPPED`\\)\\. \nIf the value is set to a positive number, the session can be stopped\\. You can call `StopStreamingSession` to stop sessions in the `READY` state\\. If the time that a session stays in the `READY` state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be stopped \\(instead of terminated\\)\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SessionBackup": "Information about the streaming session backup\\. \n*Required*: No \n*Type*: [StreamConfigurationSessionBackup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionbackup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SessionPersistenceMode": "Determine if a streaming session created from this launch profile can configure persistent storage\\. This means that `volumeConfiguration` and `automaticTerminationMode` are configured\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SessionStorage": "The upload storage for a streaming session\\. \n*Required*: No \n*Type*: [StreamConfigurationSessionStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionstorage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StreamingImageIds": "The streaming images that users can select from when launching a streaming session with this launch profile\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VolumeConfiguration": "Custom volume configuration for the root volumes that are attached to streaming sessions\\. \nThis parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED`\\. \n*Required*: No \n*Type*: [VolumeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::NimbleStudio::LaunchProfile StreamConfigurationSessionBackup": { + "MaxBackupsToRetain": "The maximum number of backups that each streaming session created from this launch profile can have\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Mode": "Specifies how artists sessions are backed up\\. \nConfigures backups for streaming sessions launched with this launch profile\\. The default value is `DEACTIVATED`, which means that backups are deactivated\\. To allow backups, set this value to `AUTOMATIC`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NimbleStudio::LaunchProfile StreamConfigurationSessionStorage": { - "Mode": "Allows artists to upload files to their workstations\\. The only valid option is `UPLOAD`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Mode": "Allows artists to upload files to their workstations\\. The only valid option is `UPLOAD`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Root": "The configuration for the upload storage root of the streaming session\\. \n*Required*: No \n*Type*: [StreamingSessionStorageRoot](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamingsessionstorageroot.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NimbleStudio::LaunchProfile StreamingSessionStorageRoot": { "Linux": "The folder path in Linux workstations where files are uploaded\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Windows": "The folder path in Windows workstations where files are uploaded\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::NimbleStudio::LaunchProfile VolumeConfiguration": { + "Iops": "The number of I/O operations per second for the root volume that is attached to streaming session\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Size": "The size of the root volume that is attached to the streaming session\\. The root volume size is measured in GiBs\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Throughput": "The throughput to provision for the root volume that is attached to the streaming session\\. The throughput is measured in MiB/s\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::NimbleStudio::StreamingImage": { "Description": "A human\\-readable description of the streaming image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Ec2ImageId": "The ID of an EC2 machine image with which to create the streaming image\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -17909,6 +20445,10 @@ "StudioId": "The unique identifier for a studio resource\\. In Nimble Studio, all other resources are contained in a studio resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::NimbleStudio::StreamingImage StreamingImageEncryptionConfiguration": { + "KeyArn": "The ARN for a KMS key that is used to encrypt studio data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KeyType": "The type of KMS key that is used to encrypt studio data\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::NimbleStudio::Studio": { "AdminRoleArn": "The IAM role that studio admins assume when logging in to the Nimble Studio portal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DisplayName": "A friendly name for the studio\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -17939,7 +20479,7 @@ }, "AWS::NimbleStudio::StudioComponent ActiveDirectoryConfiguration": { "ComputerAttributes": "A collection of custom attributes for an Active Directory computer\\. \n*Required*: No \n*Type*: List of [ActiveDirectoryComputerAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectorycomputerattribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DirectoryId": "The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DirectoryId": "The directory ID of the AWS Directory Service for Microsoft Active Directory to access using this studio component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OrganizationalUnitDistinguishedName": "The distinguished name \\(DN\\) and organizational unit \\(OU\\) of an Active Directory computer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NimbleStudio::StudioComponent ComputeFarmConfiguration": { @@ -17961,92 +20501,234 @@ "WindowsMountDrive": "The mount location for a shared file system on a Windows virtual workstation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NimbleStudio::StudioComponent StudioComponentConfiguration": { - "ActiveDirectoryConfiguration": "The configuration for a Microsoft Active Directory \\(Microsoft AD\\) studio resource\\. \n*Required*: No \n*Type*: [ActiveDirectoryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectoryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ActiveDirectoryConfiguration": "The configuration for a AWS Directory Service for Microsoft Active Directory studio resource\\. \n*Required*: No \n*Type*: [ActiveDirectoryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectoryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ComputeFarmConfiguration": "The configuration for a render farm that is associated with a studio resource\\. \n*Required*: No \n*Type*: [ComputeFarmConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-computefarmconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LicenseServiceConfiguration": "The configuration for a license service that is associated with a studio resource\\. \n*Required*: No \n*Type*: [LicenseServiceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-licenseserviceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SharedFileSystemConfiguration": "The configuration for a shared file storage system that is associated with a studio resource\\. \n*Required*: No \n*Type*: [SharedFileSystemConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-sharedfilesystemconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::NimbleStudio::StudioComponent StudioComponentInitializationScript": { "LaunchProfileProtocolVersion": "The version number of the protocol that is used by the launch profile\\. The only valid version is \"2021\\-03\\-31\"\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Platform": "The platform of the initialization script, either WINDOWS or LINUX\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Platform": "The platform of the initialization script, either Windows or Linux\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RunContext": "The method to use when running the initialization script\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Script": "The initialization script\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Omics::AnnotationStore": { + "Description": "A description for the store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the Annotation Store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Reference": "The genome reference for the store's annotations\\. \n*Required*: No \n*Type*: [ReferenceItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-referenceitem.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SseConfig": "The store's server\\-side encryption \\(SSE\\) settings\\. \n*Required*: No \n*Type*: [SseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-sseconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StoreFormat": "The annotation file format of the store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StoreOptions": "File parsing options for the annotation store\\. \n*Required*: No \n*Type*: [StoreOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-storeoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Tags for the store\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Omics::AnnotationStore ReferenceItem": { + "ReferenceArn": "The reference's ARN\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Omics::AnnotationStore SseConfig": { + "KeyArn": "An encryption key ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Type": "The encryption type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Omics::AnnotationStore StoreOptions": { + "TsvStoreOptions": "Formatting options for a TSV file\\. \n*Required*: Yes \n*Type*: [TsvStoreOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-tsvstoreoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Omics::AnnotationStore TsvStoreOptions": { + "AnnotationType": "The store's annotation type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FormatToHeader": "The store's header key to column name mapping\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Schema": "The schema of an annotation store\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Omics::ReferenceStore": { + "Description": "A description for the store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "A name for the store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SseConfig": "Server\\-side encryption \\(SSE\\) settings for the store\\. \n*Required*: No \n*Type*: [SseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-referencestore-sseconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Tags for the store\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Omics::ReferenceStore SseConfig": { + "KeyArn": "An encryption key ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Type": "The encryption type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Omics::RunGroup": { + "MaxCpus": "The group's maximum CPU count setting\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `1` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxDuration": "The group's maximum duration setting in minutes\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `1` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxRuns": "The group's maximum concurrent run setting\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `1` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The group's name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Tags for the group\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Omics::SequenceStore": { + "Description": "A description for the store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "A name for the store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SseConfig": "Server\\-side encryption \\(SSE\\) settings for the store\\. \n*Required*: No \n*Type*: [SseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-sequencestore-sseconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Tags for the store\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Omics::SequenceStore SseConfig": { + "KeyArn": "An encryption key ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Type": "The encryption type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Omics::VariantStore": { + "Description": "A description for the store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "A name for the store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Reference": "The genome reference for the store's variants\\. \n*Required*: Yes \n*Type*: [ReferenceItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-referenceitem.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SseConfig": "Server\\-side encryption \\(SSE\\) settings for the store\\. \n*Required*: No \n*Type*: [SseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-sseconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Tags for the store\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Omics::VariantStore ReferenceItem": { + "ReferenceArn": "The reference's ARN\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Omics::VariantStore SseConfig": { + "KeyArn": "An encryption key ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Type": "The encryption type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Omics::Workflow": { + "DefinitionUri": "The URI of a definition for the workflow\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Description": "The parameter's description\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Engine": "An engine for the workflow\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NEXTFLOW | WDL` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Main": "The path of the main definition file for the workflow\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The workflow's name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ParameterTemplate": "The workflow's parameter template\\. \n*Required*: No \n*Type*: Map of [WorkflowParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StorageCapacity": "A storage capacity for the workflow in gigabytes\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Maximum*: `100000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Tags for the workflow\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Omics::Workflow WorkflowParameter": { + "Description": "The parameter's description\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Optional": "Whether the parameter is optional\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::OpenSearchServerless::AccessPolicy": { + "Description": "The description of the policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Policy": "The JSON policy document without any whitespaces\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of access policy\\. Currently the only option is `data`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::OpenSearchServerless::Collection": { + "Description": "A description of the collection\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the collection\\. \nCollection names must meet the following criteria: \n+ Starts with a lowercase letter\n+ Unique to your account and AWS Region\n+ Contains between 3 and 28 characters\n+ Contains only lowercase letters a\\-z, the numbers 0\\-9, and the hyphen \\(\\-\\)\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "An arbitrary set of tags \\(key\u2013value pairs\\) to associate with the collection\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Type": "The type of collection\\. Possible values are `SEARCH` and `TIMESERIES`\\. For more information, see [Choosing a collection type](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-usecase)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::OpenSearchServerless::SecurityConfig": { + "Description": "The description of the security configuration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the security configuration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SamlOptions": "SAML options for the security configuration in the form of a key\\-value map\\. \n*Required*: No \n*Type*: [SamlConfigOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of security configuration\\. Currently the only option is `saml`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::OpenSearchServerless::SecurityConfig SamlConfigOptions": { + "GroupAttribute": "The group attribute for this SAML integration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Metadata": "The XML IdP metadata file generated from your identity provider\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SessionTimeout": "The session timeout, in minutes\\. Default is 60 minutes \\(12 hours\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UserAttribute": "A user attribute for this SAML integration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::OpenSearchServerless::SecurityPolicy": { + "Description": "The description of the security policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Policy": "The JSON policy document without any whitespaces\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of security policy\\. Can be either `encryption` or `network`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::OpenSearchServerless::VpcEndpoint": { + "Name": "The name of the endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SecurityGroupIds": "The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SubnetIds": "The ID of the subnets from which you access OpenSearch Serverless\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcId": "The ID of the VPC from which you access OpenSearch Serverless\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::OpenSearchService::Domain": { "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*\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AdvancedSecurityOptions": "Specifies options for fine\\-grained access control\\. \n*Required*: No \n*Type*: [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ClusterConfig": "`ClusterConfig` is a property of the AWS::OpenSearchService::Domain resource that configures an Amazon OpenSearch Service cluster\\. \n*Required*: No \n*Type*: [ClusterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdvancedOptions": "Additional options to specify for the OpenSearch Service domain\\. For more information, see [AdvancedOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CreateDomain.html#API_CreateDomain_RequestBody) in the OpenSearch Service API reference\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdvancedSecurityOptions": "Specifies options for fine\\-grained access control and SAML authentication\\. \nIf you specify advanced security options, you must also enable node\\-to\\-node encryption \\([NodeToNodeEncryptionOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodetonodeencryptionoptions.html)\\) and encryption at rest \\([EncryptionAtRestOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html)\\)\\. You must also enable `EnforceHTTPS` within [DomainEndpointOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html), which requires HTTPS for all traffic to the domain\\. \n*Required*: No \n*Type*: [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClusterConfig": "Container for the cluster configuration of a domain\\. \n*Required*: No \n*Type*: [ClusterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CognitoOptions": "Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards\\. \n*Required*: No \n*Type*: [CognitoOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DomainEndpointOptions": "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*Required*: No \n*Type*: [DomainEndpointOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DomainName": "A name for the OpenSearch Service domain\\. For valid values, see the [DomainName](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname) data type in the *Amazon OpenSearch Service Developer Guide*\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nRequired when creating a new domain\\. \nIf you specify a name, you can't perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DomainName": "A name for the OpenSearch Service domain\\. The name must have a minimum length of 3 and a maximum length of 28\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nRequired when creating a new domain\\. \nIf you specify a name, you can't perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EBSOptions": "The configurations of Amazon Elastic Block Store \\(Amazon EBS\\) volumes that are attached to data nodes in the OpenSearch Service domain\\. For more information, see [EBS volume size limits](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide*\\. \n*Required*: No \n*Type*: [EBSOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-ebsoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EncryptionAtRestOptions": "Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use\\. See [Encryption of data at rest for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/encryption-at-rest.html)\\. \n*Required*: No \n*Type*: [EncryptionAtRestOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EngineVersion": "The version of OpenSearch to use\\. The value must be in the format `OpenSearch_X.Y` or `Elasticsearch_X.Y`\\. If not specified, the latest version of OpenSearch is used\\. For information about the versions that OpenSearch Service supports, see [Supported versions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide*\\. \nIf you set the [EnableVersionUpgrade](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain) update policy to `true`, you can update `EngineVersion` without interruption\\. When `EnableVersionUpgrade` is set to `false`, or is not specified, updating `EngineVersion` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EngineVersion": "The version of OpenSearch to use\\. The value must be in the format `OpenSearch_X.Y` or `Elasticsearch_X.Y`\\. If not specified, the latest version of OpenSearch is used\\. For information about the versions that OpenSearch Service supports, see [Supported versions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide*\\. \nIf you set the [EnableVersionUpgrade](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain) update policy to `true`, you can update `EngineVersion` without interruption\\. When `EnableVersionUpgrade` is set to `false`, or is not specified, updating `EngineVersion` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `14` \n*Maximum*: `18` \n*Pattern*: `^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LogPublishingOptions": "An object with one or more of the following keys: `SEARCH_SLOW_LOGS`, `ES_APPLICATION_LOGS`, `INDEX_SLOW_LOGS`, `AUDIT_LOGS`, depending on the types of logs you want to publish\\. Each key needs a valid `LogPublishingOption` value\\. For the full syntax, see the [examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--examples)\\. \n*Required*: No \n*Type*: Map of [LogPublishingOption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-logpublishingoption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NodeToNodeEncryptionOptions": "Specifies whether node\\-to\\-node encryption is enabled\\. See [Node\\-to\\-node encryption for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html)\\. \n*Required*: No \n*Type*: [NodeToNodeEncryptionOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodetonodeencryptionoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SnapshotOptions": "**DEPRECATED**\\. The automated snapshot configuration for the OpenSearch Service domain indices\\. \n*Required*: No \n*Type*: [SnapshotOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-snapshotoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SnapshotOptions": "**DEPRECATED**\\. The automated snapshot configuration for the OpenSearch Service domain indexes\\. \n*Required*: No \n*Type*: [SnapshotOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-snapshotoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An arbitrary set of tags \\(key\u2013value pairs\\) to associate with the OpenSearch Service domain\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VPCOptions": "The virtual private cloud \\(VPC\\) configuration for the OpenSearch Service domain\\. For more information, see [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer Guide*\\. \n*Required*: No \n*Type*: [VPCOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-vpcoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "VPCOptions": "The virtual private cloud \\(VPC\\) configuration for the OpenSearch Service domain\\. For more information, see [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer Guide*\\. \nIf you remove this entity altogether, along with its associated properties, it causes a replacement\\. You might encounter this scenario if you're updating your security configuration from a VPC to a public endpoint\\. \n*Required*: No \n*Type*: [VPCOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-vpcoptions.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)" }, "AWS::OpenSearchService::Domain AdvancedSecurityOptionsInput": { - "Enabled": "True to enable fine\\-grained access control\\. You must also enable encryption of data at rest and node\\-to\\-node encryption\\. See [Fine\\-grained access control in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "InternalUserDatabaseEnabled": "True to enable the internal user database\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MasterUserOptions": "Specifies information about the master user\\. \n*Required*: No \n*Type*: [MasterUserOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "AnonymousAuthDisableDate": "Date and time when the migration period will be disabled\\. Only necessary when [enabling fine\\-grained access control on an existing domain](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AnonymousAuthEnabled": "True to enable a 30\\-day migration period during which administrators can create role mappings\\. Only necessary when [enabling fine\\-grained access control on an existing domain](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Enabled": "True to enable fine\\-grained access control\\. You must also enable encryption of data at rest and node\\-to\\-node encryption\\. See [Fine\\-grained access control in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InternalUserDatabaseEnabled": "True to enable the internal user database\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MasterUserOptions": "Specifies information about the master user\\. \n*Required*: No \n*Type*: [MasterUserOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SAMLOptions": "Container for information about the SAML configuration for OpenSearch Dashboards\\. \n*Required*: No \n*Type*: [SAMLOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::OpenSearchService::Domain ClusterConfig": { "DedicatedMasterCount": "The number of instances to use for the master node\\. If you specify this property, you must specify `true` for the `DedicatedMasterEnabled` property\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DedicatedMasterEnabled": "Indicates whether to use a dedicated master node for the OpenSearch Service domain\\. A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests\\. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters\\. See [Dedicated master nodes in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-dedicatedmasternodes.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DedicatedMasterType": "The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.search`\\. 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)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DedicatedMasterType": "The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.search`\\. 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)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | c4.large.search | c4.xlarge.search | c5.18xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.large.search | c5.xlarge.search | c6g.12xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.large.search | c6g.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | d2.xlarge.search | i2.2xlarge.search | i2.xlarge.search | i3.16xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.large.search | i3.xlarge.search | m3.2xlarge.search | m3.large.search | m3.medium.search | m3.xlarge.search | m4.10xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.large.search | m4.xlarge.search | m5.12xlarge.search | m5.24xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.large.search | m5.xlarge.search | m6g.12xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.large.search | m6g.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | r3.large.search | r3.xlarge.search | r4.16xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.large.search | r4.xlarge.search | r5.12xlarge.search | r5.24xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.large.search | r5.xlarge.search | r6g.12xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.large.search | r6g.xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.large.search | r6gd.xlarge.search | t2.medium.search | t2.micro.search | t2.small.search | t3.2xlarge.search | t3.large.search | t3.medium.search | t3.micro.search | t3.nano.search | t3.small.search | t3.xlarge.search | t4g.medium.search | t4g.small.search | ultrawarm1.large.search | ultrawarm1.medium.search | ultrawarm1.xlarge.search` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InstanceCount": "The number of data nodes \\(instances\\) to use in the OpenSearch Service domain\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InstanceType": "The instance type for your data nodes, such as `m3.medium.search`\\. For valid values, see [Supported instance types in Amazon OpenSearch Service ](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InstanceType": "The instance type for your data nodes, such as `m3.medium.search`\\. For valid values, see [Supported instance types in Amazon OpenSearch Service ](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | c4.large.search | c4.xlarge.search | c5.18xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.large.search | c5.xlarge.search | c6g.12xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.large.search | c6g.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | d2.xlarge.search | i2.2xlarge.search | i2.xlarge.search | i3.16xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.large.search | i3.xlarge.search | m3.2xlarge.search | m3.large.search | m3.medium.search | m3.xlarge.search | m4.10xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.large.search | m4.xlarge.search | m5.12xlarge.search | m5.24xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.large.search | m5.xlarge.search | m6g.12xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.large.search | m6g.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | r3.large.search | r3.xlarge.search | r4.16xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.large.search | r4.xlarge.search | r5.12xlarge.search | r5.24xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.large.search | r5.xlarge.search | r6g.12xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.large.search | r6g.xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.large.search | r6gd.xlarge.search | t2.medium.search | t2.micro.search | t2.small.search | t3.2xlarge.search | t3.large.search | t3.medium.search | t3.micro.search | t3.nano.search | t3.small.search | t3.xlarge.search | t4g.medium.search | t4g.small.search | ultrawarm1.large.search | ultrawarm1.medium.search | ultrawarm1.xlarge.search` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WarmCount": "The number of warm nodes in the cluster\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WarmEnabled": "Whether to enable UltraWarm storage for the cluster\\. See [UltraWarm storage for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ultrawarm.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "WarmType": "The instance type for the cluster's warm nodes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WarmType": "The instance type for the cluster's warm nodes\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ultrawarm1.large.search | ultrawarm1.medium.search | ultrawarm1.xlarge.search` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ZoneAwarenessConfig": "Specifies zone awareness configuration options\\. Only use if `ZoneAwarenessEnabled` is `true`\\. \n*Required*: No \n*Type*: [ZoneAwarenessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-zoneawarenessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::OpenSearchService::Domain CognitoOptions": { "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)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IdentityPoolId": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RoleArn": "The `AmazonOpenSearchServiceCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UserPoolId": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "IdentityPoolId": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `55` \n*Pattern*: `[\\w-]+:[0-9a-f-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleArn": "The `AmazonOpenSearchServiceCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):iam::[0-9]+:role\\/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UserPoolId": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `55` \n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::OpenSearchService::Domain DomainEndpointOptions": { - "CustomEndpoint": "The fully qualified URL for your custom endpoint\\. Required if you enabled a custom endpoint for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomEndpoint": "The fully qualified URL for your custom endpoint\\. Required if you enabled a custom endpoint for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomEndpointCertificateArn": "The AWS Certificate Manager ARN for your domain's SSL/TLS certificate\\. Required if you enabled a custom endpoint for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomEndpointEnabled": "True to enable a custom endpoint for the domain\\. If enabled, you must also provide values for `CustomEndpoint` and `CustomEndpointCertificateArn`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EnforceHTTPS": "True to require that all traffic to the domain arrive over HTTPS\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TLSSecurityPolicy": "The minimum TLS version required for traffic to the domain\\. Valid values are TLS 1\\.0 \\(default\\) or 1\\.2: \n+ `Policy-Min-TLS-1-0-2019-07`\n+ `Policy-Min-TLS-1-2-2019-07`\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "EnforceHTTPS": "True to require that all traffic to the domain arrive over HTTPS\\. Required if you enable fine\\-grained access control in [AdvancedSecurityOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \n*Required*: Conditional \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "TLSSecurityPolicy": "The minimum TLS version required for traffic to the domain\\. Valid values are TLS 1\\.0 \\(default\\) or 1\\.2: \n+ `Policy-Min-TLS-1-0-2019-07`\n+ `Policy-Min-TLS-1-2-2019-07`\n*Required*: No \n*Type*: String \n*Allowed values*: `Policy-Min-TLS-1-0-2019-07 | Policy-Min-TLS-1-2-2019-07` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::OpenSearchService::Domain EBSOptions": { "EBSEnabled": "Specifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service domain\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Iops": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. This property applies only to the Provisioned IOPS \\(SSD\\) EBS volume type\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Iops": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. This property applies only to the `gp3` and provisioned IOPS EBS volume types\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Throughput": "The throughput \\(in MiB/s\\) of the EBS volumes attached to data nodes\\. Applies only to the `gp3` volume type\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VolumeSize": "The size \\(in GiB\\) of the EBS volume for each data node\\. The minimum and maximum size of an EBS volume depends on the EBS volume type and the instance type to which it is attached\\. For more information, see [EBS volume size limits](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VolumeType": "The EBS volume type to use with the OpenSearch Service domain, such as standard, gp2, or io1\\. For more information about each type, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide for Linux Instances*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "VolumeType": "The EBS volume type to use with the OpenSearch Service domain\\. If you choose `gp3`, you must also specify values for `Iops` and `Throughput`\\. For more information about each type, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide for Linux Instances*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `gp2 | gp3 | io1 | standard` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::OpenSearchService::Domain EncryptionAtRestOptions": { - "Enabled": "Specify `true` to enable encryption at rest\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KmsKeyId": "The KMS key ID\\. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`\\. Required if you enable encryption at rest\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Enabled": "Specify `true` to enable encryption at rest\\. Required if you enable fine\\-grained access control in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \n*Required*: Conditional \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsKeyId": "The KMS key ID\\. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`\\. Required if you enable encryption at rest\\. \nYou can also use `keyAlias` as a value\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `500` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::OpenSearchService::Domain Idp": { + "EntityId": "The unique entity ID of the application in the SAML identity provider\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MetadataContent": "The metadata of the SAML application, in XML format\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1048576` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::OpenSearchService::Domain LogPublishingOption": { "CloudWatchLogsLogGroupArn": "Specifies the CloudWatch log group to publish to\\. Required if you enable log publishing\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "If `true`, enables the publishing of logs to CloudWatch\\. \nDefault: `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::OpenSearchService::Domain MasterUserOptions": { - "MasterUserARN": "ARN for the master user\\. Only specify if `InternalUserDatabaseEnabled` is false in `AdvancedSecurityOptions`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MasterUserName": "Username for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. If you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MasterUserPassword": "Password for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. If you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "MasterUserARN": "Amazon Resource Name \\(ARN\\) for the master user\\. The ARN can point to an IAM user or role\\. This property is required for Amazon Cognito to work, and it must match the role configured for Cognito\\. Only specify if `InternalUserDatabaseEnabled` is false in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MasterUserName": "Username for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \nIf you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MasterUserPassword": "Password for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \nIf you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `128` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::OpenSearchService::Domain NodeToNodeEncryptionOptions": { - "Enabled": "Specifies to enable or disable node\\-to\\-node encryption on the domain\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Enabled": "Specifies to enable or disable node\\-to\\-node encryption on the domain\\. Required if you enable fine\\-grained access control in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \n*Required*: Conditional \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::OpenSearchService::Domain SAMLOptions": { + "Enabled": "True to enable SAML authentication for a domain\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Idp": "The SAML Identity Provider's information\\. \n*Required*: No \n*Type*: [Idp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-idp.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MasterBackendRole": "The backend role that the SAML master user is mapped to\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MasterUserName": "The SAML master user name, which is stored in the domain's internal user database\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RolesKey": "Element of the SAML assertion to use for backend roles\\. Default is `roles`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SessionTimeoutMinutes": "The duration, in minutes, after which a user session becomes inactive\\. Acceptable values are between 1 and 1440, and the default value is 60\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SubjectKey": "Element of the SAML assertion to use for the user name\\. Default is `NameID`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::OpenSearchService::Domain ServiceSoftwareOptions": { + "AutomatedUpdateDate": "The timestamp, in Epoch time, until which you can manually request a service software update\\. After this date, we automatically update your service software\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Cancellable": "True if you're able to cancel your service software version update\\. False if you can't cancel your service software update\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CurrentVersion": "The current service software version present on the domain\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "A description of the service software update status\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NewVersion": "The new service software version, if one is available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OptionalDeployment": "True if a service software is never automatically updated\\. False if a service software is automatically updated after the automated update date\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UpdateAvailable": "True if you're able to update your service software version\\. False if you can't update your service software version\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UpdateStatus": "The status of your service software update\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `COMPLETED | ELIGIBLE | IN_PROGRESS | NOT_ELIGIBLE | PENDING_UPDATE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::OpenSearchService::Domain SnapshotOptions": { - "AutomatedSnapshotStartHour": "The hour in UTC during which the service takes an automated daily snapshot of the indices in the OpenSearch Service domain\\. For example, if you specify 0, OpenSearch Service takes an automated snapshot everyday between midnight and 1 am\\. You can specify a value between 0 and 23\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AutomatedSnapshotStartHour": "The hour in UTC during which the service takes an automated daily snapshot of the indexes in the OpenSearch Service domain\\. For example, if you specify 0, OpenSearch Service takes an automated snapshot everyday between midnight and 1 am\\. You can specify a value between 0 and 23\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::OpenSearchService::Domain VPCOptions": { "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*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SubnetIds": "Provide one subnet ID for each Availability Zone that your domain uses\\. For example, you must specify three subnet IDs for a three\\-AZ 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*\\. \nIf you specify more than one subnet, you must also configure `ZoneAwarenessEnabled` and `ZoneAwarenessConfig` within [ClusterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html), otherwise you'll see the error \"You must specify exactly one subnet\" during template creation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::OpenSearchService::Domain ZoneAwarenessConfig": { "AvailabilityZoneCount": "If you enabled multiple Availability Zones \\(AZs\\), the number of AZs that you want the domain to use\\. \nValid values are `2` and `3`\\. Default is 2\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -18276,7 +20958,6 @@ "PreferredBackupWindow": "The start time for a one\\-hour period during which AWS OpsWorks CM backs up application\\-level data on your server if automated backups are enabled\\. Valid values must be specified in one of the following formats: \n+ `HH:MM` for daily backups\n+ `DDD:HH:MM` for weekly backups\n `MM` must be specified as `00`\\. The specified time is in coordinated universal time \\(UTC\\)\\. The default value is a random, daily start time\\. \n **Example:** `08:00`, which represents a daily start time of 08:00 UTC\\. \n **Example:** `Mon:08:00`, which represents a start time of every Monday at 08:00 UTC\\. \\(8:00 a\\.m\\.\\) \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PreferredMaintenanceWindow": "The start time for a one\\-hour period each week during which AWS OpsWorks CM performs maintenance on the instance\\. Valid values must be specified in the following format: `DDD:HH:MM`\\. `MM` must be specified as `00`\\. The specified time is in coordinated universal time \\(UTC\\)\\. The default value is a random one\\-hour period on Tuesday, Wednesday, or Friday\\. See `TimeWindowDefinition` for more information\\. \n **Example:** `Mon:08:00`, which represents a start time of every Monday at 08:00 UTC\\. \\(8:00 a\\.m\\.\\) \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityGroupIds": "A list of security group IDs to attach to the Amazon EC2 instance\\. If you add this parameter, the specified security groups must be within the VPC that is specified by `SubnetIds`\\. \n If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0\\.0\\.0\\.0/0 \\(everyone\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ServerName": "The name of the server\\. The server name must be unique within your AWS account, within each region\\. Server names must start with a letter; then letters, numbers, or hyphens \\(\\-\\) are allowed, up to a maximum of 40 characters\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `40` \n*Pattern*: `[a-zA-Z][a-zA-Z0-9\\-]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ServiceRoleArn": "The service role that the AWS OpsWorks CM service backend uses to work with your account\\. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service\\-role\\-creation\\.yaml AWS CloudFormation template, located at https://s3\\.amazonaws\\.com/opsworks\\-cm\\-us\\-east\\-1\\-prod\\-default\\-assets/misc/opsworks\\-cm\\-roles\\.yaml\\. This template creates a CloudFormation stack that includes the service role and instance profile that you need\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `10000` \n*Pattern*: `arn:aws:iam::[0-9]{12}:role/.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SubnetIds": "The IDs of subnets in which to launch the server EC2 instance\\. \n Amazon EC2\\-Classic customers: This field is required\\. All servers must run within a VPC\\. The VPC must have \"Auto Assign Public IP\" enabled\\. \n EC2\\-VPC customers: This field is optional\\. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2\\. If you specify subnet IDs, the VPC must have \"Auto Assign Public IP\" enabled\\. \nFor more information about supported Amazon EC2 platforms, see [Supported Platforms](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server\\. \n+ The key cannot be empty\\.\n+ The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: `+ - = . _ : / @` \n+ The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: `+ - = . _ : / @` \n+ Leading and trailing spaces are trimmed from both the key and value\\.\n+ A maximum of 50 user\\-applied tags is allowed for any AWS OpsWorks CM server\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -18285,6 +20966,30 @@ "Name": "The name of the engine attribute\\. \n **Attribute name for Chef Automate servers:** \n+ `CHEF_AUTOMATE_ADMIN_PASSWORD` \n **Attribute names for Puppet Enterprise servers:** \n+ `PUPPET_ADMIN_PASSWORD` \n+ `PUPPET_R10K_REMOTE` \n+ `PUPPET_R10K_PRIVATE_KEY` \n*Required*: No \n*Type*: String \n*Maximum*: `10000` \n*Pattern*: `(?s).*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Value": "The value of the engine attribute\\. \n **Attribute value for Chef Automate servers:** \n+ `CHEF_AUTOMATE_PIVOTAL_KEY`: A base64\\-encoded RSA public key\\. The corresponding private key is required to access the Chef API\\. You can generate this key by running the following [OpenSSL](https://www.openssl.org/) command on Linux\\-based computers\\." }, + "AWS::Organizations::Account": { + "AccountName": "The account name given to the account when it was created\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\u0020-\\u007E]+` \n*Update requires*: Updates are not supported\\.", + "Email": "The email address associated with the AWS account\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) for this parameter is a string of characters that represents a standard internet email address\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `64` \n*Pattern*: `[^\\s@]+@[^\\s@]+\\.[^\\s@]+` \n*Update requires*: Updates are not supported\\.", + "ParentIds": "The unique identifier \\(ID\\) of the root or organizational unit \\(OU\\) that you want to create the new account in\\. If you don't specify this parameter, the `ParentId` defaults to the root ID\\. \nThis parameter only accepts a string array with one string value\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) for a parent ID string requires one of the following: \n+ **Root** \\- A string that begins with \"r\\-\" followed by from 4 to 32 lowercase letters or digits\\.\n+ **Organizational unit \\(OU\\)** \\- A string that begins with \"ou\\-\" followed by from 4 to 32 lowercase letters or digits \\(the ID of the root that the OU is in\\)\\. This string is followed by a second \"\\-\" dash and from 8 to 32 additional lowercase letters or digits\\.\n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Pattern*: `^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleName": "The name of an IAM role that AWS Organizations automatically preconfigures in the new member account\\. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator\\. The role has administrator permissions in the new member account\\. \nIf you don't specify this parameter, the role name defaults to `OrganizationAccountAccessRole`\\. \nFor more information about how to use this role to access the member account, see the following links: \n+ [Accessing and Administering the Member Accounts in Your Organization](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role) in the * AWS Organizations User Guide* \n+ Steps 2 and 3 in [Tutorial: Delegate Access Across AWS accounts Using IAM Roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html) in the *IAM User Guide* \nThe [regex pattern](http://wikipedia.org/wiki/regex) that is used to validate this parameter\\. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,\\.@\\- \n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Pattern*: `[\\w+=,.@-]{1,64}` \n*Update requires*: Updates are not supported\\.", + "Tags": "A list of tags that you want to attach to the newly created account\\. For each tag in the list, you must specify both a tag key and a value\\. You can set the value to an empty string, but you can't set it to `null`\\. For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide\\. \nIf any one of the tags is not valid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Organizations::OrganizationalUnit": { + "Name": "The friendly name of this OU\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) that is used to validate this parameter is a string of any of the characters in the ASCII character range\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ParentId": "The unique identifier \\(ID\\) of the parent root or OU that you want to create the new OU in\\. \nTo update the `ParentId` parameter value, you must first remove all accounts attached to the organizational unit \\(OU\\)\\. OUs can't be moved within the organization with accounts still attached\\.\nThe [regex pattern](http://wikipedia.org/wiki/regex) for a parent ID string requires one of the following: \n+ **Root** \\- A string that begins with \"r\\-\" followed by from 4 to 32 lowercase letters or digits\\.\n+ **Organizational unit \\(OU\\)** \\- A string that begins with \"ou\\-\" followed by from 4 to 32 lowercase letters or digits \\(the ID of the root that the OU is in\\)\\. This string is followed by a second \"\\-\" dash and from 8 to 32 additional lowercase letters or digits\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `100` \n*Pattern*: `^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "A list of tags that you want to attach to the newly created OU\\. For each tag in the list, you must specify both a tag key and a value\\. You can set the value to an empty string, but you can't set it to `null`\\. For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide\\. \nIf any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire request fails and the OU is not created\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Organizations::Policy": { + "Content": "The policy text content\\. The text that you supply must adhere to the rules of the policy type you specify in the `Type` parameter\\. The following AWS Organizations quotas are enforced for the maximum size of a policy document: \n+ Service control policies: 5,120 bytes *\\(not characters\\)*\n+ AI services opt\\-out policies: 2,500 characters\n+ Backup policies: 10,000 characters\n+ Tag policies: 10,000 characters\nFor more information about Organizations service quotas, see [Quotas for AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html) in the *AWS Organizations User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000000` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "Human readable description of the policy\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "Name of the policy\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) that is used to validate this parameter is a string of any of the characters in the ASCII character range\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "A list of tags that you want to attach to the newly created policy\\. For each tag in the list, you must specify both a tag key and a value\\. You can set the value to an empty string, but you can't set it to `null`\\. For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide\\. \nIf any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetIds": "List of unique identifiers \\(IDs\\) of the root, OU, or account that you want to attach the policy to\\. You can get the ID by calling the [ListRoots](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html), [ListOrganizationalUnitsForParent](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListOrganizationalUnitsForParent.html), or [ListAccounts](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListAccounts.html) operations\\. If you don't specify this parameter, the policy is created but not attached to any organization resource\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) for a target ID string requires one of the following: \n+ **Root** \\- A string that begins with \"r\\-\" followed by from 4 to 32 lowercase letters or digits\\.\n+ **Account** \\- A string that consists of exactly 12 digits\\.\n+ **Organizational unit \\(OU\\)** \\- A string that begins with \"ou\\-\" followed by from 4 to 32 lowercase letters or digits \\(the ID of the root that the OU is in\\)\\. This string is followed by a second \"\\-\" dash and from 8 to 32 additional lowercase letters or digits\\.\n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Pattern*: `^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of policy to create\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AISERVICES_OPT_OUT_POLICY | BACKUP_POLICY | SERVICE_CONTROL_POLICY | TAG_POLICY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Organizations::ResourcePolicy": { + "Content": "The policy text of the organization resource policy\\. You can specify the resource policy content as a JSON object or a JSON string\\. \nWhen you specify the resource policy content as a JSON string, you can't perform drift detection on the CloudFormation stack\\. For this reason, we recommend specifying the resource policy content as a JSON object instead\\.\n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `40000` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "A list of tags that you want to attach to the newly created resource policy\\. For each tag in the list, you must specify both a tag key and a value\\. You can set the value to an empty string, but you can't set it to `null`\\. For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the *AWS Organizations User Guide*\\. \nIf any one of the tags is not valid or if you exceed the allowed number of tags for the resource policy, then the entire request fails and the resource policy is not created\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Panorama::ApplicationInstance": { "ApplicationInstanceIdToReplace": "The ID of an application instance to replace with the new instance\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9\\-\\_]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DefaultRuntimeContextDevice": "The device's ID\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9\\-\\_]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -18294,7 +20999,7 @@ "ManifestPayload": "The application's manifest document\\. \n*Required*: Yes \n*Type*: [ManifestPayload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-panorama-applicationinstance-manifestpayload.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "A name for the application instance\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9\\-\\_]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RuntimeRoleArn": "The ARN of a runtime role for the application instance\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StatusFilter": "Only include instances with a specific status\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEPLOYMENT_ERROR | DEPLOYMENT_SUCCEEDED | PROCESSING_DEPLOYMENT | PROCESSING_REMOVAL | REMOVAL_FAILED | REMOVAL_SUCCEEDED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StatusFilter": "Only include instances with a specific status\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEPLOYMENT_ERROR | DEPLOYMENT_FAILED | DEPLOYMENT_SUCCEEDED | PROCESSING_DEPLOYMENT | PROCESSING_REMOVAL | REMOVAL_FAILED | REMOVAL_SUCCEEDED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Tags for the application instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Panorama::ApplicationInstance ManifestOverridesPayload": { @@ -18305,8 +21010,16 @@ }, "AWS::Panorama::Package": { "PackageName": "A name for the package\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[a-zA-Z0-9\\-\\_]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StorageLocation": "Property description not available\\. \n*Required*: No \n*Type*: [StorageLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-panorama-package-storagelocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Tags for the package\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Panorama::Package StorageLocation": { + "BinaryPrefixLocation": "The location's binary prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Bucket": "The location's bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "GeneratedPrefixLocation": "The location's generated prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ManifestPrefixLocation": "The location's manifest prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RepoPrefixLocation": "The location's repo prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Panorama::PackageVersion": { "MarkLatest": "Whether to mark the new version as the latest version\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OwnerAccount": "An owner account\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `12` \n*Pattern*: `[0-9a-z\\_]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -18322,8 +21035,11 @@ "Name": "The name of the dataset\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9\\-_]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SchemaArn": "The ARN of the associated schema\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:([a-z\\d-]+):personalize:.*:.*:.+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::Personalize::Dataset DataSource": { + "DataLocation": "The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored\\. For example: \n `s3://bucket-name/folder-name/` \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `(s3|http|https)://.+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Personalize::Dataset DatasetImportJob": { - "DataSource": "The Amazon S3 bucket that contains the training data to import\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataSource": "The Amazon S3 bucket that contains the training data to import\\. \n*Required*: No \n*Type*: [DataSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DatasetArn": "The Amazon Resource Name \\(ARN\\) of the dataset that receives the imported data\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:([a-z\\d-]+):personalize:.*:.*:.+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DatasetImportJobArn": "The ARN of the dataset import job\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:([a-z\\d-]+):personalize:.*:.*:.+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "JobName": "The name of the import job\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9\\-_]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -18344,17 +21060,54 @@ "DatasetGroupArn": "The Amazon Resource Name \\(ARN\\) of the dataset group that provides the training data\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:([a-z\\d-]+):personalize:.*:.*:.+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EventType": "The event type \\(for example, 'click' or 'like'\\) that is used for training the model\\. If no `eventType` is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "The name of the solution\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9\\-_]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PerformAutoML": "When true, Amazon Personalize performs a search for the best USER\\_PERSONALIZATION recipe from the list specified in the solution configuration \\(`recipeArn` must not be specified\\)\\. When false \\(the default\\), Amazon Personalize uses `recipeArn` for training\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PerformAutoML": "We don't recommend enabling automated machine learning\\. Instead, match your use case to the available Amazon Personalize recipes\\. For more information, see [Determining your use case\\.](https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html) \nWhen true, Amazon Personalize performs a search for the best USER\\_PERSONALIZATION recipe from the list specified in the solution configuration \\(`recipeArn` must not be specified\\)\\. When false \\(the default\\), Amazon Personalize uses `recipeArn` for training\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PerformHPO": "Whether to perform hyperparameter optimization \\(HPO\\) on the chosen recipe\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RecipeArn": "The ARN of the recipe used to create the solution\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:([a-z\\d-]+):personalize:.*:.*:.+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SolutionConfig": "Describes the configuration properties for the solution\\. \n*Required*: No \n*Type*: [SolutionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-solutionconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::Personalize::Solution AlgorithmHyperParameterRanges": { + "CategoricalHyperParameterRanges": "Property description not available\\. \n*Required*: No \n*Type*: List of [CategoricalHyperParameterRange](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-categoricalhyperparameterrange.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ContinuousHyperParameterRanges": "Property description not available\\. \n*Required*: No \n*Type*: List of [ContinuousHyperParameterRange](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IntegerHyperParameterRanges": "Property description not available\\. \n*Required*: No \n*Type*: List of [IntegerHyperParameterRange](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Personalize::Solution AutoMLConfig": { + "MetricName": "The metric to optimize\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RecipeList": "The list of candidate recipes\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Personalize::Solution CategoricalHyperParameterRange": { + "Name": "The name of the hyperparameter\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Values": "A list of the categories for the hyperparameter\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Personalize::Solution ContinuousHyperParameterRange": { + "MaxValue": "The maximum allowable value for the hyperparameter\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MinValue": "The minimum allowable value for the hyperparameter\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the hyperparameter\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Personalize::Solution HpoConfig": { + "AlgorithmHyperParameterRanges": "The hyperparameters and their allowable ranges\\. \n*Required*: No \n*Type*: [AlgorithmHyperParameterRanges](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-algorithmhyperparameterranges.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "HpoObjective": "The metric to optimize during HPO\\. \nAmazon Personalize doesn't support configuring the `hpoObjective` at this time\\.\n*Required*: No \n*Type*: [HpoObjective](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "HpoResourceConfig": "Describes the resource configuration for HPO\\. \n*Required*: No \n*Type*: [HpoResourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hporesourceconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Personalize::Solution HpoObjective": { + "MetricName": "The name of the metric\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MetricRegex": "A regular expression for finding the metric in the training job logs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Type": "The type of the metric\\. Valid values are `Maximize` and `Minimize`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Personalize::Solution HpoResourceConfig": { + "MaxNumberOfTrainingJobs": "The maximum number of training jobs when you create a solution version\\. The maximum value for `maxNumberOfTrainingJobs` is `40`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MaxParallelTrainingJobs": "The maximum number of parallel training jobs when you create a solution version\\. The maximum value for `maxParallelTrainingJobs` is `10`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Personalize::Solution IntegerHyperParameterRange": { + "MaxValue": "The maximum allowable value for the hyperparameter\\. \n*Required*: No \n*Type*: Integer \n*Maximum*: `1000000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MinValue": "The minimum allowable value for the hyperparameter\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `-1000000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the hyperparameter\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::Personalize::Solution SolutionConfig": { "AlgorithmHyperParameters": "Lists the hyperparameter names and ranges\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "AutoMLConfig": "The [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) object containing a list of recipes to search when AutoML is performed\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AutoMLConfig": "The [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) object containing a list of recipes to search when AutoML is performed\\. \n*Required*: No \n*Type*: [AutoMLConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-automlconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EventValueThreshold": "Only events with a value greater than or equal to this threshold are used for training a model\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FeatureTransformationParameters": "Lists the feature transformation parameters\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "HpoConfig": "Describes the properties for hyperparameter optimization \\(HPO\\)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "HpoConfig": "Describes the properties for hyperparameter optimization \\(HPO\\)\\. \n*Required*: No \n*Type*: [HpoConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Pinpoint::ADMChannel": { "ApplicationId": "The unique identifier for the Amazon Pinpoint application that the ADM channel applies to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -18442,17 +21195,19 @@ "AdditionalTreatments": "An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign\\. \n*Required*: No \n*Type*: List of [WriteTreatmentResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ApplicationId": "The unique identifier for the Amazon Pinpoint application that the campaign is associated with\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "CampaignHook": "Specifies the Lambda function to use as a code hook for a campaign\\. \n*Required*: No \n*Type*: [CampaignHook](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomDeliveryConfiguration": "The delivery configuration settings for sending the treatment through a custom channel\\. This object is required if the `MessageConfiguration` object for the treatment specifies a `CustomMessage` object\\. \n*Required*: No \n*Type*: [CustomDeliveryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A custom description of the campaign\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HoldoutPercent": "The allocated percentage of users \\(segment members\\) who shouldn't receive messages from the campaign\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IsPaused": "Specifies whether to pause the campaign\\. A paused campaign doesn't run unless you resume it by changing this value to `false`\\. If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Limits": "The messaging limits for the campaign\\. \n*Required*: No \n*Type*: [Limits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MessageConfiguration": "The message configuration settings for the campaign\\. \n*Required*: Yes \n*Type*: [MessageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MessageConfiguration": "The message configuration settings for the campaign\\. \n*Required*: No \n*Type*: [MessageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the campaign\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Priority": "An integer between 1 and 5, inclusive, that represents the priority of the in\\-app message campaign, where 1 is the highest priority and 5 is the lowest\\. If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Schedule": "The schedule settings for the campaign\\. \n*Required*: Yes \n*Type*: [Schedule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SegmentId": "The unique identifier for the segment to associate with the campaign\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SegmentVersion": "The version of the segment to associate with the campaign\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TemplateConfiguration": "The message template to use for the treatment\\. \n*Required*: No \n*Type*: [TemplateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TreatmentDescription": "A custom description of the default treatment for the campaign\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TreatmentName": "A custom name of the default treatment for the campaign, if the campaign has multiple treatments\\. A *treatment* is a variation of a campaign that's used for A/B testing\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -18460,6 +21215,9 @@ "AttributeType": "The type of segment dimension to use\\. Valid values are: \n+ `INCLUSIVE` \u2013 endpoints that have attributes matching the values are included in the segment\\.\n+ `EXCLUSIVE` \u2013 endpoints that have attributes matching the values are excluded from the segment\\.\n+ `CONTAINS` \u2013 endpoints that have attributes' substrings match the values are included in the segment\\.\n+ `BEFORE` \u2013 endpoints with attributes read as ISO\\_INSTANT datetimes before the value are included in the segment\\.\n+ `AFTER` \u2013 endpoints with attributes read as ISO\\_INSTANT datetimes after the value are included in the segment\\.\n+ `BETWEEN` \u2013 endpoints with attributes read as ISO\\_INSTANT datetimes between the values are included in the segment\\.\n+ `ON` \u2013 endpoints with attributes read as ISO\\_INSTANT dates on the value are included in the segment\\. Time is ignored in this comparison\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Values": "The criteria values to use for the segment dimension\\. Depending on the value of the `AttributeType` property, endpoints are included or excluded from the segment if their attribute values match the criteria values\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Pinpoint::Campaign CampaignCustomMessage": { + "Data": "The raw, JSON\\-formatted string to use as the payload for the message\\. The maximum size is 5 KB\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Pinpoint::Campaign CampaignEmailMessage": { "Body": "The body of the email for recipients whose email clients don't render HTML content\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FromAddress": "The verified email address to send the email from\\. The default address is the `FromAddress` specified for the email channel for the application\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -18478,7 +21236,7 @@ "AWS::Pinpoint::Campaign CampaignInAppMessage": { "Content": "An array that contains configurtion information about the in\\-app message for the campaign, including title and body text, text colors, background colors, image URLs, and button configurations\\. \n*Required*: No \n*Type*: List of [InAppMessageContent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomConfig": "Custom data, in the form of key\\-value pairs, that is included in an in\\-app messaging payload\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Layout": "A string that describes how the in\\-app message will appear\\. You can specify one of the following: \n+ `BOTTOM_BANNER` \u2013 a message that appears as a banner at the bottom of the page\\.\n+ `TOP_BANNER` \u2013 a message that appears as a banner at the top of the page\\.\n+ `OVERLAYS` \u2013 a message that covers entire screen\\.\n+ `MOBILE_FEED` \u2013 a message that appears in a window in front of the page\\.\n+ `MIDDLE_BANNER` \u2013 a message that appears as a banner in the middle of the page\\.\n+ `CAROUSEL` \u2013 a scrollable layout of up to five unique messages\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Layout": "A string that describes how the in\\-app message will appear\\. You can specify one of the following: \n+ `BOTTOM_BANNER` \u2013 a message that appears as a banner at the bottom of the page\\.\n+ `TOP_BANNER` \u2013 a message that appears as a banner at the top of the page\\.\n+ `OVERLAYS` \u2013 a message that covers entire screen\\.\n+ `MOBILE_FEED` \u2013 a message that appears in a window in front of the page\\.\n+ `MIDDLE_BANNER` \u2013 a message that appears as a banner in the middle of the page\\.\n+ `CAROUSEL` \u2013 a scrollable layout of up to five unique messages\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Pinpoint::Campaign CampaignSmsMessage": { "Body": "The body of the SMS message\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -18488,17 +21246,21 @@ "SenderId": "The alphabetic Sender ID to display as the sender of the message on a recipient's device\\. Support for sender IDs varies by country or region\\. To specify a phone number as the sender, omit this parameter and use `OriginationNumber` instead\\. For more information about support for Sender ID by country, see the [Amazon Pinpoint User Guide](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TemplateId": "The template ID received from the regulatory body for sending SMS in your country\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Pinpoint::Campaign CustomDeliveryConfiguration": { + "DeliveryUri": "The destination to send the campaign or treatment to\\. This value can be one of the following: \n+ The name or Amazon Resource Name \\(ARN\\) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment\\.\n+ The URL for a web application or service that supports HTTPS and can receive the message\\. The URL has to be a full URL, including the HTTPS protocol\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EndpointTypes": "The types of endpoints to send the campaign or treatment to\\. Each valid value maps to a type of channel that you can associate with an endpoint by using the `ChannelType` property of an endpoint\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Pinpoint::Campaign DefaultButtonConfiguration": { "BackgroundColor": "The background color of a button, expressed as a hex color code \\(such as \\#000000 for black\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BorderRadius": "The border radius of a button\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ButtonAction": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ButtonAction": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Link": "The destination \\(such as a URL\\) for a button\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Text": "The text that appears on a button in an in\\-app message\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TextColor": "The color of the body text in a button, expressed as a hex color code \\(such as \\#000000 for black\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Pinpoint::Campaign EventDimensions": { "Attributes": "One or more custom attributes that your application reports to Amazon Pinpoint\\. You can use these attributes as selection criteria when you create an event filter\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EventType": "The name of the event that causes the campaign to be sent or the journey activity to be performed\\. This can be a standard event that Amazon Pinpoint generates, such as `_email.delivered`\\. For campaigns, this can also be a custom event that's specific to your application\\. For information about standard events, see [Streaming Amazon Pinpoint Events](https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html) in the *Amazon Pinpoint Developer Guide*\\. \n*Required*: No \n*Type*: [SetDimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventType": "The name of the event that causes the campaign to be sent or the journey activity to be performed\\. This can be a standard event that Amazon Pinpoint generates, such as `_email.delivered` or `_custom.delivered`\\. For campaigns, this can also be a custom event that's specific to your application\\. For information about standard events, see [Streaming Amazon Pinpoint Events](https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html) in the * Amazon Pinpoint Developer Guide*\\. \n*Required*: No \n*Type*: [SetDimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Metrics": "One or more custom metrics that your application reports to Amazon Pinpoint\\. You can use these metrics as selection criteria when you create an event filter\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Pinpoint::Campaign InAppMessageBodyConfig": { @@ -18529,7 +21291,7 @@ "Daily": "The maximum number of messages that a campaign can send to a single endpoint during a 24\\-hour period\\. The maximum value is 100\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaximumDuration": "The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign\\. The minimum value is 60 seconds\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MessagesPerSecond": "The maximum number of messages that a campaign can send each second\\. The minimum value is 50\\. The maximum value is 20,000\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Session": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Session": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Total": "The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign\\. The maximum value is 100\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Pinpoint::Campaign Message": { @@ -18550,6 +21312,7 @@ "ADMMessage": "The message that the campaign sends through the ADM \\(Amazon Device Messaging\\) channel\\. If specified, this message overrides the default message\\. \n*Required*: No \n*Type*: [Message](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "APNSMessage": "The message that the campaign sends through the APNs \\(Apple Push Notification service\\) channel\\. If specified, this message overrides the default message\\. \n*Required*: No \n*Type*: [Message](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BaiduMessage": "The message that the campaign sends through the Baidu \\(Baidu Cloud Push\\) channel\\. If specified, this message overrides the default message\\. \n*Required*: No \n*Type*: [Message](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomMessage": "The message that the campaign sends through a custom channel, as specified by the delivery configuration \\(`CustomDeliveryConfiguration`\\) settings for the campaign\\. If specified, this message overrides the default message\\. \n*Required*: No \n*Type*: [CampaignCustomMessage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigncustommessage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DefaultMessage": "The default message that the campaign sends through all the channels that are configured for the campaign\\. \n*Required*: No \n*Type*: [Message](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EmailMessage": "The message that the campaign sends through the email channel\\. If specified, this message overrides the default message\\. \n*Required*: No \n*Type*: [CampaignEmailMessage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GCMMessage": "The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging \\(FCM\\), formerly Google Cloud Messaging \\(GCM\\), service\\. If specified, this message overrides the default message\\. \n*Required*: No \n*Type*: [Message](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -18561,7 +21324,7 @@ "Value": "The value to compare\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Pinpoint::Campaign OverrideButtonConfiguration": { - "ButtonAction": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ButtonAction": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Link": "The destination \\(such as a URL\\) for a button\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Pinpoint::Campaign QuietTime": { @@ -18581,10 +21344,22 @@ "DimensionType": "The type of segment dimension to use\\. Valid values are: `INCLUSIVE`, endpoints that match the criteria are included in the segment; and, `EXCLUSIVE`, endpoints that match the criteria are excluded from the segment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Values": "The criteria values to use for the segment dimension\\. Depending on the value of the `DimensionType` property, endpoints are included or excluded from the segment if their values match the criteria values\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Pinpoint::Campaign Template": { + "Name": "The name of the message template to use for the message\\. If specified, this value must match the name of an existing message template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Version": "The unique identifier for the version of the message template to use for the message\\. If specified, this value must match the identifier for an existing template version\\. To retrieve a list of versions and version identifiers for a template, use the [Template Versions](https://docs.aws.amazon.com/pinpoint/latest/apireference/templates-template-name-template-type-versions.html) resource\\. \nIf you don't specify a value for this property, Amazon Pinpoint uses the *active version* of the template\\. The *active version* is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow\\. It isn't necessarily the latest version of a template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pinpoint::Campaign TemplateConfiguration": { + "EmailTemplate": "The email template to use for the message\\. \n*Required*: No \n*Type*: [Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PushTemplate": "The push notification template to use for the message\\. \n*Required*: No \n*Type*: [Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SMSTemplate": "The SMS template to use for the message\\. \n*Required*: No \n*Type*: [Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VoiceTemplate": "The voice template to use for the message\\. This object isn't supported for campaigns\\. \n*Required*: No \n*Type*: [Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Pinpoint::Campaign WriteTreatmentResource": { + "CustomDeliveryConfiguration": "The delivery configuration settings for sending the treatment through a custom channel\\. This object is required if the `MessageConfiguration` object for the treatment specifies a `CustomMessage` object\\. \n*Required*: No \n*Type*: [CustomDeliveryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MessageConfiguration": "The message configuration settings for the treatment\\. \n*Required*: No \n*Type*: [MessageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Schedule": "The schedule settings for the treatment\\. \n*Required*: No \n*Type*: [Schedule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SizePercent": "The allocated percentage of users \\(segment members\\) to send the treatment to\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TemplateConfiguration": "The message template to use for the treatment\\. \n*Required*: No \n*Type*: [TemplateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TreatmentDescription": "A custom description of the treatment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TreatmentName": "A custom name for the treatment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -18618,7 +21393,7 @@ "AWS::Pinpoint::InAppTemplate": { "Content": "An object that contains information about the content of an in\\-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors\\. \n*Required*: No \n*Type*: List of [InAppMessageContent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomConfig": "Custom data, in the form of key\\-value pairs, that is included in an in\\-app messaging payload\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Layout": "A string that determines the appearance of the in\\-app message\\. You can specify one of the following: \n+ `BOTTOM_BANNER` \u2013 a message that appears as a banner at the bottom of the page\\.\n+ `TOP_BANNER` \u2013 a message that appears as a banner at the top of the page\\.\n+ `OVERLAYS` \u2013 a message that covers entire screen\\.\n+ `MOBILE_FEED` \u2013 a message that appears in a window in front of the page\\.\n+ `MIDDLE_BANNER` \u2013 a message that appears as a banner in the middle of the page\\.\n+ `CAROUSEL` \u2013 a scrollable layout of up to five unique messages\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Layout": "A string that determines the appearance of the in\\-app message\\. You can specify one of the following: \n+ `BOTTOM_BANNER` \u2013 a message that appears as a banner at the bottom of the page\\.\n+ `TOP_BANNER` \u2013 a message that appears as a banner at the top of the page\\.\n+ `OVERLAYS` \u2013 a message that covers entire screen\\.\n+ `MOBILE_FEED` \u2013 a message that appears in a window in front of the page\\.\n+ `MIDDLE_BANNER` \u2013 a message that appears as a banner in the middle of the page\\.\n+ `CAROUSEL` \u2013 a scrollable layout of up to five unique messages\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TemplateDescription": "An optional description of the in\\-app template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TemplateName": "The name of the in\\-app message template\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" @@ -18637,7 +21412,7 @@ "AWS::Pinpoint::InAppTemplate DefaultButtonConfiguration": { "BackgroundColor": "The background color of a button, expressed as a hex color code \\(such as \\#000000 for black\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BorderRadius": "The border radius of a button\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ButtonAction": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ButtonAction": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Link": "The destination \\(such as a URL\\) for a button\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Text": "The text that appears on a button in an in\\-app message\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TextColor": "The color of the body text in a button, expressed as a hex color code \\(such as \\#000000 for black\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -18656,7 +21431,7 @@ "SecondaryBtn": "An object that contains configuration information about the secondary button in an in\\-app message\\. \n*Required*: No \n*Type*: [ButtonConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Pinpoint::InAppTemplate OverrideButtonConfiguration": { - "ButtonAction": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ButtonAction": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Link": "The destination \\(such as a URL\\) for a button\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Pinpoint::PushTemplate": { @@ -18704,7 +21479,7 @@ "AWS::Pinpoint::Segment": { "ApplicationId": "The unique identifier for the Amazon Pinpoint application that the segment is associated with\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Dimensions": "The criteria that define the dimensions for the segment\\. \n*Required*: No \n*Type*: [SegmentDimensions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the segment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the segment\\. \nA segment must have a name otherwise it will not appear in the Amazon Pinpoint console\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SegmentGroups": "The segment group to use and the dimensions to apply to the group's base segments in order to build the segment\\. A segment group can consist of zero or more base segments\\. Your request can include only one segment group\\. \n*Required*: No \n*Type*: [SegmentGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -18854,9 +21629,291 @@ "Key": "One part of a key\\-value pair that defines a tag\\. The maximum length of a tag key is 128 characters\\. The minimum length is 1 character\\. \nIf you specify tags for the identity, then this value is required\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Value": "The optional part of a key\\-value pair that defines a tag\\. The maximum length of a tag value is 256 characters\\. The minimum length is 0 characters\\. If you don\u2019t want a resource to have a specific tag value, don\u2019t specify a value for this parameter\\. Amazon Pinpoint will set the value to an empty string\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Pipes::Pipe": { + "Description": "A description of the pipe\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DesiredState": "The state the pipe should be in\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Enrichment": "The ARN of the enrichment resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnrichmentParameters": "The parameters required to set up enrichment on your pipe\\. \n*Required*: No \n*Type*: [PipeEnrichmentParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmentparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the pipe\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RoleArn": "The ARN of the role that allows the pipe to send data to the target\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Source": "The ARN of the source resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SourceParameters": "The parameters required to set up a source for your pipe\\. \n*Required*: No \n*Type*: [PipeSourceParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The list of key\\-value pairs to associate with the pipe\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Target": "The ARN of the target resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetParameters": "The parameters required to set up a target for your pipe\\. \nFor more information about pipe target parameters, including how to use dynamic path parameters, see [Target parameters](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) in the *Amazon EventBridge User Guide*\\. \n*Required*: No \n*Type*: [PipeTargetParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe AwsVpcConfiguration": { + "AssignPublicIp": "Specifies whether the task's elastic network interface receives a public IP address\\. You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecurityGroups": "Specifies the security groups associated with the task\\. These security groups must all be in the same VPC\\. You can specify as many as five security groups\\. If you do not specify a security group, the default security group for the VPC is used\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Subnets": "Specifies the subnets associated with the task\\. These subnets must all be in the same VPC\\. You can specify as many as 16 subnets\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe BatchArrayProperties": { + "Size": "The size of the array, if this is an array batch job\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe BatchContainerOverrides": { + "Command": "The command to send to the container that overrides the default command from the Docker image or the task definition\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Environment": "The environment variables to send to the container\\. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition\\. \nEnvironment variables cannot start with \"`AWS Batch`\"\\. This naming convention is reserved for variables that AWS Batch sets\\.\n*Required*: No \n*Type*: List of [BatchEnvironmentVariable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchenvironmentvariable.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InstanceType": "The instance type to use for a multi\\-node parallel job\\. \nThis parameter isn't applicable to single\\-node container jobs or jobs that run on Fargate resources, and shouldn't be provided\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceRequirements": "The type and amount of resources to assign to a container\\. This overrides the settings in the job definition\\. The supported resources include `GPU`, `MEMORY`, and `VCPU`\\. \n*Required*: No \n*Type*: List of [BatchResourceRequirement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchresourcerequirement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe BatchEnvironmentVariable": { + "Name": "The name of the key\\-value pair\\. For environment variables, this is the name of the environment variable\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The value of the key\\-value pair\\. For environment variables, this is the value of the environment variable\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe BatchJobDependency": { + "JobId": "The job ID of the AWS Batch job that's associated with this dependency\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of the job dependency\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe BatchResourceRequirement": { + "Type": "The type of resource to assign to a container\\. The supported resources include `GPU`, `MEMORY`, and `VCPU`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The quantity of the specified resource to reserve for the container\\. The values vary based on the `type` specified\\. \ntype=\"GPU\" \nThe number of physical GPUs to reserve for the container\\. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on\\. \nGPUs aren't available for jobs that are running on Fargate resources\\. \ntype=\"MEMORY\" \nThe memory hard limit \\(in MiB\\) present to the container\\. This parameter is supported for jobs that are running on EC2 resources\\. If your container attempts to exceed the memory specified, the container is terminated\\. This parameter maps to `Memory` in the [ Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. You must specify at least 4 MiB of memory for a job\\. This is required but can be specified in several places for multi\\-node parallel \\(MNP\\) jobs\\. It must be specified for each node at least once\\. This parameter maps to `Memory` in the [ Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. \nIf you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see [Memory management](https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in the *AWS Batch User Guide*\\.\nFor jobs that are running on Fargate resources, then `value` is the hard limit \\(in MiB\\), and must match one of the supported values and the `VCPU` values must be one of the values supported for that memory value\\. \nvalue = 512 \n`VCPU` = 0\\.25 \nvalue = 1024 \n`VCPU` = 0\\.25 or 0\\.5 \nvalue = 2048 \n`VCPU` = 0\\.25, 0\\.5, or 1 \nvalue = 3072 \n`VCPU` = 0\\.5, or 1 \nvalue = 4096 \n`VCPU` = 0\\.5, 1, or 2 \nvalue = 5120, 6144, or 7168 \n`VCPU` = 1 or 2 \nvalue = 8192 \n`VCPU` = 1, 2, 4, or 8 \nvalue = 9216, 10240, 11264, 12288, 13312, 14336, or 15360 \n`VCPU` = 2 or 4 \nvalue = 16384 \n`VCPU` = 2, 4, or 8 \nvalue = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720 \n`VCPU` = 4 \nvalue = 20480, 24576, or 28672 \n`VCPU` = 4 or 8 \nvalue = 36864, 45056, 53248, or 61440 \n`VCPU` = 8 \nvalue = 32768, 40960, 49152, or 57344 \n`VCPU` = 8 or 16 \nvalue = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880 \n`VCPU` = 16 \ntype=\"VCPU\" \nThe number of vCPUs reserved for the container\\. This parameter maps to `CpuShares` in the [ Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--cpu-shares` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. Each vCPU is equivalent to 1,024 CPU shares\\. For EC2 resources, you must specify at least one vCPU\\. This is required but can be specified in several places; it must be specified for each node at least once\\. \nThe default for the Fargate On\\-Demand vCPU resource count quota is 6 vCPUs\\. For more information about Fargate quotas, see [AWS Fargate quotas](https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate) in the *AWS General Reference*\\. \nFor jobs that are running on Fargate resources, then `value` must match one of the supported values and the `MEMORY` values must be one of the values supported for that `VCPU` value\\. The supported values are 0\\.25, 0\\.5, 1, 2, 4, 8, and 16 \nvalue = 0\\.25 \n`MEMORY` = 512, 1024, or 2048 \nvalue = 0\\.5 \n`MEMORY` = 1024, 2048, 3072, or 4096 \nvalue = 1 \n`MEMORY` = 2048, 3072, 4096, 5120, 6144, 7168, or 8192 \nvalue = 2 \n`MEMORY` = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384 \nvalue = 4 \n`MEMORY` = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720 \nvalue = 8 \n`MEMORY` = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440 \nvalue = 16 \n`MEMORY` = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880 \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe BatchRetryStrategy": { + "Attempts": "The number of times to move a job to the `RUNNABLE` status\\. If the value of `attempts` is greater than one, the job is retried on failure the same number of attempts as the value\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe CapacityProviderStrategyItem": { + "Base": "The base value designates how many tasks, at a minimum, to run on the specified capacity provider\\. Only one capacity provider in a capacity provider strategy can have a base defined\\. If no value is specified, the default value of 0 is used\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CapacityProvider": "The short name of the capacity provider\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Weight": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider\\. The weight value is taken into consideration after the base value, if defined, is satisfied\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe DeadLetterConfig": { + "Arn": "The ARN of the Amazon SQS queue specified as the target for the dead\\-letter queue\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe EcsContainerOverride": { + "Command": "The command to send to the container that overrides the default command from the Docker image or the task definition\\. You must also specify a container name\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Cpu": "The number of `cpu` units reserved for the container, instead of the default value from the task definition\\. You must also specify a container name\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Environment": "The environment variables to send to the container\\. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition\\. You must also specify a container name\\. \n*Required*: No \n*Type*: List of [EcsEnvironmentVariable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentvariable.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnvironmentFiles": "A list of files containing the environment variables to pass to a container, instead of the value from the container definition\\. \n*Required*: No \n*Type*: List of [EcsEnvironmentFile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentfile.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Memory": "The hard limit \\(in MiB\\) of memory to present to the container, instead of the default value from the task definition\\. If your container attempts to exceed the memory specified here, the container is killed\\. You must also specify a container name\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MemoryReservation": "The soft limit \\(in MiB\\) of memory to reserve for the container, instead of the default value from the task definition\\. You must also specify a container name\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the container that receives the override\\. This parameter is required if any override is specified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceRequirements": "The type and amount of a resource to assign to a container, instead of the default value from the task definition\\. The only supported resource is a GPU\\. \n*Required*: No \n*Type*: List of [EcsResourceRequirement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsresourcerequirement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe EcsEnvironmentFile": { + "Type": "The file type to use\\. The only supported value is `s3`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The Amazon Resource Name \\(ARN\\) of the Amazon S3 object containing the environment variable file\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe EcsEnvironmentVariable": { + "Name": "The name of the key\\-value pair\\. For environment variables, this is the name of the environment variable\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The value of the key\\-value pair\\. For environment variables, this is the value of the environment variable\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe EcsEphemeralStorage": { + "SizeInGiB": "The total amount, in GiB, of ephemeral storage to set for the task\\. The minimum supported value is `21` GiB and the maximum supported value is `200` GiB\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe EcsInferenceAcceleratorOverride": { + "DeviceName": "The Elastic Inference accelerator device name to override for the task\\. This parameter must match a `deviceName` specified in the task definition\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeviceType": "The Elastic Inference accelerator type to use\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe EcsResourceRequirement": { + "Type": "The type of resource to assign to a container\\. The supported values are `GPU` or `InferenceAccelerator`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The value for the specified resource type\\. \nIf the `GPU` type is used, the value is the number of physical `GPUs` the Amazon ECS container agent reserves for the container\\. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on\\. \nIf the `InferenceAccelerator` type is used, the `value` matches the `deviceName` for an InferenceAccelerator specified in a task definition\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe EcsTaskOverride": { + "ContainerOverrides": "One or more container overrides that are sent to a task\\. \n*Required*: No \n*Type*: List of [EcsContainerOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Cpu": "The cpu override for the task\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EphemeralStorage": "The ephemeral storage setting override for the task\\. \nThis parameter is only supported for tasks hosted on Fargate that use the following platform versions: \n+ Linux platform version `1.4.0` or later\\.\n+ Windows platform version `1.0.0` or later\\.\n*Required*: No \n*Type*: [EcsEphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsephemeralstorage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExecutionRoleArn": "The Amazon Resource Name \\(ARN\\) of the task execution IAM role override for the task\\. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InferenceAcceleratorOverrides": "The Elastic Inference accelerator override for the task\\. \n*Required*: No \n*Type*: List of [EcsInferenceAcceleratorOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsinferenceacceleratoroverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Memory": "The memory override for the task\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TaskRoleArn": "The Amazon Resource Name \\(ARN\\) of the IAM role that containers in this task can assume\\. All containers in this task are granted the permissions that are specified in this role\\. For more information, see [IAM Role for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe Filter": { + "Pattern": "The event pattern\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe FilterCriteria": { + "Filters": "The event patterns\\. \n*Required*: No \n*Type*: List of [Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe MQBrokerAccessCredentials": { + "BasicAuth": "The ARN of the Secrets Manager secret\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe MSKAccessCredentials": { + "ClientCertificateTlsAuth": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SaslScram512Auth": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe NetworkConfiguration": { + "AwsvpcConfiguration": "Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used\\. This structure is relevant only for ECS tasks that use the `awsvpc` network mode\\. \n*Required*: No \n*Type*: [AwsVpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-awsvpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeEnrichmentHttpParameters": { + "HeaderParameters": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PathParameterValues": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards \\(\"\\*\"\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "QueryStringParameters": "The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeEnrichmentParameters": { + "HttpParameters": "Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination\\. \nIf you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request\\. If you're using ApiDestinations, the corresponding Connection can also have these values configured\\. In case of any conflicting keys, values from the Connection take precedence\\. \n*Required*: No \n*Type*: [PipeEnrichmentHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmenthttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InputTemplate": "Valid JSON text passed to the enrichment\\. In this case, nothing from the event itself is passed to the enrichment\\. For more information, see [The JavaScript Object Notation \\(JSON\\) Data Interchange Format](http://www.rfc-editor.org/rfc/rfc7159.txt)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeSourceActiveMQBrokerParameters": { + "BatchSize": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Credentials": "The credentials needed to access the resource\\. \n*Required*: Yes \n*Type*: [MQBrokerAccessCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mqbrokeraccesscredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "QueueName": "The name of the destination queue to consume\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Pipes::Pipe PipeSourceDynamoDBStreamParameters": { + "BatchSize": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeadLetterConfig": "Define the target queue to send dead\\-letter queue events to\\. \n*Required*: No \n*Type*: [DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-deadletterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumRecordAgeInSeconds": "\\(Streams only\\) Discard records older than the specified age\\. The default value is \\-1, which sets the maximum age to infinite\\. When the value is set to infinite, EventBridge never discards old records\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumRetryAttempts": "\\(Streams only\\) Discard records after the specified number of retries\\. The default value is \\-1, which sets the maximum number of retries to infinite\\. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OnPartialBatchItemFailure": "\\(Streams only\\) Define how to handle item process failures\\. `AUTOMATIC_BISECT` halves each batch and retry each half until all the records are processed or there is one failed message left in the batch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ParallelizationFactor": "\\(Streams only\\) The number of batches to process concurrently from each shard\\. The default value is 1\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartingPosition": "\\(Streams only\\) The position in a stream from which to start reading\\. \n*Valid values*: `TRIM_HORIZON | LATEST` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Pipes::Pipe PipeSourceKinesisStreamParameters": { + "BatchSize": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeadLetterConfig": "Define the target queue to send dead\\-letter queue events to\\. \n*Required*: No \n*Type*: [DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-deadletterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumRecordAgeInSeconds": "\\(Streams only\\) Discard records older than the specified age\\. The default value is \\-1, which sets the maximum age to infinite\\. When the value is set to infinite, EventBridge never discards old records\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumRetryAttempts": "\\(Streams only\\) Discard records after the specified number of retries\\. The default value is \\-1, which sets the maximum number of retries to infinite\\. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OnPartialBatchItemFailure": "\\(Streams only\\) Define how to handle item process failures\\. `AUTOMATIC_BISECT` halves each batch and retry each half until all the records are processed or there is one failed message left in the batch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ParallelizationFactor": "\\(Streams only\\) The number of batches to process concurrently from each shard\\. The default value is 1\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartingPosition": "\\(Streams only\\) The position in a stream from which to start reading\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StartingPositionTimestamp": "With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading, in Unix time seconds\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Pipes::Pipe PipeSourceManagedStreamingKafkaParameters": { + "BatchSize": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConsumerGroupID": "The name of the destination queue to consume\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Credentials": "The credentials needed to access the resource\\. \n*Required*: No \n*Type*: [MSKAccessCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mskaccesscredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartingPosition": "\\(Streams only\\) The position in a stream from which to start reading\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TopicName": "The name of the topic that the pipe will read from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Pipes::Pipe PipeSourceParameters": { + "ActiveMQBrokerParameters": "The parameters for using an Active MQ broker as a source\\. \n*Required*: No \n*Type*: [PipeSourceActiveMQBrokerParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DynamoDBStreamParameters": "The parameters for using a DynamoDB stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceDynamoDBStreamParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FilterCriteria": "The collection of event patterns used to filter events\\. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*\\. \n*Required*: No \n*Type*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-filtercriteria.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KinesisStreamParameters": "The parameters for using a Kinesis stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceKinesisStreamParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ManagedStreamingKafkaParameters": "The parameters for using an MSK stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceManagedStreamingKafkaParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RabbitMQBrokerParameters": "The parameters for using a Rabbit MQ broker as a source\\. \n*Required*: No \n*Type*: [PipeSourceRabbitMQBrokerParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SelfManagedKafkaParameters": "The parameters for using a self\\-managed Apache Kafka stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceSelfManagedKafkaParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SqsQueueParameters": "The parameters for using a Amazon SQS stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceSqsQueueParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcesqsqueueparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeSourceRabbitMQBrokerParameters": { + "BatchSize": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Credentials": "The credentials needed to access the resource\\. \n*Required*: Yes \n*Type*: [MQBrokerAccessCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mqbrokeraccesscredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "QueueName": "The name of the destination queue to consume\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "VirtualHost": "The name of the virtual host associated with the source broker\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Pipes::Pipe PipeSourceSelfManagedKafkaParameters": { + "AdditionalBootstrapServers": "An array of server URLs\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BatchSize": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConsumerGroupID": "The name of the destination queue to consume\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Credentials": "The credentials needed to access the resource\\. \n*Required*: No \n*Type*: [SelfManagedKafkaAccessConfigurationCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerRootCaCertificate": "The ARN of the Secrets Manager secret used for certification\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StartingPosition": "\\(Streams only\\) The position in a stream from which to start reading\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TopicName": "The name of the topic that the pipe will read from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Vpc": "This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used\\. \n*Required*: No \n*Type*: [SelfManagedKafkaAccessConfigurationVpc](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeSourceSqsQueueParameters": { + "BatchSize": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaximumBatchingWindowInSeconds": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeTargetBatchJobParameters": { + "ArrayProperties": "The array properties for the submitted job, such as the size of the array\\. The array size can be between 2 and 10,000\\. If you specify array properties for a job, it becomes an array job\\. This parameter is used only if the target is an AWS Batch job\\. \n*Required*: No \n*Type*: [BatchArrayProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batcharrayproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContainerOverrides": "The overrides that are sent to a container\\. \n*Required*: No \n*Type*: [BatchContainerOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DependsOn": "A list of dependencies for the job\\. A job can depend upon a maximum of 20 jobs\\. You can specify a `SEQUENTIAL` type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0\\. You can also specify an `N_TO_N` type dependency with a job ID for array jobs\\. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin\\. \n*Required*: No \n*Type*: List of [BatchJobDependency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchjobdependency.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "JobDefinition": "The job definition used by this job\\. This value can be one of `name`, `name:revision`, or the Amazon Resource Name \\(ARN\\) for the job definition\\. If name is specified without a revision then the latest active revision is used\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "JobName": "The name of the job\\. It can be up to 128 letters long\\. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens \\(\\-\\), and underscores \\(\\_\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Parameters": "Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition\\. Parameters are specified as a key and value pair mapping\\. Parameters included here override any corresponding parameter defaults from the job definition\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RetryStrategy": "The retry strategy to use for failed jobs\\. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition\\. \n*Required*: No \n*Type*: [BatchRetryStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchretrystrategy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeTargetCloudWatchLogsParameters": { + "LogStreamName": "The name of the log stream\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Timestamp": "The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeTargetEcsTaskParameters": { + "CapacityProviderStrategy": "The capacity provider strategy to use for the task\\. \nIf a `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted\\. If no `capacityProviderStrategy` or launchType is specified, the `defaultCapacityProviderStrategy` for the cluster is used\\. \n*Required*: No \n*Type*: List of [CapacityProviderStrategyItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-capacityproviderstrategyitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableECSManagedTags": "Specifies whether to enable Amazon ECS managed tags for the task\\. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon Elastic Container Service Developer Guide\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableExecuteCommand": "Whether or not to enable the execute command functionality for the containers in this task\\. If true, this enables execute command functionality on all containers in the task\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Group": "Specifies an Amazon ECS task group for the task\\. The maximum length is 255 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LaunchType": "Specifies the launch type on which your task is running\\. The launch type that you specify here must match one of the launch type \\(compatibilities\\) of the target task\\. The `FARGATE` value is supported only in the Regions where AWS Fargate with Amazon ECS is supported\\. For more information, see [AWS Fargate on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NetworkConfiguration": "Use this structure if the Amazon ECS task uses the `awsvpc` network mode\\. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used\\. This structure is required if `LaunchType` is `FARGATE` because the `awsvpc` mode is required for Fargate tasks\\. \nIf you specify `NetworkConfiguration` when the target ECS task does not use the `awsvpc` network mode, the task fails\\. \n*Required*: No \n*Type*: [NetworkConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-networkconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Overrides": "The overrides that are associated with a task\\. \n*Required*: No \n*Type*: [EcsTaskOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecstaskoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PlacementConstraints": "An array of placement constraint objects to use for the task\\. You can specify up to 10 constraints per task \\(including constraints in the task definition and those specified at runtime\\)\\. \n*Required*: No \n*Type*: List of [PlacementConstraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementconstraint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PlacementStrategy": "The placement strategy objects to use for the task\\. You can specify a maximum of five strategy rules per task\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementstrategy.html) of [PlacementStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementstrategy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PlatformVersion": "Specifies the platform version for the task\\. Specify only the numeric portion of the platform version, such as `1.1.0`\\. \nThis structure is used only if `LaunchType` is `FARGATE`\\. For more information about valid platform versions, see [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PropagateTags": "Specifies whether to propagate the tags from the task definition to the task\\. If no value is specified, the tags are not propagated\\. Tags can only be propagated to the task during task creation\\. To add tags to a task after task creation, use the `TagResource` API action\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReferenceId": "The reference ID to use for the task\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The metadata that you apply to the task to help you categorize and organize them\\. Each tag consists of a key and an optional value, both of which you define\\. To learn more, see [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) in the Amazon ECS API Reference\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TaskCount": "The number of tasks to create based on `TaskDefinition`\\. The default is 1\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TaskDefinitionArn": "The ARN of the task definition to use if the event target is an Amazon ECS task\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeTargetEventBridgeEventBusParameters": { + "DetailType": "A free\\-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EndpointId": "The URL subdomain of the endpoint\\. For example, if the URL for Endpoint is https://abcde\\.veo\\.endpoints\\.event\\.amazonaws\\.com, then the EndpointId is `abcde.veo`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Resources": "AWS resources, identified by Amazon Resource Name \\(ARN\\), which the event primarily concerns\\. Any number, including zero, may be present\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Source": "The source of the event\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Time": "The time stamp of the event, per [RFC3339](https://www.rfc-editor.org/rfc/rfc3339.txt)\\. If no time stamp is provided, the time stamp of the [PutEvents](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) call is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeTargetHttpParameters": { + "HeaderParameters": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PathParameterValues": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards \\(\"\\*\"\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "QueryStringParameters": "The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeTargetKinesisStreamParameters": { + "PartitionKey": "Determines which shard in the stream the data record is assigned to\\. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key\\. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard\\. Specifically, an MD5 hash function is used to map partition keys to 128\\-bit integer values and to map associated data records to shards\\. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeTargetLambdaFunctionParameters": { + "InvocationType": "Specify whether to invoke the function synchronously or asynchronously\\. \n+ `REQUEST_RESPONSE` \\(default\\) \\- Invoke synchronously\\. This corresponds to the `RequestResponse` option in the `InvocationType` parameter for the Lambda [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) API\\.\n+ `FIRE_AND_FORGET` \\- Invoke asynchronously\\. This corresponds to the `Event` option in the `InvocationType` parameter for the Lambda [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) API\\.\nFor more information, see [Invocation types](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) in the *Amazon EventBridge User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeTargetParameters": { + "BatchJobParameters": "The parameters for using an AWS Batch job as a target\\. \n*Required*: No \n*Type*: [PipeTargetBatchJobParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CloudWatchLogsParameters": "The parameters for using an CloudWatch Logs log stream as a target\\. \n*Required*: No \n*Type*: [PipeTargetCloudWatchLogsParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetcloudwatchlogsparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EcsTaskParameters": "The parameters for using an Amazon ECS task as a target\\. \n*Required*: No \n*Type*: [PipeTargetEcsTaskParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventBridgeEventBusParameters": "The parameters for using an EventBridge event bus as a target\\. \n*Required*: No \n*Type*: [PipeTargetEventBridgeEventBusParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HttpParameters": "These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations\\. \n*Required*: No \n*Type*: [PipeTargetHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargethttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InputTemplate": "Valid JSON text passed to the target\\. In this case, nothing from the event itself is passed to the target\\. For more information, see [The JavaScript Object Notation \\(JSON\\) Data Interchange Format](http://www.rfc-editor.org/rfc/rfc7159.txt)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KinesisStreamParameters": "The parameters for using a Kinesis stream as a source\\. \n*Required*: No \n*Type*: [PipeTargetKinesisStreamParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetkinesisstreamparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LambdaFunctionParameters": "The parameters for using a Lambda function as a target\\. \n*Required*: No \n*Type*: [PipeTargetLambdaFunctionParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetlambdafunctionparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RedshiftDataParameters": "These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement\\. \n*Required*: No \n*Type*: [PipeTargetRedshiftDataParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SageMakerPipelineParameters": "The parameters for using a SageMaker pipeline as a target\\. \n*Required*: No \n*Type*: [PipeTargetSageMakerPipelineParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsagemakerpipelineparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SqsQueueParameters": "The parameters for using a Amazon SQS stream as a source\\. \n*Required*: No \n*Type*: [PipeTargetSqsQueueParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StepFunctionStateMachineParameters": "The parameters for using a Step Functions state machine as a target\\. \n*Required*: No \n*Type*: [PipeTargetStateMachineParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetstatemachineparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeTargetRedshiftDataParameters": { + "Database": "The name of the database\\. Required when authenticating using temporary credentials\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DbUser": "The database user name\\. Required when authenticating using temporary credentials\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretManagerArn": "The name or ARN of the secret that enables access to the database\\. Required when authenticating using Secrets Manager\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Sqls": "The SQL statement text to run\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StatementName": "The name of the SQL statement\\. You can name the SQL statement when you create it to identify the query\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WithEvent": "Indicates whether to send an event back to EventBridge after the SQL statement runs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeTargetSageMakerPipelineParameters": { + "PipelineParameterList": "List of Parameter names and values for SageMaker Model Building Pipeline execution\\. \n*Required*: No \n*Type*: List of [SageMakerPipelineParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-sagemakerpipelineparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeTargetSqsQueueParameters": { + "MessageDeduplicationId": "This parameter applies only to FIFO \\(first\\-in\\-first\\-out\\) queues\\. \nThe token used for deduplication of sent messages\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MessageGroupId": "The FIFO message group ID to use as the target\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PipeTargetStateMachineParameters": { + "InvocationType": "Specify whether to invoke the Step Functions state machine synchronously or asynchronously\\. \n+ `REQUEST_RESPONSE` \\(default\\) \\- Invoke synchronously\\. For more information, see [StartSyncExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html) in the *AWS Step Functions API Reference*\\.\n**Note** \n`REQUEST_RESPONSE` is not supported for `STANDARD` state machine workflows\\.\n+ `FIRE_AND_FORGET` \\- Invoke asynchronously\\. For more information, see [StartExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html) in the *AWS Step Functions API Reference*\\.\nFor more information, see [Invocation types](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) in the *Amazon EventBridge User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PlacementConstraint": { + "Expression": "A cluster query language expression to apply to the constraint\\. You cannot specify an expression if the constraint type is `distinctInstance`\\. To learn more, see [Cluster Query Language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the Amazon Elastic Container Service Developer Guide\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of constraint\\. Use distinctInstance to ensure that each task in a particular group is running on a different container instance\\. Use memberOf to restrict the selection to a group of valid candidates\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe PlacementStrategy": { + "Field": "The field to apply the placement strategy against\\. For the spread placement strategy, valid values are instanceId \\(or host, which has the same effect\\), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs\\.availability\\-zone\\. For the binpack placement strategy, valid values are cpu and memory\\. For the random placement strategy, this field is not used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of placement strategy\\. The random placement strategy randomly places tasks on available candidates\\. The spread placement strategy spreads placement across available candidates evenly based on the field parameter\\. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter\\. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory \\(but still enough to run the task\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe SageMakerPipelineParameter": { + "Name": "Name of parameter to start execution of a SageMaker Model Building Pipeline\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "Value of parameter to start execution of a SageMaker Model Building Pipeline\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe SelfManagedKafkaAccessConfigurationCredentials": { + "BasicAuth": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientCertificateTlsAuth": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SaslScram256Auth": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SaslScram512Auth": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Pipes::Pipe SelfManagedKafkaAccessConfigurationVpc": { + "SecurityGroup": "Specifies the security groups associated with the stream\\. These security groups must all be in the same VPC\\. You can specify as many as five security groups\\. If you do not specify a security group, the default security group for the VPC is used\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Subnets": "Specifies the subnets associated with the stream\\. These subnets must all be in the same VPC\\. You can specify as many as 16 subnets\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::QLDB::Ledger": { - "DeletionProtection": "The flag that prevents a ledger from being deleted by any user\\. If not provided on ledger creation, this feature is enabled \\(`true`\\) by default\\. \nIf deletion protection is enabled, you must first disable it before you can delete the ledger\\. You can disable it by calling the `UpdateLedger` operation to set the flag to `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KmsKey": "The key in AWS Key Management Service \\(AWS KMS\\) to use for encryption of data at rest in the ledger\\. For more information, see [Encryption at rest](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) in the *Amazon QLDB Developer Guide*\\. \nUse one of the following options to specify this parameter: \n+ `AWS_OWNED_KMS_KEY`: Use an AWS KMS key that is owned and managed by AWS on your behalf\\.\n+ **Undefined**: By default, use an AWS owned KMS key\\.\n+ **A valid symmetric customer managed KMS key**: Use the specified KMS key in your account that you create, own, and manage\\.", + "DeletionProtection": "Specifies whether the ledger is protected from being deleted by any user\\. If not defined during ledger creation, this feature is enabled \\(`true`\\) by default\\. \nIf deletion protection is enabled, you must first disable it before you can delete the ledger\\. You can disable it by calling the `UpdateLedger` operation to set this parameter to `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsKey": "The key in AWS Key Management Service \\(AWS KMS\\) to use for encryption of data at rest in the ledger\\. For more information, see [Encryption at rest](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) in the *Amazon QLDB Developer Guide*\\. \nUse one of the following options to specify this parameter: \n+ `AWS_OWNED_KMS_KEY`: Use an AWS KMS key that is owned and managed by AWS on your behalf\\.\n+ **Undefined**: By default, use an AWS owned KMS key\\.\n+ **A valid symmetric customer managed KMS key**: Use the specified symmetric encryption KMS key in your account that you create, own, and manage\\.", "Name": "The name of the ledger that you want to create\\. The name must be unique among all of the ledgers in your AWS account in the current Region\\. \nNaming constraints for ledger names are defined in [Quotas in Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) in the *Amazon QLDB Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Pattern*: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PermissionsMode": "The permissions mode to assign to the ledger that you want to create\\. This parameter can have one of the following values: \n+ `ALLOW_ALL`: A legacy permissions mode that enables access control with API\\-level granularity for ledgers\\.", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -18875,13 +21932,13 @@ "StreamArn": "The Amazon Resource Name \\(ARN\\) of the Kinesis Data Streams resource\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `1600` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::QuickSight::Analysis": { - "AnalysisId": "The ID for the analysis that you're creating\\. This ID displays in the URL of the analysis\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AnalysisId": "The ID for the analysis that you're creating\\. This ID displays in the URL of the analysis\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "AwsAccountId": "The ID of the AWS account where you are creating an analysis\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `12` \n*Maximum*: `12` \n*Pattern*: `^[0-9]{12}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Errors": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [AnalysisError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysiserror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Errors": "Property description not available\\. \n*Required*: No \n*Type*: List of [AnalysisError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysiserror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A descriptive name for the analysis that you're creating\\. This name displays for the analysis in the Amazon QuickSight console\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Parameters": "The parameter names and override values that you want to use\\. An analysis can have any parameter type, and some parameters might accept multiple values\\. \n*Required*: No \n*Type*: [Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Permissions": "A structure that describes the principals and the resource\\-level permissions on an analysis\\. You can use the `Permissions` structure to grant permissions by providing a list of AWS Identity and Access Management \\(IAM\\) action information for each principal listed by Amazon Resource Name \\(ARN\\)\\. \nTo specify no permissions, omit `Permissions`\\. \n*Required*: No \n*Type*: List of [ResourcePermission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-resourcepermission.html) \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SourceEntity": "A source entity to use for the analysis that you're creating\\. This metadata structure contains details that describe a source template and one or more datasets\\. \n*Required*: Yes \n*Type*: [AnalysisSourceEntity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourceentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceEntity": "A source entity to use for the analysis that you're creating\\. This metadata structure contains details that describe a source template and one or more datasets\\. \nEither a `SourceEntity` or a `Definition` must be provided in order for the request to be valid\\. \n*Required*: Yes \n*Type*: [AnalysisSourceEntity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourceentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Contains a map of the key\\-value pairs for the resource tag or tags assigned to the analysis\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ThemeArn": "The ARN for the theme to apply to the analysis that you're creating\\. To see the theme in the Amazon QuickSight console, make sure that you have access to it\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -18923,8 +21980,8 @@ "Principal": "The Amazon Resource Name \\(ARN\\) of the principal\\. This can be one of the following: \n+ The ARN of an Amazon QuickSight user or group associated with a data source or dataset\\. \\(This is common\\.\\)\n+ The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme\\. \\(This is common\\.\\)\n+ The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN\\. Use this option only to share resources \\(templates\\) across AWS accounts\\. \\(This is less common\\.\\)\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::QuickSight::Analysis Sheet": { - "Name": "The name of a sheet\\. This name is displayed on the sheet's tab in the Amazon QuickSight console\\. \n*Required*: No \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SheetId": "The unique identifier associated with a sheet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "The name of a sheet\\. This name is displayed on the sheet's tab in the Amazon QuickSight console\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SheetId": "The unique identifier associated with a sheet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::QuickSight::Analysis StringParameter": { "Name": "A display name for a string parameter\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -18932,7 +21989,7 @@ }, "AWS::QuickSight::Dashboard": { "AwsAccountId": "The ID of the AWS account where you want to create the dashboard\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `12` \n*Maximum*: `12` \n*Pattern*: `^[0-9]{12}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DashboardId": "The ID for the dashboard, also added to the IAM policy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DashboardId": "The ID for the dashboard, also added to the IAM policy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DashboardPublishOptions": "Options for publishing the dashboard when you create it: \n+ `AvailabilityStatus` for `AdHocFilteringOption` \\- This status can be either `ENABLED` or `DISABLED`\\. When this is set to `DISABLED`, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc \\(one\\-time\\) filtering\\. This option is `ENABLED` by default\\. \n+ `AvailabilityStatus` for `ExportToCSVOption` \\- This status can be either `ENABLED` or `DISABLED`\\. The visual option to export data to \\.CSV format isn't enabled when this is set to `DISABLED`\\. This option is `ENABLED` by default\\. \n+ `VisibilityState` for `SheetControlsOption` \\- This visibility state can be either `COLLAPSED` or `EXPANDED`\\. This option is `COLLAPSED` by default\\. \n*Required*: No \n*Type*: [DashboardPublishOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The display name of the dashboard\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Parameters": "The parameters for the creation of the dashboard, which you want to use to override the default settings\\. A dashboard can have any type of parameters, and some parameters might accept multiple values\\. \n*Required*: No \n*Type*: [Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-parameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -18945,6 +22002,10 @@ "AWS::QuickSight::Dashboard AdHocFilteringOption": { "AvailabilityStatus": "Availability status\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::QuickSight::Dashboard DashboardError": { + "Message": "Message\\. \n*Required*: No \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "Type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACCESS_DENIED | COLUMN_GEOGRAPHIC_ROLE_MISMATCH | COLUMN_REPLACEMENT_MISSING | COLUMN_TYPE_MISMATCH | DATA_SET_NOT_FOUND | INTERNAL_FAILURE | PARAMETER_NOT_FOUND | PARAMETER_TYPE_INVALID | PARAMETER_VALUE_INCOMPATIBLE | SOURCE_NOT_FOUND` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::QuickSight::Dashboard DashboardPublishOptions": { "AdHocFilteringOption": "Ad hoc \\(one\\-time\\) filtering option\\. \n*Required*: No \n*Type*: [AdHocFilteringOption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-adhocfilteringoption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExportToCSVOption": "Export to \\.csv option\\. \n*Required*: No \n*Type*: [ExportToCSVOption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-exporttocsvoption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -18957,6 +22018,18 @@ "Arn": "The Amazon Resource Name \\(ARN\\) of the resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DataSetReferences": "Dataset references\\. \n*Required*: Yes \n*Type*: List of [DataSetReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-datasetreference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::QuickSight::Dashboard DashboardVersion": { + "Arn": "The Amazon Resource Name \\(ARN\\) of the resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CreatedTime": "The time that this dashboard version was created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataSetArns": "The Amazon Resource Numbers \\(ARNs\\) for the datasets that are associated with this version of the dashboard\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "Description\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Errors": "Errors associated with this dashboard version\\. \n*Required*: No \n*Type*: List of [DashboardError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboarderror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Sheets": "A list of the associated sheets with the unique identifier and name of each sheet\\. \n*Required*: No \n*Type*: List of [Sheet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheet.html) \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceEntityArn": "Source entity ARN\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "The HTTP status of the request\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CREATION_FAILED | CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | DELETED | UPDATE_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ThemeArn": "The ARN of the theme associated with a version of the dashboard\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VersionNumber": "Version number for this version of the dashboard\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::QuickSight::Dashboard DataSetReference": { "DataSetArn": "Dataset Amazon Resource Name \\(ARN\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DataSetPlaceholder": "Dataset placeholder\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -18986,6 +22059,10 @@ "Actions": "The IAM action to grant or revoke permissions on\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Principal": "The Amazon Resource Name \\(ARN\\) of the principal\\. This can be one of the following: \n+ The ARN of an Amazon QuickSight user or group associated with a data source or dataset\\. \\(This is common\\.\\)\n+ The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme\\. \\(This is common\\.\\)\n+ The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN\\. Use this option only to share resources \\(templates\\) across AWS accounts\\. \\(This is less common\\.\\)\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::QuickSight::Dashboard Sheet": { + "Name": "The name of a sheet\\. This name is displayed on the sheet's tab in the Amazon QuickSight console\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SheetId": "The unique identifier associated with a sheet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::QuickSight::Dashboard SheetControlsOption": { "VisibilityState": "Visibility state\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `COLLAPSED | EXPANDED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -18998,6 +22075,7 @@ "ColumnGroups": "Groupings of columns that work together in certain Amazon QuickSight features\\. Currently, only geospatial hierarchy is supported\\. \n*Required*: No \n*Type*: List of [ColumnGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columngroup.html) \n*Maximum*: `8` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ColumnLevelPermissionRules": "A set of one or more definitions of a ` ColumnLevelPermissionRule `\\. \n*Required*: No \n*Type*: List of [ColumnLevelPermissionRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnlevelpermissionrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DataSetId": "An ID for the dataset that you want to create\\. This ID is unique per AWS Region for each AWS account\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DataSetUsageConfiguration": "The usage configuration to apply to child datasets that reference this dataset as a source\\. \n*Required*: No \n*Type*: [DataSetUsageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetusageconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FieldFolders": "The folder that contains fields and nested subfolders for your dataset\\. \n*Required*: No \n*Type*: Map of [FieldFolder](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-fieldfolder.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ImportMode": "Indicates whether you want to import the data into SPICE\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DIRECT_QUERY | SPICE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IngestionWaitPolicy": "The wait policy to use when creating or updating a Dataset\\. The default is to wait for SPICE ingestion to finish with timeout of 36 hours\\. \n*Required*: No \n*Type*: [IngestionWaitPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-ingestionwaitpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19041,6 +22119,10 @@ "Name": "A display name for the SQL query result\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SqlQuery": "The SQL query\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `65536` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::QuickSight::DataSet DataSetUsageConfiguration": { + "DisableUseAsDirectQuerySource": "An option that controls whether a child dataset of a direct query can use this dataset as a source\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DisableUseAsImportedSource": "An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::QuickSight::DataSet FieldFolder": { "Columns": "A folder has a list of columns\\. A column can only be in one folder\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "The description for a field folder\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -19074,10 +22156,11 @@ }, "AWS::QuickSight::DataSet LogicalTable": { "Alias": "A display name for the logical table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DataTransforms": "Transform operations that act on this logical table\\. \n*Required*: No \n*Type*: List of [TransformOperation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html) \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataTransforms": "Transform operations that act on this logical table\\. For this structure to be valid, only one of the attributes can be non\\-null\\. \n*Required*: No \n*Type*: List of [TransformOperation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html) \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Source": "Source of this logical table\\. \n*Required*: Yes \n*Type*: [LogicalTableSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-logicaltablesource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::QuickSight::DataSet LogicalTableSource": { + "DataSetArn": "The Amazon Resource Number \\(ARN\\) of the parent dataset\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "JoinInstruction": "Specifies the result of a join of two logical tables\\. \n*Required*: No \n*Type*: [JoinInstruction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joininstruction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PhysicalTableId": "Physical table ID\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[0-9a-zA-Z-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -19095,7 +22178,7 @@ "ProjectedColumns": "Projected columns\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `2000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::QuickSight::DataSet RelationalTable": { - "Catalog": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Catalog": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DataSourceArn": "The Amazon Resource Name \\(ARN\\) for the data source\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InputColumns": "The column schema of the table\\. \n*Required*: Yes \n*Type*: List of [InputColumn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-inputcolumn.html) \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the relational table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19150,7 +22233,7 @@ "Permissions": "A list of resource permissions on the data source\\. \n*Required*: No \n*Type*: List of [ResourcePermission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-resourcepermission.html) \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SslProperties": "Secure Socket Layer \\(SSL\\) properties that apply when Amazon QuickSight connects to your underlying source\\. \n*Required*: No \n*Type*: [SslProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sslproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Contains a map of the key\\-value pairs for the resource tag or tags assigned to the data source\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Type": "The type of the data source\\. To return a list of all data sources, use `ListDataSources`\\. \nUse `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | AMAZON_OPENSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | EXASOL | GITHUB | JIRA | MARIADB | MYSQL | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TIMESTREAM | TWITTER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Type": "The type of the data source\\. To return a list of all data sources, use `ListDataSources`\\. \nUse `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | AMAZON_OPENSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | DATABRICKS | EXASOL | GITHUB | JIRA | MARIADB | MYSQL | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TIMESTREAM | TWITTER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "VpcConnectionProperties": "Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source\\. \n*Required*: No \n*Type*: [VpcConnectionProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-vpcconnectionproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::QuickSight::DataSource AmazonElasticsearchParameters": { @@ -19179,7 +22262,8 @@ }, "AWS::QuickSight::DataSource DataSourceCredentials": { "CopySourceArn": "The Amazon Resource Name \\(ARN\\) of a data source that has the credential pair that you want to use\\. When `CopySourceArn` is not null, the credential pair from the data source in the ARN is used as the credentials for the `DataSourceCredentials` structure\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CredentialPair": "Credential pair\\. For more information, see ` [CredentialPair](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html) `\\. \n*Required*: No \n*Type*: [CredentialPair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CredentialPair": "Credential pair\\. For more information, see ` [CredentialPair](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html) `\\. \n*Required*: No \n*Type*: [CredentialPair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-credentialpair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretArn": "The Amazon Resource Name \\(ARN\\) of the secret associated with the data source in Amazon Secrets Manager\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::QuickSight::DataSource DataSourceErrorInfo": { "Message": "Error message\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19191,6 +22275,7 @@ "AthenaParameters": "The parameters for Amazon Athena\\. \n*Required*: No \n*Type*: [AthenaParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-athenaparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AuroraParameters": "The parameters for Amazon Aurora MySQL\\. \n*Required*: No \n*Type*: [AuroraParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-auroraparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AuroraPostgreSqlParameters": "The parameters for Amazon Aurora\\. \n*Required*: No \n*Type*: [AuroraPostgreSqlParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-aurorapostgresqlparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DatabricksParameters": "The required parameters that are needed to connect to a Databricks data source\\. \n*Required*: No \n*Type*: [DatabricksParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-databricksparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MariaDbParameters": "The parameters for MariaDB\\. \n*Required*: No \n*Type*: [MariaDbParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mariadbparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MySqlParameters": "The parameters for MySQL\\. \n*Required*: No \n*Type*: [MySqlParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-mysqlparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OracleParameters": "Oracle parameters\\. \n*Required*: No \n*Type*: [OracleParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-oracleparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19204,6 +22289,11 @@ "SqlServerParameters": "The parameters for SQL Server\\. \n*Required*: No \n*Type*: [SqlServerParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-sqlserverparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TeradataParameters": "The parameters for Teradata\\. \n*Required*: No \n*Type*: [TeradataParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-teradataparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::QuickSight::DataSource DatabricksParameters": { + "Host": "The host name of the Databricks data source\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Port": "The port for the Databricks data source\\. \n*Required*: Yes \n*Type*: Double \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SqlEndpointPath": "The HTTP path of the Databricks data source\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::QuickSight::DataSource ManifestFileLocation": { "Bucket": "Amazon S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Key": "Amazon S3 key that identifies an object\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -19279,19 +22369,47 @@ "AwsAccountId": "The ID for the AWS account that the group is in\\. You use the ID for the AWS account that contains your Amazon QuickSight account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `12` \n*Maximum*: `12` \n*Pattern*: `^[0-9]{12}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "A display name for the template\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Permissions": "A list of resource permissions to be set on the template\\. \n*Required*: No \n*Type*: List of [ResourcePermission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-resourcepermission.html) \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SourceEntity": "The entity that you are using as a source when you create the template\\. In `SourceEntity`, you specify the type of object you're using as source: `SourceTemplate` for a template or `SourceAnalysis` for an analysis\\. Both of these require an Amazon Resource Name \\(ARN\\)\\. For `SourceTemplate`, specify the ARN of the source template\\. For `SourceAnalysis`, specify the ARN of the source analysis\\. The `SourceTemplate` ARN can contain any AWS account and any Amazon QuickSight\\-supported AWS Region\\. \nUse the `DataSetReferences` entity within `SourceTemplate` or `SourceAnalysis` to list the replacement datasets for the placeholders listed in the original\\. The schema in each dataset must match its placeholder\\. \n*Required*: Yes \n*Type*: [TemplateSourceEntity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceEntity": "The entity that you are using as a source when you create the template\\. In `SourceEntity`, you specify the type of object you're using as source: `SourceTemplate` for a template or `SourceAnalysis` for an analysis\\. Both of these require an Amazon Resource Name \\(ARN\\)\\. For `SourceTemplate`, specify the ARN of the source template\\. For `SourceAnalysis`, specify the ARN of the source analysis\\. The `SourceTemplate` ARN can contain any AWS account and any Amazon QuickSight\\-supported AWS Region\\. \nUse the `DataSetReferences` entity within `SourceTemplate` or `SourceAnalysis` to list the replacement datasets for the placeholders listed in the original\\. The schema in each dataset must match its placeholder\\. \nEither a `SourceEntity` or a `Definition` must be provided in order for the request to be valid\\. \n*Required*: Yes \n*Type*: [TemplateSourceEntity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Contains a map of the key\\-value pairs for the resource tag or tags assigned to the resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TemplateId": "An ID for the template that you want to create\\. This template is unique per AWS Region; in each AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TemplateId": "An ID for the template that you want to create\\. This template is unique per AWS Region; in each AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "VersionDescription": "A description of the current template version being created\\. This API operation creates the first version of the template\\. Every time `UpdateTemplate` is called, a new version is created\\. Each version of the template maintains a description of the version in the `VersionDescription` field\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::QuickSight::Template ColumnGroupColumnSchema": { + "Name": "The name of the column group's column schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::QuickSight::Template ColumnGroupSchema": { + "ColumnGroupColumnSchemaList": "A structure containing the list of schemas for column group columns\\. \n*Required*: No \n*Type*: List of [ColumnGroupColumnSchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupcolumnschema.html) \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the column group schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::QuickSight::Template ColumnSchema": { + "DataType": "The data type of the column schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "GeographicRole": "The geographic role of the column schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the column schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::QuickSight::Template DataSetConfiguration": { + "ColumnGroupSchemaList": "A structure containing the list of column group schemas\\. \n*Required*: No \n*Type*: List of [ColumnGroupSchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupschema.html) \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataSetSchema": "Dataset schema\\. \n*Required*: No \n*Type*: [DataSetSchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetschema.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Placeholder": "Placeholder\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::QuickSight::Template DataSetReference": { "DataSetArn": "Dataset Amazon Resource Name \\(ARN\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DataSetPlaceholder": "Dataset placeholder\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::QuickSight::Template DataSetSchema": { + "ColumnSchemaList": "A structure containing the list of column schemas\\. \n*Required*: No \n*Type*: List of [ColumnSchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html) \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::QuickSight::Template ResourcePermission": { "Actions": "The IAM action to grant or revoke permissions on\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Principal": "The Amazon Resource Name \\(ARN\\) of the principal\\. This can be one of the following: \n+ The ARN of an Amazon QuickSight user or group associated with a data source or dataset\\. \\(This is common\\.\\)\n+ The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme\\. \\(This is common\\.\\)\n+ The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN\\. Use this option only to share resources \\(templates\\) across AWS accounts\\. \\(This is less common\\.\\)\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::QuickSight::Template Sheet": { + "Name": "The name of a sheet\\. This name is displayed on the sheet's tab in the Amazon QuickSight console\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SheetId": "The unique identifier associated with a sheet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::QuickSight::Template TemplateError": { + "Message": "Description of the error type\\. \n*Required*: No \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "Type of error\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACCESS_DENIED | DATA_SET_NOT_FOUND | INTERNAL_FAILURE | SOURCE_NOT_FOUND` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::QuickSight::Template TemplateSourceAnalysis": { "Arn": "The Amazon Resource Name \\(ARN\\) of the resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DataSetReferences": "A structure containing information about the dataset references used as placeholders in the template\\. \n*Required*: Yes \n*Type*: List of [DataSetReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetreference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -19303,14 +22421,25 @@ "AWS::QuickSight::Template TemplateSourceTemplate": { "Arn": "The Amazon Resource Name \\(ARN\\) of the resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::QuickSight::Template TemplateVersion": { + "CreatedTime": "The time that this template version was created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataSetConfigurations": "Schema of the dataset identified by the placeholder\\. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation\\. \n*Required*: No \n*Type*: List of [DataSetConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html) \n*Maximum*: `30` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the template\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Errors": "Errors associated with this template version\\. \n*Required*: No \n*Type*: List of [TemplateError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateerror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Sheets": "A list of the associated sheets with the unique identifier and name of each sheet\\. \n*Required*: No \n*Type*: List of [Sheet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheet.html) \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceEntityArn": "The Amazon Resource Name \\(ARN\\) of an analysis or template that was used to create this template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "The status that is associated with the template\\. \n+ `CREATION_IN_PROGRESS` \n+ `CREATION_SUCCESSFUL` \n+ `CREATION_FAILED` \n+ `UPDATE_IN_PROGRESS` \n+ `UPDATE_SUCCESSFUL` \n+ `UPDATE_FAILED` \n+ `DELETED` \n*Required*: No \n*Type*: String \n*Allowed values*: `CREATION_FAILED | CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | DELETED | UPDATE_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ThemeArn": "The ARN of the theme associated with this version of the template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VersionNumber": "The version number of the template version\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::QuickSight::Theme": { "AwsAccountId": "The ID of the AWS account where you want to store the new theme\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `12` \n*Maximum*: `12` \n*Pattern*: `^[0-9]{12}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "BaseThemeId": "The ID of the theme that a custom theme will inherit from\\. All themes inherit from one of the starting themes defined by Amazon QuickSight\\. For a list of the starting themes, use `ListThemes` or choose **Themes** from within an analysis\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BaseThemeId": "The ID of the theme that a custom theme will inherit from\\. All themes inherit from one of the starting themes defined by Amazon QuickSight\\. For a list of the starting themes, use `ListThemes` or choose **Themes** from within an analysis\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Configuration": "The theme configuration, which contains the theme display properties\\. \n*Required*: No \n*Type*: [ThemeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A display name for the theme\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Permissions": "A valid grouping of resource permissions to apply to the new theme\\. \n*Required*: No \n*Type*: List of [ResourcePermission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-resourcepermission.html) \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A map of the key\\-value pairs for the resource tag or tags that you want to add to the resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ThemeId": "An ID for the theme that you want to create\\. The theme ID is unique per AWS Region in each AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ThemeId": "An ID for the theme that you want to create\\. The theme ID is unique per AWS Region in each AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "VersionDescription": "A description of the first version of the theme that you're creating\\. Every time `UpdateTheme` is called, a new version is created\\. Each version of the theme has a description of the version in the `VersionDescription` field\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::QuickSight::Theme BorderStyle": { @@ -19322,7 +22451,7 @@ "MinMaxGradient": "The minimum and maximum hexadecimal codes that describe a color gradient\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::QuickSight::Theme Font": { - "FontFamily": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "FontFamily": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::QuickSight::Theme GutterStyle": { "Show": "This Boolean value controls whether to display a gutter space between sheet tiles\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -19341,9 +22470,23 @@ "AWS::QuickSight::Theme ThemeConfiguration": { "DataColorPalette": "Color properties that apply to chart data colors\\. \n*Required*: No \n*Type*: [DataColorPalette](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-datacolorpalette.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Sheet": "Display options related to sheets\\. \n*Required*: No \n*Type*: [SheetStyle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-sheetstyle.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Typography": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [Typography](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-typography.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Typography": "Property description not available\\. \n*Required*: No \n*Type*: [Typography](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-typography.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UIColorPalette": "Color properties that apply to the UI and to charts, excluding the colors that apply to data\\. \n*Required*: No \n*Type*: [UIColorPalette](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-uicolorpalette.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::QuickSight::Theme ThemeError": { + "Message": "The error message\\. \n*Required*: No \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of error\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `INTERNAL_FAILURE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::QuickSight::Theme ThemeVersion": { + "Arn": "The Amazon Resource Name \\(ARN\\) of the resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BaseThemeId": "The Amazon QuickSight\\-defined ID of the theme that a custom theme inherits from\\. All themes initially inherit from a default Amazon QuickSight theme\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Configuration": "The theme configuration, which contains all the theme display properties\\. \n*Required*: No \n*Type*: [ThemeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CreatedTime": "The date and time that this theme version was created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the theme\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Errors": "Errors associated with the theme\\. \n*Required*: No \n*Type*: List of [ThemeError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeerror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "The status of the theme version\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CREATION_FAILED | CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | DELETED | UPDATE_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VersionNumber": "The version number of the theme\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::QuickSight::Theme TileLayoutStyle": { "Gutter": "The gutter settings that apply between tiles\\. \n*Required*: No \n*Type*: [GutterStyle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-gutterstyle.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Margin": "The margin settings that apply around the outside edge of sheets\\. \n*Required*: No \n*Type*: [MarginStyle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-marginstyle.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -19352,7 +22495,7 @@ "Border": "The border around a tile\\. \n*Required*: No \n*Type*: [BorderStyle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-borderstyle.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::QuickSight::Theme Typography": { - "FontFamilies": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [Font](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-font.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "FontFamilies": "Property description not available\\. \n*Required*: No \n*Type*: List of [Font](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-font.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::QuickSight::Theme UIColorPalette": { "Accent": "This color is that applies to selected states and buttons\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^#[A-F0-9]{6}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19381,129 +22524,195 @@ "Tags": "Specifies one or more tags to attach to the resource share itself\\. It doesn't attach the tags to the resources associated with the resource share\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RDS::DBCluster": { - "AssociatedRoles": "Provides a list of the AWS Identity and Access Management \\(IAM\\) roles that are associated with the DB cluster\\. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf\\. \n*Required*: No \n*Type*: List of [DBClusterRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AvailabilityZones": "A list of Availability Zones \\(AZs\\) where instances in the DB cluster can be created\\. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "BacktrackWindow": "The target backtrack window, in seconds\\. To disable backtracking, set this value to 0\\. \nCurrently, Backtrack is only supported for Aurora MySQL DB clusters\\.\nDefault: 0 \nConstraints: \n+ If specified, this value must be set to a number from 0 to 259,200 \\(72 hours\\)\\.\n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "BackupRetentionPeriod": "The number of days for which automated backups are retained\\. \nDefault: 1 \nConstraints: \n+ Must be a value from 1 to 35\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "CopyTagsToSnapshot": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster\\. The default is not to copy them\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DBClusterIdentifier": "The DB cluster identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain from 1 to 63 letters, numbers, or hyphens\\.\n+ First character must be a letter\\.\n+ Can't end with a hyphen or contain two consecutive hyphens\\.\nExample: `my-cluster1` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DBClusterParameterGroupName": "The name of the DB cluster parameter group to associate with this DB cluster\\. \nIf you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot\\. This can result in an outage while the DB instances are rebooting\\. \nIf you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started\\.\nTo list all of the available DB cluster parameter group names, use the following command: \n`aws rds describe-db-cluster-parameter-groups --query \"DBClusterParameterGroups[].DBClusterParameterGroupName\" --output text` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DBSubnetGroupName": "A DB subnet group that you want to associate with this DB cluster\\. \nIf you are restoring a DB cluster to a point in time with `RestoreType` set to `copy-on-write`, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DatabaseName": "The name of your database\\. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster\\. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DeletionProtection": "A value that indicates whether the DB cluster has deletion protection enabled\\. The database can't be deleted when deletion protection is enabled\\. By default, deletion protection is disabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EnableCloudwatchLogsExports": "The list of log types that need to be enabled for exporting to CloudWatch Logs\\. The values in the list depend on the DB engine being used\\. For more information, see [ Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*\\. \n **Aurora MySQL** \nValid values: `audit`, `error`, `general`, `slowquery` \n **Aurora PostgreSQL** \nValid values: `postgresql` \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EnableHttpEndpoint": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster\\. By default, the HTTP endpoint is disabled\\. \nWhen enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster\\. You can also query your database from inside the RDS console with the query editor\\. \nFor more information, see [Using the Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EnableIAMDatabaseAuthentication": "A value that indicates whether to enable mapping of AWS Identity and Access Management \\(IAM\\) accounts to database accounts\\. By default, mapping is disabled\\. \nFor more information, see [ IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide\\.* \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Engine": "The name of the database engine to be used for this DB cluster\\. \nValid Values: `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\), `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\), and `aurora-postgresql` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", - "EngineMode": "The DB engine mode of the DB cluster, either `provisioned`, `serverless`, `parallelquery`, `global`, or `multimaster`\\. \nThe `parallelquery` engine mode isn't required for Aurora MySQL version 1\\.23 and higher 1\\.x versions, and version 2\\.09 and higher 2\\.x versions\\. \nThe `global` engine mode isn't required for Aurora MySQL version 1\\.22 and higher 1\\.x versions, and `global` engine mode isn't required for any 2\\.x versions\\. \nThe `multimaster` engine mode only applies for DB clusters created with Aurora MySQL version 5\\.6\\.10a\\. \nFor Aurora PostgreSQL, the `global` engine mode isn't required, and both the `parallelquery` and the `multimaster` engine modes currently aren't supported\\. \nLimitations and requirements apply to some DB engine modes\\. For more information, see the following sections in the *Amazon Aurora User Guide*: \n+ [ Limitations of Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) \n+ [ Limitations of Parallel Query](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations) \n+ [ Limitations of Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations) \n+ [ Limitations of Multi\\-Master Clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations) \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "EngineVersion": "The version number of the database engine to use\\. \nTo list all of the available engine versions for `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\), use the following command: \n`aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"` \nTo list all of the available engine versions for `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\), use the following command: \n`aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"` \nTo list all of the available engine versions for `aurora-postgresql`, use the following command: \n`aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"` \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", - "GlobalClusterIdentifier": "If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster\\. To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource\\. \n If you aren't configuring a global database cluster, don't specify this property\\. \nTo remove the DB cluster from a global database cluster, specify an empty value for the `GlobalClusterIdentifier` property\\.\nFor information about Aurora global databases, see [ Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", - "KmsKeyId": "The Amazon Resource Name \\(ARN\\) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`\\. If you enable the `StorageEncrypted` property but don't specify this property, the default KMS key is used\\. If you specify this property, you must set the `StorageEncrypted` property to `true`\\. \nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MasterUserPassword": "The master password for the DB instance\\. \nIf you specify the `SourceDBClusterIdentifier` or `SnapshotIdentifier` property, don't specify this property\\. The value is inherited from the source DB instance or snapshot\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MasterUsername": "The name of the master user for the DB cluster\\. \nIf you specify the `SourceDBClusterIdentifier` or `SnapshotIdentifier` property, don't specify this property\\. The value is inherited from the source DB instance or snapshot\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Port": "The port number on which the DB instances in the DB cluster accept connections\\. \nDefault: \n+ When `EngineMode` is `provisioned`, `3306` \\(for both Aurora MySQL and Aurora PostgreSQL\\)\n+ When `EngineMode` is `serverless`:\n + `3306` when `Engine` is `aurora` or `aurora-mysql`\n + `5432` when `Engine` is `aurora-postgresql`\nThe `No interruption` on update behavior only applies to DB clusters\\. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PreferredBackupWindow": "The daily time range during which automated backups are created\\. For more information, see [ Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide\\.* \nConstraints: \n+ Must be in the format `hh24:mi-hh24:mi`\\.\n+ Must be in Universal Coordinated Time \\(UTC\\)\\.\n+ Must not conflict with the preferred maintenance window\\.\n+ Must be at least 30 minutes\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \nFormat: `ddd:hh24:mi-ddd:hh24:mi` \nThe default is a 30\\-minute window selected at random from an 8\\-hour block of time for each AWS Region, occurring on a random day of the week\\. To see the time blocks available, see [ Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide\\.* \nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun\\. \nConstraints: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ReplicationSourceIdentifier": "The Amazon Resource Name \\(ARN\\) of the source DB instance or DB cluster if this DB cluster is created as a read replica\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RestoreType": "The type of restore to be performed\\. You can specify one of the following values: \n+ `full-copy` \\- The new DB cluster is restored as a full copy of the source DB cluster\\.\n+ `copy-on-write` \\- The new DB cluster is restored as a clone of the source DB cluster\\.\nConstraints: You can't specify `copy-on-write` if the engine version of the source DB cluster is earlier than 1\\.11\\. \nIf you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ScalingConfiguration": "The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster\\. \n*Required*: No \n*Type*: [ScalingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SnapshotIdentifier": "The identifier for the DB snapshot or DB cluster snapshot to restore from\\. \nYou can use either the name or the Amazon Resource Name \\(ARN\\) to specify a DB cluster snapshot\\. However, you can use only the ARN to specify a DB snapshot\\. \nAfter you restore a DB cluster with a `SnapshotIdentifier` property, you must specify the same `SnapshotIdentifier` property for any future updates to the DB cluster\\. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed\\. However, if you don't specify the `SnapshotIdentifier` property, an empty DB cluster is created, and the original DB cluster is deleted\\. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified `SnapshotIdentifier` property, and the original DB cluster is deleted\\. \nIf you specify the `SnapshotIdentifier` property to restore a DB cluster \\(as opposed to specifying it for DB cluster updates\\), then don't specify the following properties: \n+ `GlobalClusterIdentifier`\n+ `MasterUsername`\n+ `ReplicationSourceIdentifier`\n+ `RestoreType`\n+ `SourceDBClusterIdentifier`\n+ `SourceRegion`\n+ `StorageEncrypted`\n+ `UseLatestRestorableTime`\nConstraints: \n+ Must match the identifier of an existing Snapshot\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SourceDBClusterIdentifier": "When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore\\. \nConstraints: \n+ Must match the identifier of an existing DBCluster\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SourceRegion": "The AWS Region which contains the source DB cluster when replicating a DB cluster\\. For example, `us-east-1`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StorageEncrypted": "Indicates whether the DB cluster is encrypted\\. \nIf you specify the `KmsKeyId` property, then you must enable encryption\\. \nIf you specify the `SnapshotIdentifier` or `SourceDBClusterIdentifier` property, don't specify this property\\. The value is inherited from the snapshot or source DB cluster, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "Tags to assign to the DB cluster\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UseLatestRestorableTime": "A value that indicates whether to restore the DB cluster to the latest restorable backup time\\. By default, the DB cluster is not restored to the latest restorable backup time\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "VpcSecurityGroupIds": "A list of EC2 VPC security groups to associate with this DB cluster\\. \nIf you plan to update the resource, don't specify VPC security groups in a shared VPC\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AllocatedStorage": "The amount of storage in gibibytes \\(GiB\\) to allocate to each DB instance in the Multi\\-AZ DB cluster\\. \nThis setting is required to create a Multi\\-AZ DB cluster\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AssociatedRoles": "Provides a list of the AWS Identity and Access Management \\(IAM\\) roles that are associated with the DB cluster\\. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: List of [DBClusterRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AutoMinorVersionUpgrade": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window\\. By default, minor engine upgrades are applied automatically\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AvailabilityZones": "A list of Availability Zones \\(AZs\\) where instances in the DB cluster can be created\\. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "BacktrackWindow": "The target backtrack window, in seconds\\. To disable backtracking, set this value to 0\\. \nCurrently, Backtrack is only supported for Aurora MySQL DB clusters\\.\nDefault: 0 \nConstraints: \n+ If specified, this value must be set to a number from 0 to 259,200 \\(72 hours\\)\\.\nValid for: Aurora MySQL DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BackupRetentionPeriod": "The number of days for which automated backups are retained\\. \nDefault: 1 \nConstraints: \n+ Must be a value from 1 to 35\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CopyTagsToSnapshot": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster\\. The default is not to copy them\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DBClusterIdentifier": "The DB cluster identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain from 1 to 63 letters, numbers, or hyphens\\.\n+ First character must be a letter\\.\n+ Can't end with a hyphen or contain two consecutive hyphens\\.\nExample: `my-cluster1` \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DBClusterInstanceClass": "The compute and memory capacity of each DB instance in the Multi\\-AZ DB cluster, for example db\\.m6gd\\.xlarge\\. Not all DB instance classes are available in all AWS Regions, or for all database engines\\. \nFor the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*\\. \nThis setting is required to create a Multi\\-AZ DB cluster\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DBClusterParameterGroupName": "The name of the DB cluster parameter group to associate with this DB cluster\\. \nIf you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot\\. This can result in an outage while the DB instances are rebooting\\. \nIf you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started\\.\nTo list all of the available DB cluster parameter group names, use the following command: \n`aws rds describe-db-cluster-parameter-groups --query \"DBClusterParameterGroups[].DBClusterParameterGroupName\" --output text` \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DBInstanceParameterGroupName": "The name of the DB parameter group to apply to all instances of the DB cluster\\. \nWhen you apply a parameter group using the `DBInstanceParameterGroupName` parameter, the DB cluster isn't rebooted automatically\\. Also, parameter changes are applied immediately rather than during the next maintenance window\\.\nDefault: The existing name setting \nConstraints: \n+ The DB parameter group must be in the same DB parameter group family as this DB cluster\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DBSubnetGroupName": "A DB subnet group that you want to associate with this DB cluster\\. \nIf you are restoring a DB cluster to a point in time with `RestoreType` set to `copy-on-write`, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DBSystemId": "Reserved for future use\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DatabaseName": "The name of your database\\. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster\\. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DeletionProtection": "A value that indicates whether the DB cluster has deletion protection enabled\\. The database can't be deleted when deletion protection is enabled\\. By default, deletion protection is disabled\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Domain": "Indicates the directory ID of the Active Directory to create the DB cluster\\. \nFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster\\. \nFor more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DomainIAMRoleName": "Specifies the name of the IAM role to use when making API calls to the Directory Service\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableCloudwatchLogsExports": "The list of log types that need to be enabled for exporting to CloudWatch Logs\\. The values in the list depend on the DB engine being used\\. For more information, see [ Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*\\. \n **Aurora MySQL** \nValid values: `audit`, `error`, `general`, `slowquery` \n **Aurora PostgreSQL** \nValid values: `postgresql` \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableHttpEndpoint": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster\\. By default, the HTTP endpoint is disabled\\. \nWhen enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster\\. You can also query your database from inside the RDS console with the query editor\\. \nFor more information, see [Using the Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableIAMDatabaseAuthentication": "A value that indicates whether to enable mapping of AWS Identity and Access Management \\(IAM\\) accounts to database accounts\\. By default, mapping is disabled\\. \nFor more information, see [ IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide\\.* \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Engine": "The name of the database engine to be used for this DB cluster\\. \nValid Values: \n+ `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\)\n+ `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\)\n+ `aurora-postgresql`\n+ `mysql`\n+ `postgres`\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "EngineMode": "The DB engine mode of the DB cluster, either `provisioned`, `serverless`, `parallelquery`, `global`, or `multimaster`\\. \nThe `parallelquery` engine mode isn't required for Aurora MySQL version 1\\.23 and higher 1\\.x versions, and version 2\\.09 and higher 2\\.x versions\\. \nThe `global` engine mode isn't required for Aurora MySQL version 1\\.22 and higher 1\\.x versions, and `global` engine mode isn't required for any 2\\.x versions\\. \nThe `multimaster` engine mode only applies for DB clusters created with Aurora MySQL version 5\\.6\\.10a\\. \nFor Aurora PostgreSQL, the `global` engine mode isn't required, and both the `parallelquery` and the `multimaster` engine modes currently aren't supported\\. \nLimitations and requirements apply to some DB engine modes\\. For more information, see the following sections in the *Amazon Aurora User Guide*: \n+ [ Limitations of Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) \n+ [ Limitations of Parallel Query](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations) \n+ [ Limitations of Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations) \n+ [ Limitations of Multi\\-Master Clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations) \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EngineVersion": "The version number of the database engine to use\\. \nTo list all of the available engine versions for `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\), use the following command: \n`aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"` \nTo list all of the available engine versions for `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\), use the following command: \n`aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"` \nTo list all of the available engine versions for `aurora-postgresql`, use the following command: \n`aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"` \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "GlobalClusterIdentifier": "If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster\\. To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource\\. \n If you aren't configuring a global database cluster, don't specify this property\\. \nTo remove the DB cluster from a global database cluster, specify an empty value for the `GlobalClusterIdentifier` property\\.\nFor information about Aurora global databases, see [ Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "Iops": "The amount of Provisioned IOPS \\(input/output operations per second\\) to be initially allocated for each DB instance in the Multi\\-AZ DB cluster\\. \nFor information about valid IOPS values, see [Amazon RDS Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*\\. \nThis setting is required to create a Multi\\-AZ DB cluster\\. \nConstraints: Must be a multiple between \\.5 and 50 of the storage amount for the DB cluster\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsKeyId": "The Amazon Resource Name \\(ARN\\) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`\\. If you enable the `StorageEncrypted` property but don't specify this property, the default KMS key is used\\. If you specify this property, you must set the `StorageEncrypted` property to `true`\\. \nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ManageMasterUserPassword": "A value that indicates whether to manage the master user password with AWS Secrets Manager\\. \nFor more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide\\.* \nConstraints: \n+ Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MasterUserPassword": "The master password for the DB instance\\. \nIf you specify the `SourceDBClusterIdentifier`, `SnapshotIdentifier`, or `GlobalClusterIdentifier` property, don't specify this property\\. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MasterUserSecret": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password\\. \nFor more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide\\.* \n*Required*: No \n*Type*: [MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MasterUsername": "The name of the master user for the DB cluster\\. \nIf you specify the `SourceDBClusterIdentifier`, `SnapshotIdentifier`, or `GlobalClusterIdentifier` property, don't specify this property\\. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster\\. To turn off collecting Enhanced Monitoring metrics, specify 0\\. The default is 0\\. \nIf `MonitoringRoleArn` is specified, also set `MonitoringInterval` to a value other than 0\\. \nValid Values: `0, 1, 5, 10, 15, 30, 60` \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MonitoringRoleArn": "The Amazon Resource Name \\(ARN\\) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs\\. An example is `arn:aws:iam:123456789012:role/emaccess`\\. For information on creating a monitoring role, see [Setting up and enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*\\. \nIf `MonitoringInterval` is set to a value other than 0, supply a `MonitoringRoleArn` value\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NetworkType": "The network type of the DB cluster\\. \nValid values: \n+ `IPV4` \n+ `DUAL` \nThe network type is determined by the `DBSubnetGroup` specified for the DB cluster\\. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and IPv6 protocols \\(`DUAL`\\)\\. \nFor more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide\\.* \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PerformanceInsightsEnabled": "A value that indicates whether to turn on Performance Insights for the DB cluster\\. \nFor more information, see [ Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PerformanceInsightsKmsKeyId": "The AWS KMS key identifier for encryption of Performance Insights data\\. \nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key\\. \nIf you don't specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key\\. There is a default KMS key for your AWS account\\. Your AWS account has a different default KMS key for each AWS Region\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PerformanceInsightsRetentionPeriod": "The number of days to retain Performance Insights data\\. The default is 7 days\\. The following values are valid: \n+ 7\n+ *month* \\* 31, where *month* is a number of months from 1\\-23\n+ 731\nFor example, the following values are valid: \n+ 93 \\(3 months \\* 31\\)\n+ 341 \\(11 months \\* 31\\)\n+ 589 \\(19 months \\* 31\\)\n+ 731\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Port": "The port number on which the DB instances in the DB cluster accept connections\\. \nDefault: \n+ When `EngineMode` is `provisioned`, `3306` \\(for both Aurora MySQL and Aurora PostgreSQL\\)\n+ When `EngineMode` is `serverless`:\n + `3306` when `Engine` is `aurora` or `aurora-mysql`\n + `5432` when `Engine` is `aurora-postgresql`\nThe `No interruption` on update behavior only applies to DB clusters\\. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PreferredBackupWindow": "The daily time range during which automated backups are created\\. For more information, see [ Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide\\.* \nConstraints: \n+ Must be in the format `hh24:mi-hh24:mi`\\.\n+ Must be in Universal Coordinated Time \\(UTC\\)\\.\n+ Must not conflict with the preferred maintenance window\\.\n+ Must be at least 30 minutes\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \nFormat: `ddd:hh24:mi-ddd:hh24:mi` \nThe default is a 30\\-minute window selected at random from an 8\\-hour block of time for each AWS Region, occurring on a random day of the week\\. To see the time blocks available, see [ Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide\\.* \nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun\\. \nConstraints: Minimum 30\\-minute window\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PubliclyAccessible": "A value that indicates whether the DB cluster is publicly accessible\\. \nWhen the DB cluster is publicly accessible, its Domain Name System \\(DNS\\) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud \\(VPC\\)\\. It resolves to the public IP address from outside of the DB cluster's VPC\\. Access to the DB cluster is ultimately controlled by the security group it uses\\. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it\\. \nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address\\. \nDefault: The default behavior varies depending on whether `DBSubnetGroupName` is specified\\. \nIf `DBSubnetGroupName` isn't specified, and `PubliclyAccessible` isn't specified, the following applies: \n+ If the default VPC in the target Region doesn\u2019t have an internet gateway attached to it, the DB cluster is private\\.\n+ If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public\\.\nIf `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't specified, the following applies: \n+ If the subnets are part of a VPC that doesn\u2019t have an internet gateway attached to it, the DB cluster is private\\.\n+ If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public\\.\nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ReplicationSourceIdentifier": "The Amazon Resource Name \\(ARN\\) of the source DB instance or DB cluster if this DB cluster is created as a read replica\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RestoreType": "The type of restore to be performed\\. You can specify one of the following values: \n+ `full-copy` \\- The new DB cluster is restored as a full copy of the source DB cluster\\.\n+ `copy-on-write` \\- The new DB cluster is restored as a clone of the source DB cluster\\.\nConstraints: You can't specify `copy-on-write` if the engine version of the source DB cluster is earlier than 1\\.11\\. \nIf you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ScalingConfiguration": "The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster\\. \nThis property is only supported for Aurora Serverless v1\\. For Aurora Serverless v2, use `ServerlessV2ScalingConfiguration` property\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: [ScalingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerlessV2ScalingConfiguration": "The `ServerlessV2ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster\\. \nThis property is only supported for Aurora Serverless v2\\. For Aurora Serverless v1, use `ScalingConfiguration` property\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: [ServerlessV2ScalingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SnapshotIdentifier": "The identifier for the DB snapshot or DB cluster snapshot to restore from\\. \nYou can use either the name or the Amazon Resource Name \\(ARN\\) to specify a DB cluster snapshot\\. However, you can use only the ARN to specify a DB snapshot\\. \nAfter you restore a DB cluster with a `SnapshotIdentifier` property, you must specify the same `SnapshotIdentifier` property for any future updates to the DB cluster\\. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed\\. However, if you don't specify the `SnapshotIdentifier` property, an empty DB cluster is created, and the original DB cluster is deleted\\. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified `SnapshotIdentifier` property, and the original DB cluster is deleted\\. \nIf you specify the `SnapshotIdentifier` property to restore a DB cluster \\(as opposed to specifying it for DB cluster updates\\), then don't specify the following properties: \n+ `GlobalClusterIdentifier`\n+ `MasterUsername`\n+ `MasterUserPassword`\n+ `ReplicationSourceIdentifier`\n+ `RestoreType`\n+ `SourceDBClusterIdentifier`\n+ `SourceRegion`\n+ `StorageEncrypted` \\(for an encrypted snapshot\\)\n+ `UseLatestRestorableTime`\nConstraints: \n+ Must match the identifier of an existing Snapshot\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SourceDBClusterIdentifier": "When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore\\. \nConstraints: \n+ Must match the identifier of an existing DBCluster\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SourceRegion": "The AWS Region which contains the source DB cluster when replicating a DB cluster\\. For example, `us-east-1`\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StorageEncrypted": "Indicates whether the DB cluster is encrypted\\. \nIf you specify the `KmsKeyId` property, then you must enable encryption\\. \nIf you specify the `SourceDBClusterIdentifier` property, don't specify this property\\. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used\\. \nIf you specify the `SnapshotIdentifier` and the specified snapshot is encrypted, don't specify this property\\. The value is inherited from the snapshot, and the specified `KmsKeyId` property is used\\. \nIf you specify the `SnapshotIdentifier` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted\\. Specify the `KmsKeyId` property for the KMS key to use for encryption\\. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to `false`\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StorageType": "Specifies the storage type to be associated with the DB cluster\\. \nThis setting is required to create a Multi\\-AZ DB cluster\\. \nValid values: `io1` \nWhen specified, a value for the `Iops` parameter is required\\. \nDefault: `io1` \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "An optional array of key\\-value pairs to apply to this DB cluster\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseLatestRestorableTime": "A value that indicates whether to restore the DB cluster to the latest restorable backup time\\. By default, the DB cluster is not restored to the latest restorable backup time\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "VpcSecurityGroupIds": "A list of EC2 VPC security groups to associate with this DB cluster\\. \nIf you plan to update the resource, don't specify VPC security groups in a shared VPC\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RDS::DBCluster DBClusterRole": { "FeatureName": "The name of the feature associated with the AWS Identity and Access Management \\(IAM\\) role\\. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf\\. For the list of supported feature names, see the `SupportedFeatureNames` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The Amazon Resource Name \\(ARN\\) of the IAM role that is associated with the DB cluster\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::RDS::DBCluster Endpoint": { + "Address": "Specifies the connection endpoint for the primary instance of the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Port": "Specifies the port that the database engine is listening on\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RDS::DBCluster MasterUserSecret": { + "KmsKeyId": "The AWS KMS key identifier that is used to encrypt the secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretArn": "The Amazon Resource Name \\(ARN\\) of the secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RDS::DBCluster ReadEndpoint": { + "Address": "The host address of the reader endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::RDS::DBCluster ScalingConfiguration": { "AutoPause": "A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in `serverless` DB engine mode\\. A DB cluster can be paused only when it's idle \\(it has no connections\\)\\. \nIf a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot\\. In this case, the DB cluster is restored when there is a request to connect to it\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxCapacity": "The maximum capacity for an Aurora DB cluster in `serverless` DB engine mode\\. \nFor Aurora MySQL, valid capacity values are `1`, `2`, `4`, `8`, `16`, `32`, `64`, `128`, and `256`\\. \nFor Aurora PostgreSQL, valid capacity values are `2`, `4`, `8`, `16`, `32`, `64`, `192`, and `384`\\. \nThe maximum capacity must be greater than or equal to the minimum capacity\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MinCapacity": "The minimum capacity for an Aurora DB cluster in `serverless` DB engine mode\\. \nFor Aurora MySQL, valid capacity values are `1`, `2`, `4`, `8`, `16`, `32`, `64`, `128`, and `256`\\. \nFor Aurora PostgreSQL, valid capacity values are `2`, `4`, `8`, `16`, `32`, `64`, `192`, and `384`\\. \nThe minimum capacity must be less than or equal to the maximum capacity\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecondsUntilAutoPause": "The time, in seconds, before an Aurora DB cluster in `serverless` mode is paused\\. \nSpecify a value between 300 and 86,400 seconds\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SecondsBeforeTimeout": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action\\. The default is 300\\. \nSpecify a value between 60 and 600 seconds\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecondsUntilAutoPause": "The time, in seconds, before an Aurora DB cluster in `serverless` mode is paused\\. \nSpecify a value between 300 and 86,400 seconds\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TimeoutAction": "The action to take when the timeout is reached, either `ForceApplyCapacityChange` or `RollbackCapacityChange`\\. \n `ForceApplyCapacityChange` sets the capacity to the specified value as soon as possible\\. \n `RollbackCapacityChange`, the default, ignores the capacity change if a scaling point isn't found in the timeout period\\. \nIf you specify `ForceApplyCapacityChange`, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped\\.\nFor more information, see [ Autoscaling for Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RDS::DBCluster ServerlessV2ScalingConfiguration": { + "MaxCapacity": "The maximum number of Aurora capacity units \\(ACUs\\) for a DB instance in an Aurora Serverless v2 cluster\\. You can specify ACU values in half\\-step increments, such as 40, 40\\.5, 41, and so on\\. The largest value that you can use is 128\\. \nThe maximum capacity must be higher than 0\\.5 ACUs\\. For more information, see [ Choosing the maximum Aurora Serverless v2 capacity setting for a cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.setting-capacity.html#aurora-serverless-v2.max_capacity_considerations) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MinCapacity": "The minimum number of Aurora capacity units \\(ACUs\\) for a DB instance in an Aurora Serverless v2 cluster\\. You can specify ACU values in half\\-step increments, such as 8, 8\\.5, 9, and so on\\. The smallest value that you can use is 0\\.5\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RDS::DBClusterParameterGroup": { + "DBClusterParameterGroupName": "The name of the DB cluster parameter group\\. \nConstraints: \n+ Must not match the name of an existing DB cluster parameter group\\.\nIf you don't specify a value for `DBClusterParameterGroupName` property, a name is automatically created for the DB cluster paramter group\\. \nThis value is stored as a lowercase string\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "A friendly description for this DB cluster parameter group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Family": "The DB cluster parameter group family name\\. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family\\. \nThe DB cluster parameter group family can't be changed when updating a DB cluster parameter group\\.\nTo list all of the available parameter group families, use the following command: \n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"` \nThe output contains duplicates\\. \nFor more information, see [`CreateDBClusterParameterGroup`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Parameters": "Provides a list of parameters for the DB cluster parameter group\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "Tags to assign to the DB cluster parameter group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Tags": "An optional array of key\\-value pairs to apply to this DB cluster parameter group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RDS::DBInstance": { - "AllocatedStorage": "The amount of storage \\(in gigabytes\\) to be initially allocated for the database instance\\. \nIf any value is set in the `Iops` parameter, `AllocatedStorage` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000\\. If you increase the `Iops` value \\(in 1,000 IOPS increments\\), then you must also increase the `AllocatedStorage` value \\(in 100\\-GiB increments\\)\\. \n **Amazon Aurora** \nNot applicable\\. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume\\. \n **MySQL** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **MariaDB** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **PostgreSQL** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **Oracle** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 10 to 3072\\.\n **SQL Server** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384\\.\n + Web and Express editions: Must be an integer from 20 to 16384\\.\n+ Provisioned IOPS storage \\(io1\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384\\.\n + Web and Express editions: Must be an integer from 20 to 16384\\.\n+ Magnetic storage \\(standard\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 1024\\.\n + Web and Express editions: Must be an integer from 20 to 1024\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AllocatedStorage": "The amount of storage in gibibytes \\(GiB\\) to be initially allocated for the database instance\\. \nIf any value is set in the `Iops` parameter, `AllocatedStorage` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000\\. If you increase the `Iops` value \\(in 1,000 IOPS increments\\), then you must also increase the `AllocatedStorage` value \\(in 100\\-GiB increments\\)\\. \n **Amazon Aurora** \nNot applicable\\. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume\\. \n **MySQL** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **MariaDB** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **PostgreSQL** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **Oracle** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 10 to 3072\\.\n **SQL Server** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384\\.\n + Web and Express editions: Must be an integer from 20 to 16384\\.\n+ Provisioned IOPS storage \\(io1\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384\\.\n + Web and Express editions: Must be an integer from 20 to 16384\\.\n+ Magnetic storage \\(standard\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 1024\\.\n + Web and Express editions: Must be an integer from 20 to 1024\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AllowMajorVersionUpgrade": "A value that indicates whether major version upgrades are allowed\\. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible\\. \nConstraints: Major version upgrades must be allowed when specifying a value for the `EngineVersion` parameter that is a different major version than the DB instance's current version\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AssociatedRoles": "The AWS Identity and Access Management \\(IAM\\) roles associated with the DB instance\\. \n*Required*: No \n*Type*: List of [DBInstanceRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AutoMinorVersionUpgrade": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window\\. By default, minor engine upgrades are applied automatically\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AvailabilityZone": "The Availability Zone that the database instance will be created in\\. \nDefault: A random, system\\-chosen Availability Zone in the endpoint's region\\. \n Example: `us-east-1d` \n Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to `true`\\. The specified Availability Zone must be in the same region as the current endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AssociatedRoles": "The AWS Identity and Access Management \\(IAM\\) roles associated with the DB instance\\. \n **Amazon Aurora** \nNot applicable\\. The associated roles are managed by the DB cluster\\. \n*Required*: No \n*Type*: List of [DBInstanceRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AutoMinorVersionUpgrade": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window\\. By default, minor engine upgrades are applied automatically\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "AvailabilityZone": "The Availability Zone \\(AZ\\) where the database will be created\\. For information on AWS Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)\\. \n **Amazon Aurora** \nEach Aurora DB cluster hosts copies of its storage in three separate Availability Zones\\. Specify one of these Availability Zones\\. Aurora automatically chooses an appropriate Availability Zone if you don't specify one\\. \nDefault: A random, system\\-chosen Availability Zone in the endpoint's AWS Region\\. \nExample: `us-east-1d` \nConstraint: The `AvailabilityZone` parameter can't be specified if the DB instance is a Multi\\-AZ deployment\\. The specified Availability Zone must be in the same AWS Region as the current endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "BackupRetentionPeriod": "The number of days for which automated backups are retained\\. Setting this parameter to a positive number enables backups\\. Setting this parameter to 0 disables automated backups\\. \n**Amazon Aurora** \nNot applicable\\. The retention period for automated backups is managed by the DB cluster\\. \nDefault: 1 \nConstraints: \n+ Must be a value from 0 to 35\n+ Can't be set to 0 if the DB instance is a source to read replicas\n*Required*: No \n*Type*: Integer \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "CACertificateIdentifier": "The identifier of the CA certificate for this DB instance\\. \nSpecifying or updating this property triggers a reboot\\.\nFor more information about CA certificate identifiers for RDS DB engines, see [ Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide*\\. \nFor more information about CA certificate identifiers for Aurora DB engines, see [ Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CertificateDetails": "The details of the DB instance's server certificate\\. \n*Required*: No \n*Type*: [CertificateDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-certificatedetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CertificateRotationRestart": "A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate\\. \nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate\\. The certificate is not updated until the DB instance is restarted\\. \nSet this parameter only if you are *not* using SSL/TLS to connect to the DB instance\\.\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: \n+ For more information about rotating your SSL/TLS certificate for RDS DB engines, see [ Rotating Your SSL/TLS Certificate\\.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide\\.* \n+ For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [ Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*\\.\nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CharacterSetName": "For supported engines, indicates that the DB instance should be associated with the specified character set\\. \n **Amazon Aurora** \nNot applicable\\. The character set is managed by the DB cluster\\. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "CopyTagsToSnapshot": "A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance\\. By default, tags are not copied\\. \n **Amazon Aurora** \nNot applicable\\. Copying tags to snapshots is managed by the DB cluster\\. Setting this value for an Aurora DB instance has no effect on the DB cluster setting\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomIAMInstanceProfile": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance\\. The instance profile must meet the following requirements: \n+ The profile must exist in your account\\.\n+ The profile must have an IAM role that Amazon EC2 has permissions to assume\\.\n+ The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom`\\.\nFor the list of permissions required for the IAM role, see [ Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*\\. \nThis setting is required for RDS Custom\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DBClusterIdentifier": "The identifier of the DB cluster that the instance will belong to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DBInstanceClass": "The compute and memory capacity of the DB instance, for example, `db.m4.large`\\. Not all DB instance classes are available in all AWS Regions, or for all database engines\\. \nFor the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide\\.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](http://aws.amazon.com/rds/pricing/)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "DBClusterSnapshotIdentifier": "The identifier for the RDS for MySQL Multi\\-AZ DB cluster snapshot to restore from\\. \nFor more information on Multi\\-AZ DB clusters, see [ Multi\\-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*\\. \nConstraints: \n+ Must match the identifier of an existing Multi\\-AZ DB cluster snapshot\\.\n+ Can't be specified when `DBSnapshotIdentifier` is specified\\.\n+ Must be specified when `DBSnapshotIdentifier` isn't specified\\.\n+ If you are restoring from a shared manual Multi\\-AZ DB cluster snapshot, the `DBClusterSnapshotIdentifier` must be the ARN of the shared snapshot\\.\n+ Can't be the identifier of an Aurora DB cluster snapshot\\.\n+ Can't be the identifier of an RDS for PostgreSQL Multi\\-AZ DB cluster snapshot\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "DBInstanceClass": "The compute and memory capacity of the DB instance, for example, `db.m4.large`\\. Not all DB instance classes are available in all AWS Regions, or for all database engines\\. \nFor the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide\\.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](http://aws.amazon.com/rds/pricing/)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "DBInstanceIdentifier": "A name for the DB instance\\. If you specify a name, AWS CloudFormation converts it to lowercase\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nFor information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*\\. \nIf you specify a name, you can't perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DBName": "The meaning of this parameter differs according to the database engine you use\\. \n If you specify the ` [ DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)` property, AWS CloudFormation ignores this property\\. \nIf you restore DB instances from snapshots, this property doesn't apply to the MySQL, PostgreSQL, or MariaDB engines\\.\n **MySQL** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, no database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 64 letters or numbers\\.\n+ Can't be a word reserved by the specified database engine\n **MariaDB** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, no database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 64 letters or numbers\\.\n+ Can't be a word reserved by the specified database engine\n **PostgreSQL** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, the default `postgres` database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 63 letters, numbers, or underscores\\.\n+ Must begin with a letter or an underscore\\. Subsequent characters can be letters, underscores, or digits \\(0\\-9\\)\\.\n+ Can't be a word reserved by the specified database engine\n **Oracle** \nThe Oracle System ID \\(SID\\) of the created DB instance\\. If you specify `null`, the default value `ORCL` is used\\. You can't specify the string NULL, or any other reserved word, for `DBName`\\. \nDefault: `ORCL` \nConstraints: \n+ Can't be longer than 8 characters\n **SQL Server** \nNot applicable\\. Must be null\\. \n **Amazon Aurora MySQL** \nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created\\. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster\\. \nConstraints: \n+ It must contain 1 to 64 alphanumeric characters\\.\n+ It can't be a word reserved by the database engine\\.\n **Amazon Aurora PostgreSQL** \nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created\\. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named `postgres` is created in the DB cluster\\. \nConstraints: \n+ It must contain 1 to 63 alphanumeric characters\\.\n+ It must begin with a letter or an underscore\\. Subsequent characters can be letters, underscores, or digits \\(0 to 9\\)\\.\n+ It can't be a word reserved by the database engine\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DBParameterGroupName": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template\\. \nTo list all of the available DB parameter group names, use the following command: \n`aws rds describe-db-parameter-groups --query \"DBParameterGroups[].DBParameterGroupName\" --output text` \nIf any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption\\. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot\\.\nIf you don't specify a value for the `DBParameterGroupName` property, the default DB parameter group for the specified engine and engine version is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "DBName": "The meaning of this parameter differs according to the database engine you use\\. \nIf you specify the `[ DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)` property, this property only applies to RDS for Oracle\\.\n **Amazon Aurora** \nNot applicable\\. The database name is managed by the DB cluster\\. \n **MySQL** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, no database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 64 letters or numbers\\.\n+ Can't be a word reserved by the specified database engine\n **MariaDB** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, no database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 64 letters or numbers\\.\n+ Can't be a word reserved by the specified database engine\n **PostgreSQL** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, the default `postgres` database is created in the DB instance\\. \nConstraints: \n+ Must begin with a letter\\. Subsequent characters can be letters, underscores, or digits \\(0\\-9\\)\\.\n+ Must contain 1 to 63 characters\\.\n+ Can't be a word reserved by the specified database engine\n **Oracle** \nThe Oracle System ID \\(SID\\) of the created DB instance\\. If you specify `null`, the default value `ORCL` is used\\. You can't specify the string NULL, or any other reserved word, for `DBName`\\. \nDefault: `ORCL` \nConstraints: \n+ Can't be longer than 8 characters\n **SQL Server** \nNot applicable\\. Must be null\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DBParameterGroupName": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template\\. \nTo list all of the available DB parameter group names, use the following command: \n`aws rds describe-db-parameter-groups --query \"DBParameterGroups[].DBParameterGroupName\" --output text` \nIf any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption\\. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot\\.\nIf you don't specify a value for `DBParameterGroupName` property, the default DB parameter group for the specified engine and engine version is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "DBSecurityGroups": "A list of the DB security groups to assign to the DB instance\\. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template\\. \n If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa\\. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance\\. Instead, use VPCSecurityGroups\\. \nIf you specify this property, AWS CloudFormation sends only the following properties \\(if specified\\) to Amazon RDS during create operations: \n+ `AllocatedStorage`\n+ `AutoMinorVersionUpgrade`\n+ `AvailabilityZone`\n+ `BackupRetentionPeriod`\n+ `CharacterSetName`\n+ `DBInstanceClass`\n+ `DBName`\n+ `DBParameterGroupName`\n+ `DBSecurityGroups`\n+ `DBSubnetGroupName`\n+ `Engine`\n+ `EngineVersion`\n+ `Iops`\n+ `LicenseModel`\n+ `MasterUsername`\n+ `MasterUserPassword`\n+ `MultiAZ`\n+ `OptionGroupName`\n+ `PreferredBackupWindow`\n+ `PreferredMaintenanceWindow`\nAll other properties are ignored\\. Specify a virtual private cloud \\(VPC\\) security group if you want to submit other properties, such as `StorageType`, `StorageEncrypted`, or `KmsKeyId`\\. If you're already using the `DBSecurityGroups` property, you can't use these other properties by updating your DB instance to use a VPC security group\\. You must recreate the DB instance\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DBSnapshotIdentifier": "The name or Amazon Resource Name \\(ARN\\) of the DB snapshot that's used to restore the DB instance\\. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot\\. \nBy specifying this property, you can create a DB instance from the specified DB snapshot\\. If the `DBSnapshotIdentifier` property is an empty string or the `AWS::RDS::DBInstance` declaration has no `DBSnapshotIdentifier` property, AWS CloudFormation creates a new database\\. If the property contains a value \\(other than an empty string\\), AWS CloudFormation creates a database from the specified snapshot\\. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack\\. \nSome DB instance properties aren't valid when you restore from a snapshot, such as the `MasterUsername` and `MasterUserPassword` properties\\. For information about the properties that you can specify, see the `RestoreDBInstanceFromDBSnapshot` action in the *Amazon RDS API Reference*\\. \nAfter you restore a DB instance with a `DBSnapshotIdentifier` property, you must specify the same `DBSnapshotIdentifier` property for any future updates to the DB instance\\. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed\\. However, if you don't specify the `DBSnapshotIdentifier` property, an empty DB instance is created, and the original DB instance is deleted\\. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified `DBSnapshotIdentifier` property, and the original DB instance is deleted\\. \nIf you specify the `DBSnapshotIdentifier` property to restore a DB instance \\(as opposed to specifying it for DB instance updates\\), then don't specify the following properties: \n+ `CharacterSetName`\n+ `DBClusterIdentifier`\n+ `DBName`\n+ `DeleteAutomatedBackups`\n+ `EnablePerformanceInsights`\n+ `KmsKeyId`\n+ `MasterUsername`\n+ `MonitoringInterval`\n+ `MonitoringRoleArn`\n+ `PerformanceInsightsKMSKeyId`\n+ `PerformanceInsightsRetentionPeriod`\n+ `PromotionTier`\n+ `SourceDBInstanceIdentifier`\n+ `SourceRegion`\n+ `StorageEncrypted`\n+ `Timezone`\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DBSnapshotIdentifier": "The name or Amazon Resource Name \\(ARN\\) of the DB snapshot that's used to restore the DB instance\\. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot\\. \nBy specifying this property, you can create a DB instance from the specified DB snapshot\\. If the `DBSnapshotIdentifier` property is an empty string or the `AWS::RDS::DBInstance` declaration has no `DBSnapshotIdentifier` property, AWS CloudFormation creates a new database\\. If the property contains a value \\(other than an empty string\\), AWS CloudFormation creates a database from the specified snapshot\\. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack\\. \nSome DB instance properties aren't valid when you restore from a snapshot, such as the `MasterUsername` and `MasterUserPassword` properties\\. For information about the properties that you can specify, see the `RestoreDBInstanceFromDBSnapshot` action in the *Amazon RDS API Reference*\\. \nAfter you restore a DB instance with a `DBSnapshotIdentifier` property, you must specify the same `DBSnapshotIdentifier` property for any future updates to the DB instance\\. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed\\. However, if you don't specify the `DBSnapshotIdentifier` property, an empty DB instance is created, and the original DB instance is deleted\\. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified `DBSnapshotIdentifier` property, and the original DB instance is deleted\\. \nIf you specify the `DBSnapshotIdentifier` property to restore a DB instance \\(as opposed to specifying it for DB instance updates\\), then don't specify the following properties: \n+ `CharacterSetName`\n+ `DBClusterIdentifier`\n+ `DBName`\n+ `DeleteAutomatedBackups`\n+ `EnablePerformanceInsights`\n+ `KmsKeyId`\n+ `MasterUsername`\n+ `MasterUserPassword`\n+ `PerformanceInsightsKMSKeyId`\n+ `PerformanceInsightsRetentionPeriod`\n+ `PromotionTier`\n+ `SourceDBInstanceIdentifier`\n+ `SourceRegion`\n+ `StorageEncrypted` \\(for an encrypted snapshot\\)\n+ `Timezone`\n **Amazon Aurora** \nNot applicable\\. Snapshot restore is managed by the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "DBSubnetGroupName": "A DB subnet group to associate with the DB instance\\. If you update this value, the new subnet group must be a subnet group in a new VPC\\. \nIf there's no DB subnet group, then the DB instance isn't a VPC DB instance\\. \nFor more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud \\(VPC\\)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*\\. \n**Amazon Aurora** \nNot applicable\\. The DB subnet group is managed by the DB cluster\\. If specified, the setting must match the DB cluster setting\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DeleteAutomatedBackups": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted\\. This parameter isn't case\\-sensitive\\. The default is to remove automated backups immediately after the DB instance is deleted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeleteAutomatedBackups": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted\\. This parameter isn't case\\-sensitive\\. The default is to remove automated backups immediately after the DB instance is deleted\\. \n**Amazon Aurora** \nNot applicable\\. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered\\. Manual DB cluster snapshots of the DB cluster are not deleted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DeletionProtection": "A value that indicates whether the DB instance has deletion protection enabled\\. The database can't be deleted when deletion protection is enabled\\. By default, deletion protection is disabled\\. For more information, see [ Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html)\\. \n **Amazon Aurora** \nNot applicable\\. You can enable or disable deletion protection for the DB cluster\\. For more information, see `CreateDBCluster`\\. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Domain": "The Active Directory directory ID to create the DB instance in\\. Currently, only Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain\\. \nFor more information, see [ Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DomainIAMRoleName": "Specify the name of the IAM role to be used when making API calls to the Directory Service\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DomainIAMRoleName": "Specify the name of the IAM role to be used when making API calls to the Directory Service\\. \nThis setting doesn't apply to RDS Custom\\. \n **Amazon Aurora** \nNot applicable\\. The domain is managed by the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnableCloudwatchLogsExports": "The list of log types that need to be enabled for exporting to CloudWatch Logs\\. The values in the list depend on the DB engine being used\\. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs ](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*\\. \n **Amazon Aurora** \nNot applicable\\. CloudWatch Logs exports are managed by the DB cluster\\. \n **MariaDB** \nValid values: `audit`, `error`, `general`, `slowquery` \n **Microsoft SQL Server** \nValid values: `agent`, `error` \n **MySQL** \nValid values: `audit`, `error`, `general`, `slowquery` \n **Oracle** \nValid values: `alert`, `audit`, `listener`, `trace` \n **PostgreSQL** \nValid values: `postgresql`, `upgrade` \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EnableIAMDatabaseAuthentication": "A value that indicates whether to enable mapping of AWS Identity and Access Management \\(IAM\\) accounts to database accounts\\. By default, mapping is disabled\\. \nFor more information, see [ IAM Database Authentication for MySQL and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide\\.* \n **Amazon Aurora** \nNot applicable\\. Mapping AWS IAM accounts to database accounts is managed by the DB cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableIAMDatabaseAuthentication": "A value that indicates whether to enable mapping of AWS Identity and Access Management \\(IAM\\) accounts to database accounts\\. By default, mapping is disabled\\. \nThis property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL\\. For more information, see [ IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide\\.* \n **Amazon Aurora** \nNot applicable\\. Mapping AWS IAM accounts to database accounts is managed by the DB cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnablePerformanceInsights": "A value that indicates whether to enable Performance Insights for the DB instance\\. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Engine": "The name of the database engine that you want to use for this DB instance\\. \nWhen you are creating a DB instance, the `Engine` property is required\\.\nValid Values: \n+ `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\)\n+ `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\)\n+ `aurora-postgresql`\n+ `mariadb`\n+ `mysql`\n+ `oracle-ee`\n+ `oracle-se2`\n+ `oracle-se1`\n+ `oracle-se`\n+ `postgres`\n+ `sqlserver-ee`\n+ `sqlserver-se`\n+ `sqlserver-ex`\n+ `sqlserver-web`\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", - "EngineVersion": "The version number of the database engine to use\\. \nFor a list of valid engine versions, use the `DescribeDBEngineVersions` action\\. \nThe following are the database engines and links to information about the major and minor versions that are available with Amazon RDS\\. Not every database engine is available for every AWS Region\\. \n **Amazon Aurora** \nNot applicable\\. The version number of the database engine to be used by the DB instance is managed by the DB cluster\\. \n**MariaDB** \nSee [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide\\.* \n**Microsoft SQL Server** \nSee [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide\\.* \n**MySQL** \nSee [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide\\.* \n**Oracle** \nSee [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide\\.* \n**PostgreSQL** \nSee [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "Endpoint": "Specifies the connection endpoint\\. \nThe endpoint might not be shown for instances whose status is `creating`\\.\n*Required*: No \n*Type*: [Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Engine": "The name of the database engine that you want to use for this DB instance\\. \nWhen you are creating a DB instance, the `Engine` property is required\\.\nValid Values: \n+ `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\)\n+ `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\)\n+ `aurora-postgresql`\n+ `custom-oracle-ee`\n+ `custom-oracle-ee-cdb`\n+ `custom-sqlserver-ee`\n+ `custom-sqlserver-se`\n+ `custom-sqlserver-web`\n+ `mariadb`\n+ `mysql`\n+ `oracle-ee`\n+ `oracle-ee-cdb`\n+ `oracle-se2`\n+ `oracle-se2-cdb`\n+ `postgres`\n+ `sqlserver-ee`\n+ `sqlserver-se`\n+ `sqlserver-ex`\n+ `sqlserver-web`\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "EngineVersion": "The version number of the database engine to use\\. \nFor a list of valid engine versions, use the `DescribeDBEngineVersions` action\\. \nThe following are the database engines and links to information about the major and minor versions that are available with Amazon RDS\\. Not every database engine is available for every AWS Region\\. \n **Amazon Aurora** \nNot applicable\\. The version number of the database engine to be used by the DB instance is managed by the DB cluster\\. \n**MariaDB** \nSee [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide\\.* \n**Microsoft SQL Server** \nSee [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide\\.* \n**MySQL** \nSee [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide\\.* \n**Oracle** \nSee [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide\\.* \n**PostgreSQL** \nSee [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Iops": "The number of I/O operations per second \\(IOPS\\) that the database provisions\\. The value must be equal to or greater than 1000\\. \nIf you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate \\(IOPS to allocated storage\\)\\. For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage \\(a ratio of 5:1\\), or specify 2000 IOPS with 200 GiB of storage \\(a ratio of 10:1\\)\\. For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*\\. \nIf you specify `io1` for the `StorageType` property, then you must also specify the `Iops` property\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KmsKeyId": "The ARN of the AWS KMS key that's used to encrypt the DB instance, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`\\. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key\\. If you specify this property, you must set the StorageEncrypted property to true\\. \nIf you specify the `SourceDBInstanceIdentifier` property, the value is inherited from the source DB instance if the read replica is created in the same region\\. \nIf you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region\\. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region\\. \nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified `KmsKeyId` property is used\\. \nIf you specify `DBSecurityGroups`, AWS CloudFormation ignores this property\\. To specify both a security group and this property, you must use a VPC security group\\. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html) in the *Amazon RDS User Guide*\\. \n **Amazon Aurora** \nNot applicable\\. The KMS key identifier is managed by the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "LicenseModel": "License model information for this DB instance\\. \n Valid values: \n+ Aurora MySQL \\- `general-public-license`\n+ Aurora PostgreSQL \\- `postgresql-license`\n+ MariaDB \\- `general-public-license`\n+ Microsoft SQL Server \\- `license-included`\n+ MySQL \\- `general-public-license`\n+ Oracle \\- `bring-your-own-license` or `license-included`\n+ PostgreSQL \\- `postgresql-license`\nIf you've specified `DBSecurityGroups` and then you update the license model, AWS CloudFormation replaces the underlying DB instance\\. This will incur some interruptions to database availability\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ManageMasterUserPassword": "A value that indicates whether to manage the master user password with AWS Secrets Manager\\. \nFor more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide\\.* \nConstraints: \n+ Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MasterUserPassword": "The password for the master user\\. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\"\\. \n **Amazon Aurora** \nNot applicable\\. The password for the master user is managed by the DB cluster\\. \n **MariaDB** \nConstraints: Must contain from 8 to 41 characters\\. \n **Microsoft SQL Server** \nConstraints: Must contain from 8 to 128 characters\\. \n **MySQL** \nConstraints: Must contain from 8 to 41 characters\\. \n **Oracle** \nConstraints: Must contain from 8 to 30 characters\\. \n **PostgreSQL** \nConstraints: Must contain from 8 to 128 characters\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MasterUserSecret": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password\\. \nFor more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide\\.* \n*Required*: No \n*Type*: [MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-masterusersecret.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MasterUsername": "The master user name for the DB instance\\. \nIf you specify the `SourceDBInstanceIdentifier` or `DBSnapshotIdentifier` property, don't specify this property\\. The value is inherited from the source DB instance or snapshot\\.\n **Amazon Aurora** \nNot applicable\\. The name for the master user is managed by the DB cluster\\. \n **MariaDB** \nConstraints: \n+ Required for MariaDB\\.\n+ Must be 1 to 16 letters or numbers\\.\n+ Can't be a reserved word for the chosen database engine\\.\n **Microsoft SQL Server** \nConstraints: \n+ Required for SQL Server\\.\n+ Must be 1 to 128 letters or numbers\\.\n+ The first character must be a letter\\.\n+ Can't be a reserved word for the chosen database engine\\.\n **MySQL** \nConstraints: \n+ Required for MySQL\\.\n+ Must be 1 to 16 letters or numbers\\.\n+ First character must be a letter\\.\n+ Can't be a reserved word for the chosen database engine\\.\n **Oracle** \nConstraints: \n+ Required for Oracle\\.\n+ Must be 1 to 30 letters or numbers\\.\n+ First character must be a letter\\.\n+ Can't be a reserved word for the chosen database engine\\.\n **PostgreSQL** \nConstraints: \n+ Required for PostgreSQL\\.\n+ Must be 1 to 63 letters or numbers\\.\n+ First character must be a letter\\.\n+ Can't be a reserved word for the chosen database engine\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "MaxAllocatedStorage": "The upper limit in gibibytes \\(GiB\\) to which Amazon RDS can automatically scale the storage of the DB instance\\. \nFor more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance\\. To disable collection of Enhanced Monitoring metrics, specify 0\\. The default is 0\\. \nIf `MonitoringRoleArn` is specified, then you must set `MonitoringInterval` to a value other than 0\\. \nThis setting doesn't apply to RDS Custom\\. \nValid Values: `0, 1, 5, 10, 15, 30, 60` \n*Required*: No \n*Type*: Integer \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "MaxAllocatedStorage": "The upper limit in gibibytes \\(GiB\\) to which Amazon RDS can automatically scale the storage of the DB instance\\. \nFor more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*\\. \nThis setting doesn't apply to RDS Custom\\. \n **Amazon Aurora** \nNot applicable\\. Storage is managed by the DB cluster\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MonitoringInterval": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance\\. To disable collection of Enhanced Monitoring metrics, specify 0\\. The default is 0\\. \nIf `MonitoringRoleArn` is specified, then you must set `MonitoringInterval` to a value other than 0\\. \nThis setting doesn't apply to RDS Custom\\. \nValid Values: `0, 1, 5, 10, 15, 30, 60` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MonitoringRoleArn": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs\\. For example, `arn:aws:iam:123456789012:role/emaccess`\\. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*\\. \nIf `MonitoringInterval` is set to a value other than 0, then you must supply a `MonitoringRoleArn` value\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MultiAZ": "Specifies whether the database instance is a multiple Availability Zone deployment\\. You can't set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to true\\. \n **Amazon Aurora** \nNot applicable\\. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the `MultiAZ` option to be set\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "MultiAZ": "Specifies whether the database instance is a Multi\\-AZ DB instance deployment\\. You can't set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to true\\. \nFor more information, see [ Multi\\-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*\\. \n **Amazon Aurora** \nNot applicable\\. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the `MultiAZ` option to be set\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "NcharCharacterSetName": "The name of the NCHAR character set for the Oracle DB instance\\. \nThis parameter doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "NetworkType": "The network type of the DB instance\\. \nValid values: \n+ `IPV4` \n+ `DUAL` \nThe network type is determined by the `DBSubnetGroup` specified for the DB instance\\. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and IPv6 protocols \\(`DUAL`\\)\\. \nFor more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OptionGroupName": "Indicates that the DB instance should be associated with the specified option group\\. \nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group\\. Also, that option group can't be removed from a DB instance once it is associated with a DB instance\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PerformanceInsightsKMSKeyId": "The AWS KMS key identifier for encryption of Performance Insights data\\. \nThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key\\. \nIf you do not specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key\\. There is a default KMS key for your AWS account\\. Your AWS account has a different default KMS key for each AWS Region\\. \nFor information about enabling Performance Insights, see [ EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PerformanceInsightsKMSKeyId": "The AWS KMS key identifier for encryption of Performance Insights data\\. \nThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key\\. \nIf you do not specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key\\. There is a default KMS key for your AWS account\\. Your AWS account has a different default KMS key for each AWS Region\\. \nFor information about enabling Performance Insights, see [ EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "PerformanceInsightsRetentionPeriod": "The amount of time, in days, to retain Performance Insights data\\. Valid values are 7 or 731 \\(2 years\\)\\. \nFor information about enabling Performance Insights, see [ EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Port": "The port number on which the database accepts connections\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Port": "The port number on which the database accepts connections\\. \n **Amazon Aurora** \nNot applicable\\. The port number is managed by the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PreferredBackupWindow": "The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter\\. For more information, see [ Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide\\.* \nConstraints: \n+ Must be in the format `hh24:mi-hh24:mi`\\.\n+ Must be in Universal Coordinated Time \\(UTC\\)\\.\n+ Must not conflict with the preferred maintenance window\\.\n+ Must be at least 30 minutes\\.\n **Amazon Aurora** \nNot applicable\\. The daily time range for creating automated backups is managed by the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PreferredMaintenanceWindow": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \nFormat: `ddd:hh24:mi-ddd:hh24:mi` \nThe default is a 30\\-minute window selected at random from an 8\\-hour block of time for each AWS Region, occurring on a random day of the week\\. To see the time blocks available, see [ Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide\\.* \nThis property applies when AWS CloudFormation initially creates the DB instance\\. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately\\.\nConstraints: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", - "ProcessorFeatures": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: List of [ProcessorFeature](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProcessorFeatures": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance\\. \nThis setting doesn't apply to RDS Custom\\. \n **Amazon Aurora** \nNot applicable\\. \n*Required*: No \n*Type*: List of [ProcessorFeature](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PromotionTier": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance\\. For more information, see [ Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*\\. \nThis setting doesn't apply to RDS Custom\\. \nDefault: 1 \nValid Values: 0 \\- 15 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PubliclyAccessible": "Indicates whether the DB instance is an internet\\-facing instance\\. If you specify `true`, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address\\. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address\\. \n The default behavior value depends on your VPC setup and the database subnet group\\. For more information, see the `PubliclyAccessible` parameter in [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*\\. \n If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the *DependsOn* attribute to declare a dependency on the VPC\\-gateway attachment\\. For more information, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html)\\. \nIf you specify DBSecurityGroups, AWS CloudFormation ignores this property\\. To specify a security group and this property, you must use a VPC security group\\. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SourceDBInstanceIdentifier": "If you want to create a read replica DB instance, specify the ID of the source DB instance\\. Each DB instance can have a limited number of read replicas\\. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*\\. \nFor information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*\\. \nThe `SourceDBInstanceIdentifier` property determines whether a DB instance is a read replica\\. If you remove the `SourceDBInstanceIdentifier` property from your template and then update your stack, AWS CloudFormation deletes the Read Replica and creates a new DB instance \\(not a read replica\\)\\. \n+ If you specify a source DB instance that uses VPC security groups, we recommend that you specify the `VPCSecurityGroups` property\\. If you don't specify the property, the read replica inherits the value of the `VPCSecurityGroups` property from the source DB when you create the replica\\. However, if you update the stack, AWS CloudFormation reverts the replica's `VPCSecurityGroups` property to the default value because it's not defined in the stack's template\\. This change might cause unexpected issues\\.\n+ Read replicas don't support deletion policies\\. AWS CloudFormation ignores any deletion policy that's associated with a read replica\\.\n+ If you specify `SourceDBInstanceIdentifier`, don't specify the `DBSnapshotIdentifier` property\\. You can't create a read replica from a snapshot\\.\n+ Don't set the `BackupRetentionPeriod`, `DBName`, `MasterUsername`, `MasterUserPassword`, and `PreferredBackupWindow` properties\\. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas\\.\n+ If the source DB instance is in a different region than the read replica, specify the source region in `SourceRegion`, and specify an ARN for a valid DB instance in `SourceDBInstanceIdentifier`\\. For more information, see [ Constructing a Amazon RDS Amazon Resource Name \\(ARN\\)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*\\.\n+ For DB instances in Amazon Aurora clusters, don't specify this property\\. Amazon RDS automatically assigns writer and reader DB instances\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PubliclyAccessible": "Indicates whether the DB instance is an internet\\-facing instance\\. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address\\. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address\\. \nThe default behavior value depends on your VPC setup and the database subnet group\\. For more information, see the `PubliclyAccessible` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ReplicaMode": "The open mode of an Oracle read replica\\. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*\\. \nThis setting is only supported in RDS for Oracle\\. \nDefault: `open-read-only` \nValid Values: `open-read-only` or `mounted` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RestoreTime": "The date and time to restore from\\. \nValid Values: Value must be a time in Universal Coordinated Time \\(UTC\\) format \nConstraints: \n+ Must be before the latest restorable time for the DB instance\n+ Can't be specified if the `UseLatestRestorableTime` parameter is enabled\nExample: `2009-09-07T23:45:00Z` \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "SourceDBInstanceAutomatedBackupsArn": "The Amazon Resource Name \\(ARN\\) of the replicated automated backups from which to restore, for example, `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "SourceDBInstanceIdentifier": "If you want to create a read replica DB instance, specify the ID of the source DB instance\\. Each DB instance can have a limited number of read replicas\\. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*\\. \nFor information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*\\. \nThe `SourceDBInstanceIdentifier` property determines whether a DB instance is a read replica\\. If you remove the `SourceDBInstanceIdentifier` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance\\. \n+ If you specify a source DB instance that uses VPC security groups, we recommend that you specify the `VPCSecurityGroups` property\\. If you don't specify the property, the read replica inherits the value of the `VPCSecurityGroups` property from the source DB when you create the replica\\. However, if you update the stack, AWS CloudFormation reverts the replica's `VPCSecurityGroups` property to the default value because it's not defined in the stack's template\\. This change might cause unexpected issues\\.\n+ Read replicas don't support deletion policies\\. AWS CloudFormation ignores any deletion policy that's associated with a read replica\\.\n+ If you specify `SourceDBInstanceIdentifier`, don't specify the `DBSnapshotIdentifier` property\\. You can't create a read replica from a snapshot\\.\n+ Don't set the `BackupRetentionPeriod`, `DBName`, `MasterUsername`, `MasterUserPassword`, and `PreferredBackupWindow` properties\\. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas\\.\n+ If the source DB instance is in a different region than the read replica, specify the source region in `SourceRegion`, and specify an ARN for a valid DB instance in `SourceDBInstanceIdentifier`\\. For more information, see [ Constructing a Amazon RDS Amazon Resource Name \\(ARN\\)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*\\.\n+ For DB instances in Amazon Aurora clusters, don't specify this property\\. Amazon RDS automatically assigns writer and reader DB instances\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "SourceDbiResourceId": "The resource ID of the source DB instance from which to restore\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "SourceRegion": "The ID of the region that contains the source DB instance for the read replica\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StorageEncrypted": "A value that indicates whether the DB instance is encrypted\\. By default, it isn't encrypted\\. \nIf you specify the `KmsKeyId` property, then you must enable encryption\\. \nIf you specify the `SnapshotIdentifier` or `SourceDBInstanceIdentifier` property, don't specify this property\\. The value is inherited from the snapshot or source DB instance, and if the DB instance is encrypted, the specified `KmsKeyId` property is used\\. \n **Amazon Aurora** \nNot applicable\\. The encryption for DB instances is managed by the DB cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "StorageType": "Specifies the storage type to be associated with the DB instance\\. \n Valid values: `standard | gp2 | io1` \nThe `standard` value is also known as magnetic\\. \n If you specify `io1`, you must also include a value for the `Iops` parameter\\. \n Default: `io1` if the `Iops` parameter is specified, otherwise `standard` \nFor more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*\\. \n **Amazon Aurora** \nNot applicable\\. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives \\(SSDs\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", - "Tags": "Tags to assign to the DB instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StorageEncrypted": "A value that indicates whether the DB instance is encrypted\\. By default, it isn't encrypted\\. \nIf you specify the `KmsKeyId` property, then you must enable encryption\\. \nIf you specify the `SourceDBInstanceIdentifier` property, don't specify this property\\. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified `KmsKeyId` property is used\\. \nIf you specify the `SnapshotIdentifier` and the specified snapshot is encrypted, don't specify this property\\. The value is inherited from the snapshot, and the specified `KmsKeyId` property is used\\. \nIf you specify the `SnapshotIdentifier` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted\\. Specify the `KmsKeyId` property for the KMS key to use for encryption\\. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to `false`\\. \n**Amazon Aurora** \nNot applicable\\. The encryption for DB instances is managed by the DB cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "StorageThroughput": "Specifies the storage throughput value for the DB instance\\. This setting applies only to the `gp3` storage type\\. \nThis setting doesn't apply to RDS Custom or Amazon Aurora\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "StorageType": "Specifies the storage type to be associated with the DB instance\\. \n Valid values: ` gp2 | gp3 | io1 | standard` \nThe `standard` value is also known as magnetic\\. \n If you specify `io1` or `gp3`, you must also include a value for the `Iops` parameter\\. \n Default: `io1` if the `Iops` parameter is specified, otherwise `gp2` \nFor more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*\\. \n **Amazon Aurora** \nNot applicable\\. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives \\(SSDs\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "Tags": "An optional array of key\\-value pairs to apply to this DB instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Timezone": "The time zone of the DB instance\\. The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "UseDefaultProcessorFeatures": "A value that indicates whether the DB instance class of the DB instance uses its default processor features\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UseLatestRestorableTime": "A value that indicates whether the DB instance is restored from the latest backup time\\. By default, the DB instance isn't restored from the latest backup time\\. \nConstraints: Can't be specified if the `RestoreTime` parameter is provided\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "VPCSecurityGroups": "A list of the VPC security group IDs to assign to the DB instance\\. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template\\. \nIf you plan to update the resource, don't specify VPC security groups in a shared VPC\\. \n If you set `VPCSecurityGroups`, you must not set [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa\\. \nYou can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: \n+ You can't revert to using an RDS security group after you establish a VPC security group membership\\.\n+ When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group\\.\n+ To use the properties that are available when you use a VPC security group, you must recreate the DB instance\\. If you don't, AWS CloudFormation submits only the property values that are listed in the [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property\\.\nTo avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template\\. \n **Amazon Aurora** \nNot applicable\\. The associated list of EC2 VPC security groups is managed by the DB cluster\\. If specified, the setting must match the DB cluster setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::RDS::DBInstance CertificateDetails": { + "CAIdentifier": "The CA identifier of the CA certificate used for the DB instance's server certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ValidTill": "The expiration date of the DB instance\u2019s server certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::RDS::DBInstance DBInstanceRole": { "FeatureName": "The name of the feature associated with the AWS Identity and Access Management \\(IAM\\) role\\. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf\\. For the list of supported feature names, see the `SupportedFeatureNames` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The Amazon Resource Name \\(ARN\\) of the IAM role that is associated with the DB instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::RDS::DBInstance Endpoint": { + "Address": "Specifies the DNS address of the DB instance\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HostedZoneId": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Port": "Specifies the port that the database engine is listening on\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RDS::DBInstance MasterUserSecret": { + "KmsKeyId": "The AWS KMS key identifier that is used to encrypt the secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretArn": "The Amazon Resource Name \\(ARN\\) of the secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::RDS::DBInstance ProcessorFeature": { "Name": "The name of the processor feature\\. Valid names are `coreCount` and `threadsPerCore`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Value": "The value of a processor feature name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RDS::DBParameterGroup": { - "Description": "Provides the customer\\-specified description for this DB parameter group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Family": "The DB parameter group family name\\. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family\\. \nThe DB parameter group family can't be changed when updating a DB parameter group\\.\nTo list all of the available parameter group families, use the following command: \n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"` \nThe output contains duplicates\\. \nFor more information, see [`CreateDBParameterGroup`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Parameters": "An array of parameter names and values for the parameter update\\. At least one parameter name and value must be supplied\\. Subsequent arguments are optional\\. \nFor more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*\\. \nFor more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [ Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*\\. \nAWS CloudFormation doesn't support specifying an apply method for each individual parameter\\. The default apply method for each parameter is used\\.\n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "Tags to assign to the DB parameter group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DBParameterGroupName": "The name of the DB parameter group\\. \nConstraints: \n+ Must be 1 to 255 letters, numbers, or hyphens\\.\n+ First character must be a letter\n+ Can't end with a hyphen or contain two consecutive hyphens\nIf you don't specify a value for `DBParameterGroupName` property, a name is automatically created for the DB parameter group\\. \nThis value is stored as a lowercase string\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Description": "Provides the customer\\-specified description for this DB parameter group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Family": "The DB parameter group family name\\. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family\\. \nThe DB parameter group family can't be changed when updating a DB parameter group\\.\nTo list all of the available parameter group families, use the following command: \n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"` \nThe output contains duplicates\\. \nFor more information, see [`CreateDBParameterGroup`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Parameters": "An array of parameter names and values for the parameter update\\. At least one parameter name and value must be supplied\\. Subsequent arguments are optional\\. \nFor more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*\\. \nFor more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [ Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*\\. \nAWS CloudFormation doesn't support specifying an apply method for each individual parameter\\. The default apply method for each parameter is used\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "An optional array of key\\-value pairs to apply to this DB parameter group\\. \nCurrently, this is the only property that supports drift detection\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RDS::DBProxy": { "Auth": "The authorization mechanism that the proxy uses\\. \n*Required*: Yes \n*Type*: List of [AuthFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DBProxyName": "The identifier for the proxy\\. This name must be unique for all proxies owned by your AWS account in the specified AWS Region\\. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DebugLogging": "Whether the proxy includes detailed information about SQL statements in its logs\\. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections\\. The debug information includes the text of SQL statements that you submit through the proxy\\. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EngineFamily": "The kinds of databases that the proxy can connect to\\. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database\\. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora\\. \n*Valid values*: `MYSQL` \\| `POSTGRESQL` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EngineFamily": "The kinds of databases that the proxy can connect to\\. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database\\. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify `MYSQL`\\. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify `POSTGRESQL`\\. For RDS for Microsoft SQL Server, specify `SQLSERVER`\\. \n*Valid values*: `MYSQL` \\| `POSTGRESQL` \\| `SQLSERVER` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "IdleClientTimeout": "The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it\\. You can set this value higher or lower than the connection timeout limit for the associated database\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RequireTLS": "A Boolean parameter that specifies whether Transport Layer Security \\(TLS\\) encryption is required for connections to the proxy\\. By enabling this setting, you can enforce encrypted TLS connections to the proxy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The Amazon Resource Name \\(ARN\\) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19513,10 +22722,10 @@ }, "AWS::RDS::DBProxy AuthFormat": { "AuthScheme": "The type of authentication that the proxy uses for connections from the proxy to the underlying database\\. \nValid Values: `SECRETS` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ClientPasswordAuthType": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A user\\-specified description about the authentication used by a proxy to log in as a specific database user\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IAMAuth": "Whether to require or disallow AWS Identity and Access Management \\(IAM\\) authentication for connections to the proxy\\. \nValid Values: `DISABLED | REQUIRED` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretArn": "The Amazon Resource Name \\(ARN\\) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster\\. These secrets are stored within Amazon Secrets Manager\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UserName": "The name of the database user to which the proxy connects\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "IAMAuth": "Whether to require or disallow AWS Identity and Access Management \\(IAM\\) authentication for connections to the proxy\\. The `ENABLED` value is valid only for proxies with RDS for Microsoft SQL Server\\. \nValid Values: `ENABLED | DISABLED | REQUIRED` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretArn": "The Amazon Resource Name \\(ARN\\) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster\\. These secrets are stored within Amazon Secrets Manager\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RDS::DBProxy TagFormat": { "Key": "A key is the required name of the tag\\. The string value can be 1\\-128 Unicode characters in length and can't be prefixed with `aws:`\\. The string can contain only the set of Unicode letters, digits, white\\-space, '\\_', '\\.', '/', '=', '\\+', '\\-' \\(Java regex: \"^\\(\\[\\\\\\\\p\\{L\\}\\\\\\\\p\\{Z\\}\\\\\\\\p\\{N\\}\\_\\.:/=\\+\\\\\\\\\\-\\]\\*\\)$\"\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19526,7 +22735,6 @@ "DBProxyEndpointName": "The name of the DB proxy endpoint to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DBProxyName": "The name of the DB proxy associated with the DB proxy endpoint that you create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "An optional set of key\\-value pairs to associate arbitrary data of your choosing with the proxy\\. \n*Required*: No \n*Type*: List of [TagFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxyendpoint-tagformat.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TargetRole": "A value that indicates whether the DB proxy endpoint can be used for read/write or read\\-only operations\\. \nValid Values: `READ_WRITE | READ_ONLY` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "VpcSecurityGroupIds": "The VPC security group IDs for the DB proxy endpoint that you create\\. You can specify a different set of security group IDs than for the original DB proxy\\. The default is the default security group for the VPC\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcSubnetIds": "The VPC subnet IDs for the DB proxy endpoint that you create\\. You can specify a different set of subnet IDs than for the original DB proxy\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -19538,47 +22746,49 @@ "ConnectionPoolConfigurationInfo": "Settings that control the size and behavior of the connection pool associated with a `DBProxyTargetGroup`\\. \n*Required*: No \n*Type*: [ConnectionPoolConfigurationInfoFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DBClusterIdentifiers": "One or more DB cluster identifiers\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DBInstanceIdentifiers": "One or more DB instance identifiers\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DBProxyName": "The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DBProxyName": "The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TargetGroupName": "The identifier for the target group\\. \nCurrently, this property must be set to `default`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::RDS::DBProxyTargetGroup ConnectionPoolConfigurationInfoFormat": { "ConnectionBorrowTimeout": "The number of seconds for a proxy to wait for a connection to become available in the connection pool\\. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions\\. \nDefault: 120 \nConstraints: between 1 and 3600, or 0 representing unlimited \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InitQuery": "One or more SQL statements for the proxy to run when opening each new database connection\\. Typically used with `SET` statements to make sure that each connection has identical settings such as time zone and character set\\. For multiple statements, use semicolons as the separator\\. You can also include multiple variables in a single `SET` statement, such as `SET x=1, y=2`\\. \nDefault: no initialization query \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaxConnectionsPercent": "The maximum size of the connection pool for each target in a target group\\. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group\\. \nDefault: 100 \nConstraints: between 1 and 100 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MaxIdleConnectionsPercent": "Controls how actively the proxy closes idle database connections in the connection pool\\. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group\\. With a high value, the proxy leaves a high percentage of idle database connections open\\. A low value causes the proxy to close more idle connections and return them to the database\\. \nDefault: 50 \nConstraints: between 0 and `MaxConnectionsPercent` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxConnectionsPercent": "The maximum size of the connection pool for each target in a target group\\. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group\\. \nIf you specify `MaxIdleConnectionsPercent`, then you must also include a value for this parameter\\. \nDefault: 10 for RDS for Microsoft SQL Server, and 100 for all other engines \nConstraints: Must be between 1 and 100\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MaxIdleConnectionsPercent": "Controls how actively the proxy closes idle database connections in the connection pool\\. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group\\. With a high value, the proxy leaves a high percentage of idle database connections open\\. A low value causes the proxy to close more idle connections and return them to the database\\. \nIf you specify this parameter, then you must also include a value for `MaxConnectionsPercent`\\. \nDefault: The default value is half of the value of `MaxConnectionsPercent`\\. For example, if `MaxConnectionsPercent` is 80, then the default value of `MaxIdleConnectionsPercent` is 40\\. If the value of `MaxConnectionsPercent` isn't specified, then for SQL Server, `MaxIdleConnectionsPercent` is 5, and for all other engines, the default is 50\\. \nConstraints: Must be between 0 and the value of `MaxConnectionsPercent`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SessionPinningFilters": "Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection\\. Including an item in the list exempts that class of SQL operations from the pinning behavior\\. \nDefault: no session pinning filters \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RDS::DBSecurityGroup": { "DBSecurityGroupIngress": "Ingress rules to be applied to the DB security group\\. \n*Required*: Yes \n*Type*: List of [Ingress](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EC2VpcId": "The identifier of an Amazon VPC\\. This property indicates the VPC that this DB security group belongs to\\. \nThe `EC2VpcId` property is for backward compatibility with older regions, and is no longer recommended for providing security information to an RDS DB instance\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "GroupDescription": "Provides the description of the DB security group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "Tags to assign to the DB security group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Tags": "An optional array of key\\-value pairs to apply to this DB security group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RDS::DBSecurityGroup Ingress": { "CIDRIP": "The IP range to authorize\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EC2SecurityGroupId": "Id of the EC2 Security Group to authorize\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "EC2SecurityGroupName": "Name of the EC2 Security Group to authorize\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "EC2SecurityGroupOwnerId": "AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter\\. The AWS Access Key ID is not an acceptable value\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "EC2SecurityGroupId": "Id of the EC2 security group to authorize\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EC2SecurityGroupName": "Name of the EC2 security group to authorize\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EC2SecurityGroupOwnerId": "AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter\\. The AWS access key ID isn't an acceptable value\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::RDS::DBSecurityGroupIngress": { "CIDRIP": "The IP range to authorize\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DBSecurityGroupName": "The name of the DB Security Group to add authorization to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EC2SecurityGroupId": "Id of the EC2 Security Group to authorize\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EC2SecurityGroupName": "Name of the EC2 Security Group to authorize\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EC2SecurityGroupOwnerId": "AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter\\. The AWS Access Key ID is not an acceptable value\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "DBSecurityGroupName": "The name of the DB security group to add authorization to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EC2SecurityGroupId": "Id of the EC2 security group to authorize\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EC2SecurityGroupName": "Name of the EC2 security group to authorize\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EC2SecurityGroupOwnerId": "AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter\\. The AWS access key ID isn't an acceptable value\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RDS::DBSubnetGroup": { - "DBSubnetGroupDescription": "The description for the DB Subnet Group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DBSubnetGroupDescription": "The description for the DB subnet group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DBSubnetGroupName": "The name for the DB subnet group\\. This value is stored as a lowercase string\\. \nConstraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens\\. Must not be \"Default\"\\. \nExample: `mysubnetgroup` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SubnetIds": "The EC2 Subnet IDs for the DB Subnet Group\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "Tags to assign to the DB subnet group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SubnetIds": "The EC2 Subnet IDs for the DB subnet group\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "An optional array of key\\-value pairs to apply to this DB subnet group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RDS::EventSubscription": { - "Enabled": "A Boolean value; set to **true** to activate the subscription, set to **false** to create the subscription but not active it\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "EventCategories": "A list of event categories for a SourceType that you want to subscribe to\\. You can see a list of the categories for a given SourceType in the [Events](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) topic in the Amazon RDS User Guide or by using the **DescribeEventCategories** action\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Enabled": "A value that indicates whether to activate the subscription\\. If the event notification subscription isn't activated, the subscription is created but not active\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventCategories": "A list of event categories for a particular source type \\(`SourceType`\\) that you want to subscribe to\\. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the [https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html)\\. You can also see this list by using the `DescribeEventCategories` operation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SnsTopicArn": "The Amazon Resource Name \\(ARN\\) of the SNS topic created for event notification\\. The ARN is created by Amazon SNS when you create a topic and subscribe to it\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SourceIds": "The list of identifiers of the event sources for which events are returned\\. If not specified, then all sources are included in the response\\. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens\\. It can't end with a hyphen or contain two consecutive hyphens\\. \nConstraints: \n+ If a `SourceIds` value is supplied, `SourceType` must also be provided\\.\n+ If the source type is a DB instance, a `DBInstanceIdentifier` value must be supplied\\.\n+ If the source type is a DB cluster, a `DBClusterIdentifier` value must be supplied\\.\n+ If the source type is a DB parameter group, a `DBParameterGroupName` value must be supplied\\.\n+ If the source type is a DB security group, a `DBSecurityGroupName` value must be supplied\\.\n+ If the source type is a DB snapshot, a `DBSnapshotIdentifier` value must be supplied\\.\n+ If the source type is a DB cluster snapshot, a `DBClusterSnapshotIdentifier` value must be supplied\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SourceType": "The type of source that is generating the events\\. For example, if you want to be notified of events generated by a DB instance, set this parameter to `db-instance`\\. If this value isn't specified, all events are returned\\. \nValid values: `db-instance` \\| `db-cluster` \\| `db-parameter-group` \\| `db-security-group` \\| `db-snapshot` \\| `db-cluster-snapshot` \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)" + "SourceType": "The type of source that is generating the events\\. For example, if you want to be notified of events generated by a DB instance, set this parameter to `db-instance`\\. If this value isn't specified, all events are returned\\. \nValid values: `db-instance` \\| `db-cluster` \\| `db-parameter-group` \\| `db-security-group` \\| `db-snapshot` \\| `db-cluster-snapshot` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SubscriptionName": "The name of the subscription\\. \nConstraints: The name must be less than 255 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "An optional array of key\\-value pairs to apply to this subscription\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RDS::GlobalCluster": { "DeletionProtection": "The deletion protection setting for the new global database\\. The global database can't be deleted when deletion protection is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19589,16 +22799,17 @@ "StorageEncrypted": "The storage encryption setting for the global database cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::RDS::OptionGroup": { - "EngineName": "Specifies the name of the engine that this option group should be associated with\\. \nValid Values: \n+ `mariadb`\n+ `mysql`\n+ `oracle-ee`\n+ `oracle-se2`\n+ `oracle-se1`\n+ `oracle-se`\n+ `postgres`\n+ `sqlserver-ee`\n+ `sqlserver-se`\n+ `sqlserver-ex`\n+ `sqlserver-web`\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EngineName": "Specifies the name of the engine that this option group should be associated with\\. \nValid Values: \n+ `mariadb`\n+ `mysql`\n+ `oracle-ee`\n+ `oracle-ee-cdb`\n+ `oracle-se2`\n+ `oracle-se2-cdb`\n+ `postgres`\n+ `sqlserver-ee`\n+ `sqlserver-se`\n+ `sqlserver-ex`\n+ `sqlserver-web`\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "MajorEngineVersion": "Specifies the major version of the engine that this option group should be associated with\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "OptionConfigurations": "A list of options and the settings for each option\\. \n*Required*: Conditional \n*Type*: List of [OptionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "OptionConfigurations": "A list of options and the settings for each option\\. \n*Required*: Conditional \n*Type*: List of [OptionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OptionGroupDescription": "The description of the option group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "Tags to assign to the option group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "OptionGroupName": "The name of the option group to be created\\. \nConstraints: \n+ Must be 1 to 255 letters, numbers, or hyphens\n+ First character must be a letter\n+ Can't end with a hyphen or contain two consecutive hyphens\nExample: `myoptiongroup` \nIf you don't specify a value for `OptionGroupName` property, a name is automatically created for the option group\\. \nThis value is stored as a lowercase string\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "An optional array of key\\-value pairs to apply to this option group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RDS::OptionGroup OptionConfiguration": { "DBSecurityGroupMemberships": "A list of DBSecurityGroupMembership name strings used for this option\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OptionName": "The configuration of options to include in a group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OptionSettings": "The option settings to include in an option group\\. \n*Required*: No \n*Type*: List of [OptionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations-optionsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OptionSettings": "The option settings to include in an option group\\. \n*Required*: No \n*Type*: List of [OptionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OptionVersion": "The version for the option\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Port": "The optional port for the option\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcSecurityGroupMemberships": "A list of VpcSecurityGroupMembership name strings used for this option\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -19609,6 +22820,7 @@ }, "AWS::RUM::AppMonitor": { "AppMonitorConfiguration": "A structure that contains much of the configuration data for the app monitor\\. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization\\. If you don't include `AppMonitorConfiguration`, you must set up your own authorization method\\. For more information, see [Authorize your application to send data to AWS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html)\\. \nIf you omit this argument, the sample rate used for CloudWatch RUM is set to 10% of the user sessions\\. \n*Required*: No \n*Type*: [AppMonitorConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomEvents": "Specifies whether this app monitor allows the web client to define and send custom events\\. If you omit this parameter, custom events are `DISABLED`\\. \n*Required*: No \n*Type*: [CustomEvents](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-customevents.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CwLogEnabled": "Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted\\. This parameter specifies whether CloudWatch RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account\\. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges\\. \nIf you omit this parameter, the default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Domain": "The top\\-level internet domain name for which your application has administrative authority\\. This parameter is required\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A name for the app monitor\\. This parameter is required\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -19622,12 +22834,29 @@ "GuestRoleArn": "The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IdentityPoolId": "The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludedPages": "If this app monitor is to collect data from only certain pages in your application, this structure lists those pages\\. \nYou can't include both `ExcludedPages` and `IncludedPages` in the same app monitor\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MetricDestinations": "An array of structures that each define a destination that this app monitor will send extended metrics to\\. \n*Required*: No \n*Type*: List of [MetricDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SessionSampleRate": "Specifies the portion of user sessions to use for CloudWatch RUM data collection\\. Choosing a higher portion gives you more data but also incurs more costs\\. \nThe range for this value is 0 to 1 inclusive\\. Setting this to 1 means that 100% of user sessions are sampled, and setting it to 0\\.1 means that 10% of user sessions are sampled\\. \nIf you omit this parameter, the default of 0\\.1 is used, and 10% of sessions will be sampled\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Telemetries": "An array that lists the types of telemetry data that this app monitor is to collect\\. \n+ `errors` indicates that RUM collects data about unhandled JavaScript errors raised by your application\\.\n+ `performance` indicates that RUM collects performance data about how your application and its resources are loaded and rendered\\. This includes Core Web Vitals\\.\n+ `http` indicates that RUM collects data about HTTP errors thrown by your application\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::RUM::AppMonitor CustomEvents": { + "Status": "Set this to `ENABLED` to allow the web client to send custom events for this app monitor\\. \nValid values are `ENABLED` and `DISABLED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RUM::AppMonitor MetricDefinition": { + "DimensionKeys": "This field is a map of field paths to dimension names\\. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is `CloudWatch`\\. If the metric destination is `Evidently`, the value of `DimensionKeys` is ignored\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EventPattern": "The pattern that defines the metric\\. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination\\. \nIf the metrics destination is `CloudWatch` and the event also matches a value in `DimensionKeys`, then the metric is published with the specified dimensions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the metric that is defined in this structure\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UnitLabel": "Use this field only if you are sending this metric to CloudWatch\\. It defines the CloudWatch metric unit that this metric is measured in\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ValueKey": "The field within the event object that the metric value is sourced from\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RUM::AppMonitor MetricDestination": { + "Destination": "Defines the destination to send the metrics to\\. Valid values are `CloudWatch` and `Evidently`\\. If you specify `Evidently`, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DestinationArn": "Use this parameter only if `Destination` is `Evidently`\\. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IamRoleArn": "This parameter is required if `Destination` is `Evidently`\\. If `Destination` is `CloudWatch`, do not use this parameter\\. \nThis parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to\\. This role must have permission to write to that experiment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MetricDefinitions": "An array of structures which define the metrics that you want to send\\. \n*Required*: No \n*Type*: List of [MetricDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Redshift::Cluster": { "AllowVersionUpgrade": "If `true`, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster\\. \nWhen a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster\\. \nDefault: `true` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "AquaConfigurationStatus": "The value represents how the cluster is configured to use AQUA \\(Advanced Query Accelerator\\) when it is created\\. Possible values include the following\\. \n+ enabled \\- Use AQUA if it is available for the current AWS Region and Amazon Redshift node type\\.\n+ disabled \\- Don't use AQUA\\. \n+ auto \\- Amazon Redshift determines whether to use AQUA\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `auto | disabled | enabled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AquaConfigurationStatus": "This parameter is retired\\. It does not set the AQUA configuration status\\. Amazon Redshift automatically determines whether to use AQUA \\(Advanced Query Accelerator\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `auto | disabled | enabled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AutomatedSnapshotRetentionPeriod": "The number of days that automated snapshots are retained\\. If the value is 0, automated snapshots are disabled\\. Even if automated snapshots are disabled, you can still create manual snapshots when you want with [CreateClusterSnapshot](https://docs.aws.amazon.com/redshift/latest/APIReference/API_CreateClusterSnapshot.html) in the *Amazon Redshift API Reference*\\. \nDefault: `1` \nConstraints: Must be a value from 0 to 35\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AvailabilityZone": "The EC2 Availability Zone \\(AZ\\) in which you want Amazon Redshift to provision the cluster\\. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency\\. \nDefault: A random, system\\-chosen Availability Zone in the region that is specified by the endpoint\\. \nExample: `us-east-2d` \nConstraint: The specified Availability Zone must be in the same region as the current endpoint\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AvailabilityZoneRelocation": "The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19640,13 +22869,14 @@ "ClusterType": "The type of the cluster\\. When cluster type is specified as \n+ `single-node`, the **NumberOfNodes** parameter is not required\\.\n+ `multi-node`, the **NumberOfNodes** parameter is required\\.\nValid Values: `multi-node` \\| `single-node` \nDefault: `multi-node` \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ClusterVersion": "The version of the Amazon Redshift engine software that you want to deploy on the cluster\\. \nThe version selected runs on all the nodes in the cluster\\. \nConstraints: Only version 1\\.0 is currently available\\. \nExample: `1.0` \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DBName": "The name of the first database to be created when the cluster is created\\. \nTo create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database\\. For more information, go to [Create a Database](https://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html) in the Amazon Redshift Database Developer Guide\\. \nDefault: `dev` \nConstraints: \n+ Must contain 1 to 64 alphanumeric characters\\.\n+ Must contain only lowercase letters\\.\n+ Cannot be a word that is reserved by the service\\. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DeferMaintenance": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeferMaintenanceDuration": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeferMaintenanceEndTime": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeferMaintenanceStartTime": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeferMaintenance": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeferMaintenanceDuration": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeferMaintenanceEndTime": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeferMaintenanceStartTime": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DestinationRegion": "The destination region that snapshots are automatically copied to when cross\\-region snapshot copy is enabled\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ElasticIp": "The Elastic IP \\(EIP\\) address for the cluster\\. \nConstraints: The cluster must be provisioned in EC2\\-VPC and publicly\\-accessible through an Internet gateway\\. For more information about provisioning clusters in EC2\\-VPC, go to [Supported Platforms to Launch Your Cluster](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms) in the Amazon Redshift Cluster Management Guide\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ElasticIp": "The Elastic IP \\(EIP\\) address for the cluster\\. \nConstraints: The cluster must be provisioned in EC2\\-VPC and publicly\\-accessible through an Internet gateway\\. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on\\. For more information about provisioning clusters in EC2\\-VPC, go to [Supported Platforms to Launch Your Cluster](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms) in the Amazon Redshift Cluster Management Guide\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Encrypted": "If `true`, the data in the cluster is encrypted at rest\\. \nDefault: false \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Endpoint": "The connection endpoint\\. \n*Required*: No \n*Type*: [Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnhancedVpcRouting": "An option that specifies whether to create the cluster with enhanced VPC routing enabled\\. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC\\. For more information, see [Enhanced VPC Routing](https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in the Amazon Redshift Cluster Management Guide\\. \nIf this option is `true`, enhanced VPC routing is enabled\\. \nDefault: false \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HsmClientCertificateIdentifier": "Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HsmConfigurationIdentifier": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19655,22 +22885,22 @@ "LoggingProperties": "Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster\\. \n*Required*: No \n*Type*: [LoggingProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-loggingproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaintenanceTrackName": "An optional parameter for the name of the maintenance track for the cluster\\. If you don't provide a maintenance track name, the cluster is assigned to the `current` track\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ManualSnapshotRetentionPeriod": "The default number of days to retain a manual snapshot\\. If the value is \\-1, the snapshot is retained indefinitely\\. This setting doesn't change the retention period of existing snapshots\\. \nThe value must be either \\-1 or an integer between 1 and 3,653\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MasterUserPassword": "The password associated with the admin user account for the cluster that is being created\\. \nConstraints: \n+ Must be between 8 and 64 characters in length\\.\n+ Must contain at least one uppercase letter\\.\n+ Must contain at least one lowercase letter\\.\n+ Must contain one number\\.\n+ Can be any printable ASCII character \\(ASCII code 33\\-126\\) except ' \\(single quote\\), \" \\(double quote\\), \\\\, /, or @\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MasterUsername": "The user name associated with the admin user account for the cluster that is being created\\. \nConstraints: \n+ Must be 1 \\- 128 alphanumeric characters\\. The user name can't be `PUBLIC`\\.\n+ First character must be a letter\\.\n+ Cannot be a reserved word\\. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MasterUserPassword": "The password associated with the admin user account for the cluster that is being created\\. \nConstraints: \n+ Must be between 8 and 64 characters in length\\.\n+ Must contain at least one uppercase letter\\.\n+ Must contain at least one lowercase letter\\.\n+ Must contain one number\\.\n+ Can be any printable ASCII character \\(ASCII code 33\\-126\\) except `'` \\(single quote\\), `\"` \\(double quote\\), `\\`, `/`, or `@`\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MasterUsername": "The user name associated with the admin user account for the cluster that is being created\\. \nConstraints: \n+ Must be 1 \\- 128 alphanumeric characters or hyphens\\. The user name can't be `PUBLIC`\\.\n+ Must contain only lowercase letters, numbers, underscore, plus sign, period \\(dot\\), at symbol \\(@\\), or hyphen\\.\n+ The first character must be a letter\\.\n+ Must not contain a colon \\(:\\) or a slash \\(/\\)\\.\n+ Cannot be a reserved word\\. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "NodeType": "The node type to be provisioned for the cluster\\. For information about node types, go to [ Working with Clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) in the *Amazon Redshift Cluster Management Guide*\\. \nValid Values: `ds2.xlarge` \\| `ds2.8xlarge` \\| `dc1.large` \\| `dc1.8xlarge` \\| `dc2.large` \\| `dc2.8xlarge` \\| `ra3.xlplus` \\| `ra3.4xlarge` \\| `ra3.16xlarge` \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NumberOfNodes": "The number of compute nodes in the cluster\\. This parameter is required when the **ClusterType** parameter is specified as `multi-node`\\. \nFor information about determining how many nodes you need, go to [ Working with Clusters](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes) in the *Amazon Redshift Cluster Management Guide*\\. \nIf you don't specify this parameter, you get a single\\-node cluster\\. When requesting a multi\\-node cluster, you must specify the number of nodes that you want in the cluster\\. \nDefault: `1` \nConstraints: Value must be at least 1 and no more than 100\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OwnerAccount": "The AWS account used to create or copy the snapshot\\. Required if you are restoring a snapshot you do not own, optional if you own the snapshot\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Port": "The port number on which the cluster accepts incoming connections\\. \nThe cluster is accessible only via the JDBC and ODBC connection strings\\. Part of the connection string requires the port on which the cluster will listen for incoming connections\\. \nDefault: `5439` \nValid Values: `1150-65535` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PreferredMaintenanceWindow": "The weekly time range \\(in UTC\\) during which automated cluster maintenance can occur\\. \n Format: `ddd:hh24:mi-ddd:hh24:mi` \n Default: A 30\\-minute window selected at random from an 8\\-hour block of time per region, occurring on a random day of the week\\. For more information about the time blocks for each region, see [Maintenance Windows](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows) in Amazon Redshift Cluster Management Guide\\. \nValid Days: Mon \\| Tue \\| Wed \\| Thu \\| Fri \\| Sat \\| Sun \nConstraints: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PubliclyAccessible": "If `true`, the cluster can be accessed from a public network\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResourceAction": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RevisionTarget": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RotateEncryptionKey": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceAction": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RevisionTarget": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RotateEncryptionKey": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SnapshotClusterIdentifier": "The name of the cluster the source snapshot was created from\\. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than \\* for the cluster name\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SnapshotCopyGrantName": "The name of the snapshot copy grant\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SnapshotCopyManual": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SnapshotCopyRetentionPeriod": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SnapshotIdentifier": "The name of the snapshot from which to create the new cluster\\. This parameter isn't case sensitive\\. \nExample: `my-snapshot-id` \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SnapshotCopyManual": "Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SnapshotCopyRetentionPeriod": "The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region\\. \nBy default, this only changes the retention period of copied automated snapshots\\. \nIf you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period\\. \nConstraints: Must be at least 1 and no more than 35 for automated snapshots\\. \nIf you specify the `manual` option, only newly copied manual snapshots will have the new retention period\\. \nIf you specify the value of \\-1 newly copied manual snapshots are retained indefinitely\\. \nConstraints: The number of days must be either \\-1 or an integer between 1 and 3,653 for manual snapshots\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SnapshotIdentifier": "The name of the snapshot from which to create the new cluster\\. This parameter isn't case sensitive\\. You must specify this parameter or `snapshotArn`, but not both\\. \nExample: `my-snapshot-id` \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "A list of tag instances\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcSecurityGroupIds": "A list of Virtual Private Cloud \\(VPC\\) security groups to be associated with the cluster\\. \nDefault: The default VPC security group is associated with the cluster\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -19685,7 +22915,7 @@ "AWS::Redshift::ClusterParameterGroup": { "Description": "The description of the parameter group\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ParameterGroupFamily": "The name of the cluster parameter group family that this cluster parameter group is compatible with\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Parameters": "An array of parameters to be modified\\. A maximum of 20 parameters can be modified in a single request\\. \nFor each parameter to be modified, you must supply at least the parameter name and parameter value; other name\\-value pairs of the parameter are optional\\. \nFor the workload management \\(WLM\\) configuration, you must supply all the name\\-value pairs in the wlm\\_json\\_configuration parameter\\. \n*Required*: No \n*Type*: List of [Parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-property-redshift-clusterparametergroup-parameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Parameters": "An array of parameters to be modified\\. A maximum of 20 parameters can be modified in a single request\\. \nFor each parameter to be modified, you must supply at least the parameter name and parameter value; other name\\-value pairs of the parameter are optional\\. \nFor the workload management \\(WLM\\) configuration, you must supply all the name\\-value pairs in the wlm\\_json\\_configuration parameter\\. \n*Required*: No \n*Type*: List of [Parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-clusterparametergroup-parameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The list of tags for the cluster parameter group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Redshift::ClusterParameterGroup Parameter": { @@ -19708,18 +22938,29 @@ "Tags": "Specifies an arbitrary set of tags \\(key\u2013value pairs\\) to associate with this subnet group\\. Use tags to manage your resources\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Redshift::EndpointAccess": { - "ClusterIdentifier": "The cluster identifier of the cluster associated with the endpoint\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ClusterIdentifier": "The cluster identifier of the cluster associated with the endpoint\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EndpointName": "The name of the endpoint\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ResourceOwner": "The AWS account ID of the owner of the cluster\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "SubnetGroupName": "The subnet group name where Amazon Redshift chooses to deploy the endpoint\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SubnetGroupName": "The subnet group name where Amazon Redshift chooses to deploy the endpoint\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "VpcSecurityGroupIds": "The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Redshift::EndpointAccess NetworkInterface": { + "AvailabilityZone": "The Availability Zone\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NetworkInterfaceId": "The network interface identifier\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PrivateIpAddress": "The IPv4 address of the network interface within the subnet\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SubnetId": "The subnet identifier\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Redshift::EndpointAccess VpcEndpoint": { + "NetworkInterfaces": "One or more network interfaces of the endpoint\\. Also known as an interface endpoint\\. \n*Required*: No \n*Type*: List of [NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-networkinterface.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcEndpointId": "The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcId": "The VPC identifier that the endpoint is associated\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Redshift::EndpointAccess VpcSecurityGroup": { "Status": "The status of the endpoint\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcSecurityGroupId": "The identifier of the VPC security group\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Redshift::EndpointAuthorization": { - "Account": "The AAWS account ID of either the cluster owner \\(grantor\\) or grantee\\. If `Grantee` parameter is true, then the `Account` value is of the grantor\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Account": "The AWS account ID of either the cluster owner \\(grantor\\) or grantee\\. If `Grantee` parameter is true, then the `Account` value is of the grantor\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ClusterIdentifier": "The cluster identifier\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Force": "Indicates whether to force the revoke action\\. If true, the Redshift\\-managed VPC endpoints associated with the endpoint authorization are also deleted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VpcIds": "The virtual private cloud \\(VPC\\) identifiers to grant access to\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -19775,11 +23016,25 @@ "NamespaceName": "The name of the namespace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The map of the key\\-value pairs used to tag the namespace\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::RedshiftServerless::Namespace Namespace": { + "AdminUsername": "The username of the administrator for the first database created in the namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CreationDate": "The date of when the namespace was created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DbName": "The name of the first database created in the namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefaultIamRoleArn": "The Amazon Resource Name \\(ARN\\) of the IAM role to set as a default in the namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IamRoles": "A list of IAM roles to associate with the namespace\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsKeyId": "The ID of the AWS Key Management Service key used to encrypt your data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LogExports": "The types of logs the namespace can export\\. Available export types are User log, Connection log, and User activity log\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NamespaceArn": "The Amazon Resource Name \\(ARN\\) associated with a namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NamespaceId": "The unique identifier of a namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NamespaceName": "The name of the namespace\\. Must be between 3\\-64 alphanumeric characters in lowercase, and it cannot be a reserved word\\. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "The status of the namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::RedshiftServerless::Workgroup": { "BaseCapacity": "The base compute capacity of the workgroup in Redshift Processing Units \\(RPUs\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ConfigParameters": "A list of parameters to set for finer control over a database\\. Available options are `datestyle`, `enable_user_activity_logging`, `query_group`, `search_path`, and `max_query_execution_time`\\. \n*Required*: No \n*Type*: List of [ConfigParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-configparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnhancedVpcRouting": "The value that specifies whether to enable enhanced virtual private cloud \\(VPC\\) routing, which forces Amazon Redshift Serverless to route traffic through your VPC\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NamespaceName": "The namespace the workgroup is associated with\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Port": "The custom port to use when connecting to a workgroup\\. Valid port ranges are 5431\\-5455 and 8191\\-8215\\. The default is 5439\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PubliclyAccessible": "A value that specifies whether the workgroup can be accessible from a public network\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityGroupIds": "A list of security group IDs to associate with the workgroup\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SubnetIds": "A list of subnet IDs the workgroup is associated with\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19790,6 +23045,37 @@ "ParameterKey": "The key of the parameter\\. The options are `datestyle`, `enable_user_activity_logging`, `query_group`, `search_path`, and `max_query_execution_time`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ParameterValue": "The value of the parameter to set\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::RedshiftServerless::Workgroup Endpoint": { + "Address": "The DNS address of the VPC endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Port": "The port that Amazon Redshift Serverless listens on\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcEndpoints": "An array of `VpcEndpoint` objects\\. \n*Required*: No \n*Type*: List of [VpcEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-vpcendpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RedshiftServerless::Workgroup NetworkInterface": { + "AvailabilityZone": "The availability Zone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NetworkInterfaceId": "The unique identifier of the network interface\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PrivateIpAddress": "The IPv4 address of the network interface within the subnet\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SubnetId": "The unique identifier of the subnet\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RedshiftServerless::Workgroup VpcEndpoint": { + "NetworkInterfaces": "One or more network interfaces of the endpoint\\. Also known as an interface endpoint\\. \n*Required*: No \n*Type*: List of [NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-networkinterface.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcEndpointId": "The connection endpoint ID for connecting to Amazon Redshift Serverless\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VpcId": "The VPC identifier that the endpoint is associated with\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RedshiftServerless::Workgroup Workgroup": { + "BaseCapacity": "The base data warehouse capacity of the workgroup in Redshift Processing Units \\(RPUs\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConfigParameters": "An array of parameters to set for advanced control over a database\\. The options are `auto_mv`, `datestyle`, `enable_case_sensitivity_identifier`, `enable_user_activity_logging`, `query_group`, , `search_path`, and query monitoring metrics that let you define performance boundaries\\. For more information about query monitoring rules and available metrics, see [ Query monitoring metrics for Amazon Redshift Serverless](https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless)\\. \n*Required*: No \n*Type*: List of [ConfigParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-configparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CreationDate": "The creation date of the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Endpoint": "The endpoint that is created from the workgroup\\. \n*Required*: No \n*Type*: [Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-endpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnhancedVpcRouting": "The value that specifies whether to enable enhanced virtual private cloud \\(VPC\\) routing, which forces Amazon Redshift Serverless to route traffic through your VPC\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NamespaceName": "The namespace the workgroup is associated with\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PubliclyAccessible": "A value that specifies whether the workgroup can be accessible from a public network \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecurityGroupIds": "An array of security group IDs to associate with the workgroup\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Status": "The status of the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SubnetIds": "An array of subnet IDs the workgroup is associated with\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WorkgroupArn": "The Amazon Resource Name \\(ARN\\) that links to the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WorkgroupId": "The unique identifier of the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "WorkgroupName": "The name of the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::RefactorSpaces::Application": { "ApiGatewayProxy": "The endpoint URL of the Amazon API Gateway proxy\\. \n*Required*: No \n*Type*: [ApiGatewayProxyInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-application-apigatewayproxyinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EnvironmentIdentifier": "The unique identifier of the environment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -19810,14 +23096,18 @@ }, "AWS::RefactorSpaces::Route": { "ApplicationIdentifier": "The unique identifier of the application\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DefaultRoute": "Configuration for the default route type\\. \n*Required*: No \n*Type*: [DefaultRouteInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-defaultrouteinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EnvironmentIdentifier": "The unique identifier of the environment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RouteType": "The route type of the route\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ServiceIdentifier": "The unique identifier of the service\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The tags assigned to the route\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UriPathRoute": "The configuration for the URI path route type\\. \n*Required*: No \n*Type*: [UriPathRouteInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "UriPathRoute": "The configuration for the URI path route type\\. \n*Required*: No \n*Type*: [UriPathRouteInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RefactorSpaces::Route DefaultRouteInput": { + "ActivationState": "If set to `ACTIVE`, traffic is forwarded to this route\u2019s service after the route is created\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RefactorSpaces::Route UriPathRouteInput": { - "ActivationState": "Indicates whether traffic is forwarded to this route\u2019s service after the route is created\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ActivationState": "If set to `ACTIVE`, traffic is forwarded to this route\u2019s service after the route is created\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncludeChildPaths": "Indicates whether to match all subpaths of the given source path\\. If this value is `false`, requests must match the source path exactly before they are forwarded to this route's service\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Methods": "A list of HTTP methods to match\\. An empty list matches all values\\. If a method is present, only HTTP requests using that method are forwarded to this route\u2019s service\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SourcePath": "The path to use to match traffic\\. Paths must start with `/` and are relative to the base of the application\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" @@ -19834,7 +23124,7 @@ "VpcId": "The ID of the virtual private cloud \\(VPC\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::RefactorSpaces::Service LambdaEndpointInput": { - "Arn": "The Amazon Resource Name \\(ARN\\) of the Lambda endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Arn": "The Amazon Resource Name \\(ARN\\) of the Lambda function or alias\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::RefactorSpaces::Service UrlEndpointInput": { "HealthUrl": "The health check URL of the URL endpoint type\\. If the URL is a public endpoint, the `HealthUrl` must also be a public endpoint\\. If the URL is a private endpoint inside a virtual private cloud \\(VPC\\), the health URL must also be a private endpoint, and the host must be the same as the URL\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -19847,7 +23137,53 @@ "AWS::Rekognition::Project": { "ProjectName": "The name of the project to create\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::Rekognition::StreamProcessor": { + "BoundingBoxRegionsOfInterest": "List of BoundingBox objects, each of which denotes a region of interest on screen\\. For more information, see the BoundingBox field of [RegionOfInterest](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RegionOfInterest)\\. \n*Required*: No \n*Type*: List of [BoundingBox](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-boundingbox.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ConnectedHomeSettings": "Connected home settings to use on a streaming video\\. You can use a stream processor for connected home features and select what you want the stream processor to detect, such as people or pets\\. When the stream processor has started, one notification is sent for each object class specified\\. For more information, see the ConnectedHome section of [StreamProcessorSettings](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorSettings)\\. \n*Required*: No \n*Type*: [ConnectedHomeSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-connectedhomesettings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DataSharingPreference": "Allows you to opt in or opt out to share data with Rekognition to improve model performance\\. You can choose this option at the account level or on a per\\-stream basis\\. Note that if you opt out at the account level this setting is ignored on individual streams\\. For more information, see [StreamProcessorDataSharingPreference](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorDataSharingPreference)\\. \n*Required*: No \n*Type*: [DataSharingPreference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-datasharingpreference.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FaceSearchSettings": "The input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor\\. For more information regarding the contents of the parameters, see [FaceSearchSettings](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_FaceSearchSettings)\\. \n*Required*: No \n*Type*: [FaceSearchSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-facesearchsettings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "KinesisDataStream": "Amazon Rekognition's Video Stream Processor takes a Kinesis video stream as input\\. This is the Amazon Kinesis Data Streams instance to which the Amazon Rekognition stream processor streams the analysis results\\. This must be created within the constraints specified at [KinesisDataStream](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_KinesisDataStream)\\. \n*Required*: No \n*Type*: [KinesisDataStream](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-kinesisdatastream.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "KinesisVideoStream": "The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor\\. For more information, see [KinesisVideoStream](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_KinesisVideoStream)\\. \n*Required*: Yes \n*Type*: [KinesisVideoStream](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-kinesisvideostream.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "KmsKeyId": "The identifier for your Amazon Key Management Service key \\(Amazon KMS key\\)\\. Optional parameter for connected home stream processors used to encrypt results and data published to your Amazon S3 bucket\\. For more information, see the KMSKeyId section of [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The Name attribute specifies the name of the stream processor and it must be within the constraints described in the Name section of [StreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessor)\\. If you don't specify a name, Amazon CloudFormation generates a unique ID and uses that ID for the stream processor name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[a-zA-Z0-9_.\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "NotificationChannel": "The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation\\. Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream\\. Amazon Rekognition also publishes an end\\-of\\-session notification with a summary when the stream processing session is complete\\. For more information, see [StreamProcessorNotificationChannel](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorNotificationChannel)\\. \n*Required*: No \n*Type*: [NotificationChannel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-notificationchannel.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PolygonRegionsOfInterest": "A set of ordered lists of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects\\. Each entry of the set contains a polygon denoting a region of interest on the screen\\. Each polygon is an ordered list of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects\\. For more information, see the Polygon field of [RegionOfInterest](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RegionOfInterest)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RoleArn": "The ARN of the IAM role that allows access to the stream processor\\. The IAM role provides Rekognition read permissions to the Kinesis stream\\. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a connected home stream processor\\. This is required for both face search and connected home stream processors\\. For information about constraints, see the RoleArn section of [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "S3Destination": "The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation\\. For more information, see the S3Destination section of [StreamProcessorOutput](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorOutput)\\. \n*Required*: No \n*Type*: [S3Destination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-s3destination.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "A set of tags \\(key\\-value pairs\\) that you want to attach to the stream processor\\. For more information, see the Tags section of [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Rekognition::StreamProcessor BoundingBox": { + "Height": "Height of the bounding box as a ratio of the overall image height\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Left": "Left coordinate of the bounding box as a ratio of overall image width\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Top": "Top coordinate of the bounding box as a ratio of overall image height\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Width": "Width of the bounding box as a ratio of the overall image width\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Rekognition::StreamProcessor ConnectedHomeSettings": { + "Labels": "Specifies what you want to detect in the video, such as people, packages, or pets\\. The current valid labels you can include in this list are: \"PERSON\", \"PET\", \"PACKAGE\", and \"ALL\"\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MinConfidence": "The minimum confidence required to label an object in the video\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Rekognition::StreamProcessor DataSharingPreference": { + "OptIn": "Describes the opt\\-in status applied to a stream processor's data sharing policy\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Rekognition::StreamProcessor FaceSearchSettings": { + "CollectionId": "The ID of a collection that contains faces that you want to search for\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FaceMatchThreshold": "Minimum face match confidence score that must be met to return a result for a recognized face\\. The default is 80\\. 0 is the lowest confidence\\. 100 is the highest confidence\\. Values between 0 and 100 are accepted, and values lower than 80 are set to 80\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Rekognition::StreamProcessor KinesisDataStream": { + "Arn": "ARN of the output Amazon Kinesis Data Streams stream\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `(^arn:([a-z\\d-]+):kinesis:([a-z\\d-]+):\\d{12}:.+$)` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Rekognition::StreamProcessor KinesisVideoStream": { + "Arn": "ARN of the Kinesis video stream stream that streams the source video\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `(^arn:([a-z\\d-]+):kinesisvideo:([a-z\\d-]+):\\d{12}:.+$)` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Rekognition::StreamProcessor NotificationChannel": { + "Arn": "The ARN of the SNS topic that receives notifications\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Rekognition::StreamProcessor S3Destination": { + "BucketName": "Describes the destination Amazon Simple Storage Service \\(Amazon S3\\) bucket name of a stream processor's exports\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ObjectKeyPrefix": "Describes the destination Amazon Simple Storage Service \\(Amazon S3\\) object keys of a stream processor's exports\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::ResilienceHub::App": { + "AppAssessmentSchedule": "Assessment execution schedule with 'Daily' or 'Disabled' values\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "AppTemplateBody": "A string containing a full Resilience Hub app template body\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "The optional description for an app\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name for the application\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -19863,9 +23199,10 @@ }, "AWS::ResilienceHub::App ResourceMapping": { "LogicalStackName": "The name of the CloudFormation stack this resource is mapped to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MappingType": "Specifies the type of resource mapping\\. \nAppRegistryApp \nThe resource is mapped to another application\\. The name of the application is contained in the `appRegistryAppName` property\\. \nCfnStack \nThe resource is mapped to a CloudFormation stack\\. The name of the CloudFormation stack is contained in the `logicalStackName` property\\. \nResource \nThe resource is mapped to another resource\\. The name of the resource is contained in the `resourceName` property\\. \nResourceGroup \nThe resource is mapped to a resource group\\. The name of the resource group is contained in the `resourceGroupName` property\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MappingType": "Specifies the type of resource mapping\\. \nValid Values: CfnStack \\| Resource \\| AppRegistryApp \\| ResourceGroup \\| Terraform \nAppRegistryApp \nThe resource is mapped to another application\\. The name of the application is contained in the `appRegistryAppName` property\\. \nCfnStack \nThe resource is mapped to a CloudFormation stack\\. The name of the CloudFormation stack is contained in the `logicalStackName` property\\. \nResource \nThe resource is mapped to another resource\\. The name of the resource is contained in the `resourceName` property\\. \nResourceGroup \nThe resource is mapped to a resource group\\. The name of the resource group is contained in the `resourceGroupName` property\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PhysicalResourceId": "The identifier of this resource\\. \n*Required*: Yes \n*Type*: [PhysicalResourceId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resiliencehub-app-physicalresourceid.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResourceName": "The name of the resource this resource is mapped to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ResourceName": "The name of the resource this resource is mapped to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TerraformSourceName": "The short name of the Terraform source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ResilienceHub::ResiliencyPolicy": { "DataLocationConstraint": "Specifies a high\\-level geographical location constraint for where your resilience policy data can be stored\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19879,6 +23216,25 @@ "RpoInSecs": "The Recovery Point Objective \\(RPO\\), in seconds\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RtoInSecs": "The Recovery Time Objective \\(RTO\\), in seconds\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::ResourceExplorer2::DefaultViewAssociation": { + "ViewArn": "The ARN of the view to set as the default for the AWS Region and AWS account in which you call this operation\\. The specified view must already exist in the specified Region\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ResourceExplorer2::Index": { + "Tags": "The specified tags are attached to only the index created in this AWS Region\\. The tags don't attach to any of the resources listed in the index\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "Specifies the type of the index in this Region\\. For information about the aggregator index and how it differs from a local index, see [Turning on cross\\-Region search by creating an aggregator index](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) in the *AWS Resource Explorer User Guide\\.*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AGGREGATOR | LOCAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ResourceExplorer2::View": { + "Filters": "An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view\\. When you use this view in a [Search](https://docs.aws.amazon.com/resource-explorer/latest/APIReference/API_Search.html) operation, the filter string is combined with the search's `QueryString` parameter using a logical `AND` operator\\. \nFor information about the supported syntax, see [Search query reference for Resource Explorer](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) in the *AWS Resource Explorer User Guide*\\. \nThis query string in the context of this operation supports only [filter prefixes](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) with optional [operators](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators)\\. It doesn't support free\\-form text\\. For example, the string `region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any AWS Region that begin with the letters `us` and are *not* tagged with a key `Stage` that has the value `prod`\\.\n*Required*: No \n*Type*: [Filters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-filters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludedProperties": "A list of fields that provide additional information about the view\\. \n*Required*: No \n*Type*: List of [IncludedProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-includedproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Tag key and value pairs that are attached to the view\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ViewName": "The name of the new view\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9\\-]{1,64}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::ResourceExplorer2::View Filters": { + "FilterString": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::ResourceExplorer2::View IncludedProperty": { + "Name": "The name of the property that is included in this view\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::ResourceGroups::Group": { "Configuration": "The service configuration currently associated with the resource group and in effect for the members of the resource group\\. A `Configuration` consists of one or more `ConfigurationItem` entries\\. For information about service configurations for resource groups and how to construct them, see [Service configurations for resource groups](https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html) in the *AWS Resource Groups User Guide*\\. \nYou can include either a `Configuration` or a `ResourceQuery`, but not both\\.\n*Required*: Conditional \n*Type*: List of [ConfigurationItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourcegroups-group-configurationitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "The description of the resource group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19923,13 +23279,13 @@ "CurrentRevisionId": "The current revision id\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Environment": "The environment of the robot application\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the robot application\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_\\-]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "RobotSoftwareSuite": "The robot software suite \\(ROS distribuition\\) used by the robot application\\. \n*Required*: Yes \n*Type*: [RobotSoftwareSuite](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RobotSoftwareSuite": "The robot software suite used by the robot application\\. \n*Required*: Yes \n*Type*: [RobotSoftwareSuite](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Sources": "The sources of the robot application\\. \n*Required*: No \n*Type*: List of [SourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-sourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A map that contains tag keys and tag values that are attached to the robot application\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RoboMaker::RobotApplication RobotSoftwareSuite": { - "Name": "The name of the robot software suite \\(ROS distribution\\)\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `General | ROS | ROS2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Version": "The version of the robot software suite \\(ROS distribution\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Dashing | Foxy | Kinetic | Melodic` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "The name of the robot software suite\\. `General` is the only supported value\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `General | ROS | ROS2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Version": "The version of the robot software suite\\. Not applicable for General software suite\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Dashing | Foxy | Kinetic | Melodic` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RoboMaker::RobotApplication SourceConfig": { "Architecture": "The target processor architecture for the application\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ARM64 | ARMHF | X86_64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19945,7 +23301,7 @@ "Environment": "The environment of the simulation application\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the simulation application\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_\\-]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RenderingEngine": "The rendering engine for the simulation application\\. \n*Required*: No \n*Type*: [RenderingEngine](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-renderingengine.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RobotSoftwareSuite": "The robot software suite \\(ROS distribution\\) used by the simulation application\\. \n*Required*: Yes \n*Type*: [RobotSoftwareSuite](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RobotSoftwareSuite": "The robot software suite used by the simulation application\\. \n*Required*: Yes \n*Type*: [RobotSoftwareSuite](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SimulationSoftwareSuite": "The simulation software suite used by the simulation application\\. \n*Required*: Yes \n*Type*: [SimulationSoftwareSuite](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-simulationsoftwaresuite.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Sources": "The sources of the simulation application\\. \n*Required*: No \n*Type*: List of [SourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-sourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A map that contains tag keys and tag values that are attached to the simulation application\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -19955,12 +23311,12 @@ "Version": "The version of the rendering engine\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4` \n*Pattern*: `1.x` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RoboMaker::SimulationApplication RobotSoftwareSuite": { - "Name": "The name of the robot software suite \\(ROS distribution\\)\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `General | ROS | ROS2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Version": "The version of the robot software suite \\(ROS distribution\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Dashing | Foxy | Kinetic | Melodic` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "The name of the robot software suite\\. `General` is the only supported value\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `General | ROS | ROS2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Version": "The version of the robot software suite\\. Not applicable for General software suite\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Dashing | Foxy | Kinetic | Melodic` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RoboMaker::SimulationApplication SimulationSoftwareSuite": { - "Name": "The name of the simulation software suite\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Gazebo | RosbagPlay | SimulationRuntime` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Version": "The version of the simulation software suite\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Pattern*: `7|9|11|Kinetic|Melodic|Dashing|Foxy` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "The name of the simulation software suite\\. `SimulationRuntime` is the only supported value\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Gazebo | RosbagPlay | SimulationRuntime` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Version": "The version of the simulation software suite\\. Not applicable for `SimulationRuntime`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Pattern*: `7|9|11|Kinetic|Melodic|Dashing|Foxy` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::RoboMaker::SimulationApplication SourceConfig": { "Architecture": "The target processor architecture for the application\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ARM64 | ARMHF | X86_64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -19971,13 +23327,75 @@ "Application": "The application information for the simulation application\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1224` \n*Pattern*: `arn:.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "CurrentRevisionId": "The current revision id for the simulation application\\. If you provide a value and it matches the latest revision ID, a new version will be created\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `40` \n*Pattern*: `[a-zA-Z0-9_.\\-]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::RolesAnywhere::CRL": { + "CrlData": "The revocation record for a certificate, following the x509 v3 standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Enabled": "Indicates whether the certificate revocation list \\(CRL\\) is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the certificate revocation list \\(CRL\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "A list of tags to attach to the CRL\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TrustAnchorArn": "The ARN of the TrustAnchor the certificate revocation list \\(CRL\\) will provide revocation for\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RolesAnywhere::Profile": { + "DurationSeconds": "Sets the maximum number of seconds that vended temporary credentials through [CreateSession](https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html) will be valid for, between 900 and 3600\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Enabled": "Indicates whether the profile is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ManagedPolicyArns": "A list of managed policy ARNs that apply to the vended session credentials\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the profile\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[ a-zA-Z0-9-_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RequireInstanceProperties": "Specifies whether instance properties are required in temporary credential requests with this profile\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoleArns": "A list of IAM role ARNs\\. During `CreateSession`, if a matching role ARN is provided, the properties in this profile will be applied to the intersection session policy\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SessionPolicy": "A session policy that applies to the trust boundary of the vended session credentials\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "A list of tags to attach to the profile\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RolesAnywhere::TrustAnchor": { + "Enabled": "Indicates whether the trust anchor is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the trust anchor\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[ a-zA-Z0-9-_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Source": "The trust anchor type and its related certificate data\\. \n*Required*: Yes \n*Type*: [Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-source.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "A list of tags to attach to the trust anchor\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RolesAnywhere::TrustAnchor Source": { + "SourceData": "The data field of the trust anchor depending on its type\\. \n*Required*: No \n*Type*: [SourceData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-sourcedata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SourceType": "The type of the trust anchor\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AWS_ACM_PCA | CERTIFICATE_BUNDLE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::RolesAnywhere::TrustAnchor SourceData": { + "AcmPcaArn": "The root certificate of the AWS Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests\\. Included for trust anchors of type `AWS_ACM_PCA`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "X509CertificateData": "The PEM\\-encoded data for the certificate anchor\\. Included for trust anchors of type `CERTIFICATE_BUNDLE`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Route53::CidrCollection": { + "Locations": "A complex type that contains information about the list of CIDR locations\\. \n*Required*: No \n*Type*: List of [Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrcollection-location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of a CIDR collection\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[0-9A-Za-z_\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Route53::CidrCollection Location": { + "CidrList": "List of CIDR blocks\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LocationName": "The CIDR collection location name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16` \n*Pattern*: `[0-9A-Za-z_\\-\\*]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Route53::DNSSEC": { "HostedZoneId": "A unique string \\(ID\\) that is used to identify a hosted zone\\. For example: `Z00001111A1ABCaaABC11`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Route53::HealthCheck": { - "HealthCheckConfig": "A complex type that contains detailed information about one health check\\. \nFor the values to enter for `HealthCheckConfig`, see [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html) \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HealthCheckConfig": "A complex type that contains detailed information about one health check\\. \nFor the values to enter for `HealthCheckConfig`, see [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html) \n*Required*: Yes \n*Type*: [HealthCheckConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HealthCheckTags": "The `HealthCheckTags` property describes key\\-value pairs that are associated with an `AWS::Route53::HealthCheck` resource\\. \n*Required*: No \n*Type*: List of [HealthCheckTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthchecktag.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Route53::HealthCheck AlarmIdentifier": { + "Name": "The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy\\. \nRoute 53 supports CloudWatch alarms with the following features: \n+ Standard\\-resolution metrics\\. High\\-resolution metrics aren't supported\\. For more information, see [High\\-Resolution Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics) in the *Amazon CloudWatch User Guide*\\.\n+ Statistics: Average, Minimum, Maximum, Sum, and SampleCount\\. Extended statistics aren't supported\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Region": "For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in\\. \nFor the current list of CloudWatch regions, see [Amazon CloudWatch endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/cw_region.html) in the *Amazon Web Services General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-gov-east-1 | us-gov-west-1 | us-iso-east-1 | us-iso-west-1 | us-isob-east-1 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Route53::HealthCheck HealthCheckConfig": { + "AlarmIdentifier": "A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy\\. \n*Required*: No \n*Type*: [AlarmIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ChildHealthChecks": "\\(CALCULATED Health Checks Only\\) A complex type that contains one `ChildHealthCheck` element for each health check that you want to associate with a `CALCULATED` health check\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EnableSNI": "Specify whether you want Amazon Route 53 to send the value of `FullyQualifiedDomainName` to the endpoint in the `client_hello` message during TLS negotiation\\. This allows the endpoint to respond to `HTTPS` health check requests with the applicable SSL/TLS certificate\\. \nSome endpoints require that `HTTPS` requests include the host name in the `client_hello` message\\. If you don't enable SNI, the status of the health check will be `SSL alert handshake_failure`\\. A health check can also have that status for other reasons\\. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid\\. \nThe SSL/TLS certificate on your endpoint includes a domain name in the `Common Name` field and possibly several more in the `Subject Alternative Names` field\\. One of the domain names in the certificate should match the value that you specify for `FullyQualifiedDomainName`\\. If the endpoint responds to the `client_hello` message with a certificate that does not include the domain name that you specified in `FullyQualifiedDomainName`, a health checker will retry the handshake\\. In the second attempt, the health checker will omit `FullyQualifiedDomainName` from the `client_hello` message\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FailureThreshold": "The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa\\. For more information, see [How Amazon Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) in the *Amazon Route 53 Developer Guide*\\. \nIf you don't specify a value for `FailureThreshold`, the default value is three health checks\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FullyQualifiedDomainName": "Amazon Route 53 behavior depends on whether you specify a value for `IPAddress`\\. \n **If you specify a value for** `IPAddress`: \nAmazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of `FullyQualifiedDomainName` in the `Host` header for all health checks except TCP health checks\\. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks\\. \nWhen Route 53 checks the health of an endpoint, here is how it constructs the `Host` header: \n+ If you specify a value of `80` for `Port` and `HTTP` or `HTTP_STR_MATCH` for `Type`, Route 53 passes the value of `FullyQualifiedDomainName` to the endpoint in the Host header\\. \n+ If you specify a value of `443` for `Port` and `HTTPS` or `HTTPS_STR_MATCH` for `Type`, Route 53 passes the value of `FullyQualifiedDomainName` to the endpoint in the `Host` header\\.\n+ If you specify another value for `Port` and any value except `TCP` for `Type`, Route 53 passes `FullyQualifiedDomainName:Port` to the endpoint in the `Host` header\\.\nIf you don't specify a value for `FullyQualifiedDomainName`, Route 53 substitutes the value of `IPAddress` in the `Host` header in each of the preceding cases\\. \n **If you don't specify a value for `IPAddress` **: \nRoute 53 sends a DNS request to the domain that you specify for `FullyQualifiedDomainName` at the interval that you specify for `RequestInterval`\\. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint\\. \nIf you don't specify a value for `IPAddress`, Route 53 uses only IPv4 to send health checks to the endpoint\\. If there's no record with a type of A for the name that you specify for `FullyQualifiedDomainName`, the health check fails with a \"DNS resolution failed\" error\\.\nIf you want to check the health of multiple records that have the same name and type, such as multiple weighted records, and if you choose to specify the endpoint only by `FullyQualifiedDomainName`, we recommend that you create a separate health check for each endpoint\\. For example, create a health check for each HTTP server that is serving content for www\\.example\\.com\\. For the value of `FullyQualifiedDomainName`, specify the domain name of the server \\(such as us\\-east\\-2\\-www\\.example\\.com\\), not the name of the records \\(www\\.example\\.com\\)\\. \nIn this configuration, if you create a health check for which the value of `FullyQualifiedDomainName` matches the name of the records and you then associate the health check with those records, health check results will be unpredictable\\.\nIn addition, if the value that you specify for `Type` is `HTTP`, `HTTPS`, `HTTP_STR_MATCH`, or `HTTPS_STR_MATCH`, Route 53 passes the value of `FullyQualifiedDomainName` in the `Host` header, as it does when you specify a value for `IPAddress`\\. If the value of `Type` is `TCP`, Route 53 doesn't pass a `Host` header\\. \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HealthThreshold": "The number of child health checks that are associated with a `CALCULATED` health check that Amazon Route 53 must consider healthy for the `CALCULATED` health check to be considered healthy\\. To specify the child health checks that you want to associate with a `CALCULATED` health check, use the [ChildHealthChecks](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks) element\\. \nNote the following: \n+ If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy\\.\n+ If you specify `0`, Route 53 always considers this health check to be healthy\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IPAddress": "The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on\\. If you don't specify a value for `IPAddress`, Route 53 sends a DNS request to resolve the domain name that you specify in `FullyQualifiedDomainName` at the interval that you specify in `RequestInterval`\\. Using an IP address returned by DNS, Route 53 then checks the health of the endpoint\\. \nUse one of the following formats for the value of `IPAddress`: \n+ **IPv4 address**: four values between 0 and 255, separated by periods \\(\\.\\), for example, `192.0.2.44`\\.\n+ **IPv6 address**: eight groups of four hexadecimal values, separated by colons \\(:\\), for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`\\. You can also shorten IPv6 addresses as described in RFC 5952, for example, `2001:db8:85a3::abcd:1:2345`\\.\nIf the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for `IPAddress`\\. This ensures that the IP address of your instance will never change\\. \nFor more information, see [FullyQualifiedDomainName](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName)\\. \nConstraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non\\-routable, or multicast ranges\\. For more information about IP addresses for which you can't create health checks, see the following documents: \n+ [RFC 5735, Special Use IPv4 Addresses](https://tools.ietf.org/html/rfc5735) \n+ [RFC 6598, IANA\\-Reserved IPv4 Prefix for Shared Address Space](https://tools.ietf.org/html/rfc6598) \n+ [RFC 5156, Special\\-Use IPv6 Addresses](https://tools.ietf.org/html/rfc5156) \nWhen the value of `Type` is `CALCULATED` or `CLOUDWATCH_METRIC`, omit `IPAddress`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `45` \n*Pattern*: `(^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InsufficientDataHealthStatus": "When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check: \n+ `Healthy`: Route 53 considers the health check to be healthy\\.\n+ `Unhealthy`: Route 53 considers the health check to be unhealthy\\.\n+ `LastKnownStatus`: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state\\. For new health checks that have no last known status, the default status for the health check is healthy\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `Healthy | LastKnownStatus | Unhealthy` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Inverted": "Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MeasureLatency": "Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the **Health Checks** page in the Route 53 console\\. \nYou can't change the value of `MeasureLatency` after you create a health check\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Port": "The port on the endpoint that you want Amazon Route 53 to perform health checks on\\. \nDon't specify a value for `Port` when you specify a value for [Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type) of `CLOUDWATCH_METRIC` or `CALCULATED`\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Regions": "A complex type that contains one `Region` element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint\\. \nIf you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under **Valid Values**\\. \nIf you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint \\(for example, if you replace three regions with four different regions\\)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RequestInterval": "The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request\\. Each Route 53 health checker makes requests at this interval\\. \nYou can't change the value of `RequestInterval` after you create a health check\\.\nIf you don't specify a value for `RequestInterval`, the default value is `30` seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `10` \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ResourcePath": "The path, if any, that you want Amazon Route 53 to request when performing health checks\\. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53\\-health\\-check\\.html\\. You can also include query string parameters, for example, `/welcome.html?language=jp&login=y`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RoutingControlArn": "The Amazon Resource Name \\(ARN\\) for the Route 53 Application Recovery Controller routing control\\. \nFor more information about Route 53 Application Recovery Controller, see [Route 53 Application Recovery Controller Developer Guide\\.](https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route-53-recovery.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SearchString": "If the value of Type is `HTTP_STR_MATCH` or `HTTPS_STR_MATCH`, the string that you want Amazon Route 53 to search for in the response body from the specified resource\\. If the string appears in the response body, Route 53 considers the resource healthy\\. \nRoute 53 considers case when searching for `SearchString` in the response body\\. \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Type": "The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy\\. \nYou can't change the value of `Type` after you create a health check\\.\nYou can create the following types of health checks: \n+ **HTTP**: Route 53 tries to establish a TCP connection\\. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400\\.\n+ **HTTPS**: Route 53 tries to establish a TCP connection\\. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400\\.\n**Important** \nIf you specify `HTTPS` for the value of `Type`, the endpoint must support TLS v1\\.0 or later\\.\n+ **HTTP\\_STR\\_MATCH**: Route 53 tries to establish a TCP connection\\. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in `SearchString`\\.\n+ **HTTPS\\_STR\\_MATCH**: Route 53 tries to establish a TCP connection\\. If successful, Route 53 submits an `HTTPS` request and searches the first 5,120 bytes of the response body for the string that you specify in `SearchString`\\.\n+ **TCP**: Route 53 tries to establish a TCP connection\\.\n+ **CLOUDWATCH\\_METRIC**: The health check is associated with a CloudWatch alarm\\. If the state of the alarm is `OK`, the health check is considered healthy\\. If the state is `ALARM`, the health check is considered unhealthy\\. If CloudWatch doesn't have sufficient data to determine whether the state is `OK` or `ALARM`, the health check status depends on the setting for `InsufficientDataHealthStatus`: `Healthy`, `Unhealthy`, or `LastKnownStatus`\\. \n+ **CALCULATED**: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of `HealthThreshold`\\. \n+ **RECOVERY\\_CONTROL**: The health check is assocated with a Route53 Application Recovery Controller routing control\\. If the routing control state is `ON`, the health check is considered healthy\\. If the state is `OFF`, the health check is considered unhealthy\\. \nFor more information, see [How Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) in the *Amazon Route 53 Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CALCULATED | CLOUDWATCH_METRIC | HTTP | HTTP_STR_MATCH | HTTPS | HTTPS_STR_MATCH | RECOVERY_CONTROL | TCP` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::Route53::HealthCheck HealthCheckTag": { "Key": "The value of `Key` depends on the operation that you want to perform: \n+ **Add a tag to a health check or hosted zone**: `Key` is the name that you want to give the new tag\\.\n+ **Edit a tag**: `Key` is the name of the tag that you want to change the `Value` for\\.\n+ ** Delete a key**: `Key` is the name of the tag you want to remove\\.\n+ **Give a name to a health check**: Edit the default `Name` tag\\. In the Amazon Route 53 console, the list of your health checks includes a **Name** column that lets you see the name that you've given to each health check\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Value": "The value of `Value` depends on the operation that you want to perform: \n+ **Add a tag to a health check or hosted zone**: `Value` is the value that you want to give the new tag\\.\n+ **Edit a tag**: `Value` is the new value that you want to assign the tag\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -20010,7 +23428,8 @@ "Status": "A string that represents the current key\\-signing key \\(KSK\\) status\\. \nStatus can have one of the following values: \nACTIVE \nThe KSK is being used for signing\\. \nINACTIVE \nThe KSK is not being used for signing\\. \nDELETING \nThe KSK is in the process of being deleted\\. \nACTION\\_NEEDED \nThere is a problem with the KSK that requires you to take action to resolve\\. For example, the customer managed key might have been deleted, or the permissions for the customer managed key might have been changed\\. \nINTERNAL\\_FAILURE \nThere was an error during a request\\. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem\\. For example, you may need to activate or deactivate the KSK\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `5` \n*Maximum*: `150` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Route53::RecordSet": { - "AliasTarget": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to\\. \nIf you're creating resource records sets for a private hosted zone, note the following: \n+ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution\\.\n+ Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported\\.\n+ For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide*\\.\n*Required*: No \n*Type*: [AliasTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AliasTarget": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to\\. \nIf you're creating resource records sets for a private hosted zone, note the following: \n+ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution\\.\n+ For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide*\\.\n*Required*: No \n*Type*: [AliasTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CidrRoutingConfig": "The object that is specified in resource record set object when you are linking a resource record set to a CIDR location\\. \nA `LocationName` with an asterisk \u201c\\*\u201d can be used to create a default CIDR record\\. `CollectionId` is still required for default record\\. \n*Required*: No \n*Type*: [CidrRoutingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Comment": "*Optional:* Any comments you want to include about a change batch request\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Failover": "*Failover resource record sets only:* To configure failover, you add the `Failover` element to two resource record sets\\. For one resource record set, you specify `PRIMARY` as the value for `Failover`; for the other resource record set, you specify `SECONDARY`\\. In addition, you include the `HealthCheckId` element and specify the health check that you want Amazon Route 53 to perform for each resource record set\\. \nExcept where noted, the following failover behaviors assume that you have included the `HealthCheckId` element in both resource record sets: \n+ When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set\\.\n+ When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set\\.\n+ When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set\\.\n+ If you omit the `HealthCheckId` element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set\\. This is true regardless of the health of the associated endpoint\\.\nYou can't create non\\-failover resource record sets that have the same values for the `Name` and `Type` elements as failover resource record sets\\. \nFor failover alias resource record sets, you must also include the `EvaluateTargetHealth` element and set the value to true\\. \nFor more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide*: \n+ [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) \n+ [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) \n*Required*: No \n*Type*: String \n*Allowed values*: `PRIMARY | SECONDARY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GeoLocation": "*Geolocation resource record sets only:* A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query\\. For example, if you want all queries from Africa to be routed to a web server with an IP address of `192.0.2.111`, create a resource record set with a `Type` of `A` and a `ContinentCode` of `AF`\\. \nAlthough creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported\\.\nIf you create separate resource record sets for overlapping geographic regions \\(for example, one resource record set for a continent and one for a country on the same continent\\), priority goes to the smallest geographic region\\. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource\\. \nYou can't create two geolocation resource record sets that specify the same geographic location\\. \nThe value `*` in the `CountryCode` element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the `Name` and `Type` elements\\. \nGeolocation works by mapping IP addresses to locations\\. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify\\. We recommend that you create a resource record set for which the value of `CountryCode` is `*`\\. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location\\. If you don't create a `*` resource record set, Route 53 returns a \"no answer\" response for queries from those locations\\.\nYou can't create non\\-geolocation resource record sets that have the same values for the `Name` and `Type` elements as geolocation resource record sets\\. \n*Required*: No \n*Type*: [GeoLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -20019,7 +23438,7 @@ "HostedZoneName": "The name of the hosted zone that you want to create records in\\. You must include a trailing dot \\(for example, `www.example.com.`\\) as part of the `HostedZoneName`\\. \nWhen you create a stack using an AWS::Route53::RecordSet that specifies `HostedZoneName`, AWS CloudFormation attempts to find a hosted zone whose name matches the HostedZoneName\\. If AWS CloudFormation cannot find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack\\. \nSpecify either `HostedZoneName` or `HostedZoneId`, but not both\\. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `32` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "MultiValueAnswer": "*Multivalue answer resource record sets only*: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify `true` for `MultiValueAnswer`\\. Note the following: \n+ If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy\\.\n+ If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy\\.\n+ Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records\\.\n+ If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records\\.\n+ When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records\\.\n+ If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response\\.\nYou can't create multivalue answer alias records\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "For `ChangeResourceRecordSets` requests, the name of the record that you want to create, update, or delete\\. For `ListResourceRecordSets` responses, the name of a record in the specified hosted zone\\. \n **ChangeResourceRecordSets Only** \nEnter a fully qualified domain name, for example, `www.example.com`\\. You can optionally include a trailing dot\\. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified\\. This means that Route 53 treats `www.example.com` \\(without a trailing dot\\) and `www.example.com.` \\(with a trailing dot\\) as identical\\. \nFor information about how to specify characters other than `a-z`, `0-9`, and `-` \\(hyphen\\) and how to specify internationalized domain names, see [DNS Domain Name Format](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) in the *Amazon Route 53 Developer Guide*\\. \nYou can use the asterisk \\(\\*\\) wildcard to replace the leftmost label in a domain name, for example, `*.example.com`\\. Note the following: \n+ The \\* must replace the entire label\\. For example, you can't specify `*prod.example.com` or `prod*.example.com`\\.\n+ The \\* can't replace any of the middle labels, for example, marketing\\.\\*\\.example\\.com\\.\n+ If you include \\* in any position other than the leftmost label in a domain name, DNS treats it as an \\* character \\(ASCII 42\\), not as a wildcard\\.\n**Important** \nYou can't use the \\* wildcard for resource records sets that have a type of NS\\.\nYou can use the \\* wildcard as the leftmost label in a domain name, for example, `*.example.com`\\. You can't use an \\* for one of the middle labels, for example, `marketing.*.example.com`\\. In addition, the \\* must replace the entire label; for example, you can't specify `prod*.example.com`\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Region": "*Latency\\-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to\\. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type\\. \nAlthough creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported\\.\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region\\. Route 53 then returns the value that is associated with the selected resource record set\\. \nNote the following: \n+ You can only specify one `ResourceRecord` per latency resource record set\\.\n+ You can only create one latency resource record set for each Amazon EC2 Region\\.\n+ You aren't required to create latency resource record sets for all Amazon EC2 Regions\\. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for\\.\n+ You can't create non\\-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Region": "*Latency\\-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to\\. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type\\. \nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region\\. Route 53 then returns the value that is associated with the selected resource record set\\. \nNote the following: \n+ You can only specify one `ResourceRecord` per latency resource record set\\.\n+ You can only create one latency resource record set for each Amazon EC2 Region\\.\n+ You aren't required to create latency resource record sets for all Amazon EC2 Regions\\. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for\\.\n+ You can't create non\\-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResourceRecords": "One or more values that correspond with the value that you specified for the `Type` property\\. For example, if you specified `A` for `Type`, you specify one or more IP addresses in IPv4 format for `ResourceRecords`\\. For information about the format of values for each record type, see [Supported DNS Resource Record Types](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html) in the *Amazon Route 53 Developer Guide*\\. \nNote the following: \n+ You can specify more than one value for all record types except CNAME and SOA\\.\n+ The maximum length of a value is 4000 characters\\.\n+ If you're creating an alias record, omit `ResourceRecords`\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SetIdentifier": "*Resource record sets that have a routing policy other than simple:* An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme\\.example\\.com that have a type of A\\. In a group of resource record sets that have the same name and type, the value of `SetIdentifier` must be unique for each resource record set\\. \nFor information about routing policies, see [Choosing a Routing Policy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) in the *Amazon Route 53 Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TTL": "The resource record cache time to live \\(TTL\\), in seconds\\. Note the following: \n+ If you're creating or updating an alias resource record set, omit `TTL`\\. Amazon Route 53 uses the value of `TTL` for the alias target\\. \n+ If you're associating this resource record set with a health check \\(if you're adding a `HealthCheckId` element\\), we recommend that you specify a `TTL` of 60 seconds or less so clients respond quickly to changes in health status\\.\n+ All of the resource record sets in a group of weighted resource record sets must have the same value for `TTL`\\.\n+ If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a `TTL` of 60 seconds for all of the non\\-alias weighted resource record sets that have the same name and type\\. Values other than 60 seconds \\(the TTL for load balancers\\) will change the effect of the values that you specify for `Weight`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -20031,6 +23450,10 @@ "EvaluateTargetHealth": "*Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets:* When `EvaluateTargetHealth` is `true`, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone\\. \nNote the following: \nCloudFront distributions \nYou can't set `EvaluateTargetHealth` to `true` when the alias target is a CloudFront distribution\\. \nElastic Beanstalk environments that have regionalized subdomains \nIf you specify an Elastic Beanstalk environment in `DNSName` and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer\\. \\(An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance\\.\\) If you set `EvaluateTargetHealth` to `true` and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any\\. \nIf the environment contains a single Amazon EC2 instance, there are no special requirements\\. \nELB load balancers \nHealth checking behavior depends on the type of load balancer: \n+ **Classic Load Balancers**: If you specify an ELB Classic Load Balancer in `DNSName`, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer\\. If you set `EvaluateTargetHealth` to `true` and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources\\.\n+ **Application and Network Load Balancers**: If you specify an ELB Application or Network Load Balancer and you set `EvaluateTargetHealth` to `true`, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:\n + For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target\\. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources\\.\n + A target group that has no registered targets is considered unhealthy\\.\nWhen you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function\\. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer\\. \nS3 buckets \nThere are no special requirements for setting `EvaluateTargetHealth` to `true` when the alias target is an S3 bucket\\. \nOther records in the same hosted zone \nIf the AWS resource that you specify in `DNSName` is a record or a group of records \\(for example, a group of weighted records\\) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target\\. For more information, see [What Happens When You Omit Health Checks?](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting) in the *Amazon Route 53 Developer Guide*\\.\nFor more information and examples, see [Amazon Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) in the *Amazon Route 53 Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HostedZoneId": "*Alias resource records sets only*: The value used depends on where you want to route traffic: \nAmazon API Gateway custom regional APIs and edge\\-optimized APIs \nSpecify the hosted zone ID for your API\\. You can get the applicable value using the AWS CLI command [get\\-domain\\-names](https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html): \n+ For regional APIs, specify the value of `regionalHostedZoneId`\\.\n+ For edge\\-optimized APIs, specify the value of `distributionHostedZoneId`\\. \nAmazon Virtual Private Cloud interface VPC endpoint \nSpecify the hosted zone ID for your interface endpoint\\. You can get the value of `HostedZoneId` using the AWS CLI command [describe\\-vpc\\-endpoints](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html)\\. \nCloudFront distribution \nSpecify `Z2FDTNDATAQYW2`\\. This is always the hosted zone ID when you create an alias record that routes traffic to a CloudFront distribution\\. \nAlias records for CloudFront can't be created in a private zone\\. \nElastic Beanstalk environment \nSpecify the hosted zone ID for the region that you created the environment in\\. The environment must have a regionalized subdomain\\. For a list of regions and the corresponding hosted zone IDs, see [AWS Elastic Beanstalk endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html) in the *Amazon Web Services General Reference*\\. \nELB load balancer \nSpecify the value of the hosted zone ID for the load balancer\\. Use the following methods to get the hosted zone ID: \n+ [Service Endpoints](https://docs.aws.amazon.com/general/latest/gr/elb.html) table in the \"Elastic Load Balancing Endpoints and Quotas\" topic in the *Amazon Web Services General Reference*: Use the value that corresponds with the region that you created your load balancer in\\. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers\\.\n+ **AWS Management Console**: Go to the Amazon EC2 page, choose **Load Balancers** in the navigation pane, select the load balancer, and get the value of the **Hosted zone** field on the **Description** tab\\.\n+ **Elastic Load Balancing API**: Use `DescribeLoadBalancers` to get the applicable value\\. For more information, see the applicable guide:\n + Classic Load Balancers: Use [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html) to get the value of `CanonicalHostedZoneNameID`\\.\n + Application and Network Load Balancers: Use [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) to get the value of `CanonicalHostedZoneID`\\.\n+ **CloudFormation Fn::GetAtt intrinsic function**: Use the [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) intrinsic function to get the applicable value:\n + Classic Load Balancers: Get [CanonicalHostedZoneNameID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values)\\. \n + Application and Network Load Balancers: Get [CanonicalHostedZoneID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values)\\. \n+ **AWS CLI**: Use `describe-load-balancers` to get the applicable value\\. For more information, see the applicable guide:\n + Classic Load Balancers: Use [describe\\-load\\-balancers](https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html) to get the value of `CanonicalHostedZoneNameID`\\.\n + Application and Network Load Balancers: Use [describe\\-load\\-balancers](https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html) to get the value of `CanonicalHostedZoneID`\\. \nGlobal Accelerator accelerator \nSpecify `Z2BJ6XQ5FK7U4H`\\. \nAn Amazon S3 bucket configured as a static website \nSpecify the hosted zone ID for the region that you created the bucket in\\. For more information about valid values, see the table [Amazon S3 Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) in the *Amazon Web Services General Reference*\\. \nAnother Route 53 record in your hosted zone \nSpecify the hosted zone ID of your hosted zone\\. \\(An alias record can't reference a record in a different hosted zone\\.\\)\n*Required*: Yes \n*Type*: String \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Route53::RecordSet CidrRoutingConfig": { + "CollectionId": "The CIDR collection ID\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LocationName": "The CIDR collection location name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16` \n*Pattern*: `[0-9A-Za-z_\\-\\*]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Route53::RecordSet GeoLocation": { "ContinentCode": "For geolocation resource record sets, a two\\-letter abbreviation that identifies a continent\\. Route 53 supports the following continent codes: \n+ **AF**: Africa\n+ **AN**: Antarctica\n+ **AS**: Asia\n+ **EU**: Europe\n+ **OC**: Oceania\n+ **NA**: North America\n+ **SA**: South America\nConstraint: Specifying `ContinentCode` with either `CountryCode` or `SubdivisionCode` returns an `InvalidInput` error\\. \n*Required*: No \n*Type*: String \n*Minimum*: `2` \n*Maximum*: `2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CountryCode": "For geolocation resource record sets, the two\\-letter code for a country\\. \nRoute 53 uses the two\\-letter country codes that are specified in [ISO standard 3166\\-1 alpha\\-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -20038,8 +23461,8 @@ }, "AWS::Route53::RecordSetGroup": { "Comment": "*Optional:* Any comments you want to include about a change batch request\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "HostedZoneId": "The ID of the hosted zone that contains the resource record sets that you want to change\\. \n*Required*: Conditional \n*Type*: String \n*Maximum*: `32` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "HostedZoneName": "The name of the hosted zone that you want to create, update, or delete resource record sets in\\. \n*Required*: Conditional \n*Type*: String \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "HostedZoneId": "The ID of the hosted zone that you want to create records in\\. \nSpecify either `HostedZoneName` or `HostedZoneId`, but not both\\. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `32` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "HostedZoneName": "The name of the hosted zone that you want to create records in\\. You must include a trailing dot \\(for example, `www.example.com.`\\) as part of the `HostedZoneName`\\. \nWhen you create a stack using an `AWS::Route53::RecordSet` that specifies `HostedZoneName`, AWS CloudFormation attempts to find a hosted zone whose name matches the `HostedZoneName`\\. If AWS CloudFormation can't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack\\. \nSpecify either `HostedZoneName` or `HostedZoneId`, but not both\\. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RecordSets": "A complex type that contains one `RecordSet` element for each record that you want to create\\. \n*Required*: No \n*Type*: List of [RecordSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Route53::RecordSetGroup AliasTarget": { @@ -20047,13 +23470,18 @@ "EvaluateTargetHealth": "*Applies only to alias records with any routing policy:* When `EvaluateTargetHealth` is `true`, an alias record inherits the health of the referenced AWS resource, such as an ELB load balancer or another record in the hosted zone\\. \nNote the following: \nCloudFront distributions \nYou can't set `EvaluateTargetHealth` to `true` when the alias target is a CloudFront distribution\\. \nElastic Beanstalk environments that have regionalized subdomains \nIf you specify an Elastic Beanstalk environment in `DNSName` and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer\\. \\(An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance\\.\\) If you set `EvaluateTargetHealth` to `true` and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any\\. \nIf the environment contains a single Amazon EC2 instance, there are no special requirements\\. \nELB load balancers \nHealth checking behavior depends on the type of load balancer: \n+ **Classic Load Balancers**: If you specify an ELB Classic Load Balancer in `DNSName`, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer\\. If you set `EvaluateTargetHealth` to `true` and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources\\.\n+ **Application and Network Load Balancers**: If you specify an ELB Application or Network Load Balancer and you set `EvaluateTargetHealth` to `true`, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:\n + For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target\\. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources\\.\n + A target group that has no registered targets is considered unhealthy\\.\nWhen you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function\\. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer\\. \nS3 buckets \nThere are no special requirements for setting `EvaluateTargetHealth` to `true` when the alias target is an S3 bucket\\. \nOther records in the same hosted zone \nIf the AWS resource that you specify in `DNSName` is a record or a group of records \\(for example, a group of weighted records\\) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target\\. For more information, see [What Happens When You Omit Health Checks?](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting) in the *Amazon Route 53 Developer Guide*\\.\nFor more information and examples, see [Amazon Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) in the *Amazon Route 53 Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HostedZoneId": "*Alias resource records sets only*: The value used depends on where you want to route traffic: \nAmazon API Gateway custom regional APIs and edge\\-optimized APIs \nSpecify the hosted zone ID for your API\\. You can get the applicable value using the AWS CLI command [get\\-domain\\-names](https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html): \n+ For regional APIs, specify the value of `regionalHostedZoneId`\\.\n+ For edge\\-optimized APIs, specify the value of `distributionHostedZoneId`\\. \nAmazon Virtual Private Cloud interface VPC endpoint \nSpecify the hosted zone ID for your interface endpoint\\. You can get the value of `HostedZoneId` using the AWS CLI command [describe\\-vpc\\-endpoints](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html)\\. \nCloudFront distribution \nSpecify `Z2FDTNDATAQYW2`\\. This is always the hosted zone ID when you create an alias record that routes traffic to a CloudFront distribution\\. \nAlias records for CloudFront can't be created in a private zone\\. \nElastic Beanstalk environment \nSpecify the hosted zone ID for the region that you created the environment in\\. The environment must have a regionalized subdomain\\. For a list of regions and the corresponding hosted zone IDs, see [AWS Elastic Beanstalk endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html) in the *Amazon Web Services General Reference*\\. \nELB load balancer \nSpecify the value of the hosted zone ID for the load balancer\\. Use the following methods to get the hosted zone ID: \n+ [Service Endpoints](https://docs.aws.amazon.com/general/latest/gr/elb.html) table in the \"Elastic Load Balancing endpoints and quotas\" topic in the *Amazon Web Services General Reference*: Use the value that corresponds with the region that you created your load balancer in\\. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers\\.\n+ **AWS Management Console**: Go to the Amazon EC2 page, choose **Load Balancers** in the navigation pane, select the load balancer, and get the value of the **Hosted zone** field on the **Description** tab\\.\n+ **Elastic Load Balancing API**: Use `DescribeLoadBalancers` to get the applicable value\\. For more information, see the applicable guide:\n + Classic Load Balancers: Use [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html) to get the value of `CanonicalHostedZoneNameID`\\.\n + Application and Network Load Balancers: Use [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) to get the value of `CanonicalHostedZoneID`\\.\n+ **CloudFormation Fn::GetAtt intrinsic function**: Use the [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html) intrinsic function to get the applicable value:\n + Classic Load Balancers: Get [CanonicalHostedZoneNameID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-elb.html#aws-properties-ec2-elb-return-values)\\. \n + Application and Network Load Balancers: Get [CanonicalHostedZoneID](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-loadbalancer.html#aws-resource-elasticloadbalancingv2-loadbalancer-return-values)\\. \n+ **AWS CLI**: Use `describe-load-balancers` to get the applicable value\\. For more information, see the applicable guide:\n + Classic Load Balancers: Use [describe\\-load\\-balancers](https://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html) to get the value of `CanonicalHostedZoneNameID`\\.\n + Application and Network Load Balancers: Use [describe\\-load\\-balancers](https://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html) to get the value of `CanonicalHostedZoneID`\\. \nGlobal Accelerator accelerator \nSpecify `Z2BJ6XQ5FK7U4H`\\. \nAn Amazon S3 bucket configured as a static website \nSpecify the hosted zone ID for the region that you created the bucket in\\. For more information about valid values, see the table [Amazon S3 Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints) in the *Amazon Web Services General Reference*\\. \nAnother Route 53 record in your hosted zone \nSpecify the hosted zone ID of your hosted zone\\. \\(An alias record can't reference a record in a different hosted zone\\.\\)\n*Required*: Yes \n*Type*: String \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Route53::RecordSetGroup CidrRoutingConfig": { + "CollectionId": "The CIDR collection ID\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LocationName": "The CIDR collection location name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16` \n*Pattern*: `[0-9A-Za-z_\\-\\*]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Route53::RecordSetGroup GeoLocation": { "ContinentCode": "For geolocation resource record sets, a two\\-letter abbreviation that identifies a continent\\. Route 53 supports the following continent codes: \n+ **AF**: Africa\n+ **AN**: Antarctica\n+ **AS**: Asia\n+ **EU**: Europe\n+ **OC**: Oceania\n+ **NA**: North America\n+ **SA**: South America\nConstraint: Specifying `ContinentCode` with either `CountryCode` or `SubdivisionCode` returns an `InvalidInput` error\\. \n*Required*: No \n*Type*: String \n*Minimum*: `2` \n*Maximum*: `2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CountryCode": "For geolocation resource record sets, the two\\-letter code for a country\\. \nRoute 53 uses the two\\-letter country codes that are specified in [ISO standard 3166\\-1 alpha\\-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SubdivisionCode": "For geolocation resource record sets, the two\\-letter code for a state of the United States\\. Route 53 doesn't support any other values for `SubdivisionCode`\\. For a list of state abbreviations, see [Appendix B: Two\u2013Letter State and Possession Abbreviations](https://pe.usps.com/text/pub28/28apb.htm) on the United States Postal Service website\\. \nIf you specify `subdivisioncode`, you must also specify `US` for `CountryCode`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Route53::RecordSetGroup RecordSet": { - "AliasTarget": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to\\. \nIf you're creating resource records sets for a private hosted zone, note the following: \n+ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution\\.\n+ Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported\\.\n+ For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide*\\.\n*Required*: No \n*Type*: [AliasTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AliasTarget": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to\\. \nIf you're creating resource records sets for a private hosted zone, note the following: \n+ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution\\.\n+ For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide*\\.\n*Required*: No \n*Type*: [AliasTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CidrRoutingConfig": "Property description not available\\. \n*Required*: No \n*Type*: [CidrRoutingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Failover": "*Failover resource record sets only:* To configure failover, you add the `Failover` element to two resource record sets\\. For one resource record set, you specify `PRIMARY` as the value for `Failover`; for the other resource record set, you specify `SECONDARY`\\. In addition, you include the `HealthCheckId` element and specify the health check that you want Amazon Route 53 to perform for each resource record set\\. \nExcept where noted, the following failover behaviors assume that you have included the `HealthCheckId` element in both resource record sets: \n+ When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set\\.\n+ When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set\\.\n+ When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set\\.\n+ If you omit the `HealthCheckId` element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set\\. This is true regardless of the health of the associated endpoint\\.\nYou can't create non\\-failover resource record sets that have the same values for the `Name` and `Type` elements as failover resource record sets\\. \nFor failover alias resource record sets, you must also include the `EvaluateTargetHealth` element and set the value to true\\. \nFor more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide*: \n+ [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) \n+ [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) \n*Required*: No \n*Type*: String \n*Allowed values*: `PRIMARY | SECONDARY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GeoLocation": "*Geolocation resource record sets only:* A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query\\. For example, if you want all queries from Africa to be routed to a web server with an IP address of `192.0.2.111`, create a resource record set with a `Type` of `A` and a `ContinentCode` of `AF`\\. \nAlthough creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported\\.\nIf you create separate resource record sets for overlapping geographic regions \\(for example, one resource record set for a continent and one for a country on the same continent\\), priority goes to the smallest geographic region\\. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource\\. \nYou can't create two geolocation resource record sets that specify the same geographic location\\. \nThe value `*` in the `CountryCode` element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the `Name` and `Type` elements\\. \nGeolocation works by mapping IP addresses to locations\\. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify\\. We recommend that you create a resource record set for which the value of `CountryCode` is `*`\\. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location\\. If you don't create a `*` resource record set, Route 53 returns a \"no answer\" response for queries from those locations\\.\nYou can't create non\\-geolocation resource record sets that have the same values for the `Name` and `Type` elements as geolocation resource record sets\\. \n*Required*: No \n*Type*: [GeoLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-recordset-geolocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HealthCheckId": "If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the `HealthCheckId` element and specify the ID of the applicable health check\\. \nRoute 53 determines whether a resource record set is healthy based on one of the following: \n+ By periodically sending a request to the endpoint that is specified in the health check\n+ By aggregating the status of a specified group of health checks \\(calculated health checks\\)\n+ By determining the current state of a CloudWatch alarm \\(CloudWatch metric health checks\\)\nRoute 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the `Value` element\\. When you add a `HealthCheckId` element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check\\. \nFor more information, see the following topics in the *Amazon Route 53 Developer Guide*: \n+ [How Amazon Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) \n+ [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) \n+ [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) \n **When to Specify HealthCheckId** \nSpecifying a value for `HealthCheckId` is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check\\. Configuring health checks makes sense only in the following configurations: \n+ **Non\\-alias resource record sets**: You're checking the health of a group of non\\-alias resource record sets that have the same routing policy, name, and type \\(such as multiple weighted records named www\\.example\\.com with a type of A\\) and you specify health check IDs for all the resource record sets\\.", @@ -20061,7 +23489,7 @@ "HostedZoneName": "The name of the hosted zone that you want to create records in\\. You must include a trailing dot \\(for example, `www.example.com.`\\) as part of the `HostedZoneName`\\. \nWhen you create a stack using an `AWS::Route53::RecordSet` that specifies `HostedZoneName`, AWS CloudFormation attempts to find a hosted zone whose name matches the `HostedZoneName`\\. If AWS CloudFormation can't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack\\. \nSpecify either `HostedZoneName` or `HostedZoneId`, but not both\\. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MultiValueAnswer": "*Multivalue answer resource record sets only*: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify `true` for `MultiValueAnswer`\\. Note the following: \n+ If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy\\.\n+ If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy\\.\n+ Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records\\.\n+ If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records\\.\n+ When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records\\.\n+ If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response\\.\nYou can't create multivalue answer alias records\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "For `ChangeResourceRecordSets` requests, the name of the record that you want to create, update, or delete\\. For `ListResourceRecordSets` responses, the name of a record in the specified hosted zone\\. \n **ChangeResourceRecordSets Only** \nEnter a fully qualified domain name, for example, `www.example.com`\\. You can optionally include a trailing dot\\. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified\\. This means that Route 53 treats `www.example.com` \\(without a trailing dot\\) and `www.example.com.` \\(with a trailing dot\\) as identical\\. \nFor information about how to specify characters other than `a-z`, `0-9`, and `-` \\(hyphen\\) and how to specify internationalized domain names, see [DNS Domain Name Format](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html) in the *Amazon Route 53 Developer Guide*\\. \nYou can use the asterisk \\(\\*\\) wildcard to replace the leftmost label in a domain name, for example, `*.example.com`\\. Note the following: \n+ The \\* must replace the entire label\\. For example, you can't specify `*prod.example.com` or `prod*.example.com`\\.\n+ The \\* can't replace any of the middle labels, for example, marketing\\.\\*\\.example\\.com\\.\n+ If you include \\* in any position other than the leftmost label in a domain name, DNS treats it as an \\* character \\(ASCII 42\\), not as a wildcard\\.\n**Important** \nYou can't use the \\* wildcard for resource records sets that have a type of NS\\.\nYou can use the \\* wildcard as the leftmost label in a domain name, for example, `*.example.com`\\. You can't use an \\* for one of the middle labels, for example, `marketing.*.example.com`\\. In addition, the \\* must replace the entire label; for example, you can't specify `prod*.example.com`\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Region": "*Latency\\-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to\\. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type\\. \nAlthough creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported\\.\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region\\. Route 53 then returns the value that is associated with the selected resource record set\\. \nNote the following: \n+ You can only specify one `ResourceRecord` per latency resource record set\\.\n+ You can only create one latency resource record set for each Amazon EC2 Region\\.\n+ You aren't required to create latency resource record sets for all Amazon EC2 Regions\\. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for\\.\n+ You can't create non\\-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Region": "*Latency\\-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to\\. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type\\. \nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region\\. Route 53 then returns the value that is associated with the selected resource record set\\. \nNote the following: \n+ You can only specify one `ResourceRecord` per latency resource record set\\.\n+ You can only create one latency resource record set for each Amazon EC2 Region\\.\n+ You aren't required to create latency resource record sets for all Amazon EC2 Regions\\. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for\\.\n+ You can't create non\\-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResourceRecords": "Information about the records that you want to create\\. Each record should be in the format appropriate for the record type specified by the `Type` property\\. For information about different record types and their record formats, see [Values That You Specify When You Create or Edit Amazon Route 53 Records](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resource-record-sets-values.html) in the *Amazon Route 53 Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SetIdentifier": "*Resource record sets that have a routing policy other than simple:* An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme\\.example\\.com that have a type of A\\. In a group of resource record sets that have the same name and type, the value of `SetIdentifier` must be unique for each resource record set\\. \nFor information about routing policies, see [Choosing a Routing Policy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html) in the *Amazon Route 53 Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TTL": "The resource record cache time to live \\(TTL\\), in seconds\\. Note the following: \n+ If you're creating or updating an alias resource record set, omit `TTL`\\. Amazon Route 53 uses the value of `TTL` for the alias target\\. \n+ If you're associating this resource record set with a health check \\(if you're adding a `HealthCheckId` element\\), we recommend that you specify a `TTL` of 60 seconds or less so clients respond quickly to changes in health status\\.\n+ All of the resource record sets in a group of weighted resource record sets must have the same value for `TTL`\\.\n+ If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a `TTL` of 60 seconds for all of the non\\-alias weighted resource record sets that have the same name and type\\. Values other than 60 seconds \\(the TTL for load balancers\\) will change the effect of the values that you specify for `Weight`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -20069,6 +23497,7 @@ "Weight": "*Weighted resource record sets only:* Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set\\. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type\\. Route 53 then responds to queries based on the ratio of a resource's weight to the total\\. Note the following: \n+ You must specify a value for the `Weight` element for every weighted resource record set\\.\n+ You can only specify one `ResourceRecord` per weighted resource record set\\.\n+ You can't create latency, failover, or geolocation resource record sets that have the same values for the `Name` and `Type` elements as weighted resource record sets\\.\n+ You can create a maximum of 100 weighted resource record sets that have the same values for the `Name` and `Type` elements\\.\n+ For weighted \\(but not weighted alias\\) resource record sets, if you set `Weight` to `0` for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set\\. However, if you set `Weight` to `0` for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability\\." }, "AWS::Route53RecoveryControl::Cluster": { + "ClusterEndpoints": "Property description not available\\. \n*Required*: No \n*Type*: List of [ClusterEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoverycontrol-cluster-clusterendpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "Name of the cluster\\. You can use any non\\-white space character in the name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The value for a tag\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -20090,7 +23519,7 @@ "AssertionRule": "An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met\\. Otherwise, the change to the routing control is not accepted\\. For example, the criteria might be that at least one routing control state is `On` after the transaction so that traffic continues to flow to at least one cell for the application\\. This ensures that you avoid a fail\\-open scenario\\. \n*Required*: No \n*Type*: [AssertionRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoverycontrol-safetyrule-assertionrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ControlPanelArn": "The Amazon Resource Name \\(ARN\\) for the control panel\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "GatingRule": "A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete\\. \nFor example, if you specify one gating routing control and you set the `Type` in the rule configuration to `OR`, that indicates that you must set the gating routing control to `On` for the rule to evaluate as true; that is, for the gating control \"switch\" to be \"On\"\\. When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule\\. \n*Required*: No \n*Type*: [GatingRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoverycontrol-safetyrule-gatingrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the assertion rule\\. You can use any non\\-white space character in the name\\. The name must be unique within a control panel\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the assertion rule\\. The name must be unique within a control panel\\. You can use any non\\-white space character in the name except the following: & > < ' \\(single quote\\) \" \\(double quote\\) ; \\(semicolon\\) \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RuleConfig": "The criteria that you set for specific assertion controls \\(routing controls\\) that designate how many control states must be `ON` as the result of a transaction\\. For example, if you have three assertion controls, you might specify `ATLEAST 2` for your rule configuration\\. This means that at least two assertion controls must be `ON`, so that at least two AWS Regions have traffic flowing to them\\. \n*Required*: Yes \n*Type*: [RuleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoverycontrol-safetyrule-ruleconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The value for a tag\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -20109,22 +23538,22 @@ "Type": "A rule can be one of the following: `ATLEAST`, `AND`, or `OR`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Route53RecoveryReadiness::Cell": { - "CellName": "The name of the cell to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CellName": "The name of the cell to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Cells": "A list of cell Amazon Resource Names \\(ARNs\\) contained within this cell, for use in nested cells\\. For example, Availability Zones within specific AWS Regions\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A collection of tags associated with a resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Route53RecoveryReadiness::ReadinessCheck": { - "ReadinessCheckName": "The name of the readiness check to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ReadinessCheckName": "The name of the readiness check to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ResourceSetName": "The name of the resource set to check\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A collection of tags associated with a resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Route53RecoveryReadiness::RecoveryGroup": { "Cells": "A list of the cell Amazon Resource Names \\(ARNs\\) in the recovery group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RecoveryGroupName": "The name of the recovery group to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RecoveryGroupName": "The name of the recovery group to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "A collection of tags associated with a resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Route53RecoveryReadiness::ResourceSet": { - "ResourceSetName": "The name of the resource set to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ResourceSetName": "The name of the resource set to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ResourceSetType": "The resource type of the resources in the resource set\\. Enter one of the following values for resource type: \nAWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource\\. \nNote that AWS::Route53RecoveryReadiness::DNSTargetResource is only used for this setting\\. It isn't an actual AWS CloudFormation resource type\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Resources": "A list of resource objects in the resource set\\. \n*Required*: Yes \n*Type*: List of [Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoveryreadiness-resourceset-resource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A tag to associate with the parameters for a resource set\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -20192,11 +23621,15 @@ "Direction": "Indicates whether the Resolver endpoint allows inbound or outbound DNS queries: \n+ `INBOUND`: allows DNS queries to your VPC from your network\n+ `OUTBOUND`: allows DNS queries from your VPC to your network\n*Required*: Yes \n*Type*: String \n*Allowed values*: `INBOUND | OUTBOUND` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "IpAddresses": "The subnets and IP addresses in your VPC that DNS queries originate from \\(for outbound endpoints\\) or that you forward DNS queries to \\(for inbound endpoints\\)\\. The subnet ID uniquely identifies a VPC\\. \n*Required*: Yes \n*Type*: List of [IpAddressRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverendpoint-ipaddressrequest.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console\\. \n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Pattern*: `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OutpostArn": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PreferredInstanceType": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ResolverEndpointType": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityGroupIds": "The ID of one or more security groups that control access to this VPC\\. The security group must include one or more inbound rules \\(for inbound endpoints\\) or outbound rules \\(for outbound endpoints\\)\\. Inbound and outbound rules must allow TCP and UDP access\\. For inbound access, open port 53\\. For outbound access, open the port that you're using for DNS queries on your network\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Route 53 Resolver doesn't support updating tags through CloudFormation\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Route53Resolver::ResolverEndpoint IpAddressRequest": { "Ip": "The IP address that you want to use for DNS queries\\. \n*Required*: No \n*Type*: String \n*Minimum*: `7` \n*Maximum*: `36` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Ipv6": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SubnetId": "The ID of the subnet that contains the IP address\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Route53Resolver::ResolverQueryLoggingConfig": { @@ -20208,7 +23641,7 @@ "ResourceId": "The ID of the Amazon VPC that is associated with the query logging configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Route53Resolver::ResolverRule": { - "DomainName": "DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps`\\. If a query matches multiple Resolver rules \\(example\\.com and www\\.example\\.com\\), the query is routed using the Resolver rule that contains the most specific domain name \\(www\\.example\\.com\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DomainName": "DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps`\\. If a query matches multiple Resolver rules \\(example\\.com and www\\.example\\.com\\), the query is routed using the Resolver rule that contains the most specific domain name \\(www\\.example\\.com\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "Name": "The name for the Resolver rule, which you specified when you created the Resolver rule\\. \n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Pattern*: `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResolverEndpointId": "The ID of the endpoint that the rule is associated with\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RuleType": "When you want to forward DNS queries for specified domain name to resolvers on your network, specify `FORWARD`\\. \nWhen you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify `SYSTEM`\\. \nFor example, to forward DNS queries for example\\.com to resolvers on your network, you create a rule and specify `FORWARD` for `RuleType`\\. To then have Resolver process queries for apex\\.example\\.com, you create a rule and specify `SYSTEM` for `RuleType`\\. \nCurrently, only Resolver can create rules that have a value of `RECURSIVE` for `RuleType`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FORWARD | RECURSIVE | SYSTEM` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -20216,7 +23649,8 @@ "TargetIps": "An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to\\. Typically, these are the IP addresses of DNS resolvers on your network\\. Specify IPv4 addresses\\. IPv6 is not supported\\. \n*Required*: No \n*Type*: List of [TargetAddress](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53resolver-resolverrule-targetaddress.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Route53Resolver::ResolverRule TargetAddress": { - "Ip": "One IP address that you want to forward DNS queries to\\. You can specify only IPv4 addresses\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `7` \n*Maximum*: `36` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Ip": "One IP address that you want to forward DNS queries to\\. You can specify only IPv4 addresses\\. \n*Required*: No \n*Type*: String \n*Minimum*: `7` \n*Maximum*: `36` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Ipv6": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Port": "The port at `Ip` that you want to forward DNS queries to\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Route53Resolver::ResolverRuleAssociation": { @@ -20226,12 +23660,16 @@ }, "AWS::S3::AccessPoint": { "Bucket": "The name of the bucket associated with this access point\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "BucketAccountId": "The AWS account ID associated with the S3 bucket associated with this access point\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "The name of this access point\\. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Policy": "The access point policy associated with this access point\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PolicyStatus": "The container element for a bucket's policy status\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PolicyStatus": "The container element for a bucket's policy status\\. \n*Required*: No \n*Type*: [PolicyStatus](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-policystatus.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PublicAccessBlockConfiguration": "The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket\\. You can enable the configuration options in any combination\\. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of \"Public\"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: [PublicAccessBlockConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-publicaccessblockconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "VpcConfiguration": "The Virtual Private Cloud \\(VPC\\) configuration for this access point, if one exists\\. \n*Required*: No \n*Type*: [VpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-vpcconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::S3::AccessPoint PolicyStatus": { + "IsPublic": "The policy status for this bucket\\. `TRUE` indicates that this bucket is public\\. `FALSE` indicates that the bucket is not public\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::S3::AccessPoint PublicAccessBlockConfiguration": { "BlockPublicAcls": "Specifies whether Amazon S3 should block public access control lists \\(ACLs\\) for this bucket and objects in this bucket\\. Setting this element to `TRUE` causes the following behavior: \n+ PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public\\.\n+ PUT Object calls fail if the request includes a public ACL\\.\n+ PUT Bucket calls fail if the request includes a public ACL\\.\nEnabling this setting doesn't affect existing policies or ACLs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "BlockPublicPolicy": "Specifies whether Amazon S3 should block public bucket policies for this bucket\\. Setting this element to `TRUE` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access\\. \nEnabling this setting doesn't affect existing bucket policies\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -20311,7 +23749,7 @@ "Prefix": "The prefix to use when exporting data\\. The prefix is prepended to all results\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::S3::Bucket EncryptionConfiguration": { - "ReplicaKmsKeyID": "Specifies the ID \\(Key ARN or Alias ARN\\) of the customer managed AWS KMS key stored in AWS Key Management Service \\(KMS\\) for the destination bucket\\. Amazon S3 uses this key to encrypt replica objects\\. Amazon S3 only supports symmetric, customer managed KMS keys\\. For more information, see [Using symmetric and asymmetric keys](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the * AWS Key Management Service Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ReplicaKmsKeyID": "Specifies the ID \\(Key ARN or Alias ARN\\) of the customer managed AWS KMS key stored in AWS Key Management Service \\(KMS\\) for the destination bucket\\. Amazon S3 uses this key to encrypt replica objects\\. Amazon S3 only supports symmetric encryption KMS keys\\. For more information, see [Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the * AWS Key Management Service Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::S3::Bucket EventBridgeConfiguration": { "EventBridgeEnabled": "Enables delivery of events to Amazon EventBridge\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -20378,7 +23816,7 @@ }, "AWS::S3::Bucket ObjectLockConfiguration": { "ObjectLockEnabled": "Indicates whether this bucket has an Object Lock configuration enabled\\. Enable `ObjectLockEnabled` when you apply `ObjectLockConfiguration` to a bucket\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Enabled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Rule": "Specifies the Object Lock rule for the specified object\\. Enable the this rule when you apply `ObjectLockConfiguration` to a bucket\\. If Object Lock is turned on, bucket settings require both `Mode` and a period of either `Days` or `Years`\\. You cannot specify `Days` and `Years` at the same time\\. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)\\. \n*Required*: Conditional \n*Type*: [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Rule": "Specifies the Object Lock rule for the specified object\\. Enable this rule when you apply `ObjectLockConfiguration` to a bucket\\. If Object Lock is turned on, bucket settings require both `Mode` and a period of either `Days` or `Years`\\. You cannot specify `Days` and `Years` at the same time\\. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)\\. \n*Required*: Conditional \n*Type*: [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::S3::Bucket ObjectLockRule": { "DefaultRetention": "The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket\\. If Object Lock is turned on, bucket settings require both `Mode` and a period of either `Days` or `Years`\\. You cannot specify `Days` and `Years` at the same time\\. For more information about allowable values for mode and period, see [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)\\. \n*Required*: Conditional \n*Type*: [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -20397,7 +23835,7 @@ }, "AWS::S3::Bucket QueueConfiguration": { "Event": "The Amazon S3 bucket event about which you want to publish messages to Amazon SQS\\. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Filter": "The filtering rules that determine which objects trigger notifications\\. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a `.jpg` extension are added to the bucket\\. \n*Required*: No \n*Type*: [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Filter": "The filtering rules that determine which objects trigger notifications\\. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a `.jpg` extension are added to the bucket\\. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Queue": "The Amazon Resource Name \\(ARN\\) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type\\. FIFO queues are not allowed when enabling an SQS queue as the event notification destination\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::S3::Bucket RedirectAllRequestsTo": { @@ -20430,9 +23868,9 @@ "AWS::S3::Bucket ReplicationRule": { "DeleteMarkerReplication": "Specifies whether Amazon S3 replicates delete markers\\. If you specify a `Filter` in your replication configuration, you must also include a `DeleteMarkerReplication` element\\. If your `Filter` includes a `Tag` element, the `DeleteMarkerReplication` `Status` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag\\-based rules\\. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config)\\. \nFor more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html)\\. \nIf you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently\\. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations)\\.\n*Required*: No \n*Type*: [DeleteMarkerReplication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-deletemarkerreplication.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Destination": "A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control \\(S3 RTC\\)\\. \n*Required*: Yes \n*Type*: [ReplicationDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationconfiguration-rules-destination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Filter": "A filter that identifies the subset of objects to which the replication rule applies\\. A `Filter` must specify exactly one `Prefix`, `TagFilter`, or an `And` child element\\. The use of the filter field indicates this is a V2 replication configuration\\. V1 does not have this field\\. \n*Required*: No \n*Type*: [ReplicationRuleFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Filter": "A filter that identifies the subset of objects to which the replication rule applies\\. A `Filter` must specify exactly one `Prefix`, `TagFilter`, or an `And` child element\\. The use of the filter field indicates that this is a V2 replication configuration\\. This field isn't supported in a V1 replication configuration\\. \nV1 replication configuration only supports filtering by key prefix\\. To filter using a V1 replication configuration, add the `Prefix` directly as a child element of the `Rule` element\\.\n*Required*: No \n*Type*: [ReplicationRuleFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Id": "A unique identifier for the rule\\. The maximum value is 255 characters\\. If you don't specify a value, AWS CloudFormation generates a random ID\\. When using a V2 replication configuration this property is capitalized as \"ID\"\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Prefix": "An object key name prefix that identifies the object or objects to which the rule applies\\. The maximum prefix length is 1,024 characters\\. To include all objects in a bucket, specify an empty string\\. \nReplacement must be made for object keys containing special characters \\(such as carriage returns\\) when using XML requests\\. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Prefix": "An object key name prefix that identifies the object or objects to which the rule applies\\. The maximum prefix length is 1,024 characters\\. To include all objects in a bucket, specify an empty string\\. To filter using a V1 replication configuration, add the `Prefix` directly as a child element of the `Rule` element\\. \nReplacement must be made for object keys containing special characters \\(such as carriage returns\\) when using XML requests\\. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Priority": "The priority indicates which rule has precedence whenever two or more replication rules conflict\\. Amazon S3 will attempt to replicate objects according to all replication rules\\. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority\\. The higher the number, the higher the priority\\. \nFor more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourceSelectionCriteria": "A container that describes additional filters for identifying the source objects that you want to replicate\\. You can choose to enable or disable the replication of these objects\\. \n*Required*: No \n*Type*: [SourceSelectionCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-sourceselectioncriteria.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Status": "Specifies whether the rule is enabled\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Disabled | Enabled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -20471,8 +23909,8 @@ "NoncurrentVersionExpirationInDays": "\\(Deprecated\\.\\) For buckets with versioning enabled \\(or suspended\\), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire\\. When object versions expire, Amazon S3 permanently deletes them\\. If you specify a transition and expiration time, the expiration time must be later than the transition time\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NoncurrentVersionTransition": "\\(Deprecated\\.\\) For buckets with versioning enabled \\(or suspended\\), specifies when non\\-current objects transition to a specified storage class\\. If you specify a transition and expiration time, the expiration time must be later than the transition time\\. If you specify this property, don't specify the `NoncurrentVersionTransitions` property\\. \n*Required*: Conditional \n*Type*: [NoncurrentVersionTransition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NoncurrentVersionTransitions": "For buckets with versioning enabled \\(or suspended\\), one or more transition rules that specify when non\\-current objects transition to a specified storage class\\. If you specify a transition and expiration time, the expiration time must be later than the transition time\\. If you specify this property, don't specify the `NoncurrentVersionTransition` property\\. \n*Required*: Conditional \n*Type*: List of [NoncurrentVersionTransition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule-noncurrentversiontransition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ObjectSizeGreaterThan": "Specifies the minimum object size in bytes for this rule to apply to\\. For more information about size based rules, see [Lifecycle configuration using size\\-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ObjectSizeLessThan": "Specifies the maximum object size in bytes for this rule to apply to\\. For more information about sized based rules, see [Lifecycle configuration using size\\-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ObjectSizeGreaterThan": "Specifies the minimum object size in bytes for this rule to apply to\\. Objects must be larger than this value in bytes\\. For more information about size based rules, see [Lifecycle configuration using size\\-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ObjectSizeLessThan": "Specifies the maximum object size in bytes for this rule to apply to\\. Objects must be smaller than this value in bytes\\. For more information about sized based rules, see [Lifecycle configuration using size\\-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Prefix": "Object key prefix that identifies one or more objects to which this rule applies\\. \nReplacement must be made for object keys containing special characters \\(such as carriage returns\\) when using XML requests\\. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Status": "If `Enabled`, the rule is currently being applied\\. If `Disabled`, the rule is not currently being applied\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Disabled | Enabled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TagFilters": "Tags to use to identify a subset of objects to which the lifecycle rule applies\\. \n*Required*: No \n*Type*: List of [TagFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-tagfilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -20549,23 +23987,38 @@ "MrapName": "The name of the Multi\\-Region Access Point\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Policy": "The access policy associated with the Multi\\-Region Access Point\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::S3::MultiRegionAccessPointPolicy PolicyStatus": { + "IsPublic": "The policy status for this bucket\\. `TRUE` indicates that this bucket is public\\. `FALSE` indicates that the bucket is not public\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::S3::StorageLens": { "StorageLensConfiguration": "This resource contains the details Amazon S3 Storage Lens configuration\\. \n*Required*: Yes \n*Type*: [StorageLensConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "A set of tags \\(key\u2013value pairs\\) to associate with the Storage Lens configuration\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::S3::StorageLens AccountLevel": { - "ActivityMetrics": "This property contains the details of the account\\-level activity metrics for Amazon S3 Storage Lens\\. \n*Required*: No \n*Type*: [ActivityMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "BucketLevel": "This property contains the details of the account\\-level bucket\\-level configurations for Amazon S3 Storage Lens\\. \n*Required*: Yes \n*Type*: [BucketLevel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ActivityMetrics": "This property contains the details of account\\-level activity metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [ActivityMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdvancedCostOptimizationMetrics": "This property contains the details of account\\-level advanced cost optimization metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [AdvancedCostOptimizationMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedcostoptimizationmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdvancedDataProtectionMetrics": "This property contains the details of account\\-level advanced data protection metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [AdvancedDataProtectionMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advanceddataprotectionmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BucketLevel": "This property contains the details of the account\\-level bucket\\-level configurations for Amazon S3 Storage Lens\\. \n*Required*: Yes \n*Type*: [BucketLevel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DetailedStatusCodesMetrics": "This property contains the details of account\\-level detailed status code metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [DetailedStatusCodesMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-detailedstatuscodesmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::S3::StorageLens ActivityMetrics": { "IsEnabled": "A property that indicates whether the activity metrics is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::S3::StorageLens AdvancedCostOptimizationMetrics": { + "IsEnabled": "Indicates whether advanced cost optimization metrics are enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::S3::StorageLens AdvancedDataProtectionMetrics": { + "IsEnabled": "Indicates whether advanced data protection metrics are enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::S3::StorageLens AwsOrg": { "Arn": "This resource contains the ARN of the AWS Organization\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::S3::StorageLens BucketLevel": { - "ActivityMetrics": "A property for the bucket\\-level activity metrics for Amazon S3 Storage Lens\\. \n*Required*: No \n*Type*: [ActivityMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PrefixLevel": "A property for the bucket\\-level prefix\\-level storage metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [PrefixLevel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ActivityMetrics": "A property for bucket\\-level activity metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [ActivityMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdvancedCostOptimizationMetrics": "A property for bucket\\-level advanced cost optimization metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [AdvancedCostOptimizationMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedcostoptimizationmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AdvancedDataProtectionMetrics": "A property for bucket\\-level advanced data protection metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [AdvancedDataProtectionMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advanceddataprotectionmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DetailedStatusCodesMetrics": "A property for bucket\\-level detailed status code metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [DetailedStatusCodesMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-detailedstatuscodesmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PrefixLevel": "A property for bucket\\-level prefix\\-level storage metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [PrefixLevel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::S3::StorageLens BucketsAndRegions": { "Buckets": "This property contains the details of the buckets for the Amazon S3 Storage Lens configuration\\. This should be the bucket Amazon Resource Name\\(ARN\\)\\. For valid values, see [Buckets ARN format here](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_Include.html#API_control_Include_Contents) in the *Amazon S3 API Reference*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -20578,6 +24031,13 @@ "CloudWatchMetrics": "This property enables the Amazon CloudWatch publishing option for S3 Storage Lens metrics\\. \n*Required*: No \n*Type*: [CloudWatchMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-cloudwatchmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3BucketDestination": "This property contains the details of the bucket where the S3 Storage Lens metrics export will be placed\\. \n*Required*: No \n*Type*: [S3BucketDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::S3::StorageLens DetailedStatusCodesMetrics": { + "IsEnabled": "Indicates whether detailed status code metrics are enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::S3::StorageLens Encryption": { + "SSEKMS": "Specifies the use of AWS Key Management Service keys \\(SSE\\-KMS\\) to encrypt the S3 Storage Lens metrics export file\\. \n*Required*: No \n*Type*: [SSEKMS](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-ssekms.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SSES3": "Specifies the use of an Amazon S3\\-managed key \\(SSE\\-S3\\) to encrypt the S3 Storage Lens metrics export file\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::S3::StorageLens PrefixLevel": { "StorageMetrics": "A property for the prefix\\-level storage metrics for Amazon S3 Storage Lens\\. \n*Required*: Yes \n*Type*: [PrefixLevelStorageMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevelstoragemetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -20593,6 +24053,9 @@ "OutputSchemaVersion": "This property contains the details of the output schema version of the S3 Storage Lens export bucket destination\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Prefix": "This property contains the details of the prefix of the bucket destination of the S3 Storage Lens export \\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::S3::StorageLens SSEKMS": { + "KeyId": "Specifies the Amazon Resource Name \\(ARN\\) of the customer managed AWS KMS key to use for encrypting the S3 Storage Lens metrics export file\\. Amazon S3 only supports symmetric encryption keys\\. For more information, see [Special\\-purpose keys](https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html) in the *AWS Key Management Service Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::S3::StorageLens SelectionCriteria": { "Delimiter": "This property contains the details of the S3 Storage Lens delimiter being used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxDepth": "This property contains the details of the max depth that S3 Storage Lens will collect metrics up to\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -20612,15 +24075,31 @@ "Name": "The name of this access point\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ObjectLambdaConfiguration": "A configuration used when creating an Object Lambda Access Point\\. \n*Required*: Yes \n*Type*: [ObjectLambdaConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-objectlambdaconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::S3ObjectLambda::AccessPoint AwsLambda": { + "FunctionArn": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FunctionPayload": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::S3ObjectLambda::AccessPoint ContentTransformation": { + "AwsLambda": "Property description not available\\. \n*Required*: Yes \n*Type*: [AwsLambda](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-awslambda.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::S3ObjectLambda::AccessPoint ObjectLambdaConfiguration": { - "AllowedFeatures": "A container for allowed features\\. Valid inputs are `GetObject-Range` and `GetObject-PartNumber`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AllowedFeatures": "A container for allowed features\\. Valid inputs are `GetObject-Range`, `GetObject-PartNumber`, `HeadObject-Range`, and `HeadObject-PartNumber`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CloudWatchMetricsEnabled": "A container for whether the CloudWatch metrics configuration is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SupportingAccessPoint": "Standard access point associated with the Object Lambda Access Point\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TransformationConfigurations": "A container for transformation configurations for an Object Lambda Access Point\\. \n*Required*: Yes \n*Type*: List of [TransformationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-transformationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::S3ObjectLambda::AccessPoint PolicyStatus": { + "IsPublic": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::S3ObjectLambda::AccessPoint PublicAccessBlockConfiguration": { + "BlockPublicAcls": "Specifies whether Amazon S3 should block public access control lists \\(ACLs\\) for buckets in this account\\. Setting this element to `TRUE` causes the following behavior: \n+ `PutBucketAcl` and `PutObjectAcl` calls fail if the specified ACL is public\\.\n+ PUT Object calls fail if the request includes a public ACL\\.\n+ PUT Bucket calls fail if the request includes a public ACL\\.\nEnabling this setting doesn't affect existing policies or ACLs\\. \nThis property is not supported for Amazon S3 on Outposts\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BlockPublicPolicy": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account\\. Setting this element to `TRUE` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access\\. \nEnabling this setting doesn't affect existing bucket policies\\. \nThis property is not supported for Amazon S3 on Outposts\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IgnorePublicAcls": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account\\. Setting this element to `TRUE` causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain\\. \nEnabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set\\. \nThis property is not supported for Amazon S3 on Outposts\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RestrictPublicBuckets": "Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account\\. Setting this element to `TRUE` restricts access to buckets with public policies to only AWS service principals and authorized users within this account\\. \nEnabling this setting doesn't affect previously stored bucket policies, except that public and cross\\-account access within any public bucket policy, including non\\-public delegation to specific accounts, is blocked\\. \nThis property is not supported for Amazon S3 on Outposts\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::S3ObjectLambda::AccessPoint TransformationConfiguration": { - "Actions": "A container for the action of an Object Lambda Access Point configuration\\. Valid input is `GetObject`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ContentTransformation": "A container for the content transformation of an Object Lambda Access Point configuration\\. Can include the FunctionArn and FunctionPayload\\. For more information, see [AwsLambdaTransformation](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_AwsLambdaTransformation.html) in the *Amazon S3 API Reference*\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Actions": "A container for the action of an Object Lambda Access Point configuration\\. Valid inputs are `GetObject`, `HeadObject`, `ListObject`, and `ListObjectV2`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ContentTransformation": "A container for the content transformation of an Object Lambda Access Point configuration\\. Can include the FunctionArn and FunctionPayload\\. For more information, see [AwsLambdaTransformation](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_AwsLambdaTransformation.html) in the *Amazon S3 API Reference*\\. \n*Required*: Yes \n*Type*: [ContentTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-contenttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::S3ObjectLambda::AccessPointPolicy": { "ObjectLambdaAccessPoint": "An access point with an attached AWS Lambda function used to access transformed data from an Amazon S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -20644,6 +24123,19 @@ "AWS::S3Outposts::Bucket AbortIncompleteMultipartUpload": { "DaysAfterInitiation": "Specifies the number of days after initiation that Amazon S3 on Outposts aborts an incomplete multipart upload\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::S3Outposts::Bucket Filter": { + "AndOperator": "Property description not available\\. \n*Required*: No \n*Type*: [FilterAndOperator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filterandoperator.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Prefix": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tag": "Property description not available\\. \n*Required*: No \n*Type*: [FilterTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filtertag.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::S3Outposts::Bucket FilterAndOperator": { + "Prefix": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Property description not available\\. \n*Required*: Yes \n*Type*: List of [FilterTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filtertag.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::S3Outposts::Bucket FilterTag": { + "Key": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::S3Outposts::Bucket LifecycleConfiguration": { "Rules": "The container for the lifecycle configuration rules for the objects stored in the S3 on Outposts bucket\\. \n*Required*: Yes \n*Type*: List of [Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-rule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -20651,9 +24143,9 @@ "AbortIncompleteMultipartUpload": "The container for the abort incomplete multipart upload rule\\. \n*Required*: No \n*Type*: [AbortIncompleteMultipartUpload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-abortincompletemultipartupload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExpirationDate": "Specifies the expiration for the lifecycle of the object by specifying an expiry date\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExpirationInDays": "Specifies the expiration for the lifecycle of the object in the form of days that the object has been in the S3 on Outposts bucket\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Filter": "The container for the filter of the lifecycle rule\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Filter": "The container for the filter of the lifecycle rule\\. \n*Required*: No \n*Type*: [Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Id": "The unique identifier for the lifecycle rule\\. The value can't be longer than 255 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Status": "If `Enabled`, the rule is currently being applied\\. If `Disabled`, the rule is not currently being applied\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Status": "If `Enabled`, the rule is currently being applied\\. If `Disabled`, the rule is not currently being applied\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::S3Outposts::BucketPolicy": { "Bucket": "The name of the Amazon S3 Outposts bucket to which the policy applies\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -20673,7 +24165,39 @@ "Description": "Information about the SimpleDB domain\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SES::ConfigurationSet": { - "Name": "The name of the configuration set\\. The name must meet the following requirements: \n+ Contain only letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), or dashes \\(\\-\\)\\.\n+ Contain 64 characters or fewer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "DeliveryOptions": "Specifies whether messages that use the configuration set are required to use Transport Layer Security \\(TLS\\)\\. \n*Required*: No \n*Type*: [DeliveryOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-deliveryoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the configuration set\\. The name must meet the following requirements: \n+ Contain only letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), or dashes \\(\\-\\)\\.\n+ Contain 64 characters or fewer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ReputationOptions": "An object that represents the reputation settings for the configuration set\\. \n*Required*: No \n*Type*: [ReputationOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-reputationoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SendingOptions": "An object that defines whether or not Amazon SES can send email that you send using the configuration set\\. \n*Required*: No \n*Type*: [SendingOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-sendingoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SuppressionOptions": "An object that contains information about the suppression list preferences for your account\\. \n*Required*: No \n*Type*: [SuppressionOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-suppressionoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TrackingOptions": "The name of the custom open and click tracking domain associated with the configuration set\\. \n*Required*: No \n*Type*: [TrackingOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-trackingoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VdmOptions": "The Virtual Deliverability Manager \\(VDM\\) options that apply to the configuration set\\. \n*Required*: No \n*Type*: [VdmOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-vdmoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::ConfigurationSet DashboardOptions": { + "EngagementMetrics": "Specifies the status of your VDM engagement metrics collection\\. Can be one of the following: \n+ `ENABLED` \u2013 Amazon SES enables engagement metrics for the configuration set\\.\n+ `DISABLED` \u2013 Amazon SES disables engagement metrics for the configuration set\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::ConfigurationSet DeliveryOptions": { + "SendingPoolName": "The name of the dedicated IP pool to associate with the configuration set\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TlsPolicy": "Specifies whether messages that use the configuration set are required to use Transport Layer Security \\(TLS\\)\\. If the value is `REQUIRE`, messages are only delivered if a TLS connection can be established\\. If the value is `OPTIONAL`, messages can be delivered in plain text if a TLS connection can't be established\\. \nValid Values: `REQUIRE | OPTIONAL` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::ConfigurationSet GuardianOptions": { + "OptimizedSharedDelivery": "Specifies the status of your VDM optimized shared delivery\\. Can be one of the following: \n+ `ENABLED` \u2013 Amazon SES enables optimized shared delivery for the configuration set\\.\n+ `DISABLED` \u2013 Amazon SES disables optimized shared delivery for the configuration set\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::ConfigurationSet ReputationOptions": { + "ReputationMetricsEnabled": "Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch\\. \nIf the value is `true`, reputation metrics are published\\. If the value is `false`, reputation metrics are not published\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::ConfigurationSet SendingOptions": { + "SendingEnabled": "If `true`, email sending is enabled for the configuration set\\. If `false`, email sending is disabled for the configuration set\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::ConfigurationSet SuppressionOptions": { + "SuppressedReasons": "A list that contains the reasons that email addresses are automatically added to the suppression list for your account\\. This list can contain any or all of the following: \n+ `COMPLAINT` \u2013 Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint\\.\n+ `BOUNCE` \u2013 Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::ConfigurationSet TrackingOptions": { + "CustomRedirectDomain": "The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::ConfigurationSet VdmOptions": { + "DashboardOptions": "Settings for your VDM configuration as applicable to the Dashboard\\. \n*Required*: No \n*Type*: [DashboardOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-dashboardoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "GuardianOptions": "Settings for your VDM configuration as applicable to the Guardian\\. \n*Required*: No \n*Type*: [GuardianOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-guardianoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SES::ConfigurationSetEventDestination": { "ConfigurationSetName": "The name of the configuration set that contains the event destination\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -20684,20 +24208,24 @@ }, "AWS::SES::ConfigurationSetEventDestination DimensionConfiguration": { "DefaultDimensionValue": "The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email\\. The default value must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), dashes \\(\\-\\), at signs \\(@\\), or periods \\(\\.\\)\\.\n+ Contain 256 characters or fewer\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DimensionName": "The name of an Amazon CloudWatch dimension associated with an email sending metric\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), or dashes \\(\\-\\)\\.\n+ Contain 256 characters or fewer\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DimensionName": "The name of an Amazon CloudWatch dimension associated with an email sending metric\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), dashes \\(\\-\\), or colons \\(:\\)\\.\n+ Contain 256 characters or fewer\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DimensionValueSource": "The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch\\. To use the message tags that you specify using an `X-SES-MESSAGE-TAGS` header or a parameter to the `SendEmail`/`SendRawEmail` API, specify `messageTag`\\. To use your own email headers, specify `emailHeader`\\. To put a custom tag on any link included in your email, specify `linkTag`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `emailHeader | linkTag | messageTag` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SES::ConfigurationSetEventDestination EventDestination": { "CloudWatchDestination": "An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination\\. \n*Required*: No \n*Type*: [CloudWatchDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-cloudwatchdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set\\. Set to `true` to enable publishing to this destination; set to `false` to prevent publishing to this destination\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KinesisFirehoseDestination": "An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination\\. \n*Required*: No \n*Type*: [KinesisFirehoseDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MatchingEventTypes": "The type of email sending events to publish to the event destination\\. \n+ `send` \\- The call was successful and Amazon SES is attempting to deliver the email\\.\n+ `reject` \\- Amazon SES determined that the email contained a virus and rejected it\\.\n+ `bounce` \\- The recipient's mail server permanently rejected the email\\. This corresponds to a hard bounce\\.\n+ `complaint` \\- The recipient marked the email as spam\\.\n+ `delivery` \\- Amazon SES successfully delivered the email to the recipient's mail server\\.\n+ `open` \\- The recipient received the email and opened it in their email client\\.\n+ `click` \\- The recipient clicked one or more links in the email\\.\n+ `renderingFailure` \\- Amazon SES did not send the email because of a template rendering issue\\.\n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the event destination\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), or dashes \\(\\-\\)\\.\n+ Contain 64 characters or fewer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "MatchingEventTypes": "The type of email sending events to publish to the event destination\\. \n+ `send` \\- The send request was successful and SES will attempt to deliver the message to the recipient\u2019s mail server\\. \\(If account\\-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed\\.\\)\n+ `reject` \\- SES accepted the email, but determined that it contained a virus and didn\u2019t attempt to deliver it to the recipient\u2019s mail server\\.\n+ `bounce` \\- \\(*Hard bounce*\\) The recipient's mail server permanently rejected the email\\. \\(*Soft bounces* are only included when SES fails to deliver the email after retrying for a period of time\\.\\)\n+ `complaint` \\- The email was successfully delivered to the recipient\u2019s mail server, but the recipient marked it as spam\\.\n+ `delivery` \\- SES successfully delivered the email to the recipient's mail server\\.\n+ `open` \\- The recipient received the message and opened it in their email client\\.\n+ `click` \\- The recipient clicked one or more links in the email\\.\n+ `renderingFailure` \\- The email wasn't sent because of a template rendering issue\\. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data\\. \\(This event type only occurs when you send email using the [https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html](https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html) or [https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html](https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html) API operations\\.\\) \n+ `deliveryDelay` \\- The email couldn't be delivered to the recipient\u2019s mail server because a temporary issue occurred\\. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue\\.\n+ `subscription` \\- The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an *unsubscribe* link as part of your [subscription management](https://docs.aws.amazon.com/ses/latest/dg/sending-email-subscription-management.html)\\.\n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the event destination\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), or dashes \\(\\-\\)\\.\n+ Contain 64 characters or fewer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SnsDestination": "An object that contains the topic ARN associated with an Amazon Simple Notification Service \\(Amazon SNS\\) event destination\\. \n*Required*: No \n*Type*: [SnsDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-snsdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SES::ConfigurationSetEventDestination KinesisFirehoseDestination": { "DeliveryStreamARN": "The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IAMRoleARN": "The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::SES::ConfigurationSetEventDestination SnsDestination": { + "TopicARN": "The ARN of the Amazon SNS topic for email sending events\\. You can find the ARN of a topic by using the [ListTopics](https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) Amazon SNS operation\\. \nFor more information about Amazon SNS topics, see the [Amazon SNS Developer Guide](https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::SES::ContactList": { "ContactListName": "The name of the contact list\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Description": "A description of what the contact list is about\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -20710,6 +24238,36 @@ "DisplayName": "The name of the topic the contact will see\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TopicName": "The name of the topic\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::SES::DedicatedIpPool": { + "PoolName": "The name of the dedicated IP pool that the IP address is associated with\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ScalingMode": "The type of scaling mode\\. \nThe following options are available: \n+ `STANDARD` \\- The customer controls which IPs are part of the dedicated IP pool\\.\n+ `MANAGED` \\- The reputation and number of IPs is automatically managed by Amazon SES\\.\nThe `STANDARD` option is selected by default if no value is specified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::SES::EmailIdentity": { + "ConfigurationSetAttributes": "Used to associate a configuration set with an email identity\\. \n*Required*: No \n*Type*: [ConfigurationSetAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-configurationsetattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DkimAttributes": "An object that contains information about the DKIM attributes for the identity\\. \n*Required*: No \n*Type*: [DkimAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DkimSigningAttributes": "If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM \\(BYODKIM\\) for DKIM authentication purposes, or, configures the key length to be used for [Easy DKIM](https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html)\\. \n*Required*: No \n*Type*: [DkimSigningAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimsigningattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EmailIdentity": "The email address or domain to verify\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FeedbackAttributes": "Used to enable or disable feedback forwarding for an identity\\. \n*Required*: No \n*Type*: [FeedbackAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-feedbackattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MailFromAttributes": "Used to enable or disable the custom Mail\\-From domain configuration for an email identity\\. \n*Required*: No \n*Type*: [MailFromAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-mailfromattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::EmailIdentity ConfigurationSetAttributes": { + "ConfigurationSetName": "The configuration set to associate with an email identity\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::EmailIdentity DkimAttributes": { + "SigningEnabled": "Sets the DKIM signing configuration for the identity\\. \n When you set this value `true`, then the messages that are sent from the identity are signed using DKIM\\. If you set this value to `false`, your messages are sent without DKIM signing\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::EmailIdentity DkimSigningAttributes": { + "DomainSigningPrivateKey": "\\[Bring Your Own DKIM\\] A private key that's used to generate a DKIM signature\\. \nThe private key must use 1024 or 2048\\-bit RSA encryption, and must be encoded using base64 encoding\\. \nRather than embedding sensitive information directly in your CFN templates, we recommend you use dynamic parameters in the stack template to reference sensitive information that is stored and managed outside of CFN, such as in the AWS Systems Manager Parameter Store or AWS Secrets Manager\\. \nFor more information, see the [Do not embed credentials in your templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html#creds) best practice\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DomainSigningSelector": "\\[Bring Your Own DKIM\\] A string that's used to identify a public key in the DNS configuration for a domain\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NextSigningKeyLength": "\\[Easy DKIM\\] The key length of the future DKIM key pair to be generated\\. This can be changed at most once per day\\. \nValid Values: `RSA_1024_BIT | RSA_2048_BIT` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::EmailIdentity FeedbackAttributes": { + "EmailForwardingEnabled": "Sets the feedback forwarding configuration for the identity\\. \n If the value is `true`, you receive email notifications when bounce or complaint events occur\\. These notifications are sent to the address that you specified in the `Return-Path` header of the original email\\. \n You're required to have a method of tracking bounces and complaints\\. If you haven't set up another mechanism for receiving bounce or complaint notifications \\(for example, by setting up an event destination\\), you receive an email notification when these events occur \\(even if this setting is disabled\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::EmailIdentity MailFromAttributes": { + "BehaviorOnMxFailure": "The action to take if the required MX record isn't found when you send an email\\. When you set this value to `USE_DEFAULT_VALUE`, the mail is sent using *amazonses\\.com* as the MAIL FROM domain\\. When you set this value to `REJECT_MESSAGE`, the Amazon SES API v2 returns a `MailFromDomainNotVerified` error, and doesn't attempt to deliver the email\\. \nThese behaviors are taken when the custom MAIL FROM domain configuration is in the `Pending`, `Failed`, and `TemporaryFailure` states\\. \nValid Values: `USE_DEFAULT_VALUE | REJECT_MESSAGE` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MailFromDomain": "The custom MAIL FROM domain that you want the verified identity to use\\. The MAIL FROM domain must meet the following criteria: \n+ It has to be a subdomain of the verified identity\\.\n+ It can't be used to receive email\\.\n+ It can't be used in a \"From\" address if the MAIL FROM domain is a destination for feedback forwarding emails\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::SES::ReceiptFilter": { "Filter": "A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it\\. \n*Required*: Yes \n*Type*: [Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptfilter-filter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -20754,10 +24312,10 @@ "AWS::SES::ReceiptRule Rule": { "Actions": "An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule\\. \n*Required*: No \n*Type*: List of [Action](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Enabled": "If `true`, the receipt rule is active\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the receipt rule\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), or dashes \\(\\-\\)\\.\n+ Start and end with a letter or number\\.\n+ Contain 64 characters or fewer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the receipt rule\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), dashes \\(\\-\\), or periods \\(\\.\\)\\. \n+ Start and end with a letter or number\\.\n+ Contain 64 characters or fewer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Recipients": "The recipient domains and email addresses that the receipt rule applies to\\. If this field is not specified, this rule matches all recipients on all verified domains\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ScanEnabled": "If `true`, then messages that this receipt rule applies to are scanned for spam and viruses\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TlsPolicy": "Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security \\(TLS\\)\\. If this parameter is set to `Require`, Amazon SES bounces emails that are not received over TLS\\. The default is `Optional`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Optional | Require` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "TlsPolicy": "Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security \\(TLS\\)\\. If this parameter is set to `Require`, Amazon SES bounces emails that are not received over TLS\\. The default is `Optional`\\. \nValid Values: `Require | Optional` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SES::ReceiptRule S3Action": { "BucketName": "The name of the Amazon S3 bucket for incoming email\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -20789,10 +24347,21 @@ "TemplateName": "The name of the template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TextPart": "The email body that is visible to recipients whose email clients do not display HTML content\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::SES::VdmAttributes": { + "DashboardAttributes": "Specifies additional settings for your VDM configuration as applicable to the Dashboard\\. \n*Required*: No \n*Type*: [DashboardAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-vdmattributes-dashboardattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "GuardianAttributes": "Specifies additional settings for your VDM configuration as applicable to the Guardian\\. \n*Required*: No \n*Type*: [GuardianAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-vdmattributes-guardianattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::VdmAttributes DashboardAttributes": { + "EngagementMetrics": "Specifies the status of your VDM engagement metrics collection\\. Can be one of the following: \n+ `ENABLED` \u2013 Amazon SES enables engagement metrics for your account\\.\n+ `DISABLED` \u2013 Amazon SES disables engagement metrics for your account\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SES::VdmAttributes GuardianAttributes": { + "OptimizedSharedDelivery": "Specifies the status of your VDM optimized shared delivery\\. Can be one of the following: \n+ `ENABLED` \u2013 Amazon SES enables optimized shared delivery for your account\\.\n+ `DISABLED` \u2013 Amazon SES disables optimized shared delivery for your account\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::SNS::Subscription": { "DeliveryPolicy": "The delivery policy JSON assigned to the subscription\\. Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic\\. For more information, see ` [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) ` in the *Amazon SNS API Reference* and [Message delivery retries](https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html) in the *Amazon SNS Developer Guide*\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Endpoint": "The subscription's endpoint\\. The endpoint value depends on the protocol that you specify\\. For more information, see the `Endpoint` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FilterPolicy": "The filter policy JSON assigned to the subscription\\. Enables the subscriber to filter out unwanted messages\\. For more information, see ` [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) ` in the *Amazon SNS API Reference* and [Message filtering](https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html) in the *Amazon SNS Developer Guide*\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FilterPolicyScope": "This attribute lets you choose the filtering scope by using one of the following string value types: \n+ `MessageAttributes` \\(default\\) \\- The filter is applied on the message attributes\\.\n+ `MessageBody` \\- The filter is applied on the message body\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Protocol": "The subscription's protocol\\. For more information, see the `Protocol` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RawMessageDelivery": "When set to `true`, enables raw message delivery\\. Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints\\. For more information, see ` [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) ` in the *Amazon SNS API Reference*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RedrivePolicy": "When specified, sends undeliverable messages to the specified Amazon SQS dead\\-letter queue\\. Messages that can't be delivered due to client errors \\(for example, when the subscribed endpoint is unreachable\\) or server errors \\(for example, when the service that powers the subscribed endpoint becomes unavailable\\) are held in the dead\\-letter queue for further analysis or reprocessing\\. \nFor more information about the redrive policy and dead\\-letter queues, see [Amazon SQS dead\\-letter queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) in the *Amazon SQS Developer Guide*\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -20802,16 +24371,19 @@ }, "AWS::SNS::Topic": { "ContentBasedDeduplication": "Enables content\\-based deduplication for FIFO topics\\. \n+ By default, `ContentBasedDeduplication` is set to `false`\\. If you create a FIFO topic and this attribute is `false`, you must specify a value for the `MessageDeduplicationId` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action\\. \n+ When you set `ContentBasedDeduplication` to `true`, Amazon SNS uses a SHA\\-256 hash to generate the `MessageDeduplicationId` using the body of the message \\(but not the attributes of the message\\)\\.", - "DisplayName": "The display name to use for an Amazon SNS topic with SMS subscriptions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DataProtectionPolicy": "The body of the policy document you want to use for this topic\\. \nYou can only add one policy per topic\\. \nThe policy must be in JSON string format\\. \nLength Constraints: Maximum length of 30,720\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DisplayName": "The display name to use for an Amazon SNS topic with SMS subscriptions\\. The display name must be maximum 100 characters long, including hyphens \\(\\-\\), underscores \\(\\_\\), spaces, and tabs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FifoTopic": "Set to true to create a FIFO topic\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KmsMasterKeyId": "The ID of an AWS managed customer master key \\(CMK\\) for Amazon SNS or a custom CMK\\. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms)\\. For more examples, see ` [KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) ` in the *AWS Key Management Service API Reference*\\. \nThis property applies only to [server\\-side\\-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Subscription": "The Amazon SNS subscriptions \\(endpoints\\) for this topic\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html) of [Subscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SignatureVersion": "The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS\\. By default, `SignatureVersion` is set to `1`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Subscription": "The Amazon SNS subscriptions \\(endpoints\\) for this topic\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html) of [Subscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The list of tags to add to a new topic\\. \nTo be able to tag a topic on creation, you must have the `sns:CreateTopic` and `sns:TagResource` permissions\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TopicName": "The name of the topic you want to create\\. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long\\. FIFO topic names must end with `.fifo`\\. \nIf you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name\\. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you can't perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "TopicName": "The name of the topic you want to create\\. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long\\. FIFO topic names must end with `.fifo`\\. \nIf you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name\\. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you can't perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TracingConfig": "Tracing mode of an Amazon SNS topic\\. By default `TracingConfig` is set to `PassThrough`, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions\\. If set to Active, SNS will vend X\\-Ray segment data to topic owner account if the sampled flag in the tracing header is true\\. Only supported on standard topics\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SNS::Topic Subscription": { - "Endpoint": "The endpoint that receives notifications from the Amazon SNS topic\\. The endpoint value depends on the protocol that you specify\\. For more information, see the `Endpoint` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Protocol": "The subscription's protocol\\. For more information, see the `Protocol` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Endpoint": "The endpoint that receives notifications from the Amazon SNS topic\\. The endpoint value depends on the protocol that you specify\\. For more information, see the `Endpoint` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Protocol": "The subscription's protocol\\. For more information, see the `Protocol` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SNS::TopicPolicy": { "PolicyDocument": "A policy document that contains permissions to add to the specified SNS topics\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -20824,13 +24396,14 @@ "FifoQueue": "If set to true, creates a FIFO queue\\. If you don't specify this property, Amazon SQS creates a standard queue\\. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Amazon SQS Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "FifoThroughputLimit": "For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group\\. Valid values are `perQueue` and `perMessageGroupId`\\. \nTo enable high throughput for a FIFO queue, set this attribute to `perMessageGroupId` *and* set the `DeduplicationScope` attribute to `messageGroup`\\. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified\\. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Amazon SQS Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KmsDataKeyReusePeriodSeconds": "The length of time in seconds for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again\\. The value must be an integer between 60 \\(1 minute\\) and 86,400 \\(24 hours\\)\\. The default is 300 \\(5 minutes\\)\\. \nA shorter time period provides better security, but results in more calls to AWS KMS, which might incur charges after Free Tier\\. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Amazon SQS Developer Guide*\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "KmsMasterKeyId": "The ID of an AWS managed customer master key \\(CMK\\) for Amazon SQS or a custom CMK\\. To use the AWS managed CMK for Amazon SQS, specify the \\(default\\) alias `alias/aws/sqs`\\. For more information, see the following: \n+ [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Amazon SQS Developer Guide* \n+ [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *Amazon SQS API Reference* \n+ The Customer Master Keys section of the [AWS Key Management Service Best Practices](https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsMasterKeyId": "The ID of an AWS Key Management Service \\(KMS\\) for Amazon SQS, or a custom KMS\\. To use the AWS managed KMS for Amazon SQS, specify a \\(default\\) alias ARN, alias name \\(e\\.g\\. `alias/aws/sqs`\\), key ARN, or key ID\\. For more information, see the following: \n+ [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Amazon SQS Developer Guide* \n+ [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *Amazon SQS API Reference* \n+ [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *AWS Key Management Service API Reference* \n+ The Key Management Service \\(KMS\\) section of the [AWS Key Management Service Best Practices](https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaximumMessageSize": "The limit of how many bytes that a message can contain before Amazon SQS rejects it\\. You can specify an integer value from `1,024` bytes \\(1 KiB\\) to `262,144` bytes \\(256 KiB\\)\\. The default value is `262,144` \\(256 KiB\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MessageRetentionPeriod": "The number of seconds that Amazon SQS retains a message\\. You can specify an integer value from `60` seconds \\(1 minute\\) to `1,209,600` seconds \\(14 days\\)\\. The default value is `345,600` seconds \\(4 days\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "QueueName": "A name for the queue\\. To create a FIFO queue, the name of your FIFO queue must end with the `.fifo` suffix\\. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Amazon SQS Developer Guide*\\. \nIf you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the queue name\\. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *AWS CloudFormation User Guide*\\. \nIf you specify a name, you can't perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ReceiveMessageWaitTimeSeconds": "Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available\\. You can specify an integer from 1 to 20\\. Short polling is used as the default or when you specify 0 for this property\\. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Amazon SQS Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RedriveAllowPolicy": "The string that includes the parameters for the permissions for the dead\\-letter queue redrive permission and which source queues can specify dead\\-letter queues as a JSON object\\. The parameters are as follows: \n+ `redrivePermission`: The permission type that defines which source queues can specify the current queue as the dead\\-letter queue\\. Valid values are:\n + `allowAll`: \\(Default\\) Any source queues in this AWS account in the same Region can specify this queue as the dead\\-letter queue\\.\n + `denyAll`: No source queues can specify this queue as the dead\\-letter queue\\.\n + `byQueue`: Only queues specified by the `sourceQueueArns` parameter can specify this queue as the dead\\-letter queue\\.\n+ `sourceQueueArns`: The Amazon Resource Names \\(ARN\\)s of the source queues that can specify this queue as the dead\\-letter queue and redrive messages\\. You can specify this parameter only when the `redrivePermission` parameter is set to `byQueue`\\. You can specify up to 10 source queue ARNs\\. To allow more than 10 source queues to specify dead\\-letter queues, set the `redrivePermission` parameter to `allowAll`\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RedrivePolicy": "The string that includes the parameters for the dead\\-letter queue functionality of the source queue as a JSON object\\. The parameters are as follows: \n+ `deadLetterTargetArn`: The Amazon Resource Name \\(ARN\\) of the dead\\-letter queue to which Amazon SQS moves messages after the value of `maxReceiveCount` is exceeded\\.\n+ `maxReceiveCount`: The number of times a message is delivered to the source queue before being moved to the dead\\-letter queue\\. When the `ReceiveCount` for a message exceeds the `maxReceiveCount` for a queue, Amazon SQS moves the message to the dead\\-letter\\-queue\\.\nThe dead\\-letter queue of a FIFO queue must also be a FIFO queue\\. Similarly, the dead\\-letter queue of a standard queue must also be a standard queue\\.\n *JSON* \n `{ \"deadLetterTargetArn\" : String, \"maxReceiveCount\" : Integer }` \n *YAML* \n `deadLetterTargetArn : String ` \n `maxReceiveCount : Integer ` \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SqsManagedSseEnabled": "Enables server\\-side queue encryption using SQS owned encryption keys\\. Only one server\\-side encryption option is supported per queue \\(for example, [SSE\\-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE\\-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags that you attach to this queue\\. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *AWS CloudFormation User Guide*\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VisibilityTimeout": "The length of time during which a message will be unavailable after a message is delivered from the queue\\. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue\\. \nValues must be from 0 to 43,200 seconds \\(12 hours\\)\\. If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds\\. \nFor more information about Amazon SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Amazon SQS Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -20848,10 +24421,11 @@ "InstanceId": "The ID of the instance that the SSM document is associated with\\. You must specify the `InstanceId` or `Targets` property\\. \n`InstanceId` has been deprecated\\. To specify an instance ID for an association, use the `Targets` parameter\\. If you use the parameter `InstanceId`, you cannot use the parameters `AssociationName`, `DocumentVersion`, `MaxErrors`, `MaxConcurrency`, `OutputLocation`, or `ScheduleExpression`\\. To use these parameters, you must use the `Targets` parameter\\.\n*Required*: Conditional \n*Type*: String \n*Pattern*: `(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxConcurrency": "The maximum number of targets allowed to run the association at the same time\\. You can specify a number, for example 10, or a percentage of the target set, for example 10%\\. The default value is 100%, which means all targets run the association at the same time\\. \nIf a new managed node starts and attempts to run an association while Systems Manager is running `MaxConcurrency` associations, the association is allowed to run\\. During the next association interval, the new managed node will process its association within the limit specified for `MaxConcurrency`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `7` \n*Pattern*: `^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxErrors": "The number of errors that are allowed before the system stops sending requests to run the association on additional targets\\. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%\\. If you specify 3, for example, the system stops sending requests when the fourth error is received\\. If you specify 0, then the system stops sending requests after the first error is returned\\. If you run an association on 50 managed nodes and set `MaxError` to 10%, then the system stops sending the request when the sixth error is received\\. \nExecutions that are already running an association when `MaxErrors` is reached are allowed to complete, but some of these executions may fail as well\\. If you need to ensure that there won't be more than max\\-errors failed executions, set `MaxConcurrency` to 1 so that executions proceed one at a time\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `7` \n*Pattern*: `^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name of the SSM document that contains the configuration information for the instance\\. You can specify `Command` or `Automation` documents\\. The documents can be AWS\\-predefined documents, documents you created, or a document that is shared with you from another account\\. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: \n`arn:partition:ssm:region:account-id:document/document-name` \nFor example: `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document` \nFor AWS\\-predefined documents and SSM documents you created in your account, you only need to specify the document name\\. For example, AWS\\-ApplyPatchBaseline or My\\-Document\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the SSM document that contains the configuration information for the instance\\. You can specify `Command` or `Automation` documents\\. The documents can be AWS\\-predefined documents, documents you created, or a document that is shared with you from another account\\. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: \n`arn:partition:ssm:region:account-id:document/document-name` \nFor example: `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document` \nFor AWS\\-predefined documents and SSM documents you created in your account, you only need to specify the document name\\. For example, `AWS-ApplyPatchBaseline` or `My-Document`\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OutputLocation": "An Amazon Simple Storage Service \\(Amazon S3\\) bucket where you want to store the output details of the request\\. \n*Required*: No \n*Type*: [InstanceAssociationOutputLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Parameters": "The parameters for the runtime configuration of the document\\. \n*Required*: No \n*Type*: Map of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Parameters": "The parameters for the runtime configuration of the document\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ScheduleExpression": "A cron expression that specifies a schedule when the association runs\\. The schedule runs in Coordinated Universal Time \\(UTC\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ScheduleOffset": "Number of days to wait after the scheduled day to run an association\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SyncCompliance": "The mode for generating association compliance\\. You can specify `AUTO` or `MANUAL`\\. In `AUTO` mode, the system uses the status of the association execution to determine the compliance status\\. If the association execution runs successfully, then the association is `COMPLIANT`\\. If the association execution doesn't run successfully, the association is `NON-COMPLIANT`\\. \nIn `MANUAL` mode, you must specify the `AssociationId` as a parameter for the PutComplianceItems API action\\. In this case, compliance data is not managed by State Manager\\. It is managed by your direct call to the PutComplianceItems API action\\. \nBy default, all associations use `AUTO` mode\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AUTO | MANUAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Targets": "The targets for the association\\. You must specify the `InstanceId` or `Targets` property\\. You can target all instances in an AWS account by specifying the `InstanceIds` key with a value of `*`\\. To view a JSON and a YAML example that targets all instances, see \"Create an association for all managed instances in an AWS account\" on the Examples page\\. \n*Required*: Conditional \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html) \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WaitForSuccessTimeoutSeconds": "The number of seconds the service should wait for the association status to show \"Success\" before proceeding with the stack execution\\. If the association status doesn't show \"Success\" after the specified number of seconds, then stack creation fails\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -20866,27 +24440,28 @@ }, "AWS::SSM::Association Target": { "Key": "User\\-defined criteria for sending commands that target managed nodes that meet the criteria\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `163` \n*Pattern*: `^[\\p{L}\\p{Z}\\p{N}_.:/=\\-@]*$|resource-groups:ResourceTypeFilters|resource-groups:Name` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Values": "User\\-defined criteria that maps to `Key`\\. For example, if you specified `tag:ServerRole`, you could specify Value `WebServer` to run a command on instances that include EC2 tags of `ServerRole,WebServer`\\. \nDepending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Values": "User\\-defined criteria that maps to `Key`\\. For example, if you specified `tag:ServerRole`, you could specify `value:WebServer` to run a command on instances that include EC2 tags of `ServerRole,WebServer`\\. \nDepending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SSM::Document": { - "Attachments": "A list of key\\-value pairs that describe attachments to a version of a document\\. \n*Required*: No \n*Type*: List of [AttachmentsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Content": "The content for the new SSM document in JSON or YAML\\. \nThis parameter also supports `String` data types\\.\n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DocumentFormat": "Specify the document format for the request\\. JSON is the default format\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `JSON | TEXT | YAML` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Attachments": "A list of key\\-value pairs that describe attachments to a version of a document\\. \n*Required*: No \n*Type*: List of [AttachmentsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html) \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Content": "The content for the new SSM document in JSON or YAML\\. For more information about the schemas for SSM document content, see [SSM document schema features and examples](https://docs.aws.amazon.com/systems-manager/latest/userguide/document-schemas-features.html) in the *AWS Systems Manager User Guide*\\. \nThis parameter also supports `String` data types\\.\n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DocumentFormat": "Specify the document format for the request\\. JSON is the default format\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `JSON | TEXT | YAML` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DocumentType": "The type of document to create\\. \n*Allowed Values*: `ApplicationConfigurationSchema` \\| `Automation` \\| `Automation.ChangeTemplate` \\| `Command` \\| `DeploymentStrategy` \\| `Package` \\| `Policy` \\| `Session` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Name": "A name for the SSM document\\. \nYou can't use the following strings as document name prefixes\\. These are reserved by AWS for use as document name prefixes: \n+ `aws-` \n+ `amazon` \n+ `amzn` \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Requires": "A list of SSM documents required by a document\\. This parameter is used exclusively by AWS AppConfig\\. When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes\\. In this case, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document for validation purposes\\. For more information, see [What is AWS AppConfig?](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the * AWS AppConfig User Guide*\\. \n*Required*: No \n*Type*: List of [DocumentRequires](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "A name for the SSM document\\. \nYou can't use the following strings as document name prefixes\\. These are reserved by AWS for use as document name prefixes: \n+ `aws` \n+ `amazon` \n+ `amzn` \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Requires": "A list of SSM documents required by a document\\. This parameter is used exclusively by AWS AppConfig\\. When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes\\. In this case, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document for validation purposes\\. For more information, see [What is AWS AppConfig?](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the * AWS AppConfig User Guide*\\. \n*Required*: No \n*Type*: List of [DocumentRequires](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "AWS CloudFormation resource tags to apply to the document\\. Use tags to help you identify and categorize resources\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TargetType": "Specify a target type to define the kinds of resources the document can run on\\. For example, to run a document on EC2 instances, specify the following value: `/AWS::EC2::Instance`\\. If you specify a value of '/' the document can run on all types of resources\\. If you don't specify a value, the document can't run on any resources\\. For a list of valid resource types, see [AWS resource and property types reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the *AWS CloudFormation User Guide*\\. \n*Required*: No \n*Type*: String \n*Maximum*: `200` \n*Pattern*: `^\\/[\\w\\.\\-\\:\\/]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "VersionName": "An optional field specifying the version of the artifact you are creating with the document\\. For example, \"Release 12, Update 6\"\\. This value is unique across all versions of a document, and can't be changed\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{1,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "TargetType": "Specify a target type to define the kinds of resources the document can run on\\. For example, to run a document on EC2 instances, specify the following value: `/AWS::EC2::Instance`\\. If you specify a value of '/' the document can run on all types of resources\\. If you don't specify a value, the document can't run on any resources\\. For a list of valid resource types, see [AWS resource and property types reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the *AWS CloudFormation User Guide*\\. \n*Required*: No \n*Type*: String \n*Maximum*: `200` \n*Pattern*: `^\\/[\\w\\.\\-\\:\\/]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UpdateMethod": "If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced\\. `Replace` is the default method\\. If you specify `NewVersion` for the `UpdateMethod` parameter, and the `Name` of the document does not match an existing resource, a new document is created\\. When you specify `NewVersion`, the default version of the document is changed to the newly created version\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VersionName": "An optional field specifying the version of the artifact you are creating with the document\\. For example, `Release12.1`\\. This value is unique across all versions of a document, and can't be changed\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{1,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SSM::Document AttachmentsSource": { - "Key": "The key of a key\\-value pair that identifies the location of an attachment to a document\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AttachmentReference | S3FileUrl | SourceUrl` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Name": "The name of the document attachment file\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Key": "The key of a key\\-value pair that identifies the location of an attachment to a document\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AttachmentReference | S3FileUrl | SourceUrl` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the document attachment file\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Values": "The value of a key\\-value pair that identifies the location of an attachment to a document\\. The format for **Value** depends on the type of key you specify\\. \n+ For the key *SourceUrl*, the value is an S3 bucket location\\. For example:" }, "AWS::SSM::Document DocumentRequires": { - "Name": "The name of the required SSM document\\. The name can be an Amazon Resource Name \\(ARN\\)\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Version": "The document version required by the current document\\. \n*Required*: No \n*Type*: String \n*Pattern*: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Name": "The name of the required SSM document\\. The name can be an Amazon Resource Name \\(ARN\\)\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Version": "The document version required by the current document\\. \n*Required*: No \n*Type*: String \n*Pattern*: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SSM::MaintenanceWindow": { "AllowUnassociatedTargets": "Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets\\. If enabled, then you must specify the unregistered instances \\(by instance ID\\) when you register a task with the maintenance window\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -20916,7 +24491,7 @@ "AWS::SSM::MaintenanceWindowTask": { "CutoffBehavior": "The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CANCEL_TASK | CONTINUE_TASK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description of the task\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LoggingInfo": "Information about an Amazon S3 bucket to write task\\-level logs to\\. \n `LoggingInfo` has been deprecated\\. To specify an Amazon S3 bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure\\. For information about how Systems Manager handles these options for the supported maintenance window task types, see [AWS Systems Manager MaintenanceWindowTask TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html)\\.\n*Required*: No \n*Type*: [LoggingInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LoggingInfo": "Information about an Amazon S3 bucket to write Run Command task\\-level logs to\\. \n `LoggingInfo` has been deprecated\\. To specify an Amazon S3 bucket to contain logs for Run Command tasks, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure\\. For information about how Systems Manager handles these options for the supported maintenance window task types, see [AWS::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html)\\.\n*Required*: No \n*Type*: [LoggingInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxConcurrency": "The maximum number of targets this task can be run for, in parallel\\. \nAlthough this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases\\. \nFor maintenance window tasks without a target specified, you can't supply a value for this option\\. Instead, the system inserts a placeholder value of `1`\\. This value doesn't affect the running of your task\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `7` \n*Pattern*: `^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MaxErrors": "The maximum number of errors allowed before this task stops being scheduled\\. \nAlthough this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a [targetless task](https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html) You must provide a value in all other cases\\. \nFor maintenance window tasks without a target specified, you can't supply a value for this option\\. Instead, the system inserts a placeholder value of `1`\\. This value doesn't affect the running of your task\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `7` \n*Pattern*: `^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The task name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -20935,7 +24510,7 @@ }, "AWS::SSM::MaintenanceWindowTask LoggingInfo": { "Region": "The AWS Region where the S3 bucket is located\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "S3Bucket": "The name of an S3 bucket where execution logs are stored \\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "S3Bucket": "The name of an S3 bucket where execution logs are stored\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "S3Prefix": "The Amazon S3 bucket subfolder\\. \n*Required*: No \n*Type*: String \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SSM::MaintenanceWindowTask MaintenanceWindowAutomationParameters": { @@ -20998,7 +24573,7 @@ "Description": "A description of the patch baseline\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GlobalFilters": "A set of global filters used to include patches in the baseline\\. \n*Required*: No \n*Type*: [PatchFilterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the patch baseline\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OperatingSystem": "Defines the operating system the patch baseline applies to\\. The default value is `WINDOWS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AMAZON_LINUX | AMAZON_LINUX_2 | CENTOS | DEBIAN | MACOS | ORACLE_LINUX | RASPBIAN | REDHAT_ENTERPRISE_LINUX | SUSE | UBUNTU | WINDOWS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "OperatingSystem": "Defines the operating system the patch baseline applies to\\. The default value is `WINDOWS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | CENTOS | DEBIAN | MACOS | ORACLE_LINUX | RASPBIAN | REDHAT_ENTERPRISE_LINUX | ROCKY_LINUX | SUSE | UBUNTU | WINDOWS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PatchGroups": "The name of the patch group to be registered with the patch baseline\\. \n*Required*: No \n*Type*: List of String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RejectedPatches": "A list of explicitly rejected patches for the baseline\\. \nFor information about accepted formats for lists of approved patches and rejected patches, see [About package name formats for approved and rejected patch lists](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the * AWS Systems Manager User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RejectedPatchesAction": "The action for Patch Manager to take on patches included in the `RejectedPackages` list\\. \n+ ** `ALLOW_AS_DEPENDENCY` **: A package in the `Rejected` patches list is installed only if it is a dependency of another package\\. It is considered compliant with the patch baseline, and its status is reported as `InstalledOther`\\. This is the default action if no option is specified\\.\n+ ** `BLOCK` **: Packages in the `RejectedPatches` list, and packages that include them as dependencies, aren't installed under any circumstances\\. If a package was installed before it was added to the Rejected patches list, it is considered non\\-compliant with the patch baseline, and its status is reported as `InstalledRejected`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ALLOW_AS_DEPENDENCY | BLOCK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -21055,6 +24630,10 @@ "SourceRegions": "The `SyncSource` AWS Regions included in the resource data sync\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SourceType": "The type of data source for the resource data sync\\. `SourceType` is either `AwsOrganizations` \\(if an organization is present in AWS Organizations\\) or `SingleAccountMultiRegions`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::SSM::ResourcePolicy": { + "Policy": "A policy you want to associate with a resource\\. \n*Required*: Yes \n*Type*: Json \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceArn": "Amazon Resource Name \\(ARN\\) of the resource to which you want to attach a policy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::SSMContacts::Contact": { "Alias": "The unique and identifiable alias of the contact or escalation plan\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[a-z0-9_\\-]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DisplayName": "The full name of the contact or escalation plan\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `255` \n*Pattern*: `^[\\p{L}\\p{Z}\\p{N}_.\\-]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -21086,7 +24665,8 @@ }, "AWS::SSMIncidents::ReplicationSet": { "DeletionProtected": "Determines if the replication set deletion protection is enabled or not\\. If deletion protection is enabled, you can't delete the last Region in the replication set\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Regions": "Specifies the Regions of the replication set\\. \n*Required*: Yes \n*Type*: List of [ReplicationRegion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-replicationset-replicationregion.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Regions": "Specifies the Regions of the replication set\\. \n*Required*: Yes \n*Type*: List of [ReplicationRegion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-replicationset-replicationregion.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "A list of tags to add to the replication set\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SSMIncidents::ReplicationSet RegionConfiguration": { "SseKmsKeyId": "The KMS key ID to use to encrypt your replication set\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -21099,8 +24679,9 @@ "Actions": "The actions that the response plan starts at the beginning of an incident\\. \n*Required*: No \n*Type*: List of [Action](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-action.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ChatChannel": "The AWS Chatbot chat channel used for collaboration during an incident\\. \n*Required*: No \n*Type*: [ChatChannel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-chatchannel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DisplayName": "The human readable name of the response plan\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Engagements": "The contacts and escalation plans that the response plan engages during an incident\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Engagements": "The Amazon Resource Name \\(ARN\\) for the contacts and escalation plans that the response plan engages during an incident\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IncidentTemplate": "Details used to create an incident when using this response plan\\. \n*Required*: Yes \n*Type*: [IncidentTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-incidenttemplate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Integrations": "Information about third\\-party services integrated into the response plan\\. \n*Required*: No \n*Type*: List of [Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-integration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the response plan\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `200` \n*Pattern*: `^[a-zA-Z0-9-_]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -21110,19 +24691,39 @@ "AWS::SSMIncidents::ResponsePlan ChatChannel": { "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 \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::SSMIncidents::ResponsePlan DynamicSsmParameter": { + "Key": "The key parameter to use when running the Systems Manager Automation runbook\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The dynamic parameter value\\. \n*Required*: Yes \n*Type*: [DynamicSsmParameterValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparametervalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SSMIncidents::ResponsePlan DynamicSsmParameterValue": { + "Variable": "Variable dynamic parameters\\. A parameter value is determined when an incident is created\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `INCIDENT_RECORD_ARN | INVOLVED_RESOURCES` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::SSMIncidents::ResponsePlan IncidentTemplate": { "DedupeString": "Used to create only one incident record for an incident\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Impact": "Defines the impact to the customers\\. Providing an impact overwrites the impact provided by a response plan\\.", + "IncidentTags": "Tags to assign to the template\\. When the `StartIncident` API action is called, Incident Manager assigns the tags specified in the template to the incident\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NotificationTargets": "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 using the SNS topics\\. \n*Required*: No \n*Type*: List of [NotificationTargetItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-notificationtargetitem.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Summary": "The summary describes what has happened during the incident\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `4000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Title": "The title of the incident is a brief and easily recognizable\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::SSMIncidents::ResponsePlan Integration": { + "PagerDutyConfiguration": "Information about the PagerDuty service where the response plan creates an incident\\. \n*Required*: Yes \n*Type*: [PagerDutyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::SSMIncidents::ResponsePlan NotificationTargetItem": { "SnsTopicArn": "The Amazon Resource Name \\(ARN\\) of the SNS topic\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1000` \n*Pattern*: `^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::SSMIncidents::ResponsePlan PagerDutyConfiguration": { + "Name": "The name of the PagerDuty configuration\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PagerDutyIncidentConfiguration": "Details about the PagerDuty service associated with the configuration\\. \n*Required*: Yes \n*Type*: [PagerDutyIncidentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyincidentconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecretId": "The ID of the AWS Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SSMIncidents::ResponsePlan PagerDutyIncidentConfiguration": { + "ServiceId": "The ID of the PagerDuty service that the response plan associates with an incident when it launches\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::SSMIncidents::ResponsePlan SsmAutomation": { "DocumentName": "The automation document's name\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DocumentVersion": "The automation document's version to use when running\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DynamicParameters": "The key\\-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook\\. \n*Required*: No \n*Type*: List of [DynamicSsmParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Parameters": "The key\\-value pair parameters to use when running the automation document\\. \n*Required*: No \n*Type*: List of [SsmParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-ssmparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The Amazon Resource Name \\(ARN\\) of the role that the automation document will assume when running commands\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1000` \n*Pattern*: `^arn:aws(-cn|-us-gov)?:iam::([0-9]{12})?:role/.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TargetAccount": "The account that the automation document will be run in\\. This can be in either the management account or an application account\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IMPACTED_ACCOUNT | RESPONSE_PLAN_OWNER_ACCOUNT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -21132,44 +24733,54 @@ "Values": "The value parameter to use when running the automation document\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SSO::Assignment": { - "InstanceArn": "The ARN of the SSO instance under which the operation will be executed\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InstanceArn": "The ARN of the IAM Identity Center instance under which the operation will be executed\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PermissionSetArn": "The ARN of the permission set\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::permissionSet/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}/ps-[a-zA-Z0-9-./]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PrincipalId": "An identifier for an object in AWS SSO, such as a user or group\\. PrincipalIds are GUIDs \\(For example, f81d4fae\\-7dec\\-11d0\\-a765\\-00a0c91e6bf6\\)\\. For more information about PrincipalIds in AWS SSO, see the [AWS SSO Identity Store API Reference](/singlesignon/latest/IdentityStoreAPIReference/welcome.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `47` \n*Pattern*: `^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PrincipalId": "An identifier for an object in IAM Identity Center, such as a user or group\\. PrincipalIds are GUIDs \\(For example, f81d4fae\\-7dec\\-11d0\\-a765\\-00a0c91e6bf6\\)\\. For more information about PrincipalIds in IAM Identity Center, see the [IAM Identity Center Identity Store API Reference](/singlesignon/latest/IdentityStoreAPIReference/welcome.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `47` \n*Pattern*: `^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PrincipalType": "The entity type for which the assignment will be created\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `GROUP | USER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TargetId": "TargetID is an AWS account identifier, typically a 10\\-12 digit string \\(For example, 123456789012\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `12` \n*Maximum*: `12` \n*Pattern*: `\\d{12}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "TargetType": "The entity type for which the assignment will be created\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AWS_ACCOUNT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::SSO::InstanceAccessControlAttributeConfiguration": { - "AccessControlAttributes": "Lists the attributes that are configured for ABAC in the specified AWS SSO instance\\. \n*Required*: No \n*Type*: List of [AccessControlAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InstanceArn": "The ARN of the AWS SSO instance under which the operation will be executed\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "AccessControlAttributes": "Lists the attributes that are configured for ABAC in the specified IAM Identity Center instance\\. \n*Required*: No \n*Type*: List of [AccessControlAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InstanceArn": "The ARN of the IAM Identity Center instance under which the operation will be executed\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::SSO::InstanceAccessControlAttributeConfiguration AccessControlAttribute": { - "Key": "The name of the attribute associated with your identities in your identity source\\. This is used to map a specified attribute in your identity source with an attribute in AWS SSO\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Key": "The name of the attribute associated with your identities in your identity source\\. This is used to map a specified attribute in your identity source with an attribute in IAM Identity Center\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Value": "The value used for mapping a specified attribute to an identity source\\. \n*Required*: Yes \n*Type*: [AccessControlAttributeValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattributevalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SSO::InstanceAccessControlAttributeConfiguration AccessControlAttributeValue": { - "Source": "The identity source to use when mapping a specified attribute to AWS SSO\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Source": "The identity source to use when mapping a specified attribute to IAM Identity Center\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SSO::PermissionSet": { - "Description": "The description of the [AWS::SSO::PermissionSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-resource-sso-permissionset.html#aws-resource-sso-permissionset)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `700` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A0-\\u00FF]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InlinePolicy": "The IAM inline policy that is attached to the permission set\\. \n*Required*: No \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `10240` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InstanceArn": "The ARN of the SSO instance under which the operation will be executed\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ManagedPolicies": "A structure that stores the details of the IAM managed policy\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CustomerManagedPolicyReferences": "Specifies the names and paths of the customer managed policies that you have attached to your permission set\\. \n*Required*: No \n*Type*: List of [CustomerManagedPolicyReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-customermanagedpolicyreference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The description of the [AWS::SSO::PermissionSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-resource-sso-permissionset.html#aws-resource-sso-permissionset)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `700` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InlinePolicy": "The inline policy that is attached to the permission set\\. \nFor `Length Constraints`, if a valid ARN is provided for a permission set, it is possible for an empty inline policy to be returned\\.\n*Required*: No \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `10240` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InstanceArn": "The ARN of the IAM Identity Center instance under which the operation will be executed\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ManagedPolicies": "A structure that stores the details of the AWS managed policy\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the permission set\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Pattern*: `[\\w+=,.@-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PermissionsBoundary": "Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary\\. Specify either `CustomerManagedPolicyReference` to use the name and path of a customer managed policy, or `ManagedPolicyArn` to use the ARN of an AWS managed policy\\. A permissions boundary represents the maximum permissions that any policy can grant your role\\. For more information, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*\\. \nPolicies used as permissions boundaries don't provide permissions\\. You must also attach an IAM policy to the role\\. To learn how the effective permissions for a role are evaluated, see [IAM JSON policy evaluation logic](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) in the *IAM User Guide*\\.\n*Required*: No \n*Type*: [PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-permissionsboundary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RelayStateType": "Used to redirect users within the application during the federation authentication process\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `240` \n*Pattern*: `[a-zA-Z0-9&$@#\\\\\\/%?=~\\-_'\"|!:,.;*+\\[\\]\\ \\(\\)\\{\\}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SessionDuration": "The length of time that the application user sessions are valid for in the ISO\\-8601 standard\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags to attach to the new [AWS::SSO::PermissionSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-resource-sso-permissionset.html#aws-resource-sso-permissionset)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::SSO::PermissionSet CustomerManagedPolicyReference": { + "Name": "The name of the IAM policy that you have configured in each account where you want to deploy your permission set\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\w+=,.@-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Path": "The path to the IAM policy that you have configured in each account where you want to deploy your permission set\\. The default is `/`\\. 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*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `((/[A-Za-z0-9\\.,\\+@=_-]+)*)/` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SSO::PermissionSet PermissionsBoundary": { + "CustomerManagedPolicyReference": "Specifies the name and path of a customer managed policy\\. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set\\. \n*Required*: No \n*Type*: [CustomerManagedPolicyReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-customermanagedpolicyreference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ManagedPolicyArn": "The AWS managed policy ARN that you want to attach to a permission set as a permissions boundary\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::aws:policy/[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::SageMaker::App": { "AppName": "The name of the app\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "AppType": "The type of app\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AppType": "The type of app\\. \n*Allowed Values*: `JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard | Canvas` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DomainId": "The domain ID\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `63` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ResourceSpec": "Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on\\. \n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResourceSpec": "Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on\\. \n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "UserProfileName": "The user profile name\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::SageMaker::App ResourceSpec": { - "InstanceType": "The instance type that the image version runs on\\. \nJupyterServer Apps only support the `system` value\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3dn.24xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.large | ml.r5.xlarge | ml.t3.2xlarge | ml.t3.large | ml.t3.medium | ml.t3.micro | ml.t3.small | ml.t3.xlarge | system` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InstanceType": "The instance type that the image version runs on\\. \n **JupyterServer apps** only support the `system` value\\. \nFor **KernelGateway apps**, the `system` value is translated to `ml.t3.medium`\\. KernelGateway apps also support all other values for available instance types\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.2xlarge | ml.g5.48xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3dn.24xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.large | ml.r5.xlarge | ml.t3.2xlarge | ml.t3.large | ml.t3.medium | ml.t3.micro | ml.t3.small | ml.t3.xlarge | system` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SageMakerImageArn": "The ARN of the SageMaker image that the image version belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SageMakerImageVersionArn": "The ARN of the image version created on the instance\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -21206,6 +24817,7 @@ "DataQualityBaselineConfig": "Configures the constraints and baselines for the monitoring job\\. \n*Required*: No \n*Type*: [DataQualityBaselineConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DataQualityJobInput": "A list of inputs for the monitoring job\\. Currently endpoints are supported as monitoring inputs\\. \n*Required*: Yes \n*Type*: [DataQualityJobInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-dataqualityjobinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DataQualityJobOutputConfig": "The output configuration for monitoring jobs\\. \n*Required*: Yes \n*Type*: [MonitoringOutputConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-monitoringoutputconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EndpointName": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "JobDefinitionName": "The name for the monitoring job definition\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "JobResources": "Identifies the resources to deploy for a monitoring job\\. \n*Required*: Yes \n*Type*: [MonitoringResources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-monitoringresources.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "NetworkConfig": "Specifies networking configuration for the monitoring job\\. \n*Required*: No \n*Type*: [NetworkConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-networkconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -21213,15 +24825,25 @@ "StoppingCondition": "A time limit for how long the monitoring job is allowed to run before stopping\\. \n*Required*: No \n*Type*: [StoppingCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-stoppingcondition.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::SageMaker::DataQualityJobDefinition BatchTransformInput": { + "DataCapturedDestinationS3Uri": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DatasetFormat": "Property description not available\\. \n*Required*: Yes \n*Type*: [DatasetFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-datasetformat.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "LocalPath": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "S3DataDistributionType": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "S3InputMode": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::SageMaker::DataQualityJobDefinition ClusterConfig": { "InstanceCount": "The number of ML compute instances to use in the model monitoring job\\. For distributed processing jobs, specify a value greater than 1\\. The default value is 1\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "InstanceType": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InstanceType": "The ML compute instance type for the processing job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "VolumeKmsKeyId": "The AWS Key Management Service \\(AWS KMS\\) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance\\(s\\) that run the model monitoring job\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "VolumeSizeInGB": "The size of the ML storage volume, in gigabytes, that you want to provision\\. You must specify sufficient ML storage for your scenario\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::SageMaker::DataQualityJobDefinition ConstraintsResource": { "S3Uri": "The Amazon S3 URI for the constraints resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::SageMaker::DataQualityJobDefinition Csv": { + "Header": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::SageMaker::DataQualityJobDefinition DataQualityAppSpecification": { "ContainerArguments": "The arguments to send to the container that the monitoring job runs\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ContainerEntrypoint": "The entrypoint for a container used to run a monitoring job\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -21236,7 +24858,13 @@ "StatisticsResource": "Configuration for monitoring constraints and monitoring statistics\\. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically\\. \n*Required*: No \n*Type*: [StatisticsResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-statisticsresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::SageMaker::DataQualityJobDefinition DataQualityJobInput": { - "EndpointInput": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "BatchTransformInput": "Property description not available\\. \n*Required*: No \n*Type*: [BatchTransformInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "EndpointInput": "Input object for the endpoint \n*Required*: No \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::SageMaker::DataQualityJobDefinition DatasetFormat": { + "Csv": "Property description not available\\. \n*Required*: No \n*Type*: [Csv](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-csv.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Json": "Property description not available\\. \n*Required*: No \n*Type*: [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-json.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Parquet": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::SageMaker::DataQualityJobDefinition EndpointInput": { "EndpointName": "An endpoint in customer's account which has enabled `DataCaptureConfig` enabled\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -21244,6 +24872,9 @@ "S3DataDistributionType": "Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key\\. Defaults to `FullyReplicated` \n*Required*: No \n*Type*: String \n*Allowed values*: `FullyReplicated | ShardedByS3Key` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "S3InputMode": "Whether the `Pipe` or `File` is used as the input mode for transferring data for the monitoring job\\. `Pipe` mode is recommended for large datasets\\. `File` mode is useful for small files that fit in memory\\. Defaults to `File`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `File | Pipe` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::SageMaker::DataQualityJobDefinition Json": { + "Line": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::SageMaker::DataQualityJobDefinition MonitoringOutput": { "S3Output": "The Amazon S3 storage location where the results of a monitoring job are saved\\. \n*Required*: Yes \n*Type*: [S3Output](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-s3output.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, @@ -21268,7 +24899,7 @@ "S3Uri": "The Amazon S3 URI for the statistics resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::SageMaker::DataQualityJobDefinition StoppingCondition": { - "MaxRuntimeInSeconds": "The maximum length of time, in seconds, that a training or compilation job can run\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "MaxRuntimeInSeconds": "The maximum length of time, in seconds, that a training or compilation job can run before it is stopped\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \nThe maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::SageMaker::DataQualityJobDefinition VpcConfig": { "SecurityGroupIds": "The VPC security group IDs, in the form sg\\-xxxxxxxx\\. Specify the security groups for the VPC that is specified in the `Subnets` field\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -21276,12 +24907,12 @@ }, "AWS::SageMaker::Device": { "Device": "Edge device you want to create\\. \n*Required*: No \n*Type*: [Device](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-device-device.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeviceFleetName": "The name of the fleet the device belongs to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DeviceFleetName": "The name of the fleet the device belongs to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "An array of key\\-value pairs that contain metadata to help you categorize and organize your devices\\. Each tag consists of a key and a value, both of which you define\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SageMaker::Device Device": { "Description": "Description of the device\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `40` \n*Pattern*: `[\\S\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DeviceName": "The name of the device\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeviceName": "The name of the device\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "IotThingName": "AWS Internet of Things \\(IoT\\) object name\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `[a-zA-Z0-9:_-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SageMaker::DeviceFleet": { @@ -21297,19 +24928,32 @@ }, "AWS::SageMaker::Domain": { "AppNetworkAccessType": "Specifies the VPC used for non\\-EFS traffic\\. The default value is `PublicInternetOnly`\\. \n+ `PublicInternetOnly` \\- Non\\-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access\n+ `VpcOnly` \\- All Studio traffic is through the specified VPC and subnets\n*Valid Values*: `PublicInternetOnly | VpcOnly` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "AuthMode": "The mode of authentication that members use to access the domain\\. \n*Valid Values*: `SSO | IAM` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "AppSecurityGroupManagement": "The entity that creates and manages the required security groups for inter\\-app communication in `VpcOnly` mode\\. Required when `CreateDomain.AppNetworkAccessType` is `VpcOnly` and `DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn` is provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AuthMode": "The mode of authentication that members use to access the Domain\\. \n*Valid Values*: `SSO | IAM` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DefaultSpaceSettings": "Property description not available\\. \n*Required*: No \n*Type*: [DefaultSpaceSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DefaultUserSettings": "The default user settings\\. \n*Required*: Yes \n*Type*: [UserSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-usersettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DomainName": "The domain name\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "KmsKeyId": "SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed customer master key \\(CMK\\) by default\\. For more control, specify a customer managed CMK\\. \n*Length Constraints*: Maximum length of 2048\\. \n*Pattern*: `.*` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DomainSettings": "A collection of settings that apply to the `SageMaker Domain`\\. These settings are specified through the `CreateDomain` API call\\. \n*Required*: No \n*Type*: [DomainSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsKeyId": "SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key \\(CMK\\) by default\\. For more control, specify a customer managed CMK\\. \n*Length Constraints*: Maximum length of 2048\\. \n*Pattern*: `.*` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SubnetIds": "The VPC subnets that Studio uses for communication\\. \n*Length Constraints*: Maximum length of 32\\. \n*Array members*: Minimum number of 1 item\\. Maximum number of 16 items\\. \n*Pattern*: `[-0-9a-zA-Z]+` \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Tags": "Tags to associated with the Domain\\. Each tag consists of a key and an optional value\\. Tag keys must be unique per resource\\. Tags are searchable using the Search API\\. \nTags that you specify for the Domain are also added to all Apps that are launched in the Domain\\. \n*Array members*: Minimum number of 0 items\\. Maximum number of 50 items\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "VpcId": "The ID of the Amazon Virtual Private Cloud \\(VPC\\) that Studio uses for communication\\. \n*Length Constraints*: Maximum length of 32\\. \n*Pattern*: `[-0-9a-zA-Z]+` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "Tags": "Tags to associated with the Domain\\. Each tag consists of a key and an optional value\\. Tag keys must be unique per resource\\. Tags are searchable using the Search API\\. \nTags that you specify for the Domain are also added to all apps that are launched in the Domain\\. \n*Array members*: Minimum number of 0 items\\. Maximum number of 50 items\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "VpcId": "The ID of the Amazon Virtual Private Cloud \\(Amazon VPC\\) that Studio uses for communication\\. \n*Length Constraints*: Maximum length of 32\\. \n*Pattern*: `[-0-9a-zA-Z]+` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::SageMaker::Domain CustomImage": { "AppImageConfigName": "The name of the AppImageConfig\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ImageName": "The name of the CustomImage\\. Must be unique to your account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ImageVersionNumber": "The version number of the CustomImage\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::SageMaker::Domain DefaultSpaceSettings": { + "ExecutionRole": "The execution role for the space\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "JupyterServerAppSettings": "The JupyterServer app settings\\. \n*Required*: No \n*Type*: [JupyterServerAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterserverappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KernelGatewayAppSettings": "The KernelGateway app settings\\. \n*Required*: No \n*Type*: [KernelGatewayAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-kernelgatewayappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecurityGroups": "The security groups for the Amazon Virtual Private Cloud that the space uses for communication\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SageMaker::Domain DomainSettings": { + "RStudioServerProDomainSettings": "A collection of settings that configure the `RStudioServerPro` Domain\\-level app\\. \n*Required*: No \n*Type*: [RStudioServerProDomainSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SecurityGroupIds": "The security groups for the Amazon Virtual Private Cloud that the `Domain` uses for communication between Domain\\-level apps and user apps\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::SageMaker::Domain JupyterServerAppSettings": { "DefaultResourceSpec": "The default instance type and the Amazon Resource Name \\(ARN\\) of the default SageMaker image used by the JupyterServer app\\. \n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -21317,10 +24961,25 @@ "CustomImages": "A list of custom SageMaker images that are configured to run as a KernelGateway app\\. \n*Required*: No \n*Type*: List of [CustomImage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customimage.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DefaultResourceSpec": "The default instance type and the Amazon Resource Name \\(ARN\\) of the default SageMaker image used by the KernelGateway app\\. \nThe Amazon SageMaker Studio UI does not use the default instance type value set here\\. The default instance type set here is used when Apps are created using the AWS Command Line Interface or AWS CloudFormation and the instance type parameter value is not passed\\.\n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::SageMaker::Domain RSessionAppSettings": { + "CustomImages": "A list of custom SageMaker images that are configured to run as a RSession app\\. \n*Required*: No \n*Type*: List of [CustomImage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customimage.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefaultResourceSpec": "Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on\\. \n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SageMaker::Domain RStudioServerProAppSettings": { + "AccessStatus": "Indicates whether the current user has access to the `RStudioServerPro` app\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UserGroup": "The level of permissions that the user has within the `RStudioServerPro` app\\. This value defaults to `User`\\. The `Admin` value allows the user access to the RStudio Administrative Dashboard\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `R_STUDIO_ADMIN | R_STUDIO_USER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SageMaker::Domain RStudioServerProDomainSettings": { + "DefaultResourceSpec": "A collection that defines the default `InstanceType`, `SageMakerImageArn`, and `SageMakerImageVersionArn` for the Domain\\. \n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DomainExecutionRoleArn": "The ARN of the execution role for the `RStudioServerPro` Domain\\-level app\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RStudioConnectUrl": "A URL pointing to an RStudio Connect server\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RStudioPackageManagerUrl": "A URL pointing to an RStudio Package Manager server\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::SageMaker::Domain ResourceSpec": { - "InstanceType": "The instance type that the image version runs on\\. \nJupyterServer Apps only support the `system` value\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3dn.24xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.large | ml.r5.xlarge | ml.t3.2xlarge | ml.t3.large | ml.t3.medium | ml.t3.micro | ml.t3.small | ml.t3.xlarge | system` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SageMakerImageArn": "The ARN of the SageMaker image that the image version belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SageMakerImageVersionArn": "The ARN of the image version created on the instance\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "InstanceType": "The instance type that the image version runs on\\. \n **JupyterServer apps** only support the `system` value\\. \nFor **KernelGateway apps**, the `system` value is translated to `ml.t3.medium`\\. KernelGateway apps also support all other values for available instance types\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.2xlarge | ml.g5.48xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3dn.24xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.large | ml.r5.xlarge | ml.t3.2xlarge | ml.t3.large | ml.t3.medium | ml.t3.micro | ml.t3.small | ml.t3.xlarge | system` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "LifecycleConfigArn": "The Amazon Resource Name \\(ARN\\) of the Lifecycle Configuration attached to the Resource\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "SageMakerImageArn": "The ARN of the SageMaker image that the image version belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "SageMakerImageVersionArn": "The ARN of the image version created on the instance\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)" }, "AWS::SageMaker::Domain SharingSettings": { "NotebookOutputOption": "Whether to include the notebook cell output when sharing the notebook\\. The default is `Disabled`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Allowed | Disabled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -21331,6 +24990,8 @@ "ExecutionRole": "The execution role for the user\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "JupyterServerAppSettings": "The Jupyter server's app settings\\. \n*Required*: No \n*Type*: [JupyterServerAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterserverappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "KernelGatewayAppSettings": "The kernel gateway app settings\\. \n*Required*: No \n*Type*: [KernelGatewayAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-kernelgatewayappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RSessionAppSettings": "A collection of settings that configure the `RSessionGateway` app\\. \n*Required*: No \n*Type*: [RSessionAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rsessionappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RStudioServerProAppSettings": "A collection of settings that configure user interaction with the `RStudioServerPro` app\\. \n*Required*: No \n*Type*: [RStudioServerProAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverproappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityGroups": "The security groups for the Amazon Virtual Private Cloud \\(VPC\\) that Studio uses for communication\\. \nOptional when the `CreateDomain.AppNetworkAccessType` parameter is set to `PublicInternetOnly`\\. \nRequired when the `CreateDomain.AppNetworkAccessType` parameter is set to `VpcOnly`\\. \nAmazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio\\. Therefore, the number of security groups that you can specify is one less than the maximum number shown\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SharingSettings": "Specifies options for sharing SageMaker Studio notebooks\\. \n*Required*: No \n*Type*: [SharingSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-sharingsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -21375,8 +25036,10 @@ "AsyncInferenceConfig": "Specifies configuration for how an endpoint performs asynchronous inference\\. \n*Required*: No \n*Type*: [AsyncInferenceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-asyncinferenceconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "DataCaptureConfig": "Specifies how to capture endpoint data for model monitor\\. The data capture configuration applies to all production variants hosted at the endpoint\\. \n*Required*: No \n*Type*: [DataCaptureConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EndpointConfigName": "The name of the endpoint configuration\\. \n*Required*: No \n*Type*: String \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ExplainerConfig": "Property description not available\\. \n*Required*: No \n*Type*: [ExplainerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-explainerconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KmsKeyId": "The Amazon Resource Name \\(ARN\\) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint\\. \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`\nThe KMS key policy must grant permission to the IAM role that you specify in your `CreateEndpoint`, `UpdateEndpoint` requests\\. For more information, refer to the AWS Key Management Service section [Using Key Policies in AWS KMS ](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) \nCertain 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 `KmsKeyId` when using an instance type with local storage\\. If any of the models that you specify in the `ProductionVariants` parameter use nitro\\-based instances with local storage, do not specify a value for the `KmsKeyId` parameter\\. If you specify a value for `KmsKeyId` when using any nitro\\-based instances with local storage, the call to `CreateEndpointConfig` fails\\. \nFor 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)\\. \nFor 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*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ProductionVariants": "A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint\\. \n*Required*: Yes \n*Type*: List of [ProductionVariant](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html) \n*Maximum*: `10` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ShadowProductionVariants": "Array of `ProductionVariant` objects\\. There is one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on `ProductionVariants`\\. If you use this field, you can only specify one variant for `ProductionVariants` and one variant for `ShadowProductionVariants`\\. \n*Required*: No \n*Type*: List of [ProductionVariant](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html) \n*Maximum*: `10` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "A list of key\\-value pairs to apply to this resource\\. \nFor more information, see [Resource Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SageMaker::EndpointConfig AsyncInferenceClientConfig": { @@ -21402,6 +25065,40 @@ "AWS::SageMaker::EndpointConfig CaptureOption": { "CaptureMode": "Specifies whether the endpoint captures input data or output data\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Input | Output` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::SageMaker::EndpointConfig ClarifyExplainerConfig": { + "EnableExplanations": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InferenceConfig": "Property description not available\\. \n*Required*: No \n*Type*: [ClarifyInferenceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ShapConfig": "Property description not available\\. \n*Required*: Yes \n*Type*: [ClarifyShapConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::SageMaker::EndpointConfig ClarifyInferenceConfig": { + "ContentTemplate": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FeatureHeaders": "Property description not available\\. \n*Required*: No \n*Type*: List of [ClarifyHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyheader.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FeatureTypes": "Property description not available\\. \n*Required*: No \n*Type*: List of [ClarifyFeatureType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyfeaturetype.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FeaturesAttribute": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "LabelAttribute": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "LabelHeaders": "Property description not available\\. \n*Required*: No \n*Type*: List of [ClarifyHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyheader.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "LabelIndex": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MaxPayloadInMB": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MaxRecordCount": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ProbabilityAttribute": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ProbabilityIndex": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::SageMaker::EndpointConfig ClarifyShapBaselineConfig": { + "MimeType": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ShapBaseline": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ShapBaselineUri": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::SageMaker::EndpointConfig ClarifyShapConfig": { + "NumberOfSamples": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Seed": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ShapBaselineConfig": "Property description not available\\. \n*Required*: Yes \n*Type*: [ClarifyShapBaselineConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TextConfig": "Property description not available\\. \n*Required*: No \n*Type*: [ClarifyTextConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifytextconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "UseLogit": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::SageMaker::EndpointConfig ClarifyTextConfig": { + "Granularity": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Language": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::SageMaker::EndpointConfig DataCaptureConfig": { "CaptureContentTypeHeader": "A list of the JSON and CSV content type that the endpoint captures\\. \n*Required*: No \n*Type*: [CaptureContentTypeHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-datacaptureconfig-capturecontenttypeheader.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "CaptureOptions": "Specifies whether the endpoint captures input data to your model, output data from your model, or both\\. \n*Required*: Yes \n*Type*: List of [CaptureOption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-captureoption.html) \n*Maximum*: `2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -21410,33 +25107,61 @@ "InitialSamplingPercentage": "The percentage of data to capture\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KmsKeyId": "The AWS Key Management Service \\(AWS KMS\\) key that Amazon SageMaker uses to encrypt the captured data at rest using Amazon S3 server\\-side encryption\\. The KmsKeyId can be any of the following formats: Key ID: 1234abcd\\-12ab\\-34cd\\-56ef\\-1234567890ab Key ARN: arn:aws:kms:us\\-west\\-2:111122223333:key/1234abcd\\-12ab\\-34cd\\-56ef\\-1234567890ab Alias name: alias/ExampleAlias Alias name ARN: arn:aws:kms:us\\-west\\-2:111122223333:alias/ExampleAlias If 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\\. The 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 \\(http://docs\\.aws\\.amazon\\.com/kms/latest/developerguide/key\\-policies\\.html\\) in the AWS Key Management Service Developer Guide\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::SageMaker::EndpointConfig ExplainerConfig": { + "ClarifyExplainerConfig": "Property description not available\\. \n*Required*: No \n*Type*: [ClarifyExplainerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyexplainerconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::SageMaker::EndpointConfig ProductionVariant": { "AcceleratorType": "The size of the Elastic Inference \\(EI\\) instance to use for the production variant\\. EI instances provide on\\-demand GPU computing for inference\\. For more information, see [Using Elastic Inference in Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html)\\. For more information, see [Using Elastic Inference in Amazon SageMaker](https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ml.eia1.large | ml.eia1.medium | ml.eia1.xlarge | ml.eia2.large | ml.eia2.medium | ml.eia2.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ContainerStartupHealthCheckTimeoutInSeconds": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InitialInstanceCount": "Number of instances to launch initially\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "InitialVariantWeight": "Determines initial traffic distribution among all of the models that you specify in the endpoint configuration\\. The traffic to a production variant is determined by the ratio of the `VariantWeight` to the sum of all `VariantWeight` values across all ProductionVariants\\. If unspecified, it defaults to 1\\.0\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "InstanceType": "The ML compute instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.c4.large | ml.c4.xlarge | ml.c5.18xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.c5d.18xlarge | ml.c5d.2xlarge | ml.c5d.4xlarge | ml.c5d.9xlarge | ml.c5d.large | ml.c5d.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.inf1.24xlarge | ml.inf1.2xlarge | ml.inf1.6xlarge | ml.inf1.xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p2.16xlarge | ml.p2.8xlarge | ml.p2.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.r5.12xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.large | ml.r5.xlarge | ml.r5d.12xlarge | ml.r5d.24xlarge | ml.r5d.2xlarge | ml.r5d.4xlarge | ml.r5d.large | ml.r5d.xlarge | ml.t2.2xlarge | ml.t2.large | ml.t2.medium | ml.t2.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InstanceType": "The ML compute instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.c4.large | ml.c4.xlarge | ml.c5.18xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.c5d.18xlarge | ml.c5d.2xlarge | ml.c5d.4xlarge | ml.c5d.9xlarge | ml.c5d.large | ml.c5d.xlarge | ml.c6g.12xlarge | ml.c6g.16xlarge | ml.c6g.2xlarge | ml.c6g.4xlarge | ml.c6g.8xlarge | ml.c6g.large | ml.c6g.xlarge | ml.c6gd.12xlarge | ml.c6gd.16xlarge | ml.c6gd.2xlarge | ml.c6gd.4xlarge | ml.c6gd.8xlarge | ml.c6gd.large | ml.c6gd.xlarge | ml.c6gn.12xlarge | ml.c6gn.16xlarge | ml.c6gn.2xlarge | ml.c6gn.4xlarge | ml.c6gn.8xlarge | ml.c6gn.large | ml.c6gn.xlarge | ml.c6i.12xlarge | ml.c6i.16xlarge | ml.c6i.24xlarge | ml.c6i.2xlarge | ml.c6i.32xlarge | ml.c6i.4xlarge | ml.c6i.8xlarge | ml.c6i.large | ml.c6i.xlarge | ml.c7g.12xlarge | ml.c7g.16xlarge | ml.c7g.2xlarge | ml.c7g.4xlarge | ml.c7g.8xlarge | ml.c7g.large | ml.c7g.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.2xlarge | ml.g5.48xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.xlarge | ml.inf1.24xlarge | ml.inf1.2xlarge | ml.inf1.6xlarge | ml.inf1.xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.large | ml.m5d.xlarge | ml.m6g.12xlarge | ml.m6g.16xlarge | ml.m6g.2xlarge | ml.m6g.4xlarge | ml.m6g.8xlarge | ml.m6g.large | ml.m6g.xlarge | ml.m6gd.12xlarge | ml.m6gd.16xlarge | ml.m6gd.2xlarge | ml.m6gd.4xlarge | ml.m6gd.8xlarge | ml.m6gd.large | ml.m6gd.xlarge | ml.p2.16xlarge | ml.p2.8xlarge | ml.p2.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p4d.24xlarge | ml.p4de.24xlarge | ml.r5.12xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.large | ml.r5.xlarge | ml.r5d.12xlarge | ml.r5d.24xlarge | ml.r5d.2xlarge | ml.r5d.4xlarge | ml.r5d.large | ml.r5d.xlarge | ml.r6g.12xlarge | ml.r6g.16xlarge | ml.r6g.2xlarge | ml.r6g.4xlarge | ml.r6g.8xlarge | ml.r6g.large | ml.r6g.xlarge | ml.r6gd.12xlarge | ml.r6gd.16xlarge | ml.r6gd.2xlarge | ml.r6gd.4xlarge | ml.r6gd.8xlarge | ml.r6gd.large | ml.r6gd.xlarge | ml.t2.2xlarge | ml.t2.large | ml.t2.medium | ml.t2.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ModelDataDownloadTimeoutInSeconds": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ModelName": "The name of the model that you want to host\\. This is the name that you specified when creating the model\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ServerlessConfig": "The serverless configuration for an endpoint\\. Specifies a serverless endpoint configuration instead of an instance\\-based endpoint configuration\\. \nServerless Inference is in preview release for Amazon SageMaker and is subject to change\\. We do not recommend using this feature in production environments\\.\n*Required*: No \n*Type*: [ServerlessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-serverlessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "VariantName": "The name of the production variant\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "ServerlessConfig": "The serverless configuration for an endpoint\\. Specifies a serverless endpoint configuration instead of an instance\\-based endpoint configuration\\. \n*Required*: No \n*Type*: [ServerlessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-serverlessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "VariantName": "The name of the production variant\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "VolumeSizeInGB": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::SageMaker::EndpointConfig ServerlessConfig": { - "MaxConcurrency": "The maximum number of concurrent invocations your serverless endpoint can process\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "MaxConcurrency": "The maximum number of concurrent invocations your serverless endpoint can process\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `200` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "MemorySizeInMB": "The memory size of your serverless endpoint\\. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1024` \n*Maximum*: `6144` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::SageMaker::FeatureGroup": { "Description": "A free form description of a `FeatureGroup`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "EventTimeFeatureName": "The name of the feature that stores the `EventTime` of a Record in a `FeatureGroup`\\. \nA `EventTime` is point in time when a new event occurs that corresponds to the creation or update of a `Record` in `FeatureGroup`\\. All `Records` in the `FeatureGroup` must have a corresponding `EventTime`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "FeatureDefinitions": "A list of `Feature`s\\. Each `Feature` must include a `FeatureName` and a `FeatureType`\\. \nValid `FeatureType`s are `Integral`, `Fractional` and `String`\\. \n `FeatureName`s cannot be any of the following: `is_deleted`, `write_time`, `api_invocation_time`\\. \nYou can create up to 2,500 `FeatureDefinition`s per `FeatureGroup`\\. \n*Required*: Yes \n*Type*: List of [FeatureDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html) \n*Maximum*: `2500` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "FeatureDefinitions": "A list of `Feature`s\\. Each `Feature` must include a `FeatureName` and a `FeatureType`\\. \nValid `FeatureType`s are `Integral`, `Fractional` and `String`\\. \n `FeatureName`s cannot be any of the following: `is_deleted`, `write_time`, `api_invocation_time`\\. \nYou can create up to 2,500 `FeatureDefinition`s per `FeatureGroup`\\. \n*Required*: Yes \n*Type*: List of [FeatureDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html) \n*Maximum*: `2500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FeatureGroupName": "The name of the `FeatureGroup`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "OfflineStoreConfig": "The configuration of an `OfflineStore`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "OnlineStoreConfig": "The configuration of an `OnlineStore`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "OfflineStoreConfig": "The configuration of an `OfflineStore`\\. \n*Required*: No \n*Type*: [OfflineStoreConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "OnlineStoreConfig": "The configuration of an `OnlineStore`\\. \n*Required*: No \n*Type*: [OnlineStoreConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RecordIdentifierFeatureName": "The name of the `Feature` whose value uniquely identifies a `Record` defined in the `FeatureGroup` `FeatureDefinitions`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RoleArn": "The Amazon Resource Name \\(ARN\\) of the IAM execution role used to create the feature group\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Tags used to define a `FeatureGroup`\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::SageMaker::FeatureGroup DataCatalogConfig": { + "Catalog": "The name of the Glue table catalog\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Database": "The name of the Glue table database\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TableName": "The name of the Glue table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::SageMaker::FeatureGroup FeatureDefinition": { - "FeatureName": "The name of a feature\\. The type must be a string\\. `FeatureName` cannot be any of the following: `is_deleted`, `write_time`, `api_invocation_time`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "FeatureType": "The value type of a feature\\. Valid values are Integral, Fractional, or String\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Fractional | Integral | String` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "FeatureName": "The name of a feature\\. The type must be a string\\. `FeatureName` cannot be any of the following: `is_deleted`, `write_time`, `api_invocation_time`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FeatureType": "The value type of a feature\\. Valid values are Integral, Fractional, or String\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Fractional | Integral | String` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SageMaker::FeatureGroup OfflineStoreConfig": { + "DataCatalogConfig": "The meta data of the Glue table that is autogenerated when an `OfflineStore` is created\\. \n*Required*: No \n*Type*: [DataCatalogConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DisableGlueTableCreation": "Set to `True` to disable the automatic creation of an AWS Glue table when configuring an `OfflineStore`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "S3StorageConfig": "The Amazon Simple Storage \\(Amazon S3\\) location of `OfflineStore`\\. \n*Required*: Yes \n*Type*: [S3StorageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-s3storageconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TableFormat": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::SageMaker::FeatureGroup OnlineStoreConfig": { + "EnableOnlineStore": "Turn `OnlineStore` off by specifying `False` for the `EnableOnlineStore` flag\\. Turn `OnlineStore` on by specifying `True` for the `EnableOnlineStore` flag\\. \nThe default value is `False`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SecurityConfig": "Use to specify KMS Key ID \\(`KMSKeyId`\\) for at\\-rest encryption of your `OnlineStore`\\. \n*Required*: No \n*Type*: [OnlineStoreSecurityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoresecurityconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::SageMaker::FeatureGroup OnlineStoreSecurityConfig": { + "KmsKeyId": "The ID of the AWS Key Management Service \\(AWS KMS\\) key that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server\\-side encryption\\. \nThe caller \\(either IAM user or IAM role\\) of `CreateFeatureGroup` must have below permissions to the `OnlineStore` `KmsKeyId`: \n+ `\"kms:Encrypt\"` \n+ `\"kms:Decrypt\"` \n+ `\"kms:DescribeKey\"` \n+ `\"kms:CreateGrant\"` \n+ `\"kms:RetireGrant\"` \n+ `\"kms:ReEncryptFrom\"` \n+ `\"kms:ReEncryptTo\"` \n+ `\"kms:GenerateDataKey\"` \n+ `\"kms:ListAliases\"` \n+ `\"kms:ListGrants\"` \n+ `\"kms:RevokeGrant\"` \nThe caller \\(either user or IAM role\\) to all DataPlane operations \\(`PutRecord`, `GetRecord`, `DeleteRecord`\\) must have the following permissions to the `KmsKeyId`: \n+ `\"kms:Decrypt\"` \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::SageMaker::FeatureGroup S3StorageConfig": { + "KmsKeyId": "The AWS Key Management Service \\(KMS\\) key ID of the key used to encrypt any objects written into the `OfflineStore` S3 location\\. \nThe IAM `roleARN` that is passed as a parameter to `CreateFeatureGroup` must have below permissions to the `KmsKeyId`: \n+ `\"kms:GenerateDataKey\"` \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "S3Uri": "The S3 URI, or location in Amazon S3, of `OfflineStore`\\. \nS3 URIs have a format similar to the following: `s3://example-bucket/prefix/`\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::SageMaker::Image": { "ImageDescription": "The description of the image\\. \n*Length Constraints*: Minimum length of 1\\. Maximum length of 512\\. \n*Pattern*: `.*` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -21464,9 +25189,9 @@ "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\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Image": "The path where inference code is stored\\. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint\\. If 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) \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `[\\S]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ImageConfig": "Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud \\(VPC\\)\\. For information about storing containers in a private Docker registry, see [Use a Private Docker Registry for Real\\-Time Inference Containers](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-containers-inference-private.html) \n*Required*: No \n*Type*: [ImageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-model-containerdefinition-imageconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "InferenceSpecificationName": "The inference specification name in the model package version\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InferenceSpecificationName": "The inference specification name in the model package version\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Mode": "Whether the container hosts a single model or multiple models\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `MultiModel | SingleModel` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "ModelDataUrl": "The S3 path where the model artifacts, which result from model training, are stored\\. This path must point to a single gzip compressed tar archive \\(\\.tar\\.gz suffix\\)\\. The S3 path is required for SageMaker built\\-in algorithms, but not if you use your own algorithms\\. For more information on built\\-in algorithms, see [Common Parameters](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html)\\. \nThe model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating\\.\nIf you provide a value for this parameter, SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide\\. AWS STS is activated in your IAM user account by default\\. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region\\. For more information, see [Activating and Deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the * AWS Identity and Access Management User Guide*\\. \nIf you use a built\\-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in `ModelDataUrl`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ModelDataUrl": "The S3 path where the model artifacts, which result from model training, are stored\\. This path must point to a single gzip compressed tar archive \\(\\.tar\\.gz suffix\\)\\. The S3 path is required for SageMaker built\\-in algorithms, but not if you use your own algorithms\\. For more information on built\\-in algorithms, see [Common Parameters](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html)\\. \nThe model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating\\.\nIf you provide a value for this parameter, SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide\\. AWS STS is activated in your AWS account by default\\. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region\\. For more information, see [Activating and Deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the * AWS Identity and Access Management User Guide*\\. \nIf you use a built\\-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in `ModelDataUrl`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ModelPackageName": "The name or Amazon Resource Name \\(ARN\\) of the model package to use to create the model\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `176` \n*Pattern*: `(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? ? @ [ \\ ] ^ _ ` { | } ~`\\. If you don't include this switch, the password can contain punctuation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -21957,15 +26234,15 @@ "IncludeSpace": "Specifies whether to include the space character\\. If you include this switch, the password can contain space characters\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PasswordLength": "The length of the password\\. If you don't include this parameter, the default length is 32 characters\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RequireEachIncludedType": "Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation\\. If you don't include this switch, the password contains at least one of every character type\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SecretStringTemplate": "A template that the generated string must match\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SecretStringTemplate": "A template that the generated string must match\\. When you make a change to this property, a new secret version is created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SecretsManager::Secret ReplicaRegion": { - "KmsKeyId": "The ARN, key ID, or alias of the KMS key to encrypt the secret\\. If you don't include this field, Secrets Manager uses `aws/secretsmanager`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Region": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "KmsKeyId": "The ARN, key ID, or alias of the KMS key to encrypt the secret\\. If you don't include this field, Secrets Manager uses `aws/secretsmanager`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Region": "\\(Optional\\) A string that represents a `Region`, for example \"us\\-east\\-1\"\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SecretsManager::SecretTargetAttachment": { "SecretId": "The ARN or name of the secret\\. To reference a secret also created in this template, use the see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html) function with the secret's logical ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TargetId": "The ID of the database or cluster\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TargetId": "The ID of the database or cluster\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "TargetType": "A string that defines the type of service or database associated with the secret\\. This value instructs Secrets Manager how to update the secret with the details of the service or database\\. This value must be one of the following: \n+ AWS::RDS::DBInstance\n+ AWS::RDS::DBCluster\n+ AWS::Redshift::Cluster\n+ AWS::DocDB::DBInstance\n+ AWS::DocDB::DBCluster\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::SecurityHub::Hub": { @@ -21991,7 +26268,7 @@ "AWS::ServiceCatalog::CloudFormationProduct ProvisioningArtifactProperties": { "Description": "The description of the provisioning artifact, including how it differs from the previous provisioning artifact\\. \n*Required*: No \n*Type*: String \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DisableTemplateValidation": "If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Info": "Specify the template source with one of the following options, but not both\\. Keys accepted: \\[ `LoadTemplateFromURL`, `ImportFromPhysicalId` \\] \nThe URL of the AWS CloudFormation template in Amazon S3, AWS CodeCommit, or GitHub in JSON format\\. Specify the URL in JSON format as follows: \n `\"LoadTemplateFromURL\": \"https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/...\"` \n `ImportFromPhysicalId`: The physical id of the resource that contains the template\\. Currently only supports AWS CloudFormation stack arn\\. Specify the physical id in JSON format as follows: `ImportFromPhysicalId: \u201carn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Info": "Specify the template source with one of the following options, but not both\\. Keys accepted: \\[ `LoadTemplateFromURL`, `ImportFromPhysicalId` \\] \nThe URL of the AWS CloudFormation template in Amazon S3 in JSON format\\. Specify the URL in JSON format as follows: \n `\"LoadTemplateFromURL\": \"https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/...\"` \n `ImportFromPhysicalId`: The physical id of the resource that contains the template\\. Currently only supports AWS CloudFormation stack arn\\. Specify the physical id in JSON format as follows: `ImportFromPhysicalId: \u201carn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the provisioning artifact \\(for example, v1 v2beta\\)\\. No spaces are allowed\\. \n*Required*: No \n*Type*: String \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::ServiceCatalog::CloudFormationProvisionedProduct": { @@ -22000,7 +26277,7 @@ "PathId": "The path identifier of the product\\. This value is optional if the product has a default path, and required if the product has more than one path\\. To list the paths for a product, use [ListLaunchPaths](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_ListLaunchPaths.html)\\. \nYou must provide the name or ID, but not both\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z0-9_\\-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PathName": "The name of the path\\. This value is optional if the product has a default path, and required if the product has more than one path\\. To list the paths for a product, use [ListLaunchPaths](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_ListLaunchPaths.html)\\. \nYou must provide the name or ID, but not both\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ProductId": "The product identifier\\. \nYou must specify either the ID or the name of the product, but not both\\.\n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z0-9_\\-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ProductName": "A user\\-friendly name for the provisioned product\\. This value must be unique for the AWS account and cannot be updated after the product is provisioned\\. \nEach time a stack is created or updated, if `ProductName` is provided it will successfully resolve to `ProductId` as long as only one product exists in the account or Region with that `ProductName`\\. \nYou must specify either the name or the ID of the product, but not both\\.\n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[a-zA-Z0-9][a-zA-Z0-9._-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProductName": "The name of the Service Catalog product\\. \nEach time a stack is created or updated, if `ProductName` is provided it will successfully resolve to `ProductId` as long as only one product exists in the account or Region with that `ProductName`\\. \nYou must specify either the name or the ID of the product, but not both\\.\n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[a-zA-Z0-9][a-zA-Z0-9._-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ProvisionedProductName": "A user\\-friendly name for the provisioned product\\. This value must be unique for the AWS account and cannot be updated after the product is provisioned\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[a-zA-Z0-9][a-zA-Z0-9._-]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ProvisioningArtifactId": "The identifier of the provisioning artifact \\(also known as a version\\)\\. \nYou must specify either the ID or the name of the provisioning artifact, but not both\\.\n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z0-9_\\-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ProvisioningArtifactName": "The name of the provisioning artifact \\(also known as a version\\) for the product\\. This name must be unique for the product\\. \n You must specify either the name or the ID of the provisioning artifact, but not both\\. You must also specify either the name or the ID of the product, but not both\\.\n*Required*: Conditional \n*Type*: String \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -22053,8 +26330,8 @@ "AWS::ServiceCatalog::PortfolioPrincipalAssociation": { "AcceptLanguage": "The language code\\. \n+ `en` \\- English \\(default\\)\n+ `jp` \\- Japanese\n+ `zh` \\- Chinese\n*Required*: No \n*Type*: String \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "PortfolioId": "The portfolio identifier\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z0-9_\\-]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PrincipalARN": "The ARN of the principal \\(IAM user, role, or group\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "PrincipalType": "The principal type\\. The supported value is `IAM`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IAM` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "PrincipalARN": "The ARN of the principal \\(IAM user, role, or group\\)\\. This field allows an ARN with no `accountID` if `PrincipalType` is `IAM_PATTERN`\\. \nYou can associate multiple `IAM` patterns even if the account has no principal with that name\\. This is useful in Principal Name Sharing if you want to share a principal without creating it in the account that owns the portfolio\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "PrincipalType": "The principal type\\. The supported value is `IAM` if you use a fully defined ARN, or `IAM_PATTERN` if you use an ARN with no `accountID`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IAM | IAM_PATTERN` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ServiceCatalog::PortfolioProductAssociation": { "AcceptLanguage": "The language code\\. \n+ `en` \\- English \\(default\\)\n+ `jp` \\- Japanese\n+ `zh` \\- Chinese\n*Required*: No \n*Type*: String \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -22138,12 +26415,12 @@ }, "AWS::ServiceDiscovery::Instance": { "InstanceAttributes": "A string map that contains the following information for the service that you specify in `ServiceId`: \n+ The attributes that apply to the records that are defined in the service\\. \n+ For each attribute, the applicable value\\.\nSupported attribute keys include the following: \nAWS\\_ALIAS\\_DNS\\_NAME \nIf you want AWS Cloud Map to create a Route\u00a053 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer\\. For information about how to get the DNS name, see [AliasTarget\\->DNSName](https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-DNSName) in the *Route\u00a053 API Reference*\\. \nNote the following: \n+ The configuration for the service that is specified by `ServiceId` must include settings for an `A` record, an `AAAA` record, or both\\.\n+ In the service that is specified by `ServiceId`, the value of `RoutingPolicy` must be `WEIGHTED`\\.\n+ If the service that is specified by `ServiceId` includes `HealthCheckConfig` settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record\\.\n+ Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers\\.\n+ If you specify a value for `AWS_ALIAS_DNS_NAME`, don't specify values for any of the `AWS_INSTANCE` attributes\\. \nAWS\\_EC2\\_INSTANCE\\_ID \n*HTTP namespaces only\\.* The Amazon EC2 instance ID for the instance\\. The `AWS_INSTANCE_IPV4` attribute contains the primary private IPv4 address\\. When creating resources with a type of [AWS::ServiceDiscovery::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html), if the `AWS_EC2_INSTANCE_ID` attribute is specified, the only other attribute that can be specified is `AWS_INIT_HEALTH_STATUS`\\. After the resource has been created, the `AWS_INSTANCE_IPV4` attribute contains the primary private IPv4 address\\. \nAWS\\_INIT\\_HEALTH\\_STATUS \nIf the service configuration includes `HealthCheckCustomConfig`, when creating resources with a type of [AWS::ServiceDiscovery::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-instance.html) you can optionally use `AWS_INIT_HEALTH_STATUS` to specify the initial status of the custom health check, `HEALTHY` or `UNHEALTHY`\\. If you don't specify a value for `AWS_INIT_HEALTH_STATUS`, the initial status is `HEALTHY`\\. This attribute can only be used when creating resources and will not be seen on existing resources\\. \nAWS\\_INSTANCE\\_CNAME \nIf the service configuration includes a `CNAME` record, the domain name that you want Route\u00a053 to return in response to DNS queries, for example, `example.com`\\. \nThis value is required if the service specified by `ServiceId` includes settings for an `CNAME` record\\. \nAWS\\_INSTANCE\\_IPV4 \nIf the service configuration includes an `A` record, the IPv4 address that you want Route\u00a053 to return in response to DNS queries, for example, `192.0.2.44`\\. \nThis value is required if the service specified by `ServiceId` includes settings for an `A` record\\. If the service includes settings for an `SRV` record, you must specify a value for `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both\\. \nAWS\\_INSTANCE\\_IPV6 \nIf the service configuration includes an `AAAA` record, the IPv6 address that you want Route\u00a053 to return in response to DNS queries, for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`\\. \nThis value is required if the service specified by `ServiceId` includes settings for an `AAAA` record\\. If the service includes settings for an `SRV` record, you must specify a value for `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both\\. \nAWS\\_INSTANCE\\_PORT \nIf the service includes an `SRV` record, the value that you want Route\u00a053 to return for the port\\. \nIf the service includes `HealthCheckConfig`, the port on the endpoint that you want Route\u00a053 to send requests to\\. \nThis value is required if you specified settings for an `SRV` record or a Route\u00a053 health check when you created the service\\.\n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "InstanceId": "An identifier that you want to associate with the instance\\. Note the following: \n+ If the service that's specified by `ServiceId` includes settings for an `SRV` record, the value of `InstanceId` is automatically included as part of the value for the `SRV` record\\. For more information, see [DnsRecord > Type](https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type)\\.\n+ You can use this value to update an existing instance\\.\n+ To register a new instance, you must specify a value that's unique among instances that you register by using the same service\\. \n+ If you specify an existing `InstanceId` and `ServiceId`, AWS Cloud Map updates the existing DNS records, if any\\. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one\\. \n**Note** \nThe health check isn't deleted immediately, so it will still appear for a while if you submit a `ListHealthChecks` request, for example\\.\n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Pattern*: `^[0-9a-zA-Z_/:.@-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "InstanceId": "An identifier that you want to associate with the instance\\. Note the following: \n+ If the service that's specified by `ServiceId` includes settings for an `SRV` record, the value of `InstanceId` is automatically included as part of the value for the `SRV` record\\. For more information, see [DnsRecord > Type](https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type)\\.\n+ You can use this value to update an existing instance\\.\n+ To register a new instance, you must specify a value that's unique among instances that you register by using the same service\\. \n+ If you specify an existing `InstanceId` and `ServiceId`, AWS Cloud Map updates the existing DNS records, if any\\. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one\\. \n**Note** \nThe health check isn't deleted immediately, so it will still appear for a while if you submit a `ListHealthChecks` request, for example\\.\nDo not include sensitive information in `InstanceId` if the namespace is discoverable by public DNS queries and any `Type` member of `DnsRecord` for the service contains `SRV` because the `InstanceId` is discoverable by public DNS queries\\.\n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Pattern*: `^[0-9a-zA-Z_/:.@-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "ServiceId": "The ID of the service that you want to use for settings for the instance\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::ServiceDiscovery::PrivateDnsNamespace": { "Description": "A description for the namespace\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name that you want to assign to this namespace\\. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route\u00a053 private hosted zone that has the same name as the namespace\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^[!-~]{1,1024}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name that you want to assign to this namespace\\. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route\u00a053 private hosted zone that has the same name as the namespace\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^[!-~]{1,253}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Properties": "Properties for the private DNS namespace\\. \n*Required*: No \n*Type*: [Properties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-privatednsnamespace-properties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags for the namespace\\. Each tag consists of a key and an optional value, both of which you define\\. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: Updates are not supported\\.", "Vpc": "The ID of the Amazon VPC that you want to associate the namespace with\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" @@ -22159,7 +26436,7 @@ }, "AWS::ServiceDiscovery::PublicDnsNamespace": { "Description": "A description for the namespace\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The name that you want to assign to this namespace\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name that you want to assign to this namespace\\. \nDo not include sensitive information in the name\\. The name is publicly available using DNS queries\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Properties": "Properties for the public DNS namespace\\. \n*Required*: No \n*Type*: [Properties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-publicdnsnamespace-properties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "The tags for the namespace\\. Each tag consists of a key and an optional value, both of which you define\\. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: Updates are not supported\\." }, @@ -22174,7 +26451,7 @@ }, "AWS::ServiceDiscovery::Service": { "Description": "The description of the service\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DnsConfig": "A complex type that contains information about the Route\u00a053 DNS records that you want AWS Cloud Map to create when you register an instance\\. \n*Required*: No \n*Type*: [DnsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DnsConfig": "A complex type that contains information about the Route\u00a053 DNS records that you want AWS Cloud Map to create when you register an instance\\. \nThe record types of a service can only be changed by deleting the service and recreating it with a new `Dnsconfig`\\.\n*Required*: No \n*Type*: [DnsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HealthCheckConfig": "*Public DNS and HTTP namespaces only\\.* A complex type that contains settings for an optional health check\\. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in `DnsConfig`\\. \nFor information about the charges for health checks, see [Amazon Route\u00a053 Pricing](http://aws.amazon.com/route53/pricing/)\\. \n*Required*: No \n*Type*: [HealthCheckConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HealthCheckCustomConfig": "A complex type that contains information about an optional custom health check\\. \nIf you specify a health check configuration, you can specify either `HealthCheckCustomConfig` or `HealthCheckConfig` but not both\\.\n*Required*: No \n*Type*: [HealthCheckCustomConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckcustomconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Name": "The name of the service\\. \n*Required*: No \n*Type*: String \n*Pattern*: `((?=^.{1,127}$)^([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9]))*$)|(^\\.$)` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -22215,6 +26492,15 @@ "Type": "The time unit for signature validity: DAYS \\| MONTHS \\| YEARS\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Value": "The numerical value of the time unit for signature validity\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::SimSpaceWeaver::Simulation": { + "Name": "The name of the simulation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "RoleArn": "The Amazon Resource Name \\(ARN\\) of the AWS Identity and Access Management \\(IAM\\) role that the simulation assumes to perform actions\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. For more information about IAM roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *AWS Identity and Access Management User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SchemaS3Location": "The location of the simulation schema in Amazon Simple Storage Service \\(Amazon S3\\)\\. For more information about Amazon S3, see the [https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html)\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-simspaceweaver-simulation-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SimSpaceWeaver::Simulation S3Location": { + "BucketName": "The name of an Amazon S3 bucket\\. For more information about buckets, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the *Amazon Simple Storage Service User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ObjectKey": "The key name of an object in Amazon S3\\. For more information about Amazon S3 objects and object keys, see [Uploading, downloading, and working with objects in Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html) in the *Amazon Simple Storage Service User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::StepFunctions::Activity": { "Name": "The name of the activity\\. \nA name must *not* contain: \n+ white space\n+ brackets `< > { } [ ]` \n+ wildcard characters `? *` \n+ special characters `\" # % \\ ^ | ~ ` $ & , ; : /` \n+ control characters \\(`U+0000-001F`, `U+007F-009F`\\)\nTo enable logging with CloudWatch Logs, the name should only contain 0\\-9, A\\-Z, a\\-z, \\- and \\_\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The list of tags to add to a resource\\. \nTags may only contain Unicode letters, digits, white space, or these symbols: `_ . : / = + - @`\\. \n*Required*: No \n*Type*: List of [TagsEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-activity-tagsentry.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -22224,10 +26510,10 @@ "Value": "The `value` for a key\\-value pair in a tag entry\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::StepFunctions::StateMachine": { - "Definition": "The Amazon States Language definition of the state machine\\. The state machine definition must be in JSON or YAML, and the format of the object must match the format of your AWS Step Functions template file\\. See [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html)\\. \n*Required*: No \n*Type*: [Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-definition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Definition": "The Amazon States Language definition of the state machine\\. The state machine definition must be in JSON or YAML, and the format of the object must match the format of your AWS Step Functions template file\\. See [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DefinitionS3Location": "The name of the S3 bucket where the state machine definition is stored\\. The state machine definition must be a JSON or YAML file\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DefinitionString": "The Amazon States Language definition of the state machine\\. The state machine definition must be in JSON\\. See [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "DefinitionSubstitutions": "A map \\(string to string\\) that specifies the mappings for placeholder variables in the state machine definition\\. This enables the customer to inject values obtained at runtime, for example from intrinsic functions, in the state machine definition\\. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key\\-value map\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DefinitionSubstitutions": "A map \\(string to string\\) that specifies the mappings for placeholder variables in the state machine definition\\. This enables the customer to inject values obtained at runtime, for example from intrinsic functions, in the state machine definition\\. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key\\-value map\\. \n*Required*: No \n*Type*: Map of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "LoggingConfiguration": "Defines what execution history events are logged and where they are logged\\. \nBy default, the `level` is set to `OFF`\\. For more information see [Log Levels](https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) in the AWS Step Functions User Guide\\.\n*Required*: No \n*Type*: [LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-loggingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RoleArn": "The Amazon Resource Name \\(ARN\\) of the IAM role to use for this state machine\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "StateMachineName": "The name of the state machine\\. \nA name must *not* contain: \n+ white space\n+ brackets `< > { } [ ]` \n+ wildcard characters `? *` \n+ special characters `\" # % \\ ^ | ~ ` $ & , ; : /` \n+ control characters \\(`U+0000-001F`, `U+007F-009F`\\)\nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -22258,10 +26544,28 @@ "AWS::StepFunctions::StateMachine TracingConfiguration": { "Enabled": "When set to `true`, X\\-Ray tracing is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::SupportApp::AccountAlias": { + "AccountAlias": "An alias or short name for an AWS account\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::SupportApp::SlackChannelConfiguration": { + "ChannelId": "The channel ID in Slack\\. This ID identifies a channel within a Slack workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ChannelName": "The channel name in Slack\\. This is the channel where you invite the AWS Support App\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ChannelRoleArn": "The Amazon Resource Name \\(ARN\\) of the IAM role for this Slack channel configuration\\. The AWS Support App uses this role to perform AWS Support and Service Quotas actions on your behalf\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NotifyOnAddCorrespondenceToCase": "Whether to get notified when a correspondence is added to your support cases\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NotifyOnCaseSeverity": "The case severity for your support cases that you want to receive notifications\\. You can specify `none`, `all`, or `high`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NotifyOnCreateOrReopenCase": "Whether to get notified when your support cases are created or reopened \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NotifyOnResolveCase": "Whether to get notified when your support cases are resolved\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TeamId": "The team ID in Slack\\. This ID uniquely identifies a Slack workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::SupportApp::SlackWorkspaceConfiguration": { + "TeamId": "The team ID in Slack\\. This ID uniquely identifies a Slack workspace, such as `T012ABCDEFG`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "VersionId": "An identifier used to update an existing Slack workspace configuration in AWS CloudFormation, such as `100`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Synthetics::Canary": { "ArtifactConfig": "A structure that contains the configuration for canary artifacts, including the encryption\\-at\\-rest settings for artifacts that the canary uploads to Amazon S3\\. \n*Required*: No \n*Type*: [ArtifactConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-artifactconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ArtifactS3Location": "The location in Amazon S3 where Synthetics stores artifacts from the runs of this canary\\. Artifacts include the log file, screenshots, and HAR files\\. Specify the full location path, including `s3://` at the beginning of the path\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Code": "Use this structure to input your script code for the canary\\. This structure contains the Lambda handler with the location where the canary should start running the script\\. If the script is stored in an S3 bucket, the bucket name, key, and version are also included\\. If the script is passed into the canary directly, the script code is contained in the value of `Script`\\. \n*Required*: Yes \n*Type*: [Code](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-code.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "DeleteLambdaResourcesOnCanaryDeletion": "Specifies whether AWS CloudFormation is to also delete the Lambda functions and layers used by this canary, when the canary is deleted\\. The default is false\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ExecutionRoleArn": "The ARN of the IAM role to be used to run the canary\\. This role must already exist, and must include `lambda.amazonaws.com` as a principal in the trust policy\\. The role must also have the following permissions: \n+ `s3:PutObject` \n+ `s3:GetBucketLocation` \n+ `s3:ListAllMyBuckets` \n+ `cloudwatch:PutMetricData` \n+ `logs:CreateLogGroup` \n+ `logs:CreateLogStream` \n+ `logs:PutLogEvents` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "FailureRetentionPeriod": "The number of days to retain data about failed runs of this canary\\. If you omit this field, the default of 31 days is used\\. The valid range is 1 to 455 days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name for this canary\\. Be sure to give it a descriptive name that distinguishes it from other canaries in your account\\. \nDo not include secrets or proprietary information in your canary names\\. The canary name makes up part of the canary ARN, and the ARN is included in outbound calls over the internet\\. For more information, see [Security Considerations for Synthetics Canaries](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/servicelens_canaries_security.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `21` \n*Pattern*: `^[0-9a-z_\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -22311,6 +26615,11 @@ "BaseCanaryRunId": "Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary\\. Valid values are `nextrun` to use the screenshots from the next run after this update is made, `lastrun` to use the screenshots from the most recent run before this update was made, or the value of `Id` in the [ CanaryRun](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html) from any past run of this canary\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "BaseScreenshots": "An array of screenshots that are used as the baseline for comparisons during visual monitoring\\. \n*Required*: No \n*Type*: List of [BaseScreenshot](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-basescreenshot.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Synthetics::Group": { + "Name": "A name for the group\\. It can include any Unicode characters\\. \nThe names for all groups in your account, across all Regions, must be unique\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ResourceArns": "The ARNs of the canaries that you want to associate with this group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The list of key\\-value pairs that are associated with the group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Timestream::Database": { "DatabaseName": "The name of the Timestream database\\. \n*Length Constraints*: Minimum length of 3 bytes\\. Maximum length of 256 bytes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "KmsKeyId": "The identifier of the AWS KMS key used to encrypt the data stored in the database\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -22384,21 +26693,81 @@ "TableName": "The name of the Timestream table\\. \n*Length Constraints*: Minimum length of 3 bytes\\. Maximum length of 256 bytes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "The tags to add to the table \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Timestream::Table MagneticStoreRejectedDataLocation": { + "S3Configuration": "Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes\\. \n*Required*: No \n*Type*: [S3Configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Timestream::Table MagneticStoreWriteProperties": { + "EnableMagneticStoreWrites": "A flag to enable magnetic store writes\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MagneticStoreRejectedDataLocation": "The location to write error reports for records rejected asynchronously during magnetic store writes\\. \n*Required*: No \n*Type*: [MagneticStoreRejectedDataLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorerejecteddatalocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Timestream::Table RetentionProperties": { + "MagneticStoreRetentionPeriodInDays": "The duration for which data must be stored in the magnetic store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MemoryStoreRetentionPeriodInHours": "The duration for which data must be stored in the memory store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Timestream::Table S3Configuration": { + "BucketName": "The bucket name of the customer S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EncryptionOption": "The encryption option for the customer S3 location\\. Options are S3 server\\-side encryption with an S3 managed key or AWS managed key\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SSE_KMS | SSE_S3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "KmsKeyId": "The AWS KMS key ID for the customer S3 location when encrypting with an AWS managed key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ObjectKeyPrefix": "The object key preview for the customer S3 location\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `928` \n*Pattern*: `[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Transfer::Agreement": { + "AccessRole": "With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths`\\. We use the file\u2019s parent directory \\(for example, for `--send-file-paths /bucket/dir/file.txt`, parent directory is `/bucket/dir/`\\) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission\\. So, the `AccessRole` needs to provide read and write access to the parent directory of the file location used in the `StartFileTransfer` request\\. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with `StartFileTransfer`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "BaseDirectory": "The landing directory \\(folder\\) for files that are transferred by using the AS2 protocol\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^$|/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Description": "The name or short description that's used to identify the agreement\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `200` \n*Pattern*: `^[\\p{Graph}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LocalProfileId": "A unique identifier for the AS2 local profile\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `19` \n*Maximum*: `19` \n*Pattern*: `^p-([0-9a-f]{17})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PartnerProfileId": "A unique identifier for the partner profile used in the agreement\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `19` \n*Maximum*: `19` \n*Pattern*: `^p-([0-9a-f]{17})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerId": "A system\\-assigned unique identifier for a server instance\\. This identifier indicates the specific server that the agreement uses\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `19` \n*Maximum*: `19` \n*Pattern*: `^s-([0-9a-f]{17})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Status": "The current status of the agreement, either `ACTIVE` or `INACTIVE`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | INACTIVE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Key\\-value pairs that can be used to group and search for agreements\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Transfer::Certificate": { + "ActiveDate": "An optional date that specifies when the certificate becomes active\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Certificate": "The file name for the certificate\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16384` \n*Pattern*: `^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CertificateChain": "The list of certificates that make up the chain for the certificate\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2097152` \n*Pattern*: `^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Description": "The name or description that's used to identity the certificate\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `200` \n*Pattern*: `^[\\p{Graph}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InactiveDate": "An optional date that specifies when the certificate becomes inactive\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PrivateKey": "The file that contains the private key for the certificate that's being imported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Key\\-value pairs that can be used to group and search for certificates\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Usage": "Specifies whether this certificate is used for signing or encryption\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ENCRYPTION | SIGNING` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Transfer::Connector": { + "AccessRole": "With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths`\\. We use the file\u2019s parent directory \\(for example, for `--send-file-paths /bucket/dir/file.txt`, parent directory is `/bucket/dir/`\\) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission\\. So, the `AccessRole` needs to provide read and write access to the parent directory of the file location used in the `StartFileTransfer` request\\. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with `StartFileTransfer`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "As2Config": "A structure that contains the parameters for a connector object\\. \n*Required*: Yes \n*Type*: [As2Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LoggingRole": "The Amazon Resource Name \\(ARN\\) of the AWS Identity and Access Management \\(IAM\\) role that allows a connector to turn on CloudWatch logging for Amazon S3 events\\. When set, you can view connector activity in your CloudWatch logs\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "Key\\-value pairs that can be used to group and search for connectors\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Url": "The URL of the partner's AS2 endpoint\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Transfer::Connector As2Config": { + "Compression": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EncryptionAlgorithm": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LocalProfileId": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MdnResponse": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MdnSigningAlgorithm": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MessageSubject": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PartnerProfileId": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SigningAlgorithm": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::Transfer::Profile": { + "As2Id": "The `As2Id` is the *AS2\\-name*, as defined in the [RFC 4130](https://datatracker.ietf.org/doc/html/rfc4130)\\. For inbound transfers, this is the `AS2-From` header for the AS2 messages sent from the partner\\. For outbound connectors, this is the `AS2-To` header for the AS2 messages sent to the partner using the `StartFileTransfer` API operation\\. This ID cannot include spaces\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\p{Print}\\s]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CertificateIds": "An array of identifiers for the imported certificates\\. You use this identifier for working with profiles and partner profiles\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProfileType": "Indicates whether to list only `LOCAL` type profiles or only `PARTNER` type profiles\\. If not supplied in the request, the command lists all types of profiles\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `LOCAL | PARTNER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Key\\-value pairs that can be used to group and search for profiles\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::Transfer::Server": { "Certificate": "The Amazon Resource Name \\(ARN\\) of the AWS Certificate Manager \\(ACM\\) certificate\\. Required when `Protocols` is set to `FTPS`\\. \nTo request a new public certificate, see [Request a public certificate](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) in the * AWS Certificate Manager User Guide*\\. \nTo import an existing certificate into ACM, see [Importing certificates into ACM](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the * AWS Certificate Manager User Guide*\\. \nTo request a private certificate to use FTPS through private IP addresses, see [Request a private certificate](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html) in the * AWS Certificate Manager User Guide*\\. \nCertificates with the following cryptographic algorithms and key sizes are supported: \n+ 2048\\-bit RSA \\(RSA\\_2048\\)\n+ 4096\\-bit RSA \\(RSA\\_4096\\)\n+ Elliptic Prime Curve 256 bit \\(EC\\_prime256v1\\)\n+ Elliptic Prime Curve 384 bit \\(EC\\_secp384r1\\)\n+ Elliptic Prime Curve 521 bit \\(EC\\_secp521r1\\)\nThe certificate must be a valid SSL/TLS X\\.509 version 3 certificate with FQDN or IP address specified and information about the issuer\\.\n*Required*: No \n*Type*: String \n*Maximum*: `1600` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Domain": "Specifies the domain of the storage system that is used for file transfers\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EFS | S3` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "EndpointDetails": "The virtual private cloud \\(VPC\\) endpoint settings that are configured for your server\\. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet\\. Your VPC's default security groups are automatically assigned to your endpoint\\. \n*Required*: No \n*Type*: [EndpointDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "EndpointDetails": "The virtual private cloud \\(VPC\\) endpoint settings that are configured for your server\\. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet\\. Your VPC's default security groups are automatically assigned to your endpoint\\. \n*Required*: No \n*Type*: [EndpointDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "EndpointType": "The type of endpoint that you want your server to use\\. You can choose to make your server's endpoint publicly accessible \\(PUBLIC\\) or host it inside your VPC\\. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PUBLIC | VPC | VPC_ENDPOINT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IdentityProviderDetails": "Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`\\. Accepts an array containing all of the information required to use a directory in `AWS_DIRECTORY_SERVICE` or invoke a customer\\-supplied authentication API, including the API Gateway URL\\. Not required when `IdentityProviderType` is set to `SERVICE_MANAGED`\\. \n*Required*: No \n*Type*: [IdentityProviderDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-identityproviderdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IdentityProviderType": "Specifies the mode of authentication for a server\\. The default value is `SERVICE_MANAGED`, which allows you to store and access user credentials within the AWS Transfer Family service\\. \nUse `AWS_DIRECTORY_SERVICE` to provide access to Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your on\\-premises environment or in AWS using AD Connectors\\. This option also requires you to provide a Directory ID using the `IdentityProviderDetails` parameter\\. \nUse the `API_GATEWAY` value to integrate with an identity provider of your choosing\\. The `API_GATEWAY` setting requires you to provide an API Gateway endpoint URL to call for authentication using the `IdentityProviderDetails` parameter\\. \nUse the `AWS_LAMBDA` value to directly use a Lambda function as your identity provider\\. If you choose this value, you must specify the ARN for the lambda function in the `Function` parameter for the `IdentityProviderDetails` data type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA | SERVICE_MANAGED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PostAuthenticationLoginBanner": "Specify a string to display when users connect to a server\\. This string is displayed after the user authenticates\\. \nThe SFTP protocol does not support post\\-authentication display banners\\.\n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\x09-\\x0D\\x20-\\x7E]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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 `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.` \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\x09-\\x0D\\x20-\\x7E]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ProtocolDetails": "The protocol settings that are configured for your server\\. \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\\. \nUse the `TlsSessionResumptionMode` parameter to determine whether or not your Transfer server resumes recent, negotiated sessions through a unique session ID\\. \n*Required*: No \n*Type*: [ProtocolDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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+ `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\nIf 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\\. \nIf `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType` must be `VPC` and the `IdentityProviderType` must be `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`\\. \nIf `Protocol` includes `FTP`, then `AddressAllocationIds` cannot be associated\\. \nIf `Protocol` is set only to `SFTP`, the `EndpointType` can be set to `PUBLIC` and the `IdentityProviderType` can be set to `SERVICE_MANAGED`\\.\n*Required*: No \n*Type*: List of [Protocol](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocol.html) \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IdentityProviderType": "The mode of authentication for a server\\. The default value is `SERVICE_MANAGED`, which allows you to store and access user credentials within the AWS Transfer Family service\\. \nUse `AWS_DIRECTORY_SERVICE` to provide access to Active Directory groups in AWS Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on\\-premises environment or in AWS using AD Connector\\. This option also requires you to provide a Directory ID by using the `IdentityProviderDetails` parameter\\. \nUse the `API_GATEWAY` value to integrate with an identity provider of your choosing\\. The `API_GATEWAY` setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the `IdentityProviderDetails` parameter\\. \nUse the `AWS_LAMBDA` value to directly use an AWS Lambda function as your identity provider\\. If you choose this value, you must specify the ARN for the Lambda function in the `Function` parameter or the `IdentityProviderDetails` data type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA | SERVICE_MANAGED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "LoggingRole": "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 EFSevents\\. When set, you can view user activity in your CloudWatch logs\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PostAuthenticationLoginBanner": "Specifies a string to display when users connect to a server\\. This string is displayed after the user authenticates\\. \nThe SFTP protocol does not support post\\-authentication display banners\\.\n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\x09-\\x0D\\x20-\\x7E]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PreAuthenticationLoginBanner": "Specifies 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 `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.` \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\x09-\\x0D\\x20-\\x7E]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ProtocolDetails": "The protocol settings that are configured for your server\\. \n+ To indicate passive mode \\(for FTP and FTPS protocols\\), use the `PassiveIp` parameter\\. Enter a single dotted\\-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer\\. \n+ To ignore the error that is generated when the client attempts to use the `SETSTAT` command on a file that you are uploading to an Amazon S3 bucket, use the `SetStatOption` parameter\\. To have the AWS Transfer Family server ignore the `SETSTAT` command and upload files without needing to make any changes to your SFTP client, set the value to `ENABLE_NO_OP`\\. If you set the `SetStatOption` parameter to `ENABLE_NO_OP`, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a `SETSTAT` call\\.\n+ To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the `TlsSessionResumptionMode` parameter\\.\n+ `As2Transports` indicates the transport method for the AS2 messages\\. Currently, only HTTP is supported\\.\n*Required*: No \n*Type*: [ProtocolDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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+ `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+ `AS2` \\(Applicability Statement 2\\): used for transporting structured business\\-to\\-business data\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+ If `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType` must be `VPC` and the `IdentityProviderType` must be either `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`\\.\n+ If `Protocol` includes `FTP`, then `AddressAllocationIds` cannot be associated\\.\n+ If `Protocol` is set only to `SFTP`, the `EndpointType` can be set to `PUBLIC` and the `IdentityProviderType` can be set any of the supported identity types: `SERVICE_MANAGED`, `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`\\.\n+ If `Protocol` includes `AS2`, then the `EndpointType` must be `VPC`, and domain must be Amazon S3\\.\n*Required*: No \n*Type*: List of [Protocol](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocol.html) \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SecurityPolicyName": "Specifies the name of the security policy that is attached to the server\\. \n*Required*: No \n*Type*: String \n*Maximum*: `100` \n*Pattern*: `TransferSecurityPolicy-.+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Key\\-value pairs that can be used to group and search for servers\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "WorkflowDetails": "Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow\\. \n*Required*: No \n*Type*: [WorkflowDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "WorkflowDetails": "Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow\\. \nIn addition to a workflow to execute when a file is uploaded completely, `WorkflowDetails` can also contain a workflow ID \\(and execution role\\) for a workflow to execute on partial upload\\. A partial upload occurs when a file is open when the session disconnects\\. \n*Required*: No \n*Type*: [WorkflowDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Transfer::Server EndpointDetails": { "AddressAllocationIds": "A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint\\. \nThis property can only be set when `EndpointType` is set to `VPC` and it is only valid in the `UpdateServer` API\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", @@ -22414,23 +26783,26 @@ "Url": "Provides the location of the service endpoint used to authenticate users\\. \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Transfer::Server ProtocolDetails": { - "PassiveIp": "Indicates 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*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "TlsSessionResumptionMode": "A property used with Transfer 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+ `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**Note** \nNot 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\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED | ENFORCED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "As2Transports": "List of `As2Transport` objects\\. \n*Required*: No \n*Type*: List of [As2Transport](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-as2transport.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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 `aws transfer update-server --protocol-details PassiveIp=0.0.0.0` \nReplace `0.0.0.0` in the example above with the actual IP address you want to use\\. \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](http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/)\\. \n *Special values* \nThe `AUTO` and `0.0.0.0` are special values for the `PassiveIp` parameter\\. The value `PassiveIp=AUTO` is assigned by default to FTP and FTPS type servers\\. In this case, the server automatically responds with one of the endpoint IPs within the PASV response\\. `PassiveIp=0.0.0.0` has a more unique application for its usage\\. For example, if you have a High Availability \\(HA\\) Network Load Balancer \\(NLB\\) environment, where you have 3 subnets, you can only specify a single IP address using the `PassiveIp` parameter\\. This reduces the effectiveness of having High Availability\\. In this case, you can specify `PassiveIp=0.0.0.0`\\. This tells the client to use the same IP address as the Control connection and utilize all AZs for their connections\\. Note, however, that not all FTP clients support the `PassiveIp=0.0.0.0` response\\. FileZilla and WinSCP do support it\\. If you are using other clients, check to see if your client supports the `PassiveIp=0.0.0.0` response\\. \n*Required*: No \n*Type*: String \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \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\\. \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 Amazon CloudWatch Logs, so you can determine when the client is making a `SETSTAT` call\\. \nIf 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\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `DEFAULT | ENABLE_NO_OP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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+ `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**Note** \nNot 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\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED | ENFORCED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Transfer::Server WorkflowDetail": { "ExecutionRole": "Includes the necessary permissions for S3, EFS, and Lambda operations that Transfer can assume, so that all workflow steps can operate on the required resources \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "WorkflowId": "A unique identifier for the workflow\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `19` \n*Maximum*: `19` \n*Pattern*: `^w-([a-z0-9]{17})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Transfer::Server WorkflowDetails": { - "OnUpload": "A trigger that starts a workflow: the workflow begins to execute after a file is uploaded\\. \nTo remove an associated workflow from a server, you can provide an empty `OnUpload` object, as in the following example\\. \n `aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'` \n*Required*: Yes \n*Type*: List of [WorkflowDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "OnPartialUpload": "A trigger that starts a workflow if a file is only partially uploaded\\. You can attach a workflow to a server that executes whenever there is a partial upload\\. \nA *partial upload* occurs when a file is open when the session disconnects\\. \n*Required*: No \n*Type*: List of [WorkflowDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OnUpload": "A trigger that starts a workflow: the workflow begins to execute after a file is uploaded\\. \nTo remove an associated workflow from a server, you can provide an empty `OnUpload` object, as in the following example\\. \n `aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'` \n*Required*: No \n*Type*: List of [WorkflowDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::Transfer::User": { "HomeDirectory": "The landing directory \\(folder\\) for a user when they log in to the server using the client\\. \nA `HomeDirectory` example is `/bucket_name/home/mydirectory`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^$|/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HomeDirectoryMappings": "Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible\\. You will need to specify the \"`Entry`\" and \"`Target`\" pair, where `Entry` shows how the path is made visible and `Target` is the actual Amazon S3 path\\. If you only specify a target, it will be displayed as is\\. You will need to also make sure that your IAM role provides access to paths in `Target`\\. The following is an example\\. \n `'[ { \"Entry\": \"/\", \"Target\": \"/bucket3/customized-reports/\" } ]'` \nIn most cases, you can use this value instead of the session policy to lock your user down to the designated home directory \\(\"chroot\"\\)\\. To do this, you can set `Entry` to '/' and set `Target` to the HomeDirectory parameter value\\. \nIf the target of a logical directory entry does not exist in Amazon S3, the entry will be ignored\\. As a workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your directory\\. If using the CLI, use the `s3api` call instead of `s3` so you can use the put\\-object operation\\. For example, you use the following: `AWS s3api put-object --bucket bucketname --key path/to/folder/`\\. Make sure that the end of the key name ends in a '/' for it to be considered a folder\\.\n*Required*: No \n*Type*: List of [HomeDirectoryMapEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-homedirectorymapentry.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "HomeDirectoryType": "The type of landing directory \\(folder\\) you want your users' home directory to be when they log into the server\\. If you set it to `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients\\. If you set it `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings` for how you want to make Amazon S3 or EFS paths visible to your users\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `LOGICAL | PATH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "HomeDirectoryType": "The type of landing directory \\(folder\\) that you want your users' home directory to be when they log in to the server\\. If you set it to `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients\\. If you set it `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon EFS paths visible to your users\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `LOGICAL | PATH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Policy": "A session policy for your user so you can use the same IAM role across multiple users\\. This policy restricts user access to portions of their Amazon S3 bucket\\. Variables that you can use inside this policy include `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and `${Transfer:HomeBucket}`\\. \nFor session policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name \\(ARN\\) of the policy\\. You save the policy as a JSON blob and pass it in the `Policy` argument\\. \nFor an example of a session policy, see [Example session policy](https://docs.aws.amazon.com/transfer/latest/userguide/session-policy.html)\\. \nFor more information, see [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) in the *AWS Security Token Service API Reference*\\.\n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "PosixProfile": "Specifies the full POSIX identity, including user ID \\(`Uid`\\), group ID \\(`Gid`\\), and any secondary groups IDs \\(`SecondaryGids`\\), that controls your users' access to your Amazon Elastic File System \\(Amazon EFS\\) file systems\\. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems\\. \n*Required*: No \n*Type*: [PosixProfile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-posixprofile.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Role": "Specifies the Amazon Resource Name \\(ARN\\) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system\\. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system\\. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Role": "The Amazon Resource Name \\(ARN\\) of the AWS Identity and Access Management \\(IAM\\) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system\\. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system\\. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ServerId": "A system\\-assigned unique identifier for a server instance\\. This is the specific server that you added your user to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `19` \n*Maximum*: `19` \n*Pattern*: `^s-([0-9a-f]{17})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "SshPublicKeys": "Specifies the public key portion of the Secure Shell \\(SSH\\) keys stored for the described user\\. \n*Required*: No \n*Type*: List of [SshPublicKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-user-sshpublickey.html) \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Tags": "Key\\-value pairs that can be used to group and search for users\\. Tags are metadata attached to users for any purpose\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -22451,12 +26823,69 @@ "Steps": "Specifies the details for the steps that are in the specified workflow\\. \n*Required*: Yes \n*Type*: List of [WorkflowStep](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-workflowstep.html) \n*Maximum*: `8` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Key\\-value pairs that can be used to group and search for workflows\\. Tags are metadata attached to workflows for any purpose\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::Transfer::Workflow CopyStepDetails": { + "DestinationFileLocation": "Property description not available\\. \n*Required*: No \n*Type*: [S3FileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3filelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "OverwriteExisting": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SourceFileLocation": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Transfer::Workflow CustomStepDetails": { + "Name": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SourceFileLocation": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Target": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TimeoutSeconds": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Transfer::Workflow DecryptStepDetails": { + "DestinationFileLocation": "Property description not available\\. \n*Required*: No \n*Type*: [InputFileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-inputfilelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "OverwriteExisting": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SourceFileLocation": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Type": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Transfer::Workflow DeleteStepDetails": { + "Name": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SourceFileLocation": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Transfer::Workflow EfsInputFileLocation": { + "FileSystemId": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Path": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Transfer::Workflow InputFileLocation": { + "EfsFileLocation": "Property description not available\\. \n*Required*: No \n*Type*: [EfsInputFileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-efsinputfilelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "S3FileLocation": "Property description not available\\. \n*Required*: No \n*Type*: [S3InputFileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3inputfilelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Transfer::Workflow S3FileLocation": { + "S3FileLocation": "Property description not available\\. \n*Required*: No \n*Type*: [S3InputFileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3inputfilelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Transfer::Workflow S3InputFileLocation": { + "Bucket": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Key": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Transfer::Workflow S3Tag": { + "Key": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Value": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::Transfer::Workflow TagStepDetails": { + "Name": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "SourceFileLocation": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Tags": "Property description not available\\. \n*Required*: No \n*Type*: List of [S3Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3tag.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::Transfer::Workflow WorkflowStep": { - "CopyStepDetails": "Details for a step that performs a file copy\\. \n Consists of the following values: \n+ A description\n+ An S3 location for the destination of the file copy\\.\n+ A flag that indicates whether or not to overwrite an existing file of the same name\\. The default is `FALSE`\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "CustomStepDetails": "Details for a step that invokes a lambda function\\. \n Consists of the lambda function name, target, and timeout \\(in seconds\\)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "DeleteStepDetails": "Details for a step that deletes the file\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "TagStepDetails": "Details for a step that creates one or more tags\\. \nYou specify one or more tags: each tag contains a key/value pair\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Type": "Currently, the following step types are supported\\. \n+ *Copy*: copy the file to another location\n+ *Custom*: custom step with a lambda target\n+ *Delete*: delete the file\n+ *Tag*: add a tag to the file\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "CopyStepDetails": "Details for a step that performs a file copy\\. \n Consists of the following values: \n+ A description\n+ An Amazon S3 location for the destination of the file copy\\.\n+ A flag that indicates whether to overwrite an existing file of the same name\\. The default is `FALSE`\\.\n*Required*: No \n*Type*: [CopyStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-copystepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "CustomStepDetails": "Details for a step that invokes an AWS Lambda function\\. \nConsists of the Lambda function's name, target, and timeout \\(in seconds\\)\\. \n*Required*: No \n*Type*: [CustomStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-customstepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DecryptStepDetails": "Property description not available\\. \n*Required*: No \n*Type*: [DecryptStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-decryptstepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "DeleteStepDetails": "Details for a step that deletes the file\\. \n*Required*: No \n*Type*: [DeleteStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-deletestepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "TagStepDetails": "Details for a step that creates one or more tags\\. \nYou specify one or more tags\\. Each tag contains a key\\-value pair\\. \n*Required*: No \n*Type*: [TagStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-tagstepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Type": "Currently, the following step types are supported\\. \n+ ** `COPY` ** \\- Copy the file to another location\\.\n+ ** `CUSTOM` ** \\- Perform a custom step with an AWS Lambda function target\\.\n+ ** `DECRYPT` ** \\- Decrypt a file that was encrypted before it was uploaded\\.\n+ ** `DELETE` ** \\- Delete the file\\.\n+ ** `TAG` ** \\- Add a tag to the file\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, + "AWS::VoiceID::Domain": { + "Description": "The client\\-provided description of the domain\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The client\\-provided name for the domain\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ServerSideEncryptionConfiguration": "The server\\-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data\\. \n*Required*: Yes \n*Type*: [ServerSideEncryptionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-voiceid-domain-serversideencryptionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Tags": "The tags used to organize, track, or control access for this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::VoiceID::Domain ServerSideEncryptionConfiguration": { + "KmsKeyId": "The identifier of the KMS key to use to encrypt data stored by Voice ID\\. Voice ID doesn't support asymmetric customer managed keys\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAF::ByteMatchSet": { "ByteMatchTuples": "Specifies the bytes \\(typically a string that corresponds with ASCII characters\\) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings\\. \n*Required*: No \n*Type*: List of [ByteMatchTuple](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-bytematchtuples.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -22657,55 +27086,131 @@ "TextTransformation": "Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF\\. If you specify a transformation, AWS WAF performs the transformation on `FieldToMatch` before inspecting it for a match\\. \nYou can only specify a single type of TextTransformation\\. \n **CMD\\_LINE** \nWhen you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: \n+ Delete the following characters: \\\\ \" ' ^\n+ Delete spaces before the following characters: / \\(\n+ Replace the following characters with a space: , ;\n+ Replace multiple spaces with one space\n+ Convert uppercase letters \\(A\\-Z\\) to lowercase \\(a\\-z\\)\n **COMPRESS\\_WHITE\\_SPACE** \nUse this option to replace the following characters with a space character \\(decimal 32\\): \n+ \\\\f, formfeed, decimal 12\n+ \\\\t, tab, decimal 9\n+ \\\\n, newline, decimal 10\n+ \\\\r, carriage return, decimal 13\n+ \\\\v, vertical tab, decimal 11\n+ non\\-breaking space, decimal 160\n `COMPRESS_WHITE_SPACE` also replaces multiple spaces with one space\\. \n **HTML\\_ENTITY\\_DECODE** \nUse this option to replace HTML\\-encoded characters with unencoded characters\\. `HTML_ENTITY_DECODE` performs the following operations: \n+ Replaces `(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/ampersand.html.html.html.html.html.html)quot;` with `\"` \n+ Replaces `(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/ampersand.html.html.html.html.html.html)nbsp;` with a non\\-breaking space, decimal 160\n+ Replaces `(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/ampersand.html.html.html.html.html.html)lt;` with a \"less than\" symbol\n+ Replaces `(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/ampersand.html.html.html.html.html.html)gt;` with `>` \n+ Replaces characters that are represented in hexadecimal format, `(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/ampersand.html.html.html.html.html.html)#xhhhh;`, with the corresponding characters\n+ Replaces characters that are represented in decimal format, `(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/ampersand.html.html.html.html.html.html)#nnnn;`, with the corresponding characters\n **LOWERCASE** \nUse this option to convert uppercase letters \\(A\\-Z\\) to lowercase \\(a\\-z\\)\\. \n **URL\\_DECODE** \nUse this option to decode a URL\\-encoded value\\. \n **NONE** \nSpecify `NONE` if you don't want to perform any text transformations\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CMD_LINE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | NONE | URL_DECODE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::IPSet": { - "Addresses": "Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0\\. \nExamples: \n+ To configure AWS WAF to allow, block, or count requests that originated from the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Addresses": "Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses\\. All addresses must be specified using Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for `/0`\\. \nExample address strings: \n+ To configure AWS WAF to allow, block, or count requests that originated from the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \nExample JSON `Addresses` specifications: \n+ Empty array: `\"Addresses\": []` \n+ Array with one address: `\"Addresses\": [\"192.0.2.44/32\"]` \n+ Array with three addresses: `\"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]` \n+ INVALID specification: `\"Addresses\": [\"\"]` INVALID \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description of the IP set that helps with identification\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[\\w+=:#@/\\-,\\.][\\w+=:#@/\\-,\\.\\s]+[\\w+=:#@/\\-,\\.]$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IPAddressVersion": "Specify IPV4 or IPV6\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IPV4 | IPV6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The descriptive name of the IP set\\. You cannot change the name of an `IPSet` after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", - "Scope": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "IPAddressVersion": "The version of the IP addresses, either `IPV4` or `IPV6`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IPV4 | IPV6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the IP set\\. You cannot change the name of an `IPSet` after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Scope": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, or an Amazon Cognito user pool\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Key:value pairs associated with an AWS resource\\. The key:value pair can be anything you define\\. Typically, the tag key represents a category \\(such as \"environment\"\\) and the tag value represents a specific value within that category \\(such as \"test,\" \"development,\" or \"production\"\\)\\. You can add up to 50 tags to each AWS resource\\. \nTo modify tags on existing resources, use the AWS WAF APIs or command line interface\\. With AWS CloudFormation, you can only add tags to AWS WAF resources during resource creation\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::LoggingConfiguration": { - "LogDestinationConfigs": "The logging destination configuration that you want to associate with the web ACL\\. \nYou can associate one logging destination to a web ACL\\.\nIf logging destination target is a CloudWatch Log Group, it is required that the reference Log Group's name begin with the prefix 'aws-waf-logs-'\\.\n*Required*: Yes \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "LoggingFilter": "Filtering that specifies which web requests are kept in the logs and which are dropped\\. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LogDestinationConfigs": "The logging destination configuration that you want to associate with the web ACL\\. \nYou can associate one logging destination to a web ACL\\.\n*Required*: Yes \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LoggingFilter": "Filtering that specifies which web requests are kept in the logs and which are dropped\\. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation\\. \n*Required*: No \n*Type*: [LoggingFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-loggingfilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RedactedFields": "The parts of the request that you want to keep out of the logs\\. For example, if you redact the `SingleHeader` field, the `HEADER` field in the logs will be `xxx`\\. \nYou can specify only the following fields for redaction: `UriPath`, `QueryString`, `SingleHeader`, `Method`, and `JsonBody`\\.\n*Required*: No \n*Type*: List of [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-fieldtomatch.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResourceArn": "The Amazon Resource Name \\(ARN\\) of the web ACL that you want to associate with `LogDestinationConfigs`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, + "AWS::WAFv2::LoggingConfiguration ActionCondition": { + "Action": "The action setting that a log record must contain in order to meet the condition\\. This is the action that AWS WAF applied to the web request\\. \nFor rule groups, this is either the configured rule action setting, or if you've applied a rule action override to the rule, it's the override action\\. The value `EXCLUDED_AS_COUNT` matches on excluded rules and also on rules that have a rule action override of Count\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALLOW | BLOCK | CAPTCHA | CHALLENGE | COUNT | EXCLUDED_AS_COUNT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::LoggingConfiguration Condition": { + "ActionCondition": "A single action condition\\. This is the action setting that a log record must contain in order to meet the condition\\. \n*Required*: No \n*Type*: [ActionCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-actioncondition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LabelNameCondition": "A single label name condition\\. This is the fully qualified label name that a log record must contain in order to meet the condition\\. 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\\. \n*Required*: No \n*Type*: [LabelNameCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-labelnamecondition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::WAFv2::LoggingConfiguration FieldToMatch": { - "JsonBody": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-bytematchstatement) or [RegexPatternSetReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-regexpatternsetreferencestatement), with a [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-sizeconstraintstatement) that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Method": "Inspect the HTTP method\\. The method indicates the type of operation that the request is asking the origin to perform\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "QueryString": "Inspect the query string\\. This is the part of a URL that appears after a `?` character, if any\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SingleHeader": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }` \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UriPath": "Inspect the request URI path\\. This is the part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "JsonBody": "Redact the request body JSON\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Method": "Redact the indicated HTTP method\\. The method indicates the type of operation that the request is asking the origin to perform\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "QueryString": "Redact the query string\\. This is the part of a URL that appears after a `?` character, if any\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SingleHeader": "Redact a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }` \n*Required*: No \n*Type*: [SingleHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-singleheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UriPath": "Redact the request URI path\\. This is the part of the web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::LoggingConfiguration Filter": { + "Behavior": "How to handle logs that satisfy the filter's conditions and requirement\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DROP | KEEP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Conditions": "Match conditions for the filter\\. \n*Required*: Yes \n*Type*: List of [Condition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-condition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Requirement": "Logic to apply to the filtering conditions\\. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `MEETS_ALL | MEETS_ANY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::LoggingConfiguration JsonBody": { + "InvalidFallbackBehavior": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \n AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \n AWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MatchPattern": "The patterns to look for in the JSON body\\. AWS WAF inspects the results of these pattern matches against the rule inspection criteria\\. \n*Required*: Yes \n*Type*: [MatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-matchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MatchScope": "The parts of the JSON to match against using the `MatchPattern`\\. If you specify `All`, AWS WAF matches against keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::LoggingConfiguration LabelNameCondition": { + "LabelName": "The label name that a log record must contain in order to meet the condition\\. This must be a fully qualified label name\\. 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\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::LoggingConfiguration LoggingFilter": { + "DefaultBehavior": "Default handling for logs that don't match any of the specified filtering conditions\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DROP | KEEP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Filters": "The filters that you want to apply to the logs\\. \n*Required*: Yes \n*Type*: List of [Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::LoggingConfiguration MatchPattern": { + "All": "Match all of the elements\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludedPaths": "Match only the specified include paths\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::LoggingConfiguration SingleHeader": { + "Name": "The name of the query header to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RegexPatternSet": { "Description": "A description of the set that helps with identification\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[\\w+=:#@/\\-,\\.][\\w+=:#@/\\-,\\.\\s]+[\\w+=:#@/\\-,\\.]$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The descriptive name of the set\\. You cannot change the name after you create the set\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the set\\. You cannot change the name after you create the set\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "RegularExpressionList": "The regular expression patterns in the set\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Scope": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Scope": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, or an Amazon Cognito user pool\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Key:value pairs associated with an AWS resource\\. The key:value pair can be anything you define\\. Typically, the tag key represents a category \\(such as \"environment\"\\) and the tag value represents a specific value within that category \\(such as \"test,\" \"development,\" or \"production\"\\)\\. You can add up to 50 tags to each AWS resource\\. \nTo modify tags on existing resources, use the AWS WAF APIs or command line interface\\. With AWS CloudFormation, you can only add tags to AWS WAF resources during resource creation\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup": { - "Capacity": "The web ACL capacity units \\(WCUs\\) required for this rule group\\. \nWhen you create your own rule group, you define this, and you cannot change it after creation\\. When you add or modify the rules in a rule group, AWS WAF enforces this limit\\. \nAWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs\\. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule\\. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power\\. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group\\. The WCU limit for web ACLs is 1,500\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AvailableLabels": "The labels that one or more rules in this rule group add to matching web requests\\. These labels are defined in the `RuleLabels` for a Rule\\. \n*Required*: No \n*Type*: List of [LabelSummary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelsummary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Capacity": "The web ACL capacity units \\(WCUs\\) required for this rule group\\. \nWhen you create your own rule group, you define this, and you cannot change it after creation\\. When you add or modify the rules in a rule group, AWS WAF enforces this limit\\. \n AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs\\. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule\\. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power\\. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group\\. The WCU limit for web ACLs is 1,500\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ConsumedLabels": "The labels that one or more rules in this rule group match against in label match statements\\. These labels are defined in a `LabelMatchStatement` specification, in the [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) definition of a rule\\. \n*Required*: No \n*Type*: List of [LabelSummary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelsummary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomResponseBodies": "A map of custom response keys and content bodies\\. When you create a rule with a block action, you can send a custom response to the web request\\. You define these for the rule group, and then use them in the rules that you define in the rule group\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \nFor information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: Map of [CustomResponseBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponsebody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description of the rule group that helps with identification\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[\\w+=:#@/\\-,\\.][\\w+=:#@/\\-,\\.\\s]+[\\w+=:#@/\\-,\\.]$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The descriptive name of the rule group\\. You cannot change the name of a rule group after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the rule group\\. You cannot change the name of a rule group after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Rules": "The rule statements used to identify the web requests that you want to allow, block, or count\\. Each rule includes one top\\-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them\\. \n*Required*: No \n*Type*: List of [Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-rule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Scope": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Scope": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, or an Amazon Cognito user pool\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Key:value pairs associated with an AWS resource\\. The key:value pair can be anything you define\\. Typically, the tag key represents a category \\(such as \"environment\"\\) and the tag value represents a specific value within that category \\(such as \"test,\" \"development,\" or \"production\"\\)\\. You can add up to 50 tags to each AWS resource\\. \nTo modify tags on existing resources, use the AWS WAF APIs or command line interface\\. With AWS CloudFormation, you can only add tags to AWS WAF resources during resource creation\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VisibilityConfig": "Defines and enables Amazon CloudWatch metrics and web request sample collection\\. \n*Required*: Yes \n*Type*: [VisibilityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::WAFv2::RuleGroup AllowAction": { + "CustomRequestHandling": "Defines custom handling for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::WAFv2::RuleGroup AndStatement": { "Statements": "The statements to combine with AND logic\\. You can use any statements that can be nested\\. \n*Required*: Yes \n*Type*: List of [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::WAFv2::RuleGroup BlockAction": { + "CustomResponse": "Defines a custom response for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::RuleGroup Body": { + "OversizeHandling": "What AWS WAF should do if the body is larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB \\(8192 bytes\\)\\. Only the first 8 KB of the request body are forwarded to AWS WAF by the underlying host service\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the body normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nYou can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB\\. \nDefault: `CONTINUE` \n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::WAFv2::RuleGroup ByteMatchStatement": { - "FieldToMatch": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PositionalConstraint": "The area within the portion of a web request that you want AWS WAF to search for `SearchString`\\. Valid values include the following: \n **CONTAINS** \nThe specified part of the web request must include the value of `SearchString`, but the location doesn't matter\\. \n **CONTAINS\\_WORD** \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+ `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 **EXACTLY** \nThe value of the specified part of the web request must exactly match the value of `SearchString`\\. \n **STARTS\\_WITH** \nThe value of `SearchString` must appear at the beginning of the specified part of the web request\\. \n **ENDS\\_WITH** \nThe value of `SearchString` must appear at the end of the specified part of the web request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTAINS | CONTAINS_WORD | ENDS_WITH | EXACTLY | STARTS_WITH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SearchString": "A string value that you want AWS WAF to search for\\. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch`\\. The maximum length of the value is 50 bytes\\. For alphabetic characters A\\-Z and a\\-z, the value is case sensitive\\. \nDon't encode this string\\. Provide the value that you want AWS WAF to search for\\. AWS CloudFormation automatically base64 encodes the value for you\\. \nFor example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent`\\. If you want to search the `User-Agent` header for the value `BadBot`, you provide the string `BadBot` in the value of `SearchString`\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FieldToMatch": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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 **CONTAINS** \nThe specified part of the web request must include the value of `SearchString`, but the location doesn't matter\\. \n **CONTAINS\\_WORD** \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+ `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 **EXACTLY** \nThe value of the specified part of the web request must exactly match the value of `SearchString`\\. \n **STARTS\\_WITH** \nThe value of `SearchString` must appear at the beginning of the specified part of the web request\\. \n **ENDS\\_WITH** \nThe value of `SearchString` must appear at the end of the specified part of the web request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTAINS | CONTAINS_WORD | ENDS_WITH | EXACTLY | STARTS_WITH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SearchString": "A string value that you want AWS WAF to search for\\. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch`\\. The maximum length of the value is 200 bytes\\. For alphabetic characters A\\-Z and a\\-z, the value is case sensitive\\. \nDon't encode this string\\. Provide the value that you want AWS WAF to search for\\. AWS CloudFormation automatically base64 encodes the value for you\\. \nFor example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent`\\. If you want to search the `User-Agent` header for the value `BadBot`, you provide the string `BadBot` in the value of `SearchString`\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SearchStringBase64": "String to search for in a web request component, base64\\-encoded\\. If you don't want to encode the string, specify the unencoded value in `SearchString` instead\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::RuleGroup CaptchaAction": { + "CustomRequestHandling": "Defines custom handling for the web request, used when the `CAPTCHA` inspection determines that the request's token is valid and unexpired\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup CaptchaConfig": { - "ImmunityTimeProperty": "Determines how long a `CAPTCHA` token remains valid after the client successfully solves a `CAPTCHA` puzzle\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ImmunityTimeProperty": "Determines how long a `CAPTCHA` timestamp in the token remains valid after the client successfully solves a `CAPTCHA` puzzle\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::RuleGroup ChallengeAction": { + "CustomRequestHandling": "Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::RuleGroup ChallengeConfig": { + "ImmunityTimeProperty": "Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::RuleGroup CookieMatchPattern": { + "All": "Inspect all cookies\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExcludedCookies": "Inspect only the cookies whose keys don't match any of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludedCookies": "Inspect only the cookies that have a key that matches one of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::RuleGroup Cookies": { + "MatchPattern": "The filter to use to identify the subset of cookies to inspect in a web request\\. \nYou must specify exactly one setting: either `All`, `IncludedCookies`, or `ExcludedCookies`\\. \nExample JSON: `\"MatchPattern\": { \"IncludedCookies\": {\"KeyToInclude1\", \"KeyToInclude2\", \"KeyToInclude3\"} }` \n*Required*: Yes \n*Type*: [CookieMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookiematchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MatchScope": "The parts of the cookies to inspect with the rule inspection criteria\\. If you specify `All`, AWS WAF inspects both keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OversizeHandling": "What AWS WAF should do if the cookies of the request are larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB \\(8192 bytes\\) or 200 total cookies\\. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the cookies normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::RuleGroup CountAction": { + "CustomRequestHandling": "Defines custom handling for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::RuleGroup CustomHTTPHeader": { + "Name": "The name of the custom header\\. \nFor custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name `x-amzn-waf-`, to avoid confusion with the headers that are already in the request\\. For example, for the header name `sample`, AWS WAF inserts the header `x-amzn-waf-sample`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9._$-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "The value of the custom header\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::RuleGroup CustomRequestHandling": { + "InsertHeaders": "The HTTP headers to insert into the request\\. Duplicate header names are not allowed\\. \nFor information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: Yes \n*Type*: List of [CustomHTTPHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customhttpheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::RuleGroup CustomResponse": { + "CustomResponseBodyKey": "References the response body that you want AWS WAF to return to the web request client\\. You can define a custom response for a rule action or a default web ACL action that is set to block\\. To do this, you first define the response body key and value in the `CustomResponseBodies` setting for the [AWS::WAFv2::WebACL](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html) or [AWS::WAFv2::RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html) where you want to use it\\. Then, in the rule action or web ACL default action `BlockAction` setting, you reference the response body using this key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResponseCode": "The HTTP status code to return to the client\\. \nFor a list of status codes that you can use in your custom responses, see [Supported status codes for custom response](https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `200` \n*Maximum*: `599` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResponseHeaders": "The HTTP headers to use in the response\\. Duplicate header names are not allowed\\. \nFor information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: List of [CustomHTTPHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customhttpheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup CustomResponseBody": { "Content": "The payload of the custom response\\. \nYou can use JSON escape strings in JSON content\\. To do this, you must specify JSON content in the `ContentType` setting\\. \nFor information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `10240` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -22713,22 +27218,34 @@ }, "AWS::WAFv2::RuleGroup FieldToMatch": { "AllQueryArguments": "Inspect all query arguments\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Body": "Inspect the request body, which immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the `ByteMatchStatement` or `RegexPatternSetReferenceStatement`, with a `SizeConstraintStatement` that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "JsonBody": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the `ByteMatchStatement` or `RegexPatternSetReferenceStatement`, with a `SizeConstraintStatement` that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Body": "Inspect the request body as plain text\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nOnly the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. For information about how to handle oversized request bodies, see the `Body` object configuration\\. \n*Required*: No \n*Type*: [Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-body.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Cookies": "Inspect the request cookies\\. You must configure scope and pattern matching filters in the `Cookies` object, to define the set of cookies and the parts of the cookies that AWS WAF inspects\\. \nOnly the first 8 KB \\(8192 bytes\\) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service\\. You must configure how to handle any oversize cookie content in the `Cookies` object\\. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service\\. \n*Required*: No \n*Type*: [Cookies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookies.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Headers": "Inspect the request headers\\. You must configure scope and pattern matching filters in the `Headers` object, to define the set of headers to and the parts of the headers that AWS WAF inspects\\. \nOnly the first 8 KB \\(8192 bytes\\) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service\\. You must configure how to handle any oversize header content in the `Headers` object\\. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service\\. \n*Required*: No \n*Type*: [Headers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headers.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "JsonBody": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nOnly the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. For information about how to handle oversized request bodies, see the `JsonBody` object configuration\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Method": "Inspect the HTTP method\\. The method indicates the type of operation that the request is asking the origin to perform\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "QueryString": "Inspect the query string\\. This is the part of a URL that appears after a `?` character, if any\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SingleHeader": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SingleQueryArgument": "Inspect a single query argument\\. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*\\. The name can be up to 30 characters long and isn't case sensitive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UriPath": "Inspect the request URI path\\. This is the part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SingleHeader": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }` \nAlternately, you can filter and inspect all headers with the `Headers` `FieldToMatch` setting\\. \n*Required*: No \n*Type*: [SingleHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-singleheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SingleQueryArgument": "Inspect a single query argument\\. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*\\. The name can be up to 30 characters long and isn't case sensitive\\. \nExample JSON: `\"SingleQueryArgument\": { \"Name\": \"myArgument\" }` \n*Required*: No \n*Type*: [SingleQueryArgument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-singlequeryargument.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UriPath": "Inspect the request URI path\\. This is the part of the web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup ForwardedIPConfiguration": { "FallbackBehavior": "The match status to assign to the web request if the request doesn't have a valid IP address in the specified position\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\nYou can specify the following fallback behaviors: \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HeaderName": "The name of the HTTP header to use for the IP address\\. For example, to use the X\\-Forwarded\\-For \\(XFF\\) header, set this to `X-Forwarded-For`\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[a-zA-Z0-9-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup GeoMatchStatement": { - "CountryCodes": "An array of two\\-character country codes, for example, `[ \"US\", \"CN\" ]`, from the alpha\\-2 country ISO codes of the ISO 3166 international standard\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CountryCodes": "An array of two\\-character country codes that you want to match against, for example, `[ \"US\", \"CN\" ]`, from the alpha\\-2 country ISO codes of the ISO 3166 international standard\\. \nWhen you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate\\. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches\\. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\n*Required*: No \n*Type*: [ForwardedIPConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-forwardedipconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::WAFv2::RuleGroup HeaderMatchPattern": { + "All": "Inspect all headers\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExcludedHeaders": "Inspect only the headers whose keys don't match any of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludedHeaders": "Inspect only the headers that have a key that matches one of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::RuleGroup Headers": { + "MatchPattern": "The filter to use to identify the subset of headers to inspect in a web request\\. \nYou must specify exactly one setting: either `All`, `IncludedHeaders`, or `ExcludedHeaders`\\. \nExample JSON: `\"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }` \n*Required*: Yes \n*Type*: [HeaderMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headermatchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MatchScope": "The parts of the headers to match with the rule inspection criteria\\. If you specify `All`, AWS WAF inspects both keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OversizeHandling": "What AWS WAF should do if the headers of the request are larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB \\(8192 bytes\\) or 200 total headers\\. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the headers normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::WAFv2::RuleGroup IPSetForwardedIPConfiguration": { "FallbackBehavior": "The match status to assign to the web request if the request doesn't have a valid IP address in the specified position\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\nYou can specify the following fallback behaviors: \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HeaderName": "The name of the HTTP header to use for the IP address\\. For example, to use the X\\-Forwarded\\-For \\(XFF\\) header, set this to `X-Forwarded-For`\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[a-zA-Z0-9-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -22739,26 +27256,27 @@ "IPSetForwardedIPConfig": "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\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\n*Required*: No \n*Type*: [IPSetForwardedIPConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetforwardedipconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup ImmunityTimeProperty": { - "ImmunityTime": "The amount of time, in seconds, that a `CAPTCHA` token is valid\\. The default setting is 300\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ImmunityTime": "The amount of time, in seconds, that a `CAPTCHA` or challenge timestamp is considered valid by AWS WAF\\. The default setting is 300\\. \nFor the Challenge action, the minimum setting is 300\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup JsonBody": { - "InvalidFallbackBehavior": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \nAWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \nAWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InvalidFallbackBehavior": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \n AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \n AWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MatchPattern": "The patterns to look for in the JSON body\\. AWS WAF inspects the results of these pattern matches against the rule inspection criteria\\. \n*Required*: Yes \n*Type*: [JsonMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonmatchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MatchScope": "The parts of the JSON to match against using the `MatchPattern`\\. If you specify `All`, AWS WAF matches against keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "MatchScope": "The parts of the JSON to match against using the `MatchPattern`\\. If you specify `All`, AWS WAF matches against keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OversizeHandling": "What AWS WAF should do if the body is larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB \\(8192 bytes\\)\\. Only the first 8 KB of the request body are forwarded to AWS WAF by the underlying host service\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the body normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nYou can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB\\. \nDefault: `CONTINUE` \n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup JsonMatchPattern": { - "All": "Match all of the elements\\. See also `MatchScope` in `JsonBody`\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IncludedPaths": "Match only the specified include paths\\. See also `MatchScope` in `JsonBody`\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "All": "Match all of the elements\\. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludedPaths": "Match only the specified include paths\\. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup Label": { - "Name": "The label string\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "The label string\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup LabelMatchStatement": { - "Key": "The string to match against\\. The setting you provide for this depends on the match statement's `Scope` setting: \n+ If the `Scope` indicates `LABEL`, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name\\. \n+ If the `Scope` indicates `NAMESPACE`, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates\\.\nLabels are case sensitive and components of a label must be separated by colon, for example `NS1:NS2:name`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Scope": "Specify whether you want to match using the label name or just the namespace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Key": "The string to match against\\. The setting you provide for this depends on the match statement's `Scope` setting: \n+ If the `Scope` indicates `LABEL`, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name\\. \n+ If the `Scope` indicates `NAMESPACE`, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates\\.\nLabels are case sensitive and components of a label must be separated by colon, for example `NS1:NS2:name`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Scope": "Specify whether you want to match using the label name or just the namespace\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `LABEL | NAMESPACE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup LabelSummary": { - "Name": "An individual label specification\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "An individual label specification\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup NotStatement": { "Statement": "The statement to negate\\. You can use any statement that can be nested\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -22770,57 +27288,66 @@ "AggregateKeyType": "Setting that indicates how to aggregate the request counts\\. The options are the following: \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\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FORWARDED_IP | IP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\nThis is required if `AggregateKeyType` is set to `FORWARDED_IP`\\. \n*Required*: No \n*Type*: [ForwardedIPConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-forwardedipconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Limit": "The limit on requests per 5\\-minute period for a single originating IP address\\. If the statement includes a `ScopeDownStatement`, this limit is applied only to the requests that match the statement\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ScopeDownStatement": "An optional nested statement that narrows the scope of the rate\\-based statement to matching web requests\\. This can be any nestable statement, and you can nest statements at any level below this scope\\-down statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ScopeDownStatement": "An optional nested statement that narrows the scope of the web requests that are evaluated by the rate\\-based statement\\. Requests are only tracked by the rate\\-based statement if they match the scope\\-down statement\\. You can use any nestable statement in the scope\\-down statement, and you can nest statements at any level, the same as you can for a rule statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup RegexMatchStatement": { - "FieldToMatch": "The part of a web request that you want AWS WAF to inspect\\. For more information, see `FieldToMatch`\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FieldToMatch": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RegexString": "The string representing the regular expression\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup RegexPatternSetReferenceStatement": { - "Arn": "The Amazon Resource Name \\(ARN\\) of the regular expression pattern set that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FieldToMatch": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Arn": "The Amazon Resource Name \\(ARN\\) of the [AWS::WAFv2::RegexPatternSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html) that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FieldToMatch": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup Rule": { - "Action": "The action that AWS WAF should take on a web request when it matches the rule's statement\\. Settings at the web ACL level can override the rule action setting\\. \n*Required*: No \n*Type*: [RuleAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Action": "The action that AWS WAF should take on a web request when it matches the rule statement\\. Settings at the web ACL level can override the rule action setting\\. \n*Required*: No \n*Type*: [RuleAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CaptchaConfig": "Specifies how AWS WAF should handle `CAPTCHA` evaluations\\. If you don't specify this, AWS WAF uses the `CAPTCHA` configuration that's defined for the web ACL\\. \n*Required*: No \n*Type*: [CaptchaConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-captchaconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The descriptive name of the rule\\. You can't change the name of a `Rule` after you create it\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ChallengeConfig": "Specifies how AWS WAF should handle `Challenge` evaluations\\. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL\\. \n*Required*: No \n*Type*: [ChallengeConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-challengeconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the rule\\. You can't change the name of a `Rule` after you create it\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Priority": "If you define more than one `Rule` in a `WebACL`, AWS WAF evaluates each request against the `Rules` in order based on the value of `Priority`\\. AWS WAF processes rules with lower priority first\\. The priorities don't need to be consecutive, but they must all be different\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RuleLabels": "Labels to apply to web requests that match the rule match statement\\. AWS WAF applies fully qualified labels to matching web requests\\. A fully qualified label is the concatenation of a label namespace and a rule label\\. The rule's rule group or web ACL defines the label namespace\\. \nRules that run after this rule in the web ACL can match against these labels using a `LabelMatchStatement`\\. \nFor each label, provide a case\\-sensitive string containing optional namespaces and a label name, according to the following guidelines: \n+ Separate each component of the label with a colon\\. \n+ Each namespace or name can have up to 128 characters\\.\n+ You can specify up to 5 namespaces in a label\\.\n+ Don't use the following reserved words in your label specification: `aws`, `waf`, `managed`, `rulegroup`, `webacl`, `regexpatternset`, or `ipset`\\.\nFor example, `myLabelName` or `nameSpace1:nameSpace2:myLabelName`\\. \n*Required*: No \n*Type*: List of [Label](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-label.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Statement": "The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Statement": "The AWS WAF processing statement for the rule, for example [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-bytematchstatement) or [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-sizeconstraintstatement)\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VisibilityConfig": "Defines and enables Amazon CloudWatch metrics and web request sample collection\\. \n*Required*: Yes \n*Type*: [VisibilityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-visibilityconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup RuleAction": { - "Allow": "Instructs AWS WAF to allow the web request\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Block": "Instructs AWS WAF to block the web request\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Allow": "Instructs AWS WAF to allow the web request\\. \n*Required*: No \n*Type*: [AllowAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-allowaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Block": "Instructs AWS WAF to block the web request\\. \n*Required*: No \n*Type*: [BlockAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-blockaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Captcha": "Specifies that AWS WAF should run a `CAPTCHA` check against the request: \n+ If the request includes a valid, unexpired `CAPTCHA` token, AWS WAF allows the web request inspection to proceed to the next rule, similar to a `CountAction`\\. \n+ If the request doesn't include a valid, unexpired `CAPTCHA` token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination\\.", - "Count": "Instructs AWS WAF to count the web request and allow it\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Challenge": "Instructs AWS WAF to run a `Challenge` check against the web request\\. \n*Required*: No \n*Type*: [ChallengeAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-challengeaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Count": "Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL\\. \n*Required*: No \n*Type*: [CountAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-countaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::RuleGroup SingleHeader": { + "Name": "The name of the query header to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::RuleGroup SingleQueryArgument": { + "Name": "The name of the query argument to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup SizeConstraintStatement": { "ComparisonOperator": "The operator to use to compare the request part to the size setting\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `EQ | GE | GT | LE | LT | NE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FieldToMatch": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FieldToMatch": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Size": "The size, in byte, to compare to the request part, after any transformations\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup SqliMatchStatement": { - "FieldToMatch": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "FieldToMatch": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SensitivityLevel": "The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks\\. \n `HIGH` detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings\\. For information about identifying and mitigating false positives, see [Testing and tuning](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-testing.html) in the * AWS WAF Developer Guide*\\. \n `LOW` is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives\\. \nDefault: `LOW` \n*Required*: No \n*Type*: String \n*Allowed values*: `HIGH | LOW` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup Statement": { - "AndStatement": "A logical rule statement used to combine other rule statements with AND logic\\. You provide more than one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `AndStatement`\\. \n*Required*: No \n*Type*: [AndStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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 refered to as a string match statement\\. \n*Required*: No \n*Type*: [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "GeoMatchStatement": "A rule statement used to identify web requests based on country of origin\\. \n*Required*: No \n*Type*: [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "AndStatement": "A logical rule statement used to combine other rule statements with AND logic\\. You provide more than one `Statement` within the `AndStatement`\\. \n*Required*: No \n*Type*: [AndStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: No \n*Type*: [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "GeoMatchStatement": "A rule statement that labels web requests by country and region and that matches against web requests based on country code\\. A geo match rule labels every request that it inspects regardless of whether it finds a match\\. \n+ To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the `CountryCodes` array\\. \n+ Otherwise, configure your geo match rule with Count action so that it only labels requests\\. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed\\. \n AWS WAF labels requests using the alpha\\-2 country and region codes from the International Organization for Standardization \\(ISO\\) 3166 standard\\. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match `ForwardedIPConfig`\\. \nIf you use the web request origin, the label formats are `awswaf:clientip:geo:region:-` and `awswaf:clientip:geo:country:`\\. \nIf you use a forwarded IP address, the label formats are `awswaf:forwardedip:geo:region:-` and `awswaf:forwardedip:geo:country:`\\. \nFor additional details, see [Geographic match rule statement](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IPSetReferenceStatement": "A rule statement used to detect web requests coming from particular IP addresses or address ranges\\. To use this, create an [AWS::WAFv2::IPSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html) that specifies the addresses you want to detect, then use the ARN of that set in this statement\\. \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\\. \n*Required*: No \n*Type*: [IPSetReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ipsetreferencestatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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\\. \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\\. \n*Required*: No \n*Type*: [LabelMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "NotStatement": "A logical rule statement used to negate the results of another rule statement\\. You provide one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `NotStatement`\\. \n*Required*: No \n*Type*: [NotStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OrStatement": "A logical rule statement used to combine other rule statements with OR logic\\. You provide more than one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `OrStatement`\\. \n*Required*: No \n*Type*: [OrStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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\\. \nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit\\. \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+ 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\\.\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 conditions in the statements are counted\\. If the count exceeds 1,000 requests per five minutes, the rule action triggers\\. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule\\. \nYou cannot nest a `RateBasedStatement`, for example for use inside a `NotStatement` or `OrStatement`\\. It can only be referenced as a top\\-level statement within a rule\\. \n*Required*: No \n*Type*: [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LabelMatchStatement": "A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL\\. \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\\. \n*Required*: No \n*Type*: [LabelMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "NotStatement": "A logical rule statement used to negate the results of another rule statement\\. You provide one `Statement` within the `NotStatement`\\. \n*Required*: No \n*Type*: [NotStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OrStatement": "A logical rule statement used to combine other rule statements with OR logic\\. You provide more than one `Statement` within the `OrStatement`\\. \n*Required*: No \n*Type*: [OrStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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 AWS 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\\. \nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit\\. \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+ An IP match statement with an IP set that specifies the address 192\\.0\\.2\\.44\\.\n+ A string match statement that searches in the User\\-Agent header for the string BadBot\\.\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\\. \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\\. \n*Required*: No \n*Type*: [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RegexMatchStatement": "A rule statement used to search web request components for a match against a single regular expression\\. \n*Required*: No \n*Type*: [RegexMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RegexPatternSetReferenceStatement": "A rule statement used to search web request components for matches with regular expressions\\. To use this, create a [AWS::WAFv2::RegexPatternSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html) 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\\. \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\\. \n*Required*: No \n*Type*: [RegexPatternSetReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-regexpatternsetreferencestatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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\\. \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 can create a size constraint condition and block requests that have a request body greater than 8192 bytes\\. \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\\. \n*Required*: No \n*Type*: [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SqliMatchStatement": "Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database\\. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions\\. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect\\. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code\\. \n*Required*: No \n*Type*: [SqliMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "XssMatchStatement": "A rule statement that defines a cross\\-site scripting \\(XSS\\) match search for AWS WAF to apply to web requests\\. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client\\-site scripts into other legitimate web browsers\\. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings\\. \n*Required*: No \n*Type*: [XssMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "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\\. \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\\. \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\\. \n*Required*: No \n*Type*: [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: No \n*Type*: [SqliMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: No \n*Type*: [XssMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup TextTransformation": { "Priority": "Sets the relative processing order for multiple transformations that are defined for a rule statement\\. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content\\. The priorities don't need to be consecutive, but they must all be different\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -22828,24 +27355,29 @@ }, "AWS::WAFv2::RuleGroup VisibilityConfig": { "CloudWatchMetricsEnabled": "A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch\\. For the list of available metrics, see [AWS WAF Metrics](https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics)\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MetricName": "The descriptive name of the Amazon CloudWatch metric\\. The name can contain only alphanumeric characters \\(A\\-Z, a\\-z, 0\\-9\\), with length from one to 128 characters\\. It can't contain whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default\\_Action\\.\" You can't change a `MetricName` after you create a `VisibilityConfig`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MetricName": "A name of the Amazon CloudWatch metric dimension\\. The name can contain only the characters: A\\-Z, a\\-z, 0\\-9, \\- \\(hyphen\\), and \\_ \\(underscore\\)\\. The name can be from one to 128 characters long\\. It can't contain whitespace or metric names that are reserved for AWS WAF, for example `All` and `Default_Action`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SampledRequestsEnabled": "A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules\\. You can view the sampled requests through the AWS WAF console\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::RuleGroup XssMatchStatement": { - "FieldToMatch": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "FieldToMatch": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL": { "CaptchaConfig": "Specifies how AWS WAF should handle `CAPTCHA` evaluations for rules that don't have their own `CaptchaConfig` settings\\. If you don't specify this, AWS WAF uses its default settings for `CaptchaConfig`\\. \n*Required*: No \n*Type*: [CaptchaConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-captchaconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ChallengeConfig": "Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own `ChallengeConfig` settings\\. If you don't specify this, AWS WAF uses its default settings for `ChallengeConfig`\\. \n*Required*: No \n*Type*: [ChallengeConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-challengeconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CustomResponseBodies": "A map of custom response keys and content bodies\\. When you create a rule with a block action, you can send a custom response to the web request\\. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \nFor information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: Map of [CustomResponseBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customresponsebody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "DefaultAction": "The action to perform if none of the `Rules` contained in the `WebACL` match\\. \n*Required*: Yes \n*Type*: [DefaultAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-defaultaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Description": "A description of the web ACL that helps with identification\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[\\w+=:#@/\\-,\\.][\\w+=:#@/\\-,\\.\\s]+[\\w+=:#@/\\-,\\.]$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The descriptive name of the web ACL\\. You cannot change the name of a web ACL after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Name": "The name of the web ACL\\. You cannot change the name of a web ACL after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Rules": "The rule statements used to identify the web requests that you want to allow, block, or count\\. Each rule includes one top\\-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them\\. \n*Required*: No \n*Type*: List of [Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Scope": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\nFor information about how to define the association of the web ACL with your resource, see [AWS::WAFv2::WebACLAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "Scope": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, or an Amazon Cognito user pool\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\nFor information about how to define the association of the web ACL with your resource, see [AWS::WAFv2::WebACLAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "Tags": "Key:value pairs associated with an AWS resource\\. The key:value pair can be anything you define\\. Typically, the tag key represents a category \\(such as \"environment\"\\) and the tag value represents a specific value within that category \\(such as \"test,\" \"development,\" or \"production\"\\)\\. You can add up to 50 tags to each AWS resource\\. \nTo modify tags on existing resources, use the AWS WAF APIs or command line interface\\. With AWS CloudFormation, you can only add tags to AWS WAF resources during resource creation\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "TokenDomains": "Specifies the domains that AWS WAF should accept in a web request token\\. This enables the use of tokens across multiple protected websites\\. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting\\. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource\\. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VisibilityConfig": "Defines and enables Amazon CloudWatch metrics and web request sample collection\\. \n*Required*: Yes \n*Type*: [VisibilityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::WAFv2::WebACL AWSManagedRulesBotControlRuleSet": { + "InspectionLevel": "The inspection level to use for the Bot Control rule group\\. The common level is the least expensive\\. The targeted level includes all common level rules and adds rules with more advanced inspection criteria\\. For details, see [AWS WAF Bot Control rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::WAFv2::WebACL AllowAction": { "CustomRequestHandling": "Defines custom handling for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -22855,18 +27387,37 @@ "AWS::WAFv2::WebACL BlockAction": { "CustomResponse": "Defines a custom response for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::WAFv2::WebACL Body": { + "OversizeHandling": "What AWS WAF should do if the body is larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB \\(8192 bytes\\)\\. Only the first 8 KB of the request body are forwarded to AWS WAF by the underlying host service\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the body normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nYou can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB\\. \nDefault: `CONTINUE` \n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::WAFv2::WebACL ByteMatchStatement": { - "FieldToMatch": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PositionalConstraint": "The area within the portion of a web request that you want AWS WAF to search for `SearchString`\\. Valid values include the following: \n **CONTAINS** \nThe specified part of the web request must include the value of `SearchString`, but the location doesn't matter\\. \n **CONTAINS\\_WORD** \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+ `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 **EXACTLY** \nThe value of the specified part of the web request must exactly match the value of `SearchString`\\. \n **STARTS\\_WITH** \nThe value of `SearchString` must appear at the beginning of the specified part of the web request\\. \n **ENDS\\_WITH** \nThe value of `SearchString` must appear at the end of the specified part of the web request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTAINS | CONTAINS_WORD | ENDS_WITH | EXACTLY | STARTS_WITH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SearchString": "A string value that you want AWS WAF to search for\\. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch`\\. The maximum length of the value is 50 bytes\\. For alphabetic characters A\\-Z and a\\-z, the value is case sensitive\\. \nDon't encode this string\\. Provide the value that you want AWS WAF to search for\\. AWS CloudFormation automatically base64 encodes the value for you\\. \nFor example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent`\\. If you want to search the `User-Agent` header for the value `BadBot`, you provide the string `BadBot` in the value of `SearchString`\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FieldToMatch": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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 **CONTAINS** \nThe specified part of the web request must include the value of `SearchString`, but the location doesn't matter\\. \n **CONTAINS\\_WORD** \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+ `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 **EXACTLY** \nThe value of the specified part of the web request must exactly match the value of `SearchString`\\. \n **STARTS\\_WITH** \nThe value of `SearchString` must appear at the beginning of the specified part of the web request\\. \n **ENDS\\_WITH** \nThe value of `SearchString` must appear at the end of the specified part of the web request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTAINS | CONTAINS_WORD | ENDS_WITH | EXACTLY | STARTS_WITH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SearchString": "A string value that you want AWS WAF to search for\\. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch`\\. The maximum length of the value is 200 bytes\\. For alphabetic characters A\\-Z and a\\-z, the value is case sensitive\\. \nDon't encode this string\\. Provide the value that you want AWS WAF to search for\\. AWS CloudFormation automatically base64 encodes the value for you\\. \nFor example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent`\\. If you want to search the `User-Agent` header for the value `BadBot`, you provide the string `BadBot` in the value of `SearchString`\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SearchStringBase64": "String to search for in a web request component, base64\\-encoded\\. If you don't want to encode the string, specify the unencoded value in `SearchString` instead\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL CaptchaAction": { - "CustomRequestHandling": "Defines custom handling for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "CustomRequestHandling": "Defines custom handling for the web request, used when the `CAPTCHA` inspection determines that the request's token is valid and unexpired\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL CaptchaConfig": { - "ImmunityTimeProperty": "Determines how long a `CAPTCHA` token remains valid after the client successfully solves a `CAPTCHA` puzzle\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ImmunityTimeProperty": "Determines how long a `CAPTCHA` timestamp in the token remains valid after the client successfully solves a `CAPTCHA` puzzle\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::WebACL ChallengeAction": { + "CustomRequestHandling": "Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::WebACL ChallengeConfig": { + "ImmunityTimeProperty": "Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::WebACL CookieMatchPattern": { + "All": "Inspect all cookies\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExcludedCookies": "Inspect only the cookies whose keys don't match any of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludedCookies": "Inspect only the cookies that have a key that matches one of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::WebACL Cookies": { + "MatchPattern": "The filter to use to identify the subset of cookies to inspect in a web request\\. \nYou must specify exactly one setting: either `All`, `IncludedCookies`, or `ExcludedCookies`\\. \nExample JSON: `\"MatchPattern\": { \"IncludedCookies\": {\"KeyToInclude1\", \"KeyToInclude2\", \"KeyToInclude3\"} }` \n*Required*: Yes \n*Type*: [CookieMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookiematchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MatchScope": "The parts of the cookies to inspect with the rule inspection criteria\\. If you specify `All`, AWS WAF inspects both keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OversizeHandling": "What AWS WAF should do if the cookies of the request are larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB \\(8192 bytes\\) or 200 total cookies\\. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the cookies normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL CountAction": { "CustomRequestHandling": "Defines custom handling for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -22880,7 +27431,7 @@ }, "AWS::WAFv2::WebACL CustomResponse": { "CustomResponseBodyKey": "References the response body that you want AWS WAF to return to the web request client\\. You can define a custom response for a rule action or a default web ACL action that is set to block\\. To do this, you first define the response body key and value in the `CustomResponseBodies` setting for the [AWS::WAFv2::WebACL](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html) or [AWS::WAFv2::RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html) where you want to use it\\. Then, in the rule action or web ACL default action `BlockAction` setting, you reference the response body using this key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ResponseCode": "The HTTP status code to return to the client\\. \nFor a list of status codes that you can use in your custom reqponses, see [Supported status codes for custom response](https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `200` \n*Maximum*: `599` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ResponseCode": "The HTTP status code to return to the client\\. \nFor a list of status codes that you can use in your custom responses, see [Supported status codes for custom response](https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `200` \n*Maximum*: `599` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "ResponseHeaders": "The HTTP headers to use in the response\\. Duplicate header names are not allowed\\. \nFor information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: List of [CustomHTTPHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customhttpheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL CustomResponseBody": { @@ -22892,70 +27443,85 @@ "Block": "Specifies that AWS WAF should block requests by default\\. \n*Required*: No \n*Type*: [BlockAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-blockaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL ExcludedRule": { - "Name": "The name of the rule to exclude\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Name": "The name of the rule whose action you want to override to `Count`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL FieldIdentifier": { "Identifier": "The name of the username or password field, used in the `ManagedRuleGroupConfig` settings\\. \nWhen the `PayloadType` is `JSON`, the identifier must be in JSON pointer syntax\\. For example `/form/username`\\. For information about the JSON Pointer syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nWhen the `PayloadType` is `FORM_ENCODED`, use the HTML form names\\. For example, `username`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL FieldToMatch": { "AllQueryArguments": "Inspect all query arguments\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Body": "Inspect the request body, which immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the `ByteMatchStatement` or `RegexPatternSetReferenceStatement`, with a `SizeConstraintStatement` that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "JsonBody": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the `ByteMatchStatement` or `RegexPatternSetReferenceStatement`, with a `SizeConstraintStatement` that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Body": "Inspect the request body as plain text\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nOnly the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. For information about how to handle oversized request bodies, see the `Body` object configuration\\. \n*Required*: No \n*Type*: [Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-body.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Cookies": "Inspect the request cookies\\. You must configure scope and pattern matching filters in the `Cookies` object, to define the set of cookies and the parts of the cookies that AWS WAF inspects\\. \nOnly the first 8 KB \\(8192 bytes\\) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service\\. You must configure how to handle any oversize cookie content in the `Cookies` object\\. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service\\. \n*Required*: No \n*Type*: [Cookies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookies.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Headers": "Inspect the request headers\\. You must configure scope and pattern matching filters in the `Headers` object, to define the set of headers to and the parts of the headers that AWS WAF inspects\\. \nOnly the first 8 KB \\(8192 bytes\\) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service\\. You must configure how to handle any oversize header content in the `Headers` object\\. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service\\. \n*Required*: No \n*Type*: [Headers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headers.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "JsonBody": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nOnly the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. For information about how to handle oversized request bodies, see the `JsonBody` object configuration\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Method": "Inspect the HTTP method\\. The method indicates the type of operation that the request is asking the origin to perform\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "QueryString": "Inspect the query string\\. This is the part of a URL that appears after a `?` character, if any\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SingleHeader": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SingleQueryArgument": "Inspect a single query argument\\. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*\\. The name can be up to 30 characters long and isn't case sensitive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UriPath": "Inspect the request URI path\\. This is the part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "SingleHeader": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }` \nAlternately, you can filter and inspect all headers with the `Headers` `FieldToMatch` setting\\. \n*Required*: No \n*Type*: [SingleHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-singleheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SingleQueryArgument": "Inspect a single query argument\\. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*\\. The name can be up to 30 characters long and isn't case sensitive\\. \nExample JSON: `\"SingleQueryArgument\": { \"Name\": \"myArgument\" }` \n*Required*: No \n*Type*: [SingleQueryArgument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-singlequeryargument.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UriPath": "Inspect the request URI path\\. This is the part of the web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL ForwardedIPConfiguration": { "FallbackBehavior": "The match status to assign to the web request if the request doesn't have a valid IP address in the specified position\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\nYou can specify the following fallback behaviors: \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HeaderName": "The name of the HTTP header to use for the IP address\\. For example, to use the X\\-Forwarded\\-For \\(XFF\\) header, set this to `X-Forwarded-For`\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[a-zA-Z0-9-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL GeoMatchStatement": { - "CountryCodes": "An array of two\\-character country codes, for example, `[ \"US\", \"CN\" ]`, from the alpha\\-2 country ISO codes of the ISO 3166 international standard\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "CountryCodes": "An array of two\\-character country codes that you want to match against, for example, `[ \"US\", \"CN\" ]`, from the alpha\\-2 country ISO codes of the ISO 3166 international standard\\. \nWhen you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate\\. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches\\. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\n*Required*: No \n*Type*: [ForwardedIPConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-forwardedipconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::WAFv2::WebACL HeaderMatchPattern": { + "All": "Inspect all headers\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExcludedHeaders": "Inspect only the headers whose keys don't match any of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludedHeaders": "Inspect only the headers that have a key that matches one of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::WebACL Headers": { + "MatchPattern": "The filter to use to identify the subset of headers to inspect in a web request\\. \nYou must specify exactly one setting: either `All`, `IncludedHeaders`, or `ExcludedHeaders`\\. \nExample JSON: `\"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }` \n*Required*: Yes \n*Type*: [HeaderMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headermatchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MatchScope": "The parts of the headers to match with the rule inspection criteria\\. If you specify `All`, AWS WAF inspects both keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OversizeHandling": "What AWS WAF should do if the headers of the request are larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB \\(8192 bytes\\) or 200 total headers\\. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the headers normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "AWS::WAFv2::WebACL IPSetForwardedIPConfiguration": { "FallbackBehavior": "The match status to assign to the web request if the request doesn't have a valid IP address in the specified position\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\nYou can specify the following fallback behaviors: \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "HeaderName": "The name of the HTTP header to use for the IP address\\. For example, to use the X\\-Forwarded\\-For \\(XFF\\) header, set this to `X-Forwarded-For`\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[a-zA-Z0-9-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Position": "The position in the header to search for the IP address\\. The header can contain IP addresses of the original client and also of proxies\\. For example, the header value could be `10.1.1.1, 127.0.0.0, 10.10.10.10` where the first IP address identifies the original client and the rest identify proxies that the request went through\\. \nThe options for this setting are the following: \n+ FIRST \\- Inspect the first IP address in the list of IP addresses in the header\\. This is usually the client's original IP\\.\n+ LAST \\- Inspect the last IP address in the list of IP addresses in the header\\.\n+ ANY \\- Inspect all IP addresses in the header for a match\\. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `ANY | FIRST | LAST` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL IPSetReferenceStatement": { - "Arn": "The Amazon Resource Name \\(ARN\\) of the IP set that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Arn": "The Amazon Resource Name \\(ARN\\) of the [AWS::WAFv2::IPSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html) that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IPSetForwardedIPConfig": "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\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\n*Required*: No \n*Type*: [IPSetForwardedIPConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetforwardedipconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL ImmunityTimeProperty": { - "ImmunityTime": "The amount of time, in seconds, that a `CAPTCHA` token is valid\\. The default setting is 300\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ImmunityTime": "The amount of time, in seconds, that a `CAPTCHA` or challenge timestamp is considered valid by AWS WAF\\. The default setting is 300\\. \nFor the Challenge action, the minimum setting is 300\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL JsonBody": { - "InvalidFallbackBehavior": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \nAWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \nAWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "InvalidFallbackBehavior": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \n AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \n AWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "MatchPattern": "The patterns to look for in the JSON body\\. AWS WAF inspects the results of these pattern matches against the rule inspection criteria\\. \n*Required*: Yes \n*Type*: [JsonMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonmatchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MatchScope": "The parts of the JSON to match against using the `MatchPattern`\\. If you specify `All`, AWS WAF matches against keys and values\\. \nValid Values: `ALL` \\| `KEY` \\| `VALUE` \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "MatchScope": "The parts of the JSON to match against using the `MatchPattern`\\. If you specify `All`, AWS WAF matches against keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OversizeHandling": "What AWS WAF should do if the body is larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB \\(8192 bytes\\)\\. Only the first 8 KB of the request body are forwarded to AWS WAF by the underlying host service\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the body normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nYou can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB\\. \nDefault: `CONTINUE` \n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL JsonMatchPattern": { - "All": "Match all of the elements\\. See also `MatchScope` in `JsonBody`\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "IncludedPaths": "Match only the specified include paths\\. See also `MatchScope` in `JsonBody`\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "All": "Match all of the elements\\. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "IncludedPaths": "Match only the specified include paths\\. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL Label": { "Name": "The label string\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL LabelMatchStatement": { - "Key": "The string to match against\\. The setting you provide for this depends on the match statement's `Scope` setting: \n+ If the `Scope` indicates `LABEL`, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name\\. \n+ If the `Scope` indicates `NAMESPACE`, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates\\.\nLabels are case sensitive and components of a label must be separated by colon, for example `NS1:NS2:name`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Scope": "Specify whether you want to match using the label name or just the namespace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Key": "The string to match against\\. The setting you provide for this depends on the match statement's `Scope` setting: \n+ If the `Scope` indicates `LABEL`, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name\\. \n+ If the `Scope` indicates `NAMESPACE`, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates\\.\nLabels are case sensitive and components of a label must be separated by colon, for example `NS1:NS2:name`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Scope": "Specify whether you want to match using the label name or just the namespace\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `LABEL | NAMESPACE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL ManagedRuleGroupConfig": { - "LoginPath": "The path of the login endpoint for your application\\. For example, for the URL `https://example.com/web/login`, you would provide the path `/web/login`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PasswordField": "Details about your login page password field\\. \n*Required*: No \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "PayloadType": "The payload type for your login endpoint, either JSON or form encoded\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `FORM_ENCODED | JSON` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "UsernameField": "Details about your login page username field\\. \n*Required*: No \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "AWSManagedRulesBotControlRuleSet": "Additional configuration for using the Bot Control managed rule group\\. Use this to specify the inspection level that you want to use\\. For information about using the Bot Control managed rule group, see [AWS WAF Bot Control rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html) and [AWS WAF Bot Control](https://docs.aws.amazon.com/waf/latest/developerguide/waf-bot-control.html) in the * AWS WAF Developer Guide*\\. \n*Required*: No \n*Type*: [AWSManagedRulesBotControlRuleSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesbotcontrolruleset.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LoginPath": "Instead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PasswordField": "Instead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet` `RequestInspection`\\. \n*Required*: No \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PayloadType": "Instead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet` `RequestInspection`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `FORM_ENCODED | JSON` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "UsernameField": "Instead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet` `RequestInspection`\\. \n*Required*: No \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL ManagedRuleGroupStatement": { - "ExcludedRules": "The rules whose actions are set to `COUNT` by the web ACL, regardless of the action that is configured in the rule\\. This effectively excludes the rule from acting on web requests\\. \n*Required*: No \n*Type*: List of [ExcludedRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ManagedRuleGroupConfigs": "Additional information that's used by a managed rule group\\. Most managed rule groups don't require this\\. \nUse this for the account takeover prevention managed rule group `AWSManagedRulesATPRuleSet`, to provide information about the sign\\-in page of your application\\. \nYou can provide multiple individual `ManagedRuleGroupConfig` objects for any rule group configuration, for example `UsernameField` and `PasswordField`\\. The configuration that you provide depends on the needs of the managed rule group\\. For the ATP managed rule group, you provide the following individual configuration objects: `LoginPath`, `PasswordField`, `PayloadType` and `UsernameField`\\. \n*Required*: No \n*Type*: List of [ManagedRuleGroupConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ExcludedRules": "Rules in the referenced rule group whose actions are set to `Count`\\. \nInstead of this option, use `RuleActionOverrides`\\. It accepts any valid action setting, including `Count`\\.\n*Required*: No \n*Type*: List of [ExcludedRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ManagedRuleGroupConfigs": "Additional information that's used by a managed rule group\\. Many managed rule groups don't require this\\. \nUse the `AWSManagedRulesATPRuleSet` configuration object for the account takeover prevention managed rule group, to provide information such as the sign\\-in page of your application and the type of content to accept or reject from the client\\. \nUse the `AWSManagedRulesBotControlRuleSet` configuration object to configure the protection level that you want the Bot Control rule group to use\\. \n*Required*: No \n*Type*: List of [ManagedRuleGroupConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Name": "The name of the managed rule group\\. You use this, along with the vendor name, to identify the rule group\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ScopeDownStatement": "Statement nested inside a managed rule group statement to narrow the scope of the requests that AWS WAF evaluates using the rule group\\. Requests that match the scope\\-down statement are evaluated using the rule group\\. Requests that don't match the scope\\-down statement are not a match for the managed rule group statement, without any further evaluation\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RuleActionOverrides": "Action settings to use in the place of the rule actions that are configured inside the rule group\\. You specify one override for each rule whose action you want to change\\. \nYou can use overrides for testing, for example you can override all of rule actions to `Count` and then monitor the resulting count metrics to understand how the rule group would handle your web traffic\\. You can also permanently override some or all actions, to modify how the rule group manages your web traffic\\. \n*Required*: No \n*Type*: List of [RuleActionOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleactionoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ScopeDownStatement": "An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group\\. Requests are only evaluated by the rule group if they match the scope\\-down statement\\. You can use any nestable [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) in the scope\\-down statement, and you can nest statements at any level, the same as you can for a rule statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VendorName": "The name of the managed rule group vendor\\. You use this, along with the rule group name, to identify the rule group\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Version": "The version of the managed rule group to use\\. If you specify this, the version setting is fixed until you change it\\. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Version": "The version of the managed rule group to use\\. If you specify this, the version setting is fixed until you change it\\. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL NotStatement": { "Statement": "The statement to negate\\. You can use any statement that can be nested\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" @@ -22964,71 +27530,85 @@ "Statements": "The statements to combine with OR logic\\. You can use any statements that can be nested\\. \n*Required*: Yes \n*Type*: List of [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL OverrideAction": { - "Count": "Override the rule action settings to count\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "None": "Don't override the rule action settings\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Count": "Override the rule group evaluation result to count only\\. \nThis option is usually set to none\\. It does not affect how the rules in the rule group are evaluated\\. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with `Count` action, in your rule group reference statement settings\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "None": "Don't override the rule group evaluation result\\. This is the most common setting\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL RateBasedStatement": { "AggregateKeyType": "Setting that indicates how to aggregate the request counts\\. The options are the following: \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\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FORWARDED_IP | IP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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\\. \nIf the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all\\.\nThis is required if `AggregateKeyType` is set to `FORWARDED_IP`\\. \n*Required*: No \n*Type*: [ForwardedIPConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-forwardedipconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Limit": "The limit on requests per 5\\-minute period for a single originating IP address\\. If the statement includes a `ScopeDownStatement`, this limit is applied only to the requests that match the statement\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ScopeDownStatement": "An optional nested statement that narrows the scope of the rate\\-based statement to matching web requests\\. This can be any nestable statement, and you can nest statements at any level below this scope\\-down statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ScopeDownStatement": "An optional nested statement that narrows the scope of the web requests that are evaluated by the rate\\-based statement\\. Requests are only tracked by the rate\\-based statement if they match the scope\\-down statement\\. You can use any nestable `Statement` in the scope\\-down statement, and you can nest statements at any level, the same as you can for a rule statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL RegexMatchStatement": { - "FieldToMatch": "The part of a web request that you want AWS WAF to inspect\\. For more information, see `FieldToMatch`\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FieldToMatch": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RegexString": "The string representing the regular expression\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL RegexPatternSetReferenceStatement": { - "Arn": "The Amazon Resource Name \\(ARN\\) of the regular expression pattern set that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FieldToMatch": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Arn": "The Amazon Resource Name \\(ARN\\) of the [AWS::WAFv2::RegexPatternSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html) that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FieldToMatch": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL Rule": { "Action": "The action that AWS WAF should take on a web request when it matches the rule's statement\\. Settings at the web ACL level can override the rule action setting\\. \nThis is used only for rules whose statements don't reference a rule group\\. Rule statements that reference a rule group are `RuleGroupReferenceStatement` and `ManagedRuleGroupStatement`\\. \nYou must set either this `Action` setting or the rule's `OverrideAction`, but not both: \n+ If the rule statement doesn't reference a rule group, you must set this rule action setting and you must not set the rule's override action setting\\. \n+ If the rule statement references a rule group, you must not set this action setting, because the actions are already set on the rules inside the rule group\\. You must set the rule's override action setting to indicate specifically whether to override the actions that are set on the rules in the rule group\\. \n*Required*: Conditional \n*Type*: [RuleAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "CaptchaConfig": "Specifies how AWS WAF should handle `CAPTCHA` evaluations\\. If you don't specify this, AWS WAF uses the `CAPTCHA` configuration that's defined for the web ACL\\. \n*Required*: No \n*Type*: [CaptchaConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-captchaconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Name": "The descriptive name of the rule\\. You can't change the name of a `Rule` after you create it\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ChallengeConfig": "Specifies how AWS WAF should handle `Challenge` evaluations\\. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL\\. \n*Required*: No \n*Type*: [ChallengeConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-challengeconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the rule\\. You can't change the name of a `Rule` after you create it\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "OverrideAction": "The override action to apply to the rules in a rule group, instead of the individual rule action settings\\. This is used only for rules whose statements reference a rule group\\. Rule statements that reference a rule group are `RuleGroupReferenceStatement` and `ManagedRuleGroupStatement`\\. \nSet the override action to none to leave the rule group rule actions in effect\\. Set it to count to only count matches, regardless of the rule action settings\\. \nYou must set either this `OverrideAction` setting or the `Action` setting, but not both: \n+ If the rule statement references a rule group, you must set this override action setting and you must not set the rule's action setting\\. \n+ If the rule statement doesn't reference a rule group, you must set the rule action setting and you must not set the rule's override action setting\\. \n*Required*: Conditional \n*Type*: [OverrideAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-overrideaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Priority": "If you define more than one `Rule` in a `WebACL`, AWS WAF evaluates each request against the `Rules` in order based on the value of `Priority`\\. AWS WAF processes rules with lower priority first\\. The priorities don't need to be consecutive, but they must all be different\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RuleLabels": "Labels to apply to web requests that match the rule match statement\\. AWS WAF applies fully qualified labels to matching web requests\\. A fully qualified label is the concatenation of a label namespace and a rule label\\. The rule's rule group or web ACL defines the label namespace\\. \nRules that run after this rule in the web ACL can match against these labels using a `LabelMatchStatement`\\. \nFor each label, provide a case\\-sensitive string containing optional namespaces and a label name, according to the following guidelines: \n+ Separate each component of the label with a colon\\. \n+ Each namespace or name can have up to 128 characters\\.\n+ You can specify up to 5 namespaces in a label\\.\n+ Don't use the following reserved words in your label specification: `aws`, `waf`, `managed`, `rulegroup`, `webacl`, `regexpatternset`, or `ipset`\\.\nFor example, `myLabelName` or `nameSpace1:nameSpace2:myLabelName`\\. \n*Required*: No \n*Type*: List of [Label](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-label.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Statement": "The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Statement": "The AWS WAF processing statement for the rule, for example [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-bytematchstatement) or [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-sizeconstraintstatement)\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "VisibilityConfig": "Defines and enables Amazon CloudWatch metrics and web request sample collection\\. \n*Required*: Yes \n*Type*: [VisibilityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-visibilityconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL RuleAction": { "Allow": "Instructs AWS WAF to allow the web request\\. \n*Required*: No \n*Type*: [AllowAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-allowaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Block": "Instructs AWS WAF to block the web request\\. \n*Required*: No \n*Type*: [BlockAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-blockaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Captcha": "Specifies that AWS WAF should run a `CAPTCHA` check against the request: \n+ If the request includes a valid, unexpired `CAPTCHA` token, AWS WAF allows the web request inspection to proceed to the next rule, similar to a `CountAction`\\. \n+ If the request doesn't include a valid, unexpired `CAPTCHA` token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination\\.", - "Count": "Instructs AWS WAF to count the web request and allow it\\. \n*Required*: No \n*Type*: [CountAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-countaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Challenge": "Instructs AWS WAF to run a `Challenge` check against the web request\\. \n*Required*: No \n*Type*: [ChallengeAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-challengeaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Count": "Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL\\. \n*Required*: No \n*Type*: [CountAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-countaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::WebACL RuleActionOverride": { + "ActionToUse": "The override action to use, in place of the configured action of the rule in the rule group\\. \n*Required*: Yes \n*Type*: [RuleAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Name": "The name of the rule to override\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL RuleGroupReferenceStatement": { "Arn": "The Amazon Resource Name \\(ARN\\) of the entity\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "ExcludedRules": "The rules in the referenced rule group whose actions are set to `Count`\\. When you exclude a rule, AWS WAF evaluates it exactly as it would if the rule action setting were `Count`\\. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic\\. \n*Required*: No \n*Type*: List of [ExcludedRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "ExcludedRules": "Rules in the referenced rule group whose actions are set to `Count`\\. \nInstead of this option, use `RuleActionOverrides`\\. It accepts any valid action setting, including `Count`\\.\n*Required*: No \n*Type*: List of [ExcludedRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RuleActionOverrides": "Action settings to use in the place of the rule actions that are configured inside the rule group\\. You specify one override for each rule whose action you want to change\\. \nYou can use overrides for testing, for example you can override all of rule actions to `Count` and then monitor the resulting count metrics to understand how the rule group would handle your web traffic\\. You can also permanently override some or all actions, to modify how the rule group manages your web traffic\\. \n*Required*: No \n*Type*: List of [RuleActionOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleactionoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::WebACL SingleHeader": { + "Name": "The name of the query header to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::WAFv2::WebACL SingleQueryArgument": { + "Name": "The name of the query argument to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL SizeConstraintStatement": { "ComparisonOperator": "The operator to use to compare the request part to the size setting\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `EQ | GE | GT | LE | LT | NE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "FieldToMatch": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "FieldToMatch": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "Size": "The size, in byte, to compare to the request part, after any transformations\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL SqliMatchStatement": { - "FieldToMatch": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "FieldToMatch": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SensitivityLevel": "The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks\\. \n `HIGH` detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings\\. For information about identifying and mitigating false positives, see [Testing and tuning](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-testing.html) in the * AWS WAF Developer Guide*\\. \n `LOW` is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives\\. \nDefault: `LOW` \n*Required*: No \n*Type*: String \n*Allowed values*: `HIGH | LOW` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL Statement": { "AndStatement": "A logical rule statement used to combine other rule statements with AND logic\\. You provide more than one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `AndStatement`\\. \n*Required*: No \n*Type*: [AndStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-andstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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 refered to as a string match statement\\. \n*Required*: No \n*Type*: [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "GeoMatchStatement": "A rule statement used to identify web requests based on country of origin\\. \n*Required*: No \n*Type*: [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: No \n*Type*: [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "GeoMatchStatement": "A rule statement that labels web requests by country and region and that matches against web requests based on country code\\. A geo match rule labels every request that it inspects regardless of whether it finds a match\\. \n+ To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the `CountryCodes` array\\. \n+ Otherwise, configure your geo match rule with Count action so that it only labels requests\\. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed\\. \n AWS WAF labels requests using the alpha\\-2 country and region codes from the International Organization for Standardization \\(ISO\\) 3166 standard\\. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match `ForwardedIPConfig`\\. \nIf you use the web request origin, the label formats are `awswaf:clientip:geo:region:-` and `awswaf:clientip:geo:country:`\\. \nIf you use a forwarded IP address, the label formats are `awswaf:forwardedip:geo:region:-` and `awswaf:forwardedip:geo:country:`\\. \nFor additional details, see [Geographic match rule statement](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "IPSetReferenceStatement": "A rule statement used to detect web requests coming from particular IP addresses or address ranges\\. To use this, create an [AWS::WAFv2::IPSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html) that specifies the addresses you want to detect, then use the ARN of that set in this statement\\. \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\\. \n*Required*: No \n*Type*: [IPSetReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ipsetreferencestatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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\\. \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\\. \n*Required*: No \n*Type*: [LabelMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-labelmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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\\. \nYou can't 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\\. \n*Required*: No \n*Type*: [ManagedRuleGroupStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "LabelMatchStatement": "A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL\\. \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\\. \n*Required*: No \n*Type*: [LabelMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-labelmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \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\\. \n*Required*: No \n*Type*: [ManagedRuleGroupStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NotStatement": "A logical rule statement used to negate the results of another rule statement\\. You provide one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `NotStatement`\\. \n*Required*: No \n*Type*: [NotStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "OrStatement": "A logical rule statement used to combine other rule statements with OR logic\\. You provide more than one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `OrStatement`\\. \n*Required*: No \n*Type*: [OrStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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\\. \nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit\\. \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+ 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\\.\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 conditions in the statements are counted\\. If the count exceeds 1,000 requests per five minutes, the rule action triggers\\. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule\\. \nYou cannot nest a `RateBasedStatement`, for example for use inside a `NotStatement` or `OrStatement`\\. It can only be referenced as a top\\-level statement within a rule\\. \n*Required*: No \n*Type*: [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "OrStatement": "A logical rule statement used to combine other rule statements with OR logic\\. You provide more than one `Statement` within the `OrStatement`\\. \n*Required*: No \n*Type*: [OrStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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 AWS 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\\. \nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit\\. \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+ An IP match statement with an IP set that specifies the address 192\\.0\\.2\\.44\\.\n+ A string match statement that searches in the User\\-Agent header for the string BadBot\\.\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\\. \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\\. \n*Required*: No \n*Type*: [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RegexMatchStatement": "A rule statement used to search web request components for a match against a single regular expression\\. \n*Required*: No \n*Type*: [RegexMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RegexPatternSetReferenceStatement": "A rule statement used to search web request components for matches with regular expressions\\. To use this, create a [AWS::WAFv2::RegexPatternSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html) 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\\. \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\\. \n*Required*: No \n*Type*: [RegexPatternSetReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-regexpatternsetreferencestatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RuleGroupReferenceStatement": "A rule statement used to run the rules that are defined in a [AWS::WAFv2::RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html)\\. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement\\. \nYou cannot nest a `RuleGroupReferenceStatement`, for example for use inside a `NotStatement` or `OrStatement`\\. It can only be referenced as a top\\-level statement within a rule\\. \n*Required*: No \n*Type*: [RuleGroupReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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\\. \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 can create a size constraint condition and block requests that have a request body greater than 8192 bytes\\. \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\\. \n*Required*: No \n*Type*: [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SqliMatchStatement": "Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database\\. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions\\. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect\\. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code\\. \n*Required*: No \n*Type*: [SqliMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "XssMatchStatement": "A rule statement that defines a cross\\-site scripting \\(XSS\\) match search for AWS WAF to apply to web requests\\. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client\\-site scripts into other legitimate web browsers\\. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings\\. \n*Required*: No \n*Type*: [XssMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "RuleGroupReferenceStatement": "A rule statement used to run the rules that are defined in a [AWS::WAFv2::RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html)\\. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement\\. \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\\. \n*Required*: No \n*Type*: [RuleGroupReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \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\\. \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\\. \n*Required*: No \n*Type*: [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: No \n*Type*: [SqliMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: No \n*Type*: [XssMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL TextTransformation": { "Priority": "Sets the relative processing order for multiple transformations that are defined for a rule statement\\. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content\\. The priorities don't need to be consecutive, but they must all be different\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -23036,15 +27616,15 @@ }, "AWS::WAFv2::WebACL VisibilityConfig": { "CloudWatchMetricsEnabled": "A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch\\. For the list of available metrics, see [AWS WAF Metrics](https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics)\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "MetricName": "The descriptive name of the Amazon CloudWatch metric\\. The name can contain only alphanumeric characters \\(A\\-Z, a\\-z, 0\\-9\\), with length from one to 128 characters\\. It can't contain whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default\\_Action\\.\" You can't change a `MetricName` after you create a `VisibilityConfig`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "MetricName": "A name of the Amazon CloudWatch metric dimension\\. The name can contain only the characters: A\\-Z, a\\-z, 0\\-9, \\- \\(hyphen\\), and \\_ \\(underscore\\)\\. The name can be from one to 128 characters long\\. It can't contain whitespace or metric names that are reserved for AWS WAF, for example `All` and `Default_Action`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SampledRequestsEnabled": "A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules\\. You can view the sampled requests through the AWS WAF console\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACL XssMatchStatement": { - "FieldToMatch": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "FieldToMatch": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WAFv2::WebACLAssociation": { - "ResourceArn": "The Amazon Resource Name \\(ARN\\) of the resource to associate with the web ACL\\. \nThe ARN must be in one of the following formats: \n+ For an Application Load Balancer: `arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id ` \n+ For an Amazon API Gateway REST API: `arn:aws:apigateway:region::/restapis/api-id/stages/stage-name ` \n+ For an AWS AppSync GraphQL API: `arn:aws:appsync:region:account-id:apis/GraphQLApiId`\nFor Amazon CloudFront, define the association in your CloudFront distribution configuration\\. To associate a web ACL, provide the Amazon Resource Name \\(ARN\\) of the [AWS::WAFv2::WebACL](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html) to your CloudFront distribution configuration\\. To disassociate a web ACL, provide an empty ARN\\. For information, see [AWS::CloudFront::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "ResourceArn": "The Amazon Resource Name \\(ARN\\) of the resource to associate with the web ACL\\. \nThe ARN must be in one of the following formats: \n+ For an Application Load Balancer: `arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id ` \n+ For an Amazon API Gateway REST API: `arn:aws:apigateway:region::/restapis/api-id/stages/stage-name ` \n+ For an AWS AppSync GraphQL API: `arn:aws:appsync:region:account-id:apis/GraphQLApiId ` \n+ For an Amazon Cognito user pool: `arn:aws:cognito-idp:region:account-id:userpool/user-pool-id ` \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "WebACLArn": "The Amazon Resource Name \\(ARN\\) of the web ACL that you want to associate with the resource\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Wisdom::Assistant": { @@ -23086,7 +27666,7 @@ "KmsKeyId": "The KMS key\\. For information about valid ID values, see [Key identifiers \\(KeyId\\)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4096` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::Wisdom::KnowledgeBase SourceConfiguration": { - "AppIntegrations": "Configuration information for Amazon AppIntegrations to automatically ingest content\\. \n*Required*: No \n*Type*: [AppIntegrationsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-appintegrationsconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + "AppIntegrations": "Configuration information for Amazon AppIntegrations to automatically ingest content\\. \n*Required*: Yes \n*Type*: [AppIntegrationsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-appintegrationsconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" }, "AWS::WorkSpaces::ConnectionAlias": { "ConnectionString": "The connection string specified for the connection alias\\. The connection string must be in the form of a fully qualified domain name \\(FQDN\\), such as `www.example.com`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[.0-9a-zA-Z\\-]{1,255}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -23109,9 +27689,9 @@ "WorkspaceProperties": "The WorkSpace properties\\. \n*Required*: No \n*Type*: [WorkspaceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspaces-workspace-workspaceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::WorkSpaces::Workspace WorkspaceProperties": { - "ComputeTypeName": "The compute type\\. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GRAPHICS | GRAPHICSPRO | PERFORMANCE | POWER | POWERPRO | STANDARD | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "ComputeTypeName": "The compute type\\. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GRAPHICS | GRAPHICS_G4DN | GRAPHICSPRO | GRAPHICSPRO_G4DN | PERFORMANCE | POWER | POWERPRO | STANDARD | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RootVolumeSizeGib": "The size of the root volume\\. For important information about how to modify the size of the root and user volumes, see [Modify a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "RunningMode": "The running mode\\. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS_ON | AUTO_STOP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "RunningMode": "The running mode\\. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html)\\. \nThe `MANUAL` value is only supported by Amazon WorkSpaces Core\\. Contact your account team to be allow\\-listed to use this value\\. For more information, see [Amazon WorkSpaces Core](http://aws.amazon.com/workspaces/core/)\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS_ON | AUTO_STOP | MANUAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "RunningModeAutoStopTimeoutInMinutes": "The time after a user logs off when WorkSpaces are automatically stopped\\. Configured in 60\\-minute intervals\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "UserVolumeSizeGib": "The size of the user storage\\. For important information about how to modify the size of the root and user volumes, see [Modify a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, @@ -23119,18 +27699,27 @@ "FilterExpression": "The filter expression defining the parameters to include traces\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "GroupName": "The unique case\\-sensitive name of the group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "InsightsConfiguration": "The structure containing configurations related to insights\\. \n+ The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group\\.\n+ The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group\\.\n*Required*: No \n*Type*: [InsightsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-group-insightsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [TagsItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-group-tagsitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::XRay::Group InsightsConfiguration": { "InsightsEnabled": "Set the InsightsEnabled value to true to enable insights or false to disable insights\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "NotificationsEnabled": "Set the NotificationsEnabled value to true to enable insights notifications\\. Notifications can only be enabled on a group with InsightsEnabled set to true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::XRay::Group TagsItems": { + "Key": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, + "AWS::XRay::ResourcePolicy": { + "BypassPolicyLockoutCheck": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PolicyDocument": "The resource policy document, which can be up to 5kb in size\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "PolicyName": "The name of the resource policy\\. Must be unique within a specific AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\w+=,.@-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" + }, "AWS::XRay::SamplingRule": { "RuleName": "The name of the sampling rule\\. Specify a rule by either name or ARN, but not both\\. Used only when deleting a sampling rule\\. When creating or updating a sampling rule, use the `RuleName` or `RuleARN` properties within `SamplingRule` or `SamplingRuleUpdate`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SamplingRule": "The sampling rule to be created\\. \nMust be provided if creating a new sampling rule\\. Not valid when updating an existing sampling rule\\. \n*Required*: Conditional \n*Type*: [SamplingRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "SamplingRuleRecord": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SamplingRuleRecord](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "SamplingRuleRecord": "Property description not available\\. \n*Required*: No \n*Type*: [SamplingRuleRecord](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SamplingRuleUpdate": "A document specifying changes to a sampling rule's configuration\\. \nMust be provided if updating an existing sampling rule\\. Not valid when creating a new sampling rule\\. \nThe `Version` of a sampling rule cannot be updated, and is not part of `SamplingRuleUpdate`\\.\n*Required*: Conditional \n*Type*: [SamplingRuleUpdate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingruleupdate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + "Tags": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [TagsItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-tagsitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, "AWS::XRay::SamplingRule SamplingRule": { "Attributes": "Matches attributes derived from the request\\. \n*Map Entries:* Maximum number of 5 items\\. \n*Key Length Constraints:* Minimum length of 1\\. Maximum length of 32\\. \n*Value Length Constraints:* Minimum length of 1\\. Maximum length of 32\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -23166,6 +27755,10 @@ "ServiceType": "Matches the `origin` that the service uses to identify its type in segments\\. \n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "URLPath": "Matches the path from a request URL\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" }, + "AWS::XRay::SamplingRule TagsItems": { + "Key": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "Value": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)" + }, "Alexa::ASK::Skill": { "AuthenticationConfiguration": "Login with Amazon \\(LWA\\) configuration used to authenticate with the Alexa service\\. Only Login with Amazon clients created through the [Amazon Developer Console](https://developer.amazon.com/lwa/sp/overview.html) are supported\\. The client ID, client secret, and refresh token are required\\. \n*Required*: Yes \n*Type*: [AuthenticationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "SkillPackage": "Configuration for the skill package that contains the components of the Alexa skill\\. Skill packages are retrieved from an Amazon S3 bucket and key and used to create and update the skill\\. For more information about the skill package format, see the [Skill Package API Reference](https://developer.amazon.com/docs/smapi/skill-package-api-reference.html#skill-package-format)\\. \n*Required*: Yes \n*Type*: [SkillPackage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", diff --git a/schema_source/cloudformation.schema.json b/schema_source/cloudformation.schema.json index a60ffbbb3..6186af01c 100644 --- a/schema_source/cloudformation.schema.json +++ b/schema_source/cloudformation.schema.json @@ -58,7 +58,7 @@ "type": "string" }, "TemplateArn": { - "markdownDescription": "Specifies a custom configuration template to use when issuing a certificate\\. If this parameter is not provided, ACM Private CA defaults to the `EndEntityCertificate/V1` template\\. For more information about ACM Private CA templates, see [Using Templates](https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a custom configuration template to use when issuing a certificate\\. If this parameter is not provided, AWS Private CA defaults to the `EndEntityCertificate/V1` template\\. For more information about AWS Private CA templates, see [Using Templates](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TemplateArn", "type": "string" }, @@ -69,7 +69,7 @@ }, "ValidityNotBefore": { "$ref": "#/definitions/AWS::ACMPCA::Certificate.Validity", - "markdownDescription": "Information describing the start of the validity period of the certificate\\. This parameter sets the \u201cNot Before\" date for the certificate\\. \nBy default, when issuing a certificate, ACM Private CA sets the \"Not Before\" date to the issuance time minus 60 minutes\\. This compensates for clock inconsistencies across computer systems\\. The `ValidityNotBefore` parameter can be used to customize the \u201cNot Before\u201d value\\. \nUnlike the `Validity` parameter, the `ValidityNotBefore` parameter is optional\\. \nThe `ValidityNotBefore` value is expressed as an explicit date and time, using the `Validity` type value `ABSOLUTE`\\. \n*Required*: No \n*Type*: [Validity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Information describing the start of the validity period of the certificate\\. This parameter sets the \u201cNot Before\" date for the certificate\\. \nBy default, when issuing a certificate, AWS Private CA sets the \"Not Before\" date to the issuance time minus 60 minutes\\. This compensates for clock inconsistencies across computer systems\\. The `ValidityNotBefore` parameter can be used to customize the \u201cNot Before\u201d value\\. \nUnlike the `Validity` parameter, the `ValidityNotBefore` parameter is optional\\. \nThe `ValidityNotBefore` value is expressed as an explicit date and time, using the `Validity` type value `ABSOLUTE`\\. \n*Required*: No \n*Type*: [Validity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ValidityNotBefore" } }, @@ -122,9 +122,13 @@ "additionalProperties": false, "properties": { "ObjectIdentifier": { + "markdownDescription": "Specifies the object identifier \\(OID\\) of the attribute type of the relative distinguished name \\(RDN\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ObjectIdentifier", "type": "string" }, "Value": { + "markdownDescription": "Specifies the attribute value of relative distinguished name \\(RDN\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "string" } }, @@ -138,12 +142,18 @@ "additionalProperties": false, "properties": { "Critical": { + "markdownDescription": "Specifies the critical flag of the X\\.509 extension\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Critical", "type": "boolean" }, "ObjectIdentifier": { + "markdownDescription": "Specifies the object identifier \\(OID\\) of the X\\.509 extension\\. For more information, see the [Global OID reference database\\.](https://oidref.com/2.5.29) \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ObjectIdentifier", "type": "string" }, "Value": { + "markdownDescription": "Specifies the base64\\-encoded value of the X\\.509 extension\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4096` \n*Pattern*: `^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "string" } }, @@ -182,7 +192,7 @@ "type": "string" }, "ExtendedKeyUsageType": { - "markdownDescription": "Specifies a standard `ExtendedKeyUsage` as defined as in [RFC 5280](https://tools.ietf.org/html/rfc5280#section-4.2.1.12)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CERTIFICATE_TRANSPARENCY | CLIENT_AUTH | CODE_SIGNING | DOCUMENT_SIGNING | EMAIL_PROTECTION | OCSP_SIGNING | SERVER_AUTH | SMART_CARD_LOGIN | TIME_STAMPING` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a standard `ExtendedKeyUsage` as defined as in [RFC 5280](https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CERTIFICATE_TRANSPARENCY | CLIENT_AUTH | CODE_SIGNING | DOCUMENT_SIGNING | EMAIL_PROTECTION | OCSP_SIGNING | SERVER_AUTH | SMART_CARD_LOGIN | TIME_STAMPING` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ExtendedKeyUsageType", "type": "string" } @@ -204,6 +214,8 @@ "items": { "$ref": "#/definitions/AWS::ACMPCA::Certificate.CustomExtension" }, + "markdownDescription": "Contains a sequence of one or more X\\.509 extensions, each of which consists of an object identifier \\(OID\\), a base64\\-encoded value, and the critical flag\\. For more information, see the [Global OID reference database\\.](https://oidref.com/2.5.29) \n*Required*: No \n*Type*: List of [CustomExtension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CustomExtensions", "type": "array" }, "ExtendedKeyUsage": { @@ -216,7 +228,7 @@ }, "KeyUsage": { "$ref": "#/definitions/AWS::ACMPCA::Certificate.KeyUsage", - "markdownDescription": "Defines one or more purposes for which the key contained in the certificate can be used\\. Default value for each option is false\\. \n*Required*: No \n*Type*: [KeyUsage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Defines one or more purposes for which the key contained in the certificate can be used\\. Default value for each option is false\\. \n*Required*: No \n*Type*: [KeyUsage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeyUsage" }, "SubjectAlternativeNames": { @@ -264,7 +276,7 @@ "type": "string" }, "Rfc822Name": { - "markdownDescription": "Represents `GeneralName` as an [RFC 822](https://tools.ietf.org/html/rfc822) email address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Represents `GeneralName` as an [RFC 822](https://datatracker.ietf.org/doc/html/rfc822) email address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Rfc822Name", "type": "string" }, @@ -359,7 +371,7 @@ "items": { "$ref": "#/definitions/AWS::ACMPCA::Certificate.PolicyQualifierInfo" }, - "markdownDescription": "Modifies the given `CertPolicyId` with a qualifier\\. ACM Private CA supports the certification practice statement \\(CPS\\) qualifier\\. \n*Required*: No \n*Type*: List of [PolicyQualifierInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Modifies the given `CertPolicyId` with a qualifier\\. AWS Private CA supports the certification practice statement \\(CPS\\) qualifier\\. \n*Required*: No \n*Type*: List of [PolicyQualifierInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PolicyQualifiers", "type": "array" } @@ -379,7 +391,7 @@ }, "Qualifier": { "$ref": "#/definitions/AWS::ACMPCA::Certificate.Qualifier", - "markdownDescription": "Defines the qualifier type\\. ACM Private CA supports the use of a URI for a CPS qualifier in this field\\. \n*Required*: Yes \n*Type*: [Qualifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-qualifier.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Defines the qualifier type\\. AWS Private CA supports the use of a URI for a CPS qualifier in this field\\. \n*Required*: Yes \n*Type*: [Qualifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-qualifier.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Qualifier" } }, @@ -420,6 +432,8 @@ "items": { "$ref": "#/definitions/AWS::ACMPCA::Certificate.CustomAttribute" }, + "markdownDescription": "Contains a sequence of one or more X\\.500 relative distinguished names \\(RDNs\\), each of which consists of an object identifier \\(OID\\) and a value\\. For more information, see NIST\u2019s definition of [Object Identifier \\(OID\\)](https://csrc.nist.gov/glossary/term/Object_Identifier)\\. \nCustom attributes cannot be used in combination with standard attributes\\.\n*Required*: No \n*Type*: List of [CustomAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customattribute.html) \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CustomAttributes", "type": "array" }, "DistinguishedNameQualifier": { @@ -448,7 +462,7 @@ "type": "string" }, "Organization": { - "markdownDescription": "Legal name of the organization with which the certificate subject is affiliated\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Legal name of the organization with which the certificate subject is affiliated\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Organization", "type": "string" }, @@ -551,13 +565,13 @@ "type": "string" }, "KeyStorageSecurityStandard": { - "markdownDescription": "Specifies a cryptographic key management compliance standard used for handling CA keys\\. \nDefault: FIPS\\_140\\_2\\_LEVEL\\_3\\_OR\\_HIGHER \nNote: `FIPS_140_2_LEVEL_3_OR_HIGHER` is not supported in Region ap\\-northeast\\-3\\. When creating a CA in the ap\\-northeast\\-3, you must provide `FIPS_140_2_LEVEL_2_OR_HIGHER` as the argument for `KeyStorageSecurityStandard`\\. Failure to do this results in an `InvalidArgsException` with the message, \"A certificate authority cannot be created in this region with the specified security standard\\.\" \n*Required*: No \n*Type*: String \n*Allowed values*: `FIPS_140_2_LEVEL_2_OR_HIGHER | FIPS_140_2_LEVEL_3_OR_HIGHER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a cryptographic key management compliance standard used for handling CA keys\\. \nDefault: FIPS\\_140\\_2\\_LEVEL\\_3\\_OR\\_HIGHER \n *Note:* `FIPS_140_2_LEVEL_3_OR_HIGHER` is not supported in the following Regions: \n+ ap\\-northeast\\-3\n+ ap\\-southeast\\-3\nWhen creating a CA in these Regions, you must provide `FIPS_140_2_LEVEL_2_OR_HIGHER` as the argument for `KeyStorageSecurityStandard`\\. Failure to do this results in an `InvalidArgsException` with the message, \"A certificate authority cannot be created in this region with the specified security standard\\.\" \n*Required*: No \n*Type*: String \n*Allowed values*: `FIPS_140_2_LEVEL_2_OR_HIGHER | FIPS_140_2_LEVEL_3_OR_HIGHER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeyStorageSecurityStandard", "type": "string" }, "RevocationConfiguration": { "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.RevocationConfiguration", - "markdownDescription": "Information about the certificate revocation list \\(CRL\\) created and maintained by your private CA\\. Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions\\. Your certificate authority can create and maintain a certificate revocation list \\(CRL\\)\\. A CRL contains information about certificates that have been revoked\\. \n*Required*: No \n*Type*: [RevocationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Certificate revocation information used by the [CreateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html) and [UpdateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) actions\\. Your private certificate authority \\(CA\\) can configure Online Certificate Status Protocol \\(OCSP\\) support and/or maintain a certificate revocation list \\(CRL\\)\\. OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA\\. For more information, see [RevokeCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html) in the *AWS Private CA API Reference* and [Setting up a certificate revocation method](https://docs.aws.amazon.com/privateca/latest/userguide/revocation-setup.html) in the *AWS Private CA User Guide*\\. \nThe following requirements apply to revocation configurations\\. \n+ A configuration disabling CRLs or OCSP must contain only the `Enabled=False` parameter, and will fail if other parameters such as `CustomCname` or `ExpirationInDays` are included\\.\n+ In a CRL configuration, the `S3BucketName` parameter must conform to the [Amazon S3 bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html)\\.\n+ A configuration containing a custom Canonical Name \\(CNAME\\) parameter for CRLs or OCSP must conform to [RFC2396](https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in a CNAME\\. \n+ In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as \"http://\" or \"https://\"\\.\n*Required*: No \n*Type*: [RevocationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-revocationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RevocationConfiguration" }, "SigningAlgorithm": { @@ -584,6 +598,8 @@ "type": "string" }, "UsageMode": { + "markdownDescription": "Specifies whether the CA issues general\\-purpose certificates that typically require a revocation mechanism, or short\\-lived certificates that may optionally omit revocation because they expire quickly\\. Short\\-lived certificate validity is limited to seven days\\. \nThe default value is GENERAL\\_PURPOSE\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GENERAL_PURPOSE | SHORT_LIVED_CERTIFICATE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "UsageMode", "type": "string" } }, @@ -656,7 +672,7 @@ "additionalProperties": false, "properties": { "CustomCname": { - "markdownDescription": "Name inserted into the certificate **CRL Distribution Points** extension that enables the use of an alias for the CRL distribution point\\. Use this value if you don't want the name of your S3 bucket to be public\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Name inserted into the certificate **CRL Distribution Points** extension that enables the use of an alias for the CRL distribution point\\. Use this value if you don't want the name of your S3 bucket to be public\\. \nThe content of a Canonical Name \\(CNAME\\) record must conform to [RFC2396](https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in URIs\\. Additionally, the value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\"\\.\n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Pattern*: `^[-a-zA-Z0-9;/?:@&=+$,%_.!~*()']*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomCname", "type": "string" }, @@ -671,12 +687,12 @@ "type": "number" }, "S3BucketName": { - "markdownDescription": "Name of the S3 bucket that contains the CRL\\. If you do not provide a value for the **CustomCname** argument, the name of your S3 bucket is placed into the **CRL Distribution Points** extension of the issued certificate\\. You can change the name of your bucket by calling the [UpdateCertificateAuthority](https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html) operation\\. You must specify a [bucket policy](https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-policies) that allows ACM Private CA to write the CRL to your bucket\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Name of the S3 bucket that contains the CRL\\. If you do not provide a value for the **CustomCname** argument, the name of your S3 bucket is placed into the **CRL Distribution Points** extension of the issued certificate\\. You can change the name of your bucket by calling the [UpdateCertificateAuthority](https://docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html) operation\\. You must specify a [bucket policy](https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-policies) that allows AWS Private CA to write the CRL to your bucket\\. \nThe `S3BucketName` parameter must conform to the [S3 bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html)\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `^[-a-zA-Z0-9._/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3BucketName", "type": "string" }, "S3ObjectAcl": { - "markdownDescription": "Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket\\. If you choose PUBLIC\\_READ, the CRL will be accessible over the public internet\\. If you choose BUCKET\\_OWNER\\_FULL\\_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access\\. \nIf no value is specified, the default is PUBLIC\\_READ\\. \nThis default can cause CA creation to fail in some circumstances\\. If you have enabled the Block Public Access \\(BPA\\) feature in your S3 account, then you must specify the value of this parameter as `BUCKET_OWNER_FULL_CONTROL`, and not doing so results in an error\\. If you have disabled BPA in S3, then you can specify either `BUCKET_OWNER_FULL_CONTROL` or `PUBLIC_READ` as the value\\.\nFor more information, see [Blocking public access to the S3 bucket](https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-bpa)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket\\. If you choose PUBLIC\\_READ, the CRL will be accessible over the public internet\\. If you choose BUCKET\\_OWNER\\_FULL\\_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access\\. \nIf no value is specified, the default is PUBLIC\\_READ\\. \n*Note:* This default can cause CA creation to fail in some circumstances\\. If you have have enabled the Block Public Access \\(BPA\\) feature in your S3 account, then you must specify the value of this parameter as `BUCKET_OWNER_FULL_CONTROL`, and not doing so results in an error\\. If you have disabled BPA in S3, then you can specify either `BUCKET_OWNER_FULL_CONTROL` or `PUBLIC_READ` as the value\\. \nFor more information, see [Blocking public access to the S3 bucket](https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#s3-bpa)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3ObjectAcl", "type": "string" } @@ -695,7 +711,7 @@ "items": { "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.AccessDescription" }, - "markdownDescription": "For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy\\. For more information, see [Subject Information Access](https://tools.ietf.org/html/rfc5280#section-4.2.2.2) in RFC 5280\\. \n*Required*: No \n*Type*: List of [AccessDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "For CA certificates, provides a path to additional information pertaining to the CA, such as revocation and policy\\. For more information, see [Subject Information Access](https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2) in RFC 5280\\. \n*Required*: No \n*Type*: List of [AccessDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-accessdescription.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SubjectInformationAccess", "type": "array" } @@ -706,9 +722,13 @@ "additionalProperties": false, "properties": { "ObjectIdentifier": { + "markdownDescription": "Specifies the object identifier \\(OID\\) of the attribute type of the relative distinguished name \\(RDN\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `64` \n*Pattern*: `^([0-2])\\.([0-9]|([0-3][0-9]))((\\.([0-9]+)){0,126})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ObjectIdentifier", "type": "string" }, "Value": { + "markdownDescription": "Specifies the attribute value of relative distinguished name \\(RDN\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "string" } }, @@ -772,7 +792,7 @@ "type": "string" }, "Rfc822Name": { - "markdownDescription": "Represents `GeneralName` as an [RFC 822](https://tools.ietf.org/html/rfc822) email address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Represents `GeneralName` as an [RFC 822](https://datatracker.ietf.org/doc/html/rfc822) email address\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Rfc822Name", "type": "string" }, @@ -844,7 +864,7 @@ "type": "boolean" }, "OcspCustomCname": { - "markdownDescription": "By default, ACM Private CA injects an Amazon domain into certificates being validated by the Online Certificate Status Protocol \\(OCSP\\)\\. A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain\\. \nNote: The value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\"\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "By default, AWS Private CA injects an Amazon domain into certificates being validated by the Online Certificate Status Protocol \\(OCSP\\)\\. A customer can alternatively use this object to define a CNAME specifying a customized OCSP domain\\. \nThe content of a Canonical Name \\(CNAME\\) record must conform to [RFC2396](https://www.ietf.org/rfc/rfc2396.txt) restrictions on the use of special characters in URIs\\. Additionally, the value of the CNAME must not include a protocol prefix such as \"http://\" or \"https://\"\\.\n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `253` \n*Pattern*: `^[-a-zA-Z0-9;/?:@&=+$,%_.!~*()']*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OcspCustomCname", "type": "string" } @@ -904,6 +924,8 @@ "items": { "$ref": "#/definitions/AWS::ACMPCA::CertificateAuthority.CustomAttribute" }, + "markdownDescription": "Contains a sequence of one or more X\\.500 relative distinguished names \\(RDNs\\), each of which consists of an object identifier \\(OID\\) and a value\\. For more information, see NIST\u2019s definition of [Object Identifier \\(OID\\)](https://csrc.nist.gov/glossary/term/Object_Identifier)\\. \nCustom attributes cannot be used in combination with standard attributes\\.\n*Required*: No \n*Type*: List of [CustomAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificateauthority-customattribute.html) \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CustomAttributes", "type": "array" }, "DistinguishedNameQualifier": { @@ -1272,7 +1294,9 @@ "type": "string" }, "LoggingConfiguration": { - "$ref": "#/definitions/AWS::APS::Workspace.LoggingConfiguration" + "$ref": "#/definitions/AWS::APS::Workspace.LoggingConfiguration", + "markdownDescription": "The LoggingConfiguration attribute is used to set the logging configuration for the workspace\\. \n*Required*: No \n*Type*: [LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-aps-workspace-loggingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LoggingConfiguration" }, "Tags": { "items": { @@ -1309,6 +1333,8 @@ "additionalProperties": false, "properties": { "LogGroupArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the CloudWatch log group the logs are emitted to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogGroupArn", "type": "string" } }, @@ -2098,7 +2124,7 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "Personal Access token for 3rd party source control system for an Amplify app, used to create webhook and read\\-only deploy key\\. Token is not stored\\. \n*Length Constraints:* Minimum length of 1\\. Maximum length of 255\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The personal access token for a GitHub repository for an Amplify app\\. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App\\. The token is not stored\\. \nUse `AccessToken` for GitHub repositories only\\. To authorize access to a repository provider such as Bitbucket or CodeCommit, use `OauthToken`\\. \nYou must specify either `AccessToken` or `OauthToken` when you create a new app\\. \nExisting Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD\\. However, we strongly recommend that you migrate these apps to use the GitHub App\\. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* \\. \n*Length Constraints:* Minimum length of 1\\. Maximum length of 255\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, @@ -2136,7 +2162,7 @@ "type": "string" }, "EnableBranchAutoDeletion": { - "markdownDescription": "Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableBranchAutoDeletion", "type": "boolean" }, @@ -2159,11 +2185,13 @@ "type": "string" }, "OauthToken": { - "markdownDescription": "The OAuth token for a third\\-party source control system for an Amplify app\\. The OAuth token is used to create a webhook and a read\\-only deploy key\\. The OAuth token is not stored\\. \n*Length Constraints:* Maximum length of 1000\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The OAuth token for a third\\-party source control system for an Amplify app\\. The OAuth token is used to create a webhook and a read\\-only deploy key using SSH cloning\\. The OAuth token is not stored\\. \nUse `OauthToken` for repository providers other than GitHub, such as Bitbucket or CodeCommit\\. To authorize access to GitHub as your repository provider, use `AccessToken`\\. \nYou must specify either `OauthToken` or `AccessToken` when you create a new app\\. \nExisting Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD\\. However, we strongly recommend that you migrate these apps to use the GitHub App\\. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* \\. \n*Length Constraints:* Maximum length of 1000\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OauthToken", "type": "string" }, "Platform": { + "markdownDescription": "The platform for the Amplify app\\. For a static app, set the platform type to `WEB`\\. For a dynamic server\\-side rendered \\(SSR\\) app, set the platform type to `WEB_COMPUTE`\\. For an app requiring Amplify Hosting's original SSR support only, set the platform type to `WEB_DYNAMIC`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Platform", "type": "string" }, "Repository": { @@ -2243,7 +2271,7 @@ "type": "boolean" }, "EnablePullRequestPreview": { - "markdownDescription": "Sets whether pull request previews are enabled for each branch that Amplify Console automatically creates for your app\\. Amplify Console creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch\\. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch\\. \nTo provide backend support for your preview, the Amplify Console automatically provisions a temporary backend environment that it deletes when the pull request is closed\\. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property\\. \nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Console User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app\\. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch\\. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch\\. \nTo provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed\\. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property\\. \nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnablePullRequestPreview", "type": "boolean" }, @@ -2256,10 +2284,12 @@ "type": "array" }, "Framework": { + "markdownDescription": "The framework for the autocreated branch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Framework", "type": "string" }, "PullRequestEnvironmentName": { - "markdownDescription": "If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews\\. For example, you could specify an environment named `prod`, `test`, or `dev` that you initialized with the Amplify CLI\\. \nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true`\\. \nIf you don't specify an environment, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment\\. Amplify Console deletes this environment when the pull request is closed\\. \nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Console User Guide*\\. \n*Length Constraints:* Maximum length of 20\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews\\. For example, you could specify an environment named `prod`, `test`, or `dev` that you initialized with the Amplify CLI\\. \nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true`\\. \nIf you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment\\. Amplify deletes this environment when the pull request is closed\\. \nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide*\\. \n*Length Constraints:* Maximum length of 20\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PullRequestEnvironmentName", "type": "string" }, @@ -2413,7 +2443,7 @@ "type": "boolean" }, "EnablePullRequestPreview": { - "markdownDescription": "Sets whether the Amplify Console creates a preview for each pull request that is made for this branch\\. If this property is enabled, the Amplify Console deploys your app to a unique preview URL after each pull request is opened\\. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch\\. \nTo provide backend support for your preview, the Amplify Console automatically provisions a temporary backend environment that it deletes when the pull request is closed\\. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property\\. \nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Console User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch\\. If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened\\. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch\\. \nTo provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed\\. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property\\. \nFor more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnablePullRequestPreview", "type": "boolean" }, @@ -2426,10 +2456,12 @@ "type": "array" }, "Framework": { + "markdownDescription": "The framework for the branch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Framework", "type": "string" }, "PullRequestEnvironmentName": { - "markdownDescription": "If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews\\. For example, you could specify an environment named `prod`, `test`, or `dev` that you initialized with the Amplify CLI and mapped to this branch\\. \nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true`\\. \nIf you don't specify an environment, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment\\. Amplify Console deletes this environment when the pull request is closed\\. \nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Console User Guide*\\. \n*Length Constraints:* Maximum length of 20\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews\\. For example, you could specify an environment named `prod`, `test`, or `dev` that you initialized with the Amplify CLI and mapped to this branch\\. \nTo enable pull request previews, set the `EnablePullRequestPreview` property to `true`\\. \nIf you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment\\. Amplify Hosting deletes this environment when the pull request is closed\\. \nFor more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide*\\. \n*Length Constraints:* Maximum length of 20\\. \n*Pattern:* \\(?s\\)\\.\\* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PullRequestEnvironmentName", "type": "string" }, @@ -2675,6 +2707,8 @@ "additionalProperties": false, "properties": { "AppId": { + "markdownDescription": "The unique ID of the Amplify app associated with the component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppId", "type": "string" }, "BindingProperties": { @@ -2713,6 +2747,8 @@ "type": "string" }, "EnvironmentName": { + "markdownDescription": "The name of the backend environment that is a part of the Amplify app\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnvironmentName", "type": "string" }, "Events": { @@ -2732,7 +2768,7 @@ "type": "string" }, "Overrides": { - "markdownDescription": "Describes the component's properties that can be overriden in a customized instance of the component\\. You can't specify `tags` as a valid property for `overrides`\\. \n*Required*: Yes \n*Type*: Map of [ComponentOverridesValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentoverridesvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Describes the component's properties that can be overriden in a customized instance of the component\\. You can't specify `tags` as a valid property for `overrides`\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Overrides", "type": "object" }, @@ -2818,7 +2854,7 @@ }, "Fields": { "additionalProperties": false, - "markdownDescription": "A dictionary of key\\-value pairs mapping Amplify Studio properties to fields in a data model\\. Use when the action performs an operation on an Amplify DataStore model\\. \n*Required*: No \n*Type*: [ComponentProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A dictionary of key\\-value pairs mapping Amplify Studio properties to fields in a data model\\. Use when the action performs an operation on an Amplify DataStore model\\. \n*Required*: No \n*Type*: Map of [ComponentProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Component.ComponentProperty" @@ -2948,7 +2984,7 @@ }, "Events": { "additionalProperties": false, - "markdownDescription": "Describes the events that can be raised on the child component\\. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components\\. \n*Required*: No \n*Type*: [ComponentEvents](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevents.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Describes the events that can be raised on the child component\\. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components\\. \n*Required*: No \n*Type*: Map of [ComponentEvent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Component.ComponentEvent" @@ -2964,7 +3000,7 @@ }, "Properties": { "additionalProperties": false, - "markdownDescription": "Describes the properties of the child component\\. You can't specify `tags` as a valid property for `properties`\\. \n*Required*: Yes \n*Type*: [ComponentProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Describes the properties of the child component\\. You can't specify `tags` as a valid property for `properties`\\. \n*Required*: Yes \n*Type*: Map of [ComponentProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Component.ComponentProperty" @@ -3083,7 +3119,7 @@ }, "Bindings": { "additionalProperties": false, - "markdownDescription": "The information to bind the component property to form data\\. \n*Required*: No \n*Type*: [FormBindings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-formbindings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The information to bind the component property to form data\\. \n*Required*: No \n*Type*: Map of [FormBindingElement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-formbindingelement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Component.FormBindingElement" @@ -3186,13 +3222,13 @@ "additionalProperties": false, "properties": { "Overrides": { - "markdownDescription": "The properties of the component variant that can be overriden when customizing an instance of the component\\. You can't specify `tags` as a valid property for `overrides`\\. \n*Required*: No \n*Type*: [ComponentOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentoverrides.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties of the component variant that can be overriden when customizing an instance of the component\\. You can't specify `tags` as a valid property for `overrides`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Overrides", "type": "object" }, "VariantValues": { "additionalProperties": true, - "markdownDescription": "The combination of variants that comprise this variant\\. \n*Required*: No \n*Type*: [ComponentVariantValues](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentvariantvalues.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The combination of variants that comprise this variant\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -3208,9 +3244,13 @@ "additionalProperties": false, "properties": { "Element": { + "markdownDescription": "The name of the component to retrieve a value from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Element", "type": "string" }, "Property": { + "markdownDescription": "The property to retrieve a value from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Property", "type": "string" } }, @@ -3339,54 +3379,76 @@ "additionalProperties": false, "properties": { "AppId": { + "markdownDescription": "The unique ID of the Amplify app associated with the form\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppId", "type": "string" }, "Cta": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormCTA" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormCTA", + "markdownDescription": "Stores the call to action configuration for the form\\. \n*Required*: No \n*Type*: [FormCTA](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cta" }, "DataType": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormDataTypeConfig" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormDataTypeConfig", + "markdownDescription": "The type of data source to use to create the form\\. \n*Required*: Yes \n*Type*: [FormDataTypeConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formdatatypeconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType" }, "EnvironmentName": { + "markdownDescription": "The name of the backend environment that is a part of the Amplify app\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnvironmentName", "type": "string" }, "Fields": { "additionalProperties": false, + "markdownDescription": "Stores the information about the form's fields\\. \n*Required*: Yes \n*Type*: Map of [FieldConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldConfig" } }, + "title": "Fields", "type": "object" }, "FormActionType": { + "markdownDescription": "The operation to perform on the specified form\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FormActionType", "type": "string" }, "Name": { + "markdownDescription": "The name of the form\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "SchemaVersion": { + "markdownDescription": "The schema version of the form when it was imported\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SchemaVersion", "type": "string" }, "SectionalElements": { "additionalProperties": false, + "markdownDescription": "Stores the visual helper elements for the form that are not associated with any data\\. \n*Required*: Yes \n*Type*: Map of [SectionalElement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.SectionalElement" } }, + "title": "SectionalElements", "type": "object" }, "Style": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyle" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyle", + "markdownDescription": "Stores the configuration for the form's style\\. \n*Required*: Yes \n*Type*: [FormStyle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyle.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Style" }, "Tags": { "additionalProperties": true, + "markdownDescription": "One or more key\\-value pairs to use when tagging the form\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -3426,21 +3488,31 @@ "additionalProperties": false, "properties": { "Excluded": { + "markdownDescription": "Specifies whether to hide a field\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Excluded", "type": "boolean" }, "InputType": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldInputConfig" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldInputConfig", + "markdownDescription": "Describes the configuration for the default input value to display for a field\\. \n*Required*: No \n*Type*: [FieldInputConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputType" }, "Label": { + "markdownDescription": "The label for the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Label", "type": "string" }, "Position": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldPosition" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldPosition", + "markdownDescription": "Specifies the field position\\. \n*Required*: No \n*Type*: [FieldPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Position" }, "Validations": { "items": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldValidationConfiguration" }, + "markdownDescription": "The validations to perform on the value in the field\\. \n*Required*: No \n*Type*: List of [FieldValidationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Validations", "type": "array" } }, @@ -3450,49 +3522,79 @@ "additionalProperties": false, "properties": { "DefaultChecked": { + "markdownDescription": "Specifies whether a field has a default value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultChecked", "type": "boolean" }, "DefaultCountryCode": { + "markdownDescription": "The default country code for a phone number\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultCountryCode", "type": "string" }, "DefaultValue": { + "markdownDescription": "The default value for the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultValue", "type": "string" }, "DescriptiveText": { + "markdownDescription": "The text to display to describe the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DescriptiveText", "type": "string" }, "IsArray": { + "markdownDescription": "Specifies whether to render the field as an array\\. This property is ignored if the `dataSourceType` for the form is a Data Store\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsArray", "type": "boolean" }, "MaxValue": { + "markdownDescription": "The maximum value to display for the field\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxValue", "type": "number" }, "MinValue": { + "markdownDescription": "The minimum value to display for the field\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MinValue", "type": "number" }, "Name": { + "markdownDescription": "The name of the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Placeholder": { + "markdownDescription": "The text to display as a placeholder for the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Placeholder", "type": "string" }, "ReadOnly": { + "markdownDescription": "Specifies a read only field\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReadOnly", "type": "boolean" }, "Required": { + "markdownDescription": "Specifies a field that requires input\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Required", "type": "boolean" }, "Step": { + "markdownDescription": "The stepping increment for a numeric value in a field\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Step", "type": "number" }, "Type": { + "markdownDescription": "The input type for the field\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "Value": { + "markdownDescription": "The value for the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" }, "ValueMappings": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.ValueMappings" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.ValueMappings", + "markdownDescription": "The information to use to customize the input fields with data at runtime\\. \n*Required*: No \n*Type*: [ValueMappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemappings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ValueMappings" } }, "required": [ @@ -3504,12 +3606,18 @@ "additionalProperties": false, "properties": { "Below": { + "markdownDescription": "The field position is below the field specified by the string\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Below", "type": "string" }, "Fixed": { + "markdownDescription": "The field position is fixed and doesn't change in relation to other fields\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Fixed", "type": "string" }, "RightOf": { + "markdownDescription": "The field position is to the right of the field specified by the string\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RightOf", "type": "string" } }, @@ -3522,18 +3630,26 @@ "items": { "type": "number" }, + "markdownDescription": "The validation to perform on a number value\\. \n*Required*: No \n*Type*: List of Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NumValues", "type": "array" }, "StrValues": { "items": { "type": "string" }, + "markdownDescription": "The validation to perform on a string value\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StrValues", "type": "array" }, "Type": { + "markdownDescription": "The validation to perform on an object type\\.`` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "ValidationMessage": { + "markdownDescription": "The validation message to display\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ValidationMessage", "type": "string" } }, @@ -3546,13 +3662,19 @@ "additionalProperties": false, "properties": { "Children": { + "markdownDescription": "Describes the button's properties\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Children", "type": "string" }, "Excluded": { + "markdownDescription": "Specifies whether the button is visible on the form\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Excluded", "type": "boolean" }, "Position": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldPosition" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldPosition", + "markdownDescription": "The position of the button\\. \n*Required*: No \n*Type*: [FieldPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Position" } }, "type": "object" @@ -3561,16 +3683,24 @@ "additionalProperties": false, "properties": { "Cancel": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormButton" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormButton", + "markdownDescription": "Displays a cancel button\\. \n*Required*: No \n*Type*: [FormButton](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cancel" }, "Clear": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormButton" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormButton", + "markdownDescription": "Displays a clear button\\. \n*Required*: No \n*Type*: [FormButton](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Clear" }, "Position": { + "markdownDescription": "The position of the button\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Position", "type": "string" }, "Submit": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormButton" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormButton", + "markdownDescription": "Displays a submit button\\. \n*Required*: No \n*Type*: [FormButton](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Submit" } }, "type": "object" @@ -3579,9 +3709,13 @@ "additionalProperties": false, "properties": { "DataSourceType": { + "markdownDescription": "The data source type, either an Amplify DataStore model or a custom data type\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSourceType", "type": "string" }, "DataTypeName": { + "markdownDescription": "The unique name of the data type you are using as the data source for the form\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataTypeName", "type": "string" } }, @@ -3595,6 +3729,8 @@ "additionalProperties": false, "properties": { "Value": { + "markdownDescription": "The value to assign to the input field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -3604,13 +3740,19 @@ "additionalProperties": false, "properties": { "HorizontalGap": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyleConfig" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyleConfig", + "markdownDescription": "The spacing for the horizontal gap\\. \n*Required*: No \n*Type*: [FormStyleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HorizontalGap" }, "OuterPadding": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyleConfig" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyleConfig", + "markdownDescription": "The size of the outer padding for the form\\. \n*Required*: No \n*Type*: [FormStyleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OuterPadding" }, "VerticalGap": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyleConfig" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormStyleConfig", + "markdownDescription": "The spacing for the vertical gap\\. \n*Required*: No \n*Type*: [FormStyleConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VerticalGap" } }, "type": "object" @@ -3619,9 +3761,13 @@ "additionalProperties": false, "properties": { "TokenReference": { + "markdownDescription": "A reference to a design token to use to bind the form's style properties to an existing theme\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TokenReference", "type": "string" }, "Value": { + "markdownDescription": "The value of the style setting\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -3631,21 +3777,33 @@ "additionalProperties": false, "properties": { "Excluded": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Excluded", "type": "boolean" }, "Level": { + "markdownDescription": "Specifies the size of the font for a `Heading` sectional element\\. Valid values are `1 | 2 | 3 | 4 | 5 | 6`\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Level", "type": "number" }, "Orientation": { + "markdownDescription": "Specifies the orientation for a `Divider` sectional element\\. Valid values are `horizontal` or `vertical`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Orientation", "type": "string" }, "Position": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldPosition" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FieldPosition", + "markdownDescription": "Specifies the position of the text in a field for a `Text` sectional element\\. \n*Required*: No \n*Type*: [FieldPosition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Position" }, "Text": { + "markdownDescription": "The text for a `Text` sectional element\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Text", "type": "string" }, "Type": { + "markdownDescription": "The type of sectional element\\. Valid values are `Heading`, `Text`, and `Divider`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -3658,10 +3816,14 @@ "additionalProperties": false, "properties": { "DisplayValue": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormInputValueProperty" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormInputValueProperty", + "markdownDescription": "The value to display for the complex object\\. \n*Required*: No \n*Type*: [FormInputValueProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DisplayValue" }, "Value": { - "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormInputValueProperty" + "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.FormInputValueProperty", + "markdownDescription": "The complex object\\. \n*Required*: Yes \n*Type*: [FormInputValueProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value" } }, "required": [ @@ -3676,6 +3838,8 @@ "items": { "$ref": "#/definitions/AWS::AmplifyUIBuilder::Form.ValueMapping" }, + "markdownDescription": "The value and display value pairs\\. \n*Required*: Yes \n*Type*: List of [ValueMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemapping.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Values", "type": "array" } }, @@ -3720,9 +3884,13 @@ "additionalProperties": false, "properties": { "AppId": { + "markdownDescription": "The unique ID for the Amplify app associated with the theme\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppId", "type": "string" }, "EnvironmentName": { + "markdownDescription": "The name of the backend environment that is a part of the Amplify app\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnvironmentName", "type": "string" }, "Name": { @@ -3856,7 +4024,7 @@ "additionalProperties": false, "properties": { "CloudWatchRoleArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an IAM role that has write access to CloudWatch Logs in your account\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN of an Amazon CloudWatch role for the current Account\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchRoleArn", "type": "string" } @@ -3919,22 +4087,22 @@ "additionalProperties": false, "properties": { "CustomerId": { - "markdownDescription": "An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomerId", "type": "string" }, "Description": { - "markdownDescription": "A description of the purpose of the API key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the ApiKey\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "Enabled": { - "markdownDescription": "Indicates whether the API key can be used by clients\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the ApiKey can be used by callers\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, "GenerateDistinctId": { - "markdownDescription": "Specifies whether the key identifier is distinct from the created API key value\\. This parameter is deprecated and should not be used\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies whether \\(`true`\\) or not \\(`false`\\) the key identifier is distinct from the created API key value\\. This parameter is deprecated and should not be used\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "GenerateDistinctId", "type": "boolean" }, @@ -3947,7 +4115,7 @@ "items": { "$ref": "#/definitions/AWS::ApiGateway::ApiKey.StageKey" }, - "markdownDescription": "A list of stages to associate with this API key\\. \n*Required*: No \n*Type*: List of [StageKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "DEPRECATED FOR USAGE PLANS \\- Specifies stages associated with the API key\\. \n*Required*: No \n*Type*: List of [StageKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StageKeys", "type": "array" }, @@ -3955,12 +4123,12 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the API key\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key\\-value map of strings\\. The valid character set is \\[a\\-zA\\-Z\\+\\-=\\.\\_:/\\]\\. The tag key can be up to 128 characters and must not start with `aws:`\\. The tag value can be up to 256 characters\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, "Value": { - "markdownDescription": "The value of the API key\\. Must be at least 20 characters long\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a value of the API key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Value", "type": "string" } @@ -3991,12 +4159,12 @@ "additionalProperties": false, "properties": { "RestApiId": { - "markdownDescription": "The ID of a `RestApi` resource that includes the stage with which you want to associate the API key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RestApiId", "type": "string" }, "StageName": { - "markdownDescription": "The name of the stage with which to associate the API key\\. The stage must be included in the `RestApi` resource that you specified in the `RestApiId` property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The stage name associated with the stage key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StageName", "type": "string" } @@ -4039,32 +4207,32 @@ "additionalProperties": false, "properties": { "AuthType": { - "markdownDescription": "An optional customer\\-defined field that's used in OpenApi imports and exports without functional impact\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Optional customer\\-defined field, used in OpenAPI imports and exports without functional impact\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthType", "type": "string" }, "AuthorizerCredentials": { - "markdownDescription": "The credentials that are required for the authorizer\\. To specify an IAM role that API Gateway assumes, specify the role's Amazon Resource Name \\(ARN\\)\\. To use resource\\-based permissions on the Lambda function, specify null\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer\\. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name \\(ARN\\)\\. To use resource\\-based permissions on the Lambda function, specify null\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizerCredentials", "type": "string" }, "AuthorizerResultTtlInSeconds": { - "markdownDescription": "The time\\-to\\-live \\(TTL\\) period, in seconds, that specifies how long API Gateway caches authorizer results\\. If you specify a value greater than 0, API Gateway caches the authorizer responses\\. By default, API Gateway sets this property to 300\\. The maximum value is 3600, or 1 hour\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The TTL in seconds of cached authorizer results\\. If it equals 0, authorization caching is disabled\\. If it is greater than 0, API Gateway will cache authorizer responses\\. If this field is not set, the default value is 300\\. The maximum value is 3600, or 1 hour\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizerResultTtlInSeconds", "type": "number" }, "AuthorizerUri": { - "markdownDescription": "The authorizer's Uniform Resource Identifier \\(URI\\)\\. If you specify `TOKEN` for the authorizer's `Type` property, specify a Lambda function URI that has the form `arn:aws:apigateway:region:lambda:path/path`\\. The path usually has the form /2015\\-03\\-31/functions/*LambdaFunctionARN*/invocations\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the authorizer's Uniform Resource Identifier \\(URI\\)\\. For `TOKEN` or `REQUEST` authorizers, this must be a well\\-formed Lambda function URI, for example, `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations`\\. In general, the URI has this form `arn:aws:apigateway:{region}:lambda:path/{service_api}`, where `{region}` is the same as the region hosting the Lambda function, `path` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial `/`\\. For Lambda functions, this is usually of the form `/2015-03-31/functions/[FunctionARN]/invocations`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizerUri", "type": "string" }, "IdentitySource": { - "markdownDescription": "The source of the identity in an incoming request\\. \nIf you specify `TOKEN` or `COGNITO_USER_POOLS` for the `Type` property, this property is required\\. Specify a header mapping expression using the form `method.request.header.name`, where *name* is the name of a custom authorization header that clients submit as part of their requests\\. \nIf you specify `REQUEST` for the `Type` property, this property is required when authorization caching is enabled\\. Specify a comma\\-separated string of one or more mapping expressions of the specified request parameter using the form `method.request.parameter.name`\\. For supported parameter types, see [Configure Lambda Authorizer Using the API Gateway Console](https://docs.aws.amazon.com/apigateway/latest/developerguide/configure-api-gateway-lambda-authorization-with-console.html) in the *API Gateway Developer Guide*\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identity source for which authorization is requested\\. For a `TOKEN` or `COGNITO_USER_POOLS` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client\\. For example, if the token header name is `Auth`, the header mapping expression is `method.request.header.Auth`\\. For the `REQUEST` authorizer, this is required when authorization caching is enabled\\. The value is a comma\\-separated string of one or more mapping expressions of the specified request parameters\\. For example, if an `Auth` header, a `Name` query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`\\. These parameters will be used to derive the authorization caching key and to perform runtime validation of the `REQUEST` authorizer by verifying all of the identity\\-related request parameters are present, not null and non\\-empty\\. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function\\. The valid value is a string of comma\\-separated mapping expressions of the specified request parameters\\. When the authorization caching is not enabled, this property is optional\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdentitySource", "type": "string" }, "IdentityValidationExpression": { - "markdownDescription": "A validation expression for the incoming identity\\. If you specify `TOKEN` for the authorizer's `Type` property, specify a regular expression\\. API Gateway uses the expression to attempt to match the incoming client token, and proceeds if the token matches\\. If the token doesn't match, API Gateway responds with a 401 \\(unauthorized request\\) error code\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A validation expression for the incoming identity token\\. For `TOKEN` authorizers, this value is a regular expression\\. For `COGNITO_USER_POOLS` authorizers, API Gateway will match the `aud` field of the incoming token from the client against the specified regular expression\\. It will invoke the authorizer's Lambda function when there is a match\\. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function\\. The validation expression does not apply to the `REQUEST` authorizer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdentityValidationExpression", "type": "string" }, @@ -4077,17 +4245,17 @@ "items": { "type": "string" }, - "markdownDescription": "A list of the Amazon Cognito user pool Amazon Resource Names \\(ARNs\\) to associate with this authorizer\\. Required if you specify `COGNITO_USER_POOLS` as the authorizer `Type`\\. For more information, see [Use Amazon Cognito User Pools](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html#apigateway-enable-cognito-user-pool) in the *API Gateway Developer Guide*\\. \n*Required*: Conditional \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of the Amazon Cognito user pool ARNs for the `COGNITO_USER_POOLS` authorizer\\. Each element is of this format: `arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}`\\. For a `TOKEN` or `REQUEST` authorizer, this is not defined\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProviderARNs", "type": "array" }, "RestApiId": { - "markdownDescription": "The ID of the `RestApi` resource that API Gateway creates the authorizer in\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" }, "Type": { - "markdownDescription": "The type of authorizer\\. Valid values include: \n+ `TOKEN`: A custom authorizer that uses a Lambda function\\.\n+ `COGNITO_USER_POOLS`: An authorizer that uses Amazon Cognito user pools\\.\n+ `REQUEST`: An authorizer that uses a Lambda function using incoming request parameters\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The authorizer type\\. Valid values are `TOKEN` for a Lambda function using a single authorization token submitted in a custom header, `REQUEST` for a Lambda function using incoming request parameters, and `COGNITO_USER_POOLS` for using an Amazon Cognito user pool\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" } @@ -4156,27 +4324,27 @@ "additionalProperties": false, "properties": { "BasePath": { - "markdownDescription": "The base path name that callers of the API must provide in the URL after the domain name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The base path name that callers of the API must provide as part of the URL after the domain name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "BasePath", "type": "string" }, "DomainName": { - "markdownDescription": "The `DomainName` of an [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The domain name of the BasePathMapping resource to be described\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DomainName", "type": "string" }, "Id": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Id", "type": "string" }, "RestApiId": { - "markdownDescription": "The ID of the API\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RestApiId", "type": "string" }, "Stage": { - "markdownDescription": "The name of the API's stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the associated stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Stage", "type": "string" } @@ -4243,7 +4411,7 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "A description of the client certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the client certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -4251,7 +4419,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the client certificate\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -4315,26 +4483,26 @@ "properties": { "DeploymentCanarySettings": { "$ref": "#/definitions/AWS::ApiGateway::Deployment.DeploymentCanarySettings", - "markdownDescription": "Specifies settings for the canary deployment\\. \n*Required*: No \n*Type*: [DeploymentCanarySettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The input configuration for a canary deployment\\. \n*Required*: No \n*Type*: [DeploymentCanarySettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DeploymentCanarySettings" }, "Description": { - "markdownDescription": "A description of the purpose of the API Gateway deployment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description for the Deployment resource to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "RestApiId": { - "markdownDescription": "The ID of the `RestApi` resource to deploy\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" }, "StageDescription": { "$ref": "#/definitions/AWS::ApiGateway::Deployment.StageDescription", - "markdownDescription": "Configures the stage that API Gateway creates with this deployment\\. \n*Required*: No \n*Type*: [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the Stage resource for the Deployment resource to create\\. \n*Required*: No \n*Type*: [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StageDescription" }, "StageName": { - "markdownDescription": "A name for the stage that API Gateway creates with this deployment\\. Use only alphanumeric characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the Stage resource for the Deployment resource to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StageName", "type": "string" } @@ -4374,7 +4542,7 @@ "type": "string" }, "Format": { - "markdownDescription": "A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference)\\. The format must include at least `$context.requestId`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A single line format of the access logs of data, as specified by selected $context variables\\. The format must include at least `$context.requestId`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Format", "type": "string" } @@ -4401,7 +4569,7 @@ "type": "object" }, "UseStageCache": { - "markdownDescription": "Whether the canary deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UseStageCache", "type": "boolean" } @@ -4412,13 +4580,13 @@ "additionalProperties": false, "properties": { "PercentTraffic": { - "markdownDescription": "The percentage \\(0\\-100\\) of traffic diverted to a canary deployment\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The percentage \\(0\\.0\\-100\\.0\\) of traffic routed to the canary deployment\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PercentTraffic", "type": "number" }, "StageVariableOverrides": { "additionalProperties": true, - "markdownDescription": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary\\. These stage variables are represented as a string\\-to\\-string map between stage variable names and their values\\. \nDuplicates are not allowed\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A stage variable overrides used for the canary release deployment\\. They can override existing stage variables or add new stage variables for the canary release deployment\\. These stage variables are represented as a string\\-to\\-string map between stage variable names and their values\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -4428,7 +4596,7 @@ "type": "object" }, "UseStageCache": { - "markdownDescription": "Whether the canary deployment uses the stage cache\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A Boolean flag to indicate whether the canary release deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "UseStageCache", "type": "boolean" } @@ -4439,22 +4607,22 @@ "additionalProperties": false, "properties": { "CacheDataEncrypted": { - "markdownDescription": "Indicates whether the cached responses are encrypted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the cached responses are encrypted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheDataEncrypted", "type": "boolean" }, "CacheTtlInSeconds": { - "markdownDescription": "The time\\-to\\-live \\(TTL\\) period, in seconds, that specifies how long API Gateway caches responses\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the time to live \\(TTL\\), in seconds, for cached responses\\. The higher the TTL, the longer the response will be cached\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheTtlInSeconds", "type": "number" }, "CachingEnabled": { - "markdownDescription": "Indicates whether responses are cached and returned for requests\\. You must enable a cache cluster on the stage to cache responses\\. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether responses should be cached and returned for requests\\. A cache cluster must be enabled on the stage for responses to be cached\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CachingEnabled", "type": "boolean" }, "DataTraceEnabled": { - "markdownDescription": "Indicates whether data trace logging is enabled for methods in the stage\\. API Gateway pushes these logs to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataTraceEnabled", "type": "boolean" }, @@ -4464,12 +4632,12 @@ "type": "string" }, "LoggingLevel": { - "markdownDescription": "The logging level for this method\\. For valid values, see the `loggingLevel` property of the [Stage](https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the *Amazon API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs\\. Valid values are `OFF`, `ERROR`, and `INFO`\\. Choose `ERROR` to write only error\\-level entries to CloudWatch Logs, or choose `INFO` to include all `ERROR` events as well as extra informational events\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoggingLevel", "type": "string" }, "MetricsEnabled": { - "markdownDescription": "Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether Amazon CloudWatch metrics are enabled for this method\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricsEnabled", "type": "boolean" }, @@ -4479,12 +4647,12 @@ "type": "string" }, "ThrottlingBurstLimit": { - "markdownDescription": "The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account\\. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the throttling burst limit\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThrottlingBurstLimit", "type": "number" }, "ThrottlingRateLimit": { - "markdownDescription": "The number of steady\\-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account\\. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the throttling rate limit\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThrottlingRateLimit", "type": "number" } @@ -4500,12 +4668,12 @@ "title": "AccessLogSetting" }, "CacheClusterEnabled": { - "markdownDescription": "Indicates whether cache clustering is enabled for the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether a cache cluster is enabled for the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheClusterEnabled", "type": "boolean" }, "CacheClusterSize": { - "markdownDescription": "The size of the stage's cache cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The size of the stage's cache cluster\\. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheClusterSize", "type": "string" }, @@ -4550,7 +4718,7 @@ "type": "string" }, "LoggingLevel": { - "markdownDescription": "The logging level for this method\\. For valid values, see the `loggingLevel` property of the [Stage](https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the *Amazon API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The logging level for this method\\. For valid values, see the `loggingLevel` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoggingLevel", "type": "string" }, @@ -4641,16 +4809,16 @@ "properties": { "Location": { "$ref": "#/definitions/AWS::ApiGateway::DocumentationPart.Location", - "markdownDescription": "The location of the API entity that the documentation applies to\\. \n*Required*: Yes \n*Type*: [Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The location of the targeted API entity of the to\\-be\\-created documentation part\\. \n*Required*: Yes \n*Type*: [Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Location" }, "Properties": { - "markdownDescription": "The documentation content map of the targeted API entity\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The new documentation content map of the targeted API entity\\. Enclosed key\\-value pairs are API\\-specific, but only OpenAPI\\-compliant key\\-value pairs can be exported and, hence, published\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Properties", "type": "string" }, "RestApiId": { - "markdownDescription": "The identifier of the targeted API entity\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" } @@ -4687,27 +4855,27 @@ "additionalProperties": false, "properties": { "Method": { - "markdownDescription": "The HTTP verb of a method\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The HTTP verb of a method\\. It is a valid field for the API entity types of `METHOD`, `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`\\. The default value is `*` for any method\\. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other `location` attributes, the child entity's `method` attribute must match that of the parent entity exactly\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Method", "type": "string" }, "Name": { - "markdownDescription": "The name of the targeted API entity\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the targeted API entity\\. It is a valid and required field for the API entity types of `AUTHORIZER`, `MODEL`, `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY` and `RESPONSE_HEADER`\\. It is an invalid field for any other entity type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, "Path": { - "markdownDescription": "The URL path of the target\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The URL path of the target\\. It is a valid field for the API entity types of `RESOURCE`, `METHOD`, `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`\\. The default value is `/` for the root resource\\. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other `location` attributes, the child entity's `path` attribute must match that of the parent entity as a prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Path", "type": "string" }, "StatusCode": { - "markdownDescription": "The HTTP status code of a response\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The HTTP status code of a response\\. It is a valid field for the API entity types of `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`\\. The default value is `*` for any status code\\. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other `location` attributes, the child entity's `statusCode` attribute must match that of the parent entity exactly\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^([1-5]\\d\\d|\\*|\\s*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StatusCode", "type": "string" }, "Type": { - "markdownDescription": "The type of API entity that the documentation content applies to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of API entity to which the documentation content applies\\. Valid values are `API`, `AUTHORIZER`, `MODEL`, `RESOURCE`, `METHOD`, `PATH_PARAMETER`, `QUERY_PARAMETER`, `REQUEST_HEADER`, `REQUEST_BODY`, `RESPONSE`, `RESPONSE_HEADER`, and `RESPONSE_BODY`\\. Content inheritance does not apply to any entity of the `API`, `AUTHORIZER`, `METHOD`, `MODEL`, `REQUEST_BODY`, or `RESOURCE` type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `API | AUTHORIZER | METHOD | MODEL | PATH_PARAMETER | QUERY_PARAMETER | REQUEST_BODY | REQUEST_HEADER | RESOURCE | RESPONSE | RESPONSE_BODY | RESPONSE_HEADER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -4750,17 +4918,17 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "The description of the API documentation snapshot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description about the new documentation snapshot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "DocumentationVersion": { - "markdownDescription": "The version identifier of the API documentation snapshot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The version identifier of the to\\-be\\-updated documentation version\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DocumentationVersion", "type": "string" }, "RestApiId": { - "markdownDescription": "The identifier of the API\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" } @@ -4828,23 +4996,23 @@ "additionalProperties": false, "properties": { "CertificateArn": { - "markdownDescription": "The reference to an AWS\\-managed certificate for use by the edge\\-optimized endpoint for this domain name\\. AWS Certificate Manager is the only supported source\\. For requirements and additional information about setting up certificates, see [Get Certificates Ready in AWS Certificate Manager](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html#how-to-custom-domains-prerequisites) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The reference to an AWS\\-managed certificate that will be used by edge\\-optimized endpoint for this domain name\\. AWS Certificate Manager is the only supported source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CertificateArn", "type": "string" }, "DomainName": { - "markdownDescription": "The custom domain name for your API\\. Uppercase letters are not supported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The custom domain name as an API host name, for example, `my-api.example.com`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DomainName", "type": "string" }, "EndpointConfiguration": { "$ref": "#/definitions/AWS::ApiGateway::DomainName.EndpointConfiguration", - "markdownDescription": "A list of the endpoint types of the domain name\\. \n*Required*: No \n*Type*: [EndpointConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The endpoint configuration of this DomainName showing the endpoint types of the domain name\\. \n*Required*: No \n*Type*: [EndpointConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EndpointConfiguration" }, "MutualTlsAuthentication": { "$ref": "#/definitions/AWS::ApiGateway::DomainName.MutualTlsAuthentication", - "markdownDescription": "The mutual TLS authentication configuration for a custom domain name\\. \n*Required*: No \n*Type*: [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The mutual TLS authentication configuration for a custom domain name\\. If specified, API Gateway performs two\\-way authentication between the client and the server\\. Clients must present a trusted certificate to access your API\\. \n*Required*: No \n*Type*: [MutualTlsAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MutualTlsAuthentication" }, "OwnershipVerificationCertificateArn": { @@ -4853,12 +5021,12 @@ "type": "string" }, "RegionalCertificateArn": { - "markdownDescription": "The reference to an AWS\\-managed certificate for use by the regional endpoint for the domain name\\. AWS Certificate Manager is the only supported source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The reference to an AWS\\-managed certificate that will be used for validating the regional domain name\\. AWS Certificate Manager is the only supported source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RegionalCertificateArn", "type": "string" }, "SecurityPolicy": { - "markdownDescription": "The Transport Layer Security \\(TLS\\) version \\+ cipher suite for this domain name\\. \nValid values include `TLS_1_0` and `TLS_1_2`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Transport Layer Security \\(TLS\\) version \\+ cipher suite for this DomainName\\. The valid values are `TLS_1_0` and `TLS_1_2`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `TLS_1_0 | TLS_1_2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecurityPolicy", "type": "string" }, @@ -4866,7 +5034,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the domain name\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -4900,7 +5068,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of endpoint types of an API or its custom domain name\\. For an edge\\-optimized API and its custom domain name, the endpoint type is `EDGE`\\. For a regional API and its custom domain name, the endpoint type is `REGIONAL`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of endpoint types of an API \\(RestApi\\) or its custom domain name \\(DomainName\\)\\. For an edge\\-optimized API and its custom domain name, the endpoint type is `\"EDGE\"`\\. For a regional API and its custom domain name, the endpoint type is `REGIONAL`\\. For a private API, the endpoint type is `PRIVATE`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Types", "type": "array" } @@ -4911,7 +5079,7 @@ "additionalProperties": false, "properties": { "TruststoreUri": { - "markdownDescription": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, `s3://bucket-name/key-name`\\. The truststore can contain certificates from public or private certificate authorities\\. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version\\. To update the truststore, you must have permissions to access the S3 object\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example `s3://bucket-name/key-name`\\. The truststore can contain certificates from public or private certificate authorities\\. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version\\. To update the truststore, you must have permissions to access the S3 object\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TruststoreUri", "type": "string" }, @@ -4960,7 +5128,7 @@ "properties": { "ResponseParameters": { "additionalProperties": true, - "markdownDescription": "The response parameters \\(paths, query strings, and headers\\) for the response\\. Duplicates not allowed\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Response parameters \\(paths, query strings and headers\\) of the GatewayResponse as a string\\-to\\-string map of key\\-value pairs\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -4971,7 +5139,7 @@ }, "ResponseTemplates": { "additionalProperties": true, - "markdownDescription": "The response templates for the response\\. Duplicates not allowed\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Response templates of the GatewayResponse as a string\\-to\\-string map of key\\-value pairs\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -4981,17 +5149,17 @@ "type": "object" }, "ResponseType": { - "markdownDescription": "The response type\\. For valid values, see [GatewayResponse](https://docs.aws.amazon.com/apigateway/api-reference/resource/gateway-response/) in the *API Gateway API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The response type of the associated GatewayResponse\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ACCESS_DENIED | API_CONFIGURATION_ERROR | AUTHORIZER_CONFIGURATION_ERROR | AUTHORIZER_FAILURE | BAD_REQUEST_BODY | BAD_REQUEST_PARAMETERS | DEFAULT_4XX | DEFAULT_5XX | EXPIRED_TOKEN | INTEGRATION_FAILURE | INTEGRATION_TIMEOUT | INVALID_API_KEY | INVALID_SIGNATURE | MISSING_AUTHENTICATION_TOKEN | QUOTA_EXCEEDED | REQUEST_TOO_LARGE | RESOURCE_NOT_FOUND | THROTTLED | UNAUTHORIZED | UNSUPPORTED_MEDIA_TYPE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResponseType", "type": "string" }, "RestApiId": { - "markdownDescription": "The identifier of the API\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" }, "StatusCode": { - "markdownDescription": "The HTTP status code for the response\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The HTTP status code for this GatewayResponse\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StatusCode", "type": "string" } @@ -5059,7 +5227,7 @@ "additionalProperties": false, "properties": { "ApiKeyRequired": { - "markdownDescription": "Indicates whether the method requires clients to submit a valid API key\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A boolean flag specifying whether a valid ApiKey is required to invoke this method\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiKeyRequired", "type": "boolean" }, @@ -5067,46 +5235,46 @@ "items": { "type": "string" }, - "markdownDescription": "A list of authorization scopes configured on the method\\. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation\\. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request\\. The method invocation is authorized if any method scopes match a claimed scope in the access token\\. Otherwise, the invocation is not authorized\\. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of authorization scopes configured on the method\\. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation\\. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request\\. The method invocation is authorized if any method scopes matches a claimed scope in the access token\\. Otherwise, the invocation is not authorized\\. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizationScopes", "type": "array" }, "AuthorizationType": { - "markdownDescription": "The method's authorization type\\. This parameter is required\\. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/api-reference/resource/method/) in the *API Gateway API Reference*\\. \nIf you specify the `AuthorizerId` property, specify `CUSTOM` or `COGNITO_USER_POOLS` for this property\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The method's authorization type\\. This parameter is required\\. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*\\. \nIf you specify the `AuthorizerId` property, specify `CUSTOM` or `COGNITO_USER_POOLS` for this property\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizationType", "type": "string" }, "AuthorizerId": { - "markdownDescription": "The identifier of the [authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html) to use on this method\\. If you specify this property, specify `CUSTOM` or `COGNITO_USER_POOLS` for the `AuthorizationType` property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of an Authorizer to use on this method\\. The `authorizationType` must be `CUSTOM`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthorizerId", "type": "string" }, "HttpMethod": { - "markdownDescription": "The HTTP method that clients use to call this method\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The method's HTTP verb\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HttpMethod", "type": "string" }, "Integration": { "$ref": "#/definitions/AWS::ApiGateway::Method.Integration", - "markdownDescription": "The backend system that the method calls when it receives a request\\. \n*Required*: No \n*Type*: [Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Represents an `HTTP`, `HTTP_PROXY`, `AWS`, `AWS_PROXY`, or Mock integration\\. \n*Required*: No \n*Type*: [Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Integration" }, "MethodResponses": { "items": { "$ref": "#/definitions/AWS::ApiGateway::Method.MethodResponse" }, - "markdownDescription": "The responses that can be sent to the client who calls the method\\. \n*Required*: No \n*Type*: List of [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Gets a method response associated with a given HTTP status code\\. \n*Required*: No \n*Type*: List of [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MethodResponses", "type": "array" }, "OperationName": { - "markdownDescription": "A friendly operation name for the method\\. For example, you can assign the `OperationName` of `ListPets` for the `GET /pets` method\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A human\\-friendly operation identifier for the method\\. For example, you can assign the `operationName` of `ListPets` for the `GET /pets` method in the `PetStore` example\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OperationName", "type": "string" }, "RequestModels": { "additionalProperties": true, - "markdownDescription": "The resources that are used for the request's content type\\. Specify request models as key\\-value pairs \\(string\\-to\\-string mapping\\), with a content type as the key and a `Model` resource name as the value\\. To use the same model regardless of the content type, specify `$default` as the key\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A key\\-value map specifying data schemas, represented by Model resources, \\(as the mapped value\\) of the request payloads of given content types \\(as the mapping key\\)\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5117,7 +5285,7 @@ }, "RequestParameters": { "additionalProperties": true, - "markdownDescription": "The request parameters that API Gateway accepts\\. Specify request parameters as key\\-value pairs \\(string\\-to\\-Boolean mapping\\), with a source as the key and a Boolean as the value\\. The Boolean specifies whether a parameter is required\\. A source must match the format `method.request.location.name`, where the location is querystring, path, or header, and *name* is a valid, unique parameter name\\. \n*Required*: No \n*Type*: Map of Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A key\\-value map defining required or optional method request parameters that can be accepted by API Gateway\\. A key is a method request parameter name matching the pattern of `method.request.{location}.{name}`, where `location` is `querystring`, `path`, or `header` and `name` is a valid and unique parameter name\\. The value associated with the key is a Boolean flag indicating whether the parameter is required \\(`true`\\) or optional \\(`false`\\)\\. The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates\\. \n*Required*: No \n*Type*: Map of Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "boolean" @@ -5127,17 +5295,17 @@ "type": "object" }, "RequestValidatorId": { - "markdownDescription": "The ID of the associated request validator\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of a RequestValidator for request validation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RequestValidatorId", "type": "string" }, "ResourceId": { - "markdownDescription": "The ID of an API Gateway [resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html)\\. For root resource methods, specify the `RestApi` root resource ID, such as `{ \"Fn::GetAtt\": [\"MyRestApi\", \"RootResourceId\"] }`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Resource identifier for the MethodResponse resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceId", "type": "string" }, "RestApiId": { - "markdownDescription": "The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which API Gateway creates the method\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RestApiId", "type": "string" } @@ -5177,37 +5345,37 @@ "items": { "type": "string" }, - "markdownDescription": "A list of request parameters whose values API Gateway caches\\. For cases where the integration type allows for RequestParameters to be set, these parameters must also be specified in [RequestParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters) to be supported in `CacheKeyParameters`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of request parameters whose values API Gateway caches\\. To be valid values for `cacheKeyParameters`, these parameters must also be specified for Method `requestParameters`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheKeyParameters", "type": "array" }, "CacheNamespace": { - "markdownDescription": "An API\\-specific tag group of related cached parameters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a group of related cached parameters\\. By default, API Gateway uses the resource ID as the `cacheNamespace`\\. You can specify the same `cacheNamespace` across resources to return the same cached data for requests to different resources\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheNamespace", "type": "string" }, "ConnectionId": { - "markdownDescription": "The ID of the `VpcLink` used for the integration when `connectionType=VPC_LINK`, otherwise undefined\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectionId", "type": "string" }, "ConnectionType": { - "markdownDescription": "The type of the network connection to the integration endpoint\\. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC\\. The default value is `INTERNET`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of the network connection to the integration endpoint\\. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC\\. The default value is `INTERNET`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `INTERNET | VPC_LINK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectionType", "type": "string" }, "ContentHandling": { - "markdownDescription": "Specifies how to handle request payload content type conversions\\. Valid values are: \n+ `CONVERT_TO_BINARY`: Converts a request payload from a base64\\-encoded string to a binary blob\\.\n+ `CONVERT_TO_TEXT`: Converts a request payload from a binary blob to a base64\\-encoded string\\.\nIf this property isn't defined, the request payload is passed through from the method request to the integration request without modification, provided that the `PassthroughBehaviors` property is configured to support payload pass\\-through\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how to handle request payload content type conversions\\. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors: \nIf this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the `passthroughBehavior` is configured to support payload pass\\-through\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CONVERT_TO_BINARY | CONVERT_TO_TEXT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContentHandling", "type": "string" }, "Credentials": { - "markdownDescription": "The credentials that are required for the integration\\. To specify an AWS Identity and Access Management \\(IAM\\) role that API Gateway assumes, specify the role's Amazon Resource Name \\(ARN\\)\\. To require that the caller's identity be passed through from the request, specify arn:aws:iam::\\*:user/\\*\\. \nTo use resource\\-based permissions on the AWS Lambda \\(Lambda\\) function, don't specify this property\\. Use the [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) resource to permit API Gateway to call the function\\. For more information, see [Allow Amazon API Gateway to Invoke a Lambda Function](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html#access-control-resource-based-example-apigateway-invoke-function) in the *AWS Lambda Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the credentials required for the integration, if any\\. For AWS integrations, three options are available\\. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name \\(ARN\\)\\. To require that the caller's identity be passed through from the request, specify the string `arn:aws:iam::\\*:user/\\*`\\. To use resource\\-based permissions on supported AWS services, specify null\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Credentials", "type": "string" }, "IntegrationHttpMethod": { - "markdownDescription": "The integration's HTTP method type\\. \nFor the `Type` property, if you specify `MOCK`, this property is optional\\. For all other types, you must specify this property\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the integration's HTTP method type\\. For the Type property, if you specify `MOCK`, this property is optional\\. For Lambda integrations, you must set the integration method to `POST`\\. For all other types, you must specify this property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IntegrationHttpMethod", "type": "string" }, @@ -5215,18 +5383,18 @@ "items": { "$ref": "#/definitions/AWS::ApiGateway::Method.IntegrationResponse" }, - "markdownDescription": "The response that API Gateway provides after a method's backend completes processing a request\\. API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses\\. For example, you can map the backend status codes to codes that you define\\. \n*Required*: No \n*Type*: List of [IntegrationResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the integration's responses\\. \n*Required*: No \n*Type*: List of [IntegrationResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IntegrationResponses", "type": "array" }, "PassthroughBehavior": { - "markdownDescription": "Indicates when API Gateway passes requests to the targeted backend\\. This behavior depends on the request's `Content-Type` header and whether you defined a mapping template for it\\. \nFor more information and valid values, see the [passthroughBehavior](https://docs.aws.amazon.com/apigateway/api-reference/link-relation/integration-put/#passthroughBehavior) field in the *API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation\\. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in `requestTemplates`\\. The valid value is one of the following: `WHEN_NO_MATCH`: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request\\. `WHEN_NO_TEMPLATES`: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request\\. If a template is defined when this option is selected, the method request of an unmapped content\\-type will be rejected with an HTTP 415 Unsupported Media Type response\\. `NEVER`: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PassthroughBehavior", "type": "string" }, "RequestParameters": { "additionalProperties": true, - "markdownDescription": "The request parameters that API Gateway sends with the backend request\\. Specify request parameters as key\\-value pairs \\(string\\-to\\-string mappings\\), with a destination as the key and a source as the value\\. \nSpecify the destination by using the following pattern `integration.request.location.name`, where *location* is query string, path, or header, and *name* is a valid, unique parameter name\\. \nThe source must be an existing method request parameter or a static value\\. You must enclose static values in single quotation marks and pre\\-encode these values based on their destination in the request\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A key\\-value map specifying request parameters that are passed from the method request to the back end\\. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre\\-encoded as required by the back end\\. The method request parameter value must match the pattern of `method.request.{location}.{name}`, where `location` is `querystring`, `path`, or `header` and `name` must be a valid and unique method request parameter name\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5237,7 +5405,7 @@ }, "RequestTemplates": { "additionalProperties": true, - "markdownDescription": "A map of Apache Velocity templates that are applied on the request payload\\. The template that API Gateway uses is based on the value of the `Content-Type` header that's sent by the client\\. The content type value is the key, and the template is the value \\(specified as a string\\), such as the following snippet: \n`\"application/json\": \"{\\n \\\"statusCode\\\": 200\\n}\"` \nFor more information about templates, see [API Gateway Mapping Template and Access Logging Variable Reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Represents a map of Velocity templates that are applied on the request payload based on the value of the Content\\-Type header sent by the client\\. The content type value is the key in this map, and the template \\(as a String\\) is the value\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5252,12 +5420,12 @@ "type": "number" }, "Type": { - "markdownDescription": "The type of backend that your method is running, such as `HTTP` or `MOCK`\\. For all of the valid values, see the [type](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#type) property for the `Integration` resource in the *Amazon API Gateway REST API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies an API method integration type\\. The valid value is one of the following: \nFor the HTTP and HTTP proxy integrations, each integration can specify a protocol \\(`http/https`\\), port and path\\. Standard 80 and 443 ports are supported as well as custom ports above 1024\\. An HTTP or HTTP proxy integration with a `connectionType` of `VPC_LINK` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AWS | AWS_PROXY | HTTP | HTTP_PROXY | MOCK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" }, "Uri": { - "markdownDescription": "The Uniform Resource Identifier \\(URI\\) for the integration\\. \nIf you specify `HTTP` for the `Type` property, specify the API endpoint URL\\. \nIf you specify `MOCK` for the `Type` property, don't specify this property\\. \nIf you specify `AWS` for the `Type` property, specify an AWS service that follows this form: arn:aws:apigateway:*region*:*subdomain*\\.*service\\|service*:*path\\|action*/*service\\_api*\\. For example, a Lambda function URI follows this form: arn:aws:apigateway:*region*:lambda:path/*path*\\. The path is usually in the form /2015\\-03\\-31/functions/*LambdaFunctionARN*/invocations\\. For more information, see the `uri` property of the [Integration](https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/) resource in the Amazon API Gateway REST API Reference\\. \nIf you specified `HTTP` or `AWS` for the `Type` property, you must specify this property\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies Uniform Resource Identifier \\(URI\\) of the integration endpoint\\. \nFor `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully formed, encoded HTTP\\(S\\) URL according to the RFC\\-3986 specification for standard integrations\\. If `connectionType` is `VPC_LINK` specify the Network Load Balancer DNS name\\. For `AWS` or `AWS_PROXY` integrations, the URI is of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}`\\. Here, \\{Region\\} is the API Gateway region \\(e\\.g\\., us\\-east\\-1\\); \\{service\\} is the name of the integrated AWS service \\(e\\.g\\., s3\\); and \\{subdomain\\} is a designated subdomain supported by certain AWS service for fast host\\-name lookup\\. action can be used for an AWS service action\\-based API, using an Action=\\{name\\}&\\{p1\\}=\\{v1\\}&p2=\\{v2\\}\\.\\.\\. query string\\. The ensuing \\{service\\_api\\} refers to a supported action \\{name\\} plus any required input parameters\\. Alternatively, path can be used for an AWS service path\\-based API\\. The ensuing service\\_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable\\. For example, for integration with the S3 API of GetObject, the uri can be either `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}` or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Uri", "type": "string" } @@ -5268,13 +5436,13 @@ "additionalProperties": false, "properties": { "ContentHandling": { - "markdownDescription": "Specifies how to handle request payload content type conversions\\. Valid values are: \n+ `CONVERT_TO_BINARY`: Converts a request payload from a base64\\-encoded string to a binary blob\\.\n+ `CONVERT_TO_TEXT`: Converts a request payload from a binary blob to a base64\\-encoded string\\.\nIf this property isn't defined, the request payload is passed through from the method request to the integration request without modification\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how to handle response payload content type conversions\\. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`, with the following behaviors: \nIf this property is not defined, the response payload will be passed through from the integration response to the method response without modification\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CONVERT_TO_BINARY | CONVERT_TO_TEXT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContentHandling", "type": "string" }, "ResponseParameters": { "additionalProperties": true, - "markdownDescription": "The response parameters from the backend response that API Gateway sends to the method response\\. Specify response parameters as key\\-value pairs \\([string\\-to\\-string mappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html)\\)\\. \nUse the destination as the key and the source as the value: \n+ The destination must be an existing response parameter in the [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) property\\.\n+ The source must be an existing method request parameter or a static value\\. You must enclose static values in single quotation marks and pre\\-encode these values based on the destination specified in the request\\.\nFor more information about templates, see [API Gateway Mapping Template and Access Logging Variable Reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A key\\-value map specifying response parameters that are passed to the method response from the back end\\. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body\\. The mapping key must match the pattern of `method.response.header.{name}`, where `name` is a valid and unique header name\\. The mapped non\\-static value must match the pattern of `integration.response.header.{name}` or `integration.response.body.{JSON-expression}`, where `name` is a valid and unique response header name and `JSON-expression` is a valid JSON expression without the `$` prefix\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5285,7 +5453,7 @@ }, "ResponseTemplates": { "additionalProperties": true, - "markdownDescription": "The templates that are used to transform the integration response body\\. Specify templates as key\\-value pairs \\(string\\-to\\-string mappings\\), with a content type as the key and a template as the value\\. For more information, see [API Gateway Mapping Template and Access Logging Variable Reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the templates used to transform the integration response body\\. Response templates are represented as a key/value map, with a content\\-type as the key and a template as the value\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5295,12 +5463,12 @@ "type": "object" }, "SelectionPattern": { - "markdownDescription": "A [regular expression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-regexes.html) that specifies which error strings or status codes from the backend map to the integration response\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the regular expression \\(regex\\) pattern used to choose an integration response based on the response from the back end\\. For example, if the success response returns nothing and the error response returns some string, you could use the `.+` regex to match error response\\. However, make sure that the error response does not contain any newline \\(`\\n`\\) character in such cases\\. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched\\. For all other HTTP and AWS back ends, the HTTP status code is matched\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SelectionPattern", "type": "string" }, "StatusCode": { - "markdownDescription": "The status code that API Gateway uses to map the integration response to a [MethodResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html) status code\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the status code that is used to map the integration response to an existing MethodResponse\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StatusCode", "type": "string" } @@ -5315,7 +5483,7 @@ "properties": { "ResponseModels": { "additionalProperties": true, - "markdownDescription": "The resources used for the response's content type\\. Specify response models as key\\-value pairs \\(string\\-to\\-string maps\\), with a content type as the key and a [Model](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html) resource name as the value\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the Model resources used for the response's content\\-type\\. Response models are represented as a key/value map, with a content\\-type as the key and a Model name as the value\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5326,7 +5494,7 @@ }, "ResponseParameters": { "additionalProperties": true, - "markdownDescription": "Response parameters that API Gateway sends to the client that called a method\\. Specify response parameters as key\\-value pairs \\(string\\-to\\-Boolean maps\\), with a destination as the key and a Boolean as the value\\. Specify the destination using the following pattern: `method.response.header.name`, where *name* is a valid, unique header name\\. The Boolean specifies whether a parameter is required\\. \n*Required*: No \n*Type*: Map of Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A key\\-value map specifying required or optional response parameters that API Gateway can send back to the caller\\. A key defines a method response header and the value specifies whether the associated method response header is required or not\\. The expression of the key must match the pattern `method.response.header.{name}`, where `name` is a valid and unique header name\\. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse\\. The integration response data that can be mapped include an integration response header expressed in `integration.response.header.{name}`, a static value enclosed within a pair of single quotes \\(e\\.g\\., `'application/json'`\\), or a JSON expression from the back\\-end response payload in the form of `integration.response.body.{JSON-expression}`, where `JSON-expression` is a valid JSON expression without the `$` prefix\\.\\) \n*Required*: No \n*Type*: Map of Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "boolean" @@ -5336,7 +5504,7 @@ "type": "object" }, "StatusCode": { - "markdownDescription": "The method response's status code, which you map to an [IntegrationResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The method response's status code\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StatusCode", "type": "string" } @@ -5382,12 +5550,12 @@ "additionalProperties": false, "properties": { "ContentType": { - "markdownDescription": "The content type for the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The content\\-type for the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ContentType", "type": "string" }, "Description": { - "markdownDescription": "A description that identifies this model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -5397,12 +5565,12 @@ "type": "string" }, "RestApiId": { - "markdownDescription": "The ID of a REST API with which to associate this model\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" }, "Schema": { - "markdownDescription": "The schema to use to transform data to one or more output formats\\. Specify null \\(`{}`\\) if you don't want to specify a schema\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The schema for the model\\. For `application/json` models, this should be JSON schema draft 4 model\\. Do not include \"\\\\\\*/\" characters in the description of any properties because such \"\\\\\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Schema", "type": "object" } @@ -5469,22 +5637,22 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of this request validator\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of this RequestValidator \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, "RestApiId": { - "markdownDescription": "The identifier of the targeted API entity\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" }, "ValidateRequestBody": { - "markdownDescription": "Indicates whether to validate the request body according to the configured schema for the targeted API and method\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A Boolean flag to indicate whether to validate a request body according to the configured Model schema\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ValidateRequestBody", "type": "boolean" }, "ValidateRequestParameters": { - "markdownDescription": "Indicates whether to validate request parameters\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A Boolean flag to indicate whether to validate request parameters \\(`true`\\) or not \\(`false`\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ValidateRequestParameters", "type": "boolean" } @@ -5551,17 +5719,17 @@ "additionalProperties": false, "properties": { "ParentId": { - "markdownDescription": "If you want to create a child resource, the ID of the parent resource\\. For resources without a parent, specify the `RestApi` root resource ID, such as `{ \"Fn::GetAtt\": [\"MyRestApi\", \"RootResourceId\"] }`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The parent resource's identifier\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ParentId", "type": "string" }, "PathPart": { - "markdownDescription": "A path name for the resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The last path segment for this resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PathPart", "type": "string" }, "RestApiId": { - "markdownDescription": "The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which you want to create this resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" } @@ -5630,7 +5798,7 @@ "additionalProperties": false, "properties": { "ApiKeySourceType": { - "markdownDescription": "The source of the API key for metering requests according to a usage plan\\. Valid values are: \n+ `HEADER` to read the API key from the `X-API-Key` header of a request\\.\n+ `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a Lambda authorizer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The source of the API key for metering requests according to a usage plan\\. Valid values are: `HEADER` to read the API key from the `X-API-Key` header of a request\\. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiKeySourceType", "type": "string" }, @@ -5638,7 +5806,7 @@ "items": { "type": "string" }, - "markdownDescription": "The list of binary media types that are supported by the `RestApi` resource\\. Use `~1` instead of `/` in the media types, for example `image~1png` or `application~1octet-stream`\\. By default, `RestApi` supports only UTF\\-8\\-encoded text payloads\\. Duplicates are not allowed\\. For more information, see [Enable Support for Binary Payloads in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The list of binary media types supported by the RestApi\\. By default, the RestApi supports only UTF\\-8\\-encoded text payloads\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BinaryMediaTypes", "type": "array" }, @@ -5653,17 +5821,17 @@ "title": "BodyS3Location" }, "CloneFrom": { - "markdownDescription": "The ID of the `RestApi` resource that you want to clone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of the RestApi that you want to clone from\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloneFrom", "type": "string" }, "Description": { - "markdownDescription": "A description of the `RestApi` resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the RestApi\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "DisableExecuteApiEndpoint": { - "markdownDescription": "Specifies whether clients can invoke your API by using the default `execute-api` endpoint\\. By default, clients can invoke your API with the default https://\\{api\\_id\\}\\.execute\\-api\\.\\{region\\}\\.amazonaws\\.com endpoint\\. To require that clients use a custom domain name to invoke your API, disable the default endpoint\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether clients can invoke your API by using the default `execute-api` endpoint\\. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint\\. To require that clients use a custom domain name to invoke your API, disable the default endpoint \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DisableExecuteApiEndpoint", "type": "boolean" }, @@ -5673,7 +5841,7 @@ "title": "EndpointConfiguration" }, "FailOnWarnings": { - "markdownDescription": "Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the `RestApi` resource\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A query parameter to indicate whether to rollback the API update \\(`true`\\) or not \\(`false`\\) when a warning is encountered\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailOnWarnings", "type": "boolean" }, @@ -5688,13 +5856,13 @@ "type": "string" }, "Name": { - "markdownDescription": "A name for the `RestApi` resource\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the RestApi\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Parameters": { "additionalProperties": true, - "markdownDescription": "Custom header parameters for the request\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Custom header parameters as part of the request\\. For example, to exclude DocumentationParts from an imported API, set `ignore=documentation` as a `parameters` value, as in the AWS CLI command of `aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'`\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5712,7 +5880,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the API\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key\\-value map of strings\\. The valid character set is \\[a\\-zA\\-Z\\+\\-=\\.\\_:/\\]\\. The tag key can be up to 128 characters and must not start with `aws:`\\. The tag value can be up to 256 characters\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -5746,7 +5914,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of endpoint types of an API or its custom domain name\\. Valid values include: \n+ `EDGE`: For an edge\\-optimized API and its custom domain name\\.\n+ `REGIONAL`: For a regional API and its custom domain name\\.\n+ `PRIVATE`: For a private API\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of endpoint types of an API \\(RestApi\\) or its custom domain name \\(DomainName\\)\\. For an edge\\-optimized API and its custom domain name, the endpoint type is `\"EDGE\"`\\. For a regional API and its custom domain name, the endpoint type is `REGIONAL`\\. For a private API, the endpoint type is `PRIVATE`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Types", "type": "array" }, @@ -5754,7 +5922,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of VPC endpoint IDs of an API \\([AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html)\\) against which to create Route53 ALIASes\\. It is only supported for `PRIVATE` endpoint type\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of VpcEndpointIds of an API \\(RestApi\\) against which to create Route53 ALIASes\\. It is only supported for `PRIVATE` endpoint type\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VpcEndpointIds", "type": "array" } @@ -5824,41 +5992,41 @@ "properties": { "AccessLogSetting": { "$ref": "#/definitions/AWS::ApiGateway::Stage.AccessLogSetting", - "markdownDescription": "Specifies settings for logging access in this stage\\. \n*Required*: No \n*Type*: [AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Access log settings, including the access log format and access log destination ARN\\. \n*Required*: No \n*Type*: [AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessLogSetting" }, "CacheClusterEnabled": { - "markdownDescription": "Indicates whether cache clustering is enabled for the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether a cache cluster is enabled for the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheClusterEnabled", "type": "boolean" }, "CacheClusterSize": { - "markdownDescription": "The stage's cache cluster size\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The stage's cache capacity in GB\\. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `0.5 | 1.6 | 118 | 13.5 | 237 | 28.4 | 58.2 | 6.1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheClusterSize", "type": "string" }, "CanarySetting": { "$ref": "#/definitions/AWS::ApiGateway::Stage.CanarySetting", - "markdownDescription": "Specifies settings for the canary deployment in this stage\\. \n*Required*: No \n*Type*: [CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings for the canary deployment in this stage\\. \n*Required*: No \n*Type*: [CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CanarySetting" }, "ClientCertificateId": { - "markdownDescription": "The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of a client certificate for an API stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientCertificateId", "type": "string" }, "DeploymentId": { - "markdownDescription": "The ID of the deployment that the stage is associated with\\. This parameter is required to create a stage\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of the Deployment that the stage points to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeploymentId", "type": "string" }, "Description": { - "markdownDescription": "A description of the stage\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The stage's description\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "DocumentationVersion": { - "markdownDescription": "The version ID of the API documentation snapshot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the associated API documentation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DocumentationVersion", "type": "string" }, @@ -5866,17 +6034,17 @@ "items": { "$ref": "#/definitions/AWS::ApiGateway::Stage.MethodSetting" }, - "markdownDescription": "Settings for all methods in the stage\\. \n*Required*: No \n*Type*: List of [MethodSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A map that defines the method settings for a Stage resource\\. Keys \\(designated as `/{method_setting_key` below\\) are method paths defined as `{resource_path}/{http_method}` for an individual method override, or `/\\*/\\*` for overriding all methods in the stage\\. \n*Required*: No \n*Type*: List of [MethodSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MethodSettings", "type": "array" }, "RestApiId": { - "markdownDescription": "The ID of the `RestApi` resource that you're deploying with this stage\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The string identifier of the associated RestApi\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestApiId", "type": "string" }, "StageName": { - "markdownDescription": "The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier \\(URI\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the stage is the first path segment in the Uniform Resource Identifier \\(URI\\) of a call to API Gateway\\. Stage names can only contain alphanumeric characters, hyphens, and underscores\\. Maximum length is 128 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StageName", "type": "string" }, @@ -5884,12 +6052,12 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the stage\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, "TracingEnabled": { - "markdownDescription": "Specifies whether active X\\-Ray tracing is enabled for this stage\\. \nFor more information, see [Trace API Gateway API Execution with AWS X\\-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether active tracing with X\\-ray is enabled for the Stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TracingEnabled", "type": "boolean" }, @@ -5951,18 +6119,18 @@ "additionalProperties": false, "properties": { "DeploymentId": { - "markdownDescription": "The identifier of the deployment that the stage points to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of the canary deployment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeploymentId", "type": "string" }, "PercentTraffic": { - "markdownDescription": "The percentage \\(0\\-100\\) of traffic diverted to a canary deployment\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The percent \\(0\\-100\\) of traffic diverted to a canary deployment\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PercentTraffic", "type": "number" }, "StageVariableOverrides": { "additionalProperties": true, - "markdownDescription": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary\\. These stage variables are represented as a string\\-to\\-string map between stage variable names and their values\\. \nDuplicates are not allowed\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary\\. These stage variables are represented as a string\\-to\\-string map between stage variable names and their values\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -5972,7 +6140,7 @@ "type": "object" }, "UseStageCache": { - "markdownDescription": "Whether the canary deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UseStageCache", "type": "boolean" } @@ -5983,22 +6151,22 @@ "additionalProperties": false, "properties": { "CacheDataEncrypted": { - "markdownDescription": "Indicates whether the cached responses are encrypted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the cached responses are encrypted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheDataEncrypted", "type": "boolean" }, "CacheTtlInSeconds": { - "markdownDescription": "The time\\-to\\-live \\(TTL\\) period, in seconds, that specifies how long API Gateway caches responses\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the time to live \\(TTL\\), in seconds, for cached responses\\. The higher the TTL, the longer the response will be cached\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheTtlInSeconds", "type": "number" }, "CachingEnabled": { - "markdownDescription": "Indicates whether responses are cached and returned for requests\\. You must enable a cache cluster on the stage to cache responses\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether responses should be cached and returned for requests\\. A cache cluster must be enabled on the stage for responses to be cached\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CachingEnabled", "type": "boolean" }, "DataTraceEnabled": { - "markdownDescription": "Indicates whether data trace logging is enabled for methods in the stage\\. API Gateway pushes these logs to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataTraceEnabled", "type": "boolean" }, @@ -6008,12 +6176,12 @@ "type": "string" }, "LoggingLevel": { - "markdownDescription": "The logging level for this method\\. For valid values, see the `loggingLevel` property of the [Stage](https://docs.aws.amazon.com/apigateway/api-reference/resource/stage/#loggingLevel) resource in the *Amazon API Gateway API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs\\. Valid values are `OFF`, `ERROR`, and `INFO`\\. Choose `ERROR` to write only error\\-level entries to CloudWatch Logs, or choose `INFO` to include all `ERROR` events as well as extra informational events\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoggingLevel", "type": "string" }, "MetricsEnabled": { - "markdownDescription": "Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether Amazon CloudWatch metrics are enabled for this method\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricsEnabled", "type": "boolean" }, @@ -6023,12 +6191,12 @@ "type": "string" }, "ThrottlingBurstLimit": { - "markdownDescription": "The number of burst requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account\\. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the throttling burst limit\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThrottlingBurstLimit", "type": "number" }, "ThrottlingRateLimit": { - "markdownDescription": "The number of steady\\-state requests per second that API Gateway permits across all APIs, stages, and methods in your AWS account\\. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the throttling rate limit\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThrottlingRateLimit", "type": "number" } @@ -6074,35 +6242,35 @@ "items": { "$ref": "#/definitions/AWS::ApiGateway::UsagePlan.ApiStage" }, - "markdownDescription": "The API stages to associate with this usage plan\\. \n*Required*: No \n*Type*: List of [ApiStage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The associated API stages of a usage plan\\. \n*Required*: No \n*Type*: List of [ApiStage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiStages", "type": "array" }, "Description": { - "markdownDescription": "A description of the usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of a usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "Quota": { "$ref": "#/definitions/AWS::ApiGateway::UsagePlan.QuotaSettings", - "markdownDescription": "Configures the number of requests that users can make within a given interval\\. \n*Required*: No \n*Type*: [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The target maximum number of permitted requests per a given unit time interval\\. \n*Required*: No \n*Type*: [QuotaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Quota" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "An array of arbitrary tags \\(key\\-value pairs\\) to associate with the usage plan\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, "Throttle": { "$ref": "#/definitions/AWS::ApiGateway::UsagePlan.ThrottleSettings", - "markdownDescription": "Configures the overall request rate \\(average requests per second\\) and burst capacity\\. \n*Required*: No \n*Type*: [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A map containing method level throttling information for API stage in a usage plan\\. \n*Required*: No \n*Type*: [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Throttle" }, "UsagePlanName": { - "markdownDescription": "A name for the usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of a usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UsagePlanName", "type": "string" } @@ -6133,18 +6301,18 @@ "additionalProperties": false, "properties": { "ApiId": { - "markdownDescription": "The ID of an API that is in the specified `Stage` property that you want to associate with the usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "API Id of the associated API stage in a usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiId", "type": "string" }, "Stage": { - "markdownDescription": "The name of the stage to associate with the usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "API stage name of the associated API stage in a usage plan\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Stage", "type": "string" }, "Throttle": { "additionalProperties": false, - "markdownDescription": "Map containing method\\-level throttling information for an API stage in a usage plan\\. The key for the map is the path and method for which to configure custom throttling, for example, \"/pets/GET\"\\. \nDuplicates are not allowed\\. \n*Required*: No \n*Type*: Map of [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Map containing method level throttling information for API stage in a usage plan\\. \n*Required*: No \n*Type*: Map of [ThrottleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::ApiGateway::UsagePlan.ThrottleSettings" @@ -6165,12 +6333,12 @@ "type": "number" }, "Offset": { - "markdownDescription": "The day that a time period starts\\. For example, with a time period of `WEEK`, an offset of `0` starts on Sunday, and an offset of `1` starts on Monday\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of requests subtracted from the given limit in the initial time period\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Offset", "type": "number" }, "Period": { - "markdownDescription": "The time period for which the target maximum limit of requests applies, such as `DAY` or `WEEK`\\. For valid values, see the period property for the [UsagePlan](https://docs.aws.amazon.com/apigateway/api-reference/resource/usage-plan) resource in the *Amazon API Gateway REST API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The time period in which the limit applies\\. Valid values are \"DAY\", \"WEEK\" or \"MONTH\"\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAY | MONTH | WEEK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Period", "type": "string" } @@ -6181,12 +6349,12 @@ "additionalProperties": false, "properties": { "BurstLimit": { - "markdownDescription": "The API target request burst rate limit\\. This allows more requests through for a period of time than the target rate limit\\. For more information about request throttling, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The API target request burst rate limit\\. This allows more requests through for a period of time than the target rate limit\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BurstLimit", "type": "number" }, "RateLimit": { - "markdownDescription": "The API target request steady\\-state rate limit\\. For more information about request throttling, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The API target request rate limit\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RateLimit", "type": "number" } @@ -6229,17 +6397,17 @@ "additionalProperties": false, "properties": { "KeyId": { - "markdownDescription": "The ID of the usage plan key\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Id of the UsagePlanKey resource to be deleted\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeyId", "type": "string" }, "KeyType": { - "markdownDescription": "The type of usage plan key\\. Currently, the only valid key type is `API_KEY`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of a UsagePlanKey resource for a plan customer\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeyType", "type": "string" }, "UsagePlanId": { - "markdownDescription": "The ID of the usage plan\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Id of the UsagePlan resource representing the usage plan containing the to\\-be\\-deleted UsagePlanKey resource representing a plan customer\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "UsagePlanId", "type": "string" } @@ -6308,12 +6476,12 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "A description of the VPC link\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the VPC link\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "Name": { - "markdownDescription": "A name for the VPC link\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name used to label and identify the VPC link\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -6329,7 +6497,7 @@ "items": { "type": "string" }, - "markdownDescription": "The ARN of network load balancer of the VPC targeted by the VPC link\\. The network load balancer must be owned by the same AWS account of the API owner\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the network load balancer of the VPC targeted by the VPC link\\. The network load balancer must be owned by the same AWS account of the API owner\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TargetArns", "type": "array" } @@ -6468,7 +6636,7 @@ }, "Tags": { "additionalProperties": true, - "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -6845,7 +7013,7 @@ "additionalProperties": false, "properties": { "ApiId": { - "markdownDescription": "The identifier of the API\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The identifier of the API\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApiId", "type": "string" }, @@ -7215,7 +7383,7 @@ "type": "string" }, "OwnershipVerificationCertificateArn": { - "markdownDescription": "The ARN of the public certificate issued by ACM to validate ownership of your custom domain\\. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon resource name \\(ARN\\) for the public certificate issued by AWS Certificate Manager\\. This ARN is used to validate custom domain ownership\\. It's required only if you configure mutual TLS and use either an ACM\\-imported or a private CA certificate ARN as the regionalCertificateArn\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OwnershipVerificationCertificateArn", "type": "string" }, @@ -7863,20 +8031,6 @@ ], "type": "object" }, - "AWS::ApiGatewayV2::RouteResponse.ParameterConstraints": { - "additionalProperties": false, - "properties": { - "Required": { - "markdownDescription": "Specifies whether the parameter is required\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "title": "Required", - "type": "boolean" - } - }, - "required": [ - "Required" - ], - "type": "object" - }, "AWS::ApiGatewayV2::Stage": { "additionalProperties": false, "properties": { @@ -8105,7 +8259,7 @@ }, "Tags": { "additionalProperties": true, - "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The collection of tags\\. Each tag element is associated with a given resource\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -8284,12 +8438,12 @@ "type": "string" }, "LocationUri": { - "markdownDescription": "A URI to locate the configuration\\. You can specify the AWS AppConfig hosted configuration store, Systems Manager \\(SSM\\) document, an SSM Parameter Store parameter, or an Amazon S3 object\\. For the hosted configuration store and for feature flags, specify `hosted`\\. For an SSM document, specify either the document name in the format `ssm-document://` or the Amazon Resource Name \\(ARN\\)\\. For a parameter, specify either the parameter name in the format `ssm-parameter://` or the ARN\\. For an Amazon S3 object, specify the URI in the following format: `s3:/// `\\. Here is an example: `s3://my-bucket/my-app/us-east-1/my-config.json` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A URI to locate the configuration\\. You can specify the following: \n+ For the AWS AppConfig hosted configuration store and for feature flags, specify `hosted`\\.\n+ For an AWS Systems Manager Parameter Store parameter, specify either the parameter name in the format `ssm-parameter://` or the ARN\\.\n+ For an AWS Secrets Manager secret, specify the URI in the following format: `secrets-manager`://\\.\n+ For an Amazon S3 object, specify the URI in the following format: `s3:/// `\\. Here is an example: `s3://my-bucket/my-app/us-east-1/my-config.json` \n+ For an SSM document, specify either the document name in the format `ssm-document://` or the Amazon Resource Name \\(ARN\\)\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "LocationUri", "type": "string" }, "Name": { - "markdownDescription": "A name for the configuration profile\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A name for the configuration profile\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -8426,7 +8580,7 @@ "type": "string" }, "ConfigurationVersion": { - "markdownDescription": "The configuration version to deploy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The configuration version to deploy\\. If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ConfigurationVersion", "type": "string" }, @@ -8446,13 +8600,15 @@ "type": "string" }, "KmsKeyIdentifier": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyIdentifier", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/AWS::AppConfig::Deployment.Tags" }, - "markdownDescription": "Metadata to assign to the deployment\\. Tags help organize and categorize your AWS AppConfig resources\\. Each tag consists of a key and an optional value, both of which you define\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html) of [Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Metadata to assign to the deployment\\. Tags help organize and categorize your AWS AppConfig resources\\. Each tag consists of a key and an optional value, both of which you define\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html) of [Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-deployment-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Tags", "type": "array" } @@ -8549,7 +8705,7 @@ "type": "string" }, "FinalBakeTimeInMinutes": { - "markdownDescription": "The amount of time AWS AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Maximum*: `1440` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete\\. If an alarm is triggered during this time, AWS AppConfig rolls back the deployment\\. You must configure permissions for AWS AppConfig to roll back based on CloudWatch alarms\\. For more information, see [Configuring permissions for rollback based on Amazon CloudWatch alarms](https://docs.aws.amazon.com/appconfig/latest/userguide/getting-started-with-appconfig-cloudwatch-alarms-permissions.html) in the * AWS AppConfig User Guide*\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Maximum*: `1440` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FinalBakeTimeInMinutes", "type": "number" }, @@ -8884,15 +9040,23 @@ "additionalProperties": false, "properties": { "ConnectorLabel": { + "markdownDescription": "The label used for registering the connector\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9][\\w!@#.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConnectorLabel", "type": "string" }, "ConnectorProvisioningConfig": { - "$ref": "#/definitions/AWS::AppFlow::Connector.ConnectorProvisioningConfig" + "$ref": "#/definitions/AWS::AppFlow::Connector.ConnectorProvisioningConfig", + "markdownDescription": "The configuration required for registering the connector\\. \n*Required*: Yes \n*Type*: [ConnectorProvisioningConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connector-connectorprovisioningconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectorProvisioningConfig" }, "ConnectorProvisioningType": { + "markdownDescription": "The provisioning type used to register the connector\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `LAMBDA` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectorProvisioningType", "type": "string" }, "Description": { + "markdownDescription": "A description of the connector entity field\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `[\\s\\w/!@#+=.-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" } }, @@ -8927,7 +9091,9 @@ "additionalProperties": false, "properties": { "Lambda": { - "$ref": "#/definitions/AWS::AppFlow::Connector.LambdaConnectorProvisioningConfig" + "$ref": "#/definitions/AWS::AppFlow::Connector.LambdaConnectorProvisioningConfig", + "markdownDescription": "Contains information about the configuration of the lambda which is being registered as the connector\\. \n*Required*: No \n*Type*: [LambdaConnectorProvisioningConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connector-lambdaconnectorprovisioningconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Lambda" } }, "type": "object" @@ -8936,6 +9102,8 @@ "additionalProperties": false, "properties": { "LambdaArn": { + "markdownDescription": "Lambda ARN of the connector being registered\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `arn:aws:.*:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LambdaArn", "type": "string" } }, @@ -8985,6 +9153,8 @@ "type": "string" }, "ConnectorLabel": { + "markdownDescription": "The label for the connector profile being created\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9][\\w!@#.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectorLabel", "type": "string" }, "ConnectorProfileConfig": { @@ -8998,7 +9168,7 @@ "type": "string" }, "ConnectorType": { - "markdownDescription": "The type of connector, such as Salesforce, Amplitude, and so on\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Amplitude | CustomConnector | CustomerProfiles | Datadog | Dynatrace | EventBridge | Googleanalytics | Honeycode | Infornexus | LookoutMetrics | Marketo | Redshift | S3 | Salesforce | SAPOData | Servicenow | Singular | Slack | Snowflake | Trendmicro | Upsolver | Veeva | Zendesk` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of connector, such as Salesforce, Amplitude, and so on\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Amplitude | CustomConnector | CustomerProfiles | Datadog | Dynatrace | EventBridge | Googleanalytics | Honeycode | Infornexus | LookoutMetrics | Marketo | Pardot | Redshift | S3 | Salesforce | SAPOData | Servicenow | Singular | Slack | Snowflake | Trendmicro | Upsolver | Veeva | Zendesk` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ConnectorType", "type": "string" }, @@ -9060,9 +9230,13 @@ "additionalProperties": false, "properties": { "ApiKey": { + "markdownDescription": "The API key required for API key authentication\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApiKey", "type": "string" }, "ApiSecretKey": { + "markdownDescription": "The API secret key required for API key authentication\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApiSecretKey", "type": "string" } }, @@ -9075,9 +9249,13 @@ "additionalProperties": false, "properties": { "Password": { + "markdownDescription": "The password to use to connect to a resource\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Password", "type": "string" }, "Username": { + "markdownDescription": "The username to use to connect to a resource\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Username", "type": "string" } }, @@ -9091,7 +9269,7 @@ "additionalProperties": false, "properties": { "AuthCode": { - "markdownDescription": "The code provided by the connector when it has been authenticated via the connected app\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The code provided by the connector when it has been authenticated via the connected app\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthCode", "type": "string" }, @@ -9108,7 +9286,7 @@ "properties": { "ConnectorProfileCredentials": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorProfileCredentials", - "markdownDescription": "The connector\\-specific credentials required by each connector\\. \n*Required*: Yes \n*Type*: [ConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The connector\\-specific credentials required by each connector\\. \n*Required*: No \n*Type*: [ConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectorProfileCredentials" }, "ConnectorProfileProperties": { @@ -9128,7 +9306,9 @@ "title": "Amplitude" }, "CustomConnector": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.CustomConnectorProfileCredentials" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.CustomConnectorProfileCredentials", + "markdownDescription": "The connector\\-specific profile credentials that are required when using the custom connector\\. \n*Required*: No \n*Type*: [CustomConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomConnector" }, "Datadog": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.DatadogConnectorProfileCredentials", @@ -9156,7 +9336,9 @@ "title": "Marketo" }, "Pardot": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.PardotConnectorProfileCredentials" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.PardotConnectorProfileCredentials", + "markdownDescription": "The connector\\-specific credentials required when using Salesforce Pardot\\. \n*Required*: No \n*Type*: [PardotConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pardot" }, "Redshift": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.RedshiftConnectorProfileCredentials", @@ -9165,7 +9347,7 @@ }, "SAPOData": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.SAPODataConnectorProfileCredentials", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SAPODataConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The connector\\-specific profile credentials required when using SAPOData\\. \n*Required*: No \n*Type*: [SAPODataConnectorProfileCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofilecredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SAPOData" }, "Salesforce": { @@ -9215,7 +9397,9 @@ "additionalProperties": false, "properties": { "CustomConnector": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.CustomConnectorProfileProperties" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.CustomConnectorProfileProperties", + "markdownDescription": "The properties required by the custom connector\\. \n*Required*: No \n*Type*: [CustomConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomConnector" }, "Datadog": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.DatadogConnectorProfileProperties", @@ -9238,7 +9422,9 @@ "title": "Marketo" }, "Pardot": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.PardotConnectorProfileProperties" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.PardotConnectorProfileProperties", + "markdownDescription": "The connector\\-specific properties required by Salesforce Pardot\\. \n*Required*: No \n*Type*: [PardotConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pardot" }, "Redshift": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.RedshiftConnectorProfileProperties", @@ -9247,7 +9433,7 @@ }, "SAPOData": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.SAPODataConnectorProfileProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SAPODataConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The connector\\-specific profile properties required when using SAPOData\\. \n*Required*: No \n*Type*: [SAPODataConnectorProfileProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SAPOData" }, "Salesforce": { @@ -9288,14 +9474,18 @@ "properties": { "CredentialsMap": { "additionalProperties": true, + "markdownDescription": "A map that holds custom authentication credentials\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "CredentialsMap", "type": "object" }, "CustomAuthenticationType": { + "markdownDescription": "The custom authentication type that the connector uses\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomAuthenticationType", "type": "string" } }, @@ -9308,19 +9498,29 @@ "additionalProperties": false, "properties": { "ApiKey": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ApiKeyCredentials" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ApiKeyCredentials", + "markdownDescription": "The API keys required for the authentication of the user\\. \n*Required*: No \n*Type*: [ApiKeyCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-apikeycredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApiKey" }, "AuthenticationType": { + "markdownDescription": "The authentication type that the custom connector uses for authenticating while creating a connector profile\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `APIKEY | BASIC | CUSTOM | OAUTH2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AuthenticationType", "type": "string" }, "Basic": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.BasicAuthCredentials" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.BasicAuthCredentials", + "markdownDescription": "The basic credentials that are required for the authentication of the user\\. \n*Required*: No \n*Type*: [BasicAuthCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-basicauthcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Basic" }, "Custom": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.CustomAuthCredentials" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.CustomAuthCredentials", + "markdownDescription": "If the connector uses the custom authentication mechanism, this holds the required credentials\\. \n*Required*: No \n*Type*: [CustomAuthCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customauthcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Custom" }, "Oauth2": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.OAuth2Credentials" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.OAuth2Credentials", + "markdownDescription": "The OAuth 2\\.0 credentials required for the authentication of the user\\. \n*Required*: No \n*Type*: [OAuth2Credentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Oauth2" } }, "required": [ @@ -9332,15 +9532,19 @@ "additionalProperties": false, "properties": { "OAuth2Properties": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.OAuth2Properties" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.OAuth2Properties", + "markdownDescription": "The OAuth 2\\.0 properties required for OAuth 2\\.0 authentication\\. \n*Required*: No \n*Type*: [OAuth2Properties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2properties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OAuth2Properties" }, "ProfileProperties": { "additionalProperties": true, + "markdownDescription": "A map of properties that are required to create a profile for the custom connector\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "ProfileProperties", "type": "object" } }, @@ -9412,7 +9616,7 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "The credentials used to access protected Google Analytics resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to access protected Google Analytics resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, @@ -9432,7 +9636,7 @@ "title": "ConnectorOAuthRequest" }, "RefreshToken": { - "markdownDescription": "The credentials used to acquire new access tokens\\. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to acquire new access tokens\\. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RefreshToken", "type": "string" } @@ -9493,7 +9697,7 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "The credentials used to access protected Marketo resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to access protected Marketo resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, @@ -9537,18 +9741,28 @@ "additionalProperties": false, "properties": { "AccessToken": { + "markdownDescription": "The access token used to access the connector on your behalf\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessToken", "type": "string" }, "ClientId": { + "markdownDescription": "The identifier for the desired client\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientId", "type": "string" }, "ClientSecret": { + "markdownDescription": "The client secret used by the OAuth client to authenticate to the authorization server\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientSecret", "type": "string" }, "OAuthRequest": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OAuthRequest" }, "RefreshToken": { + "markdownDescription": "The refresh token used to refresh an expired access token\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RefreshToken", "type": "string" } }, @@ -9558,18 +9772,24 @@ "additionalProperties": false, "properties": { "OAuth2GrantType": { + "markdownDescription": "The OAuth 2\\.0 grant type used by connector for OAuth 2\\.0 authentication\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AUTHORIZATION_CODE | CLIENT_CREDENTIALS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OAuth2GrantType", "type": "string" }, "TokenUrl": { + "markdownDescription": "The token URL required for OAuth 2\\.0 authentication\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TokenUrl", "type": "string" }, "TokenUrlCustomProperties": { "additionalProperties": true, + "markdownDescription": "Associates your token URL with a map of properties that you define\\. Use this parameter to provide any additional details that the connector requires to authenticate your request\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "TokenUrlCustomProperties", "type": "object" } }, @@ -9579,18 +9799,28 @@ "additionalProperties": false, "properties": { "AccessToken": { + "markdownDescription": "The access token used to access protected SAPOData resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessToken", "type": "string" }, "ClientId": { + "markdownDescription": "The identifier for the desired client\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientId", "type": "string" }, "ClientSecret": { + "markdownDescription": "The client secret used by the OAuth client to authenticate to the authorization server\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientSecret", "type": "string" }, "ConnectorOAuthRequest": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectorOAuthRequest" }, "RefreshToken": { + "markdownDescription": "The refresh token used to refresh expired access token\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RefreshToken", "type": "string" } }, @@ -9600,7 +9830,7 @@ "additionalProperties": false, "properties": { "AuthCodeUrl": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthCodeUrl", "type": "string" }, @@ -9608,12 +9838,12 @@ "items": { "type": "string" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The OAuth scopes required for OAuth type authentication\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OAuthScopes", "type": "array" }, "TokenUrl": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TokenUrl", "type": "string" } @@ -9624,15 +9854,23 @@ "additionalProperties": false, "properties": { "AccessToken": { + "markdownDescription": "The credentials used to access protected Salesforce Pardot resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessToken", "type": "string" }, "ClientCredentialsArn": { + "markdownDescription": "The secret manager ARN, which contains the client ID and client secret of the connected app\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:aws:secretsmanager:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientCredentialsArn", "type": "string" }, "ConnectorOAuthRequest": { - "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest" + "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.ConnectorOAuthRequest", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConnectorOAuthRequest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectorOAuthRequest" }, "RefreshToken": { + "markdownDescription": "The credentials used to acquire new access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RefreshToken", "type": "string" } }, @@ -9642,12 +9880,18 @@ "additionalProperties": false, "properties": { "BusinessUnitId": { + "markdownDescription": "The business unit id of Salesforce Pardot instance\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `18` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BusinessUnitId", "type": "string" }, "InstanceUrl": { + "markdownDescription": "The location of the Salesforce Pardot resource\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InstanceUrl", "type": "string" }, "IsSandboxEnvironment": { + "markdownDescription": "Indicates whether the connector profile applies to a sandbox or production environment\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsSandboxEnvironment", "type": "boolean" } }, @@ -9660,12 +9904,12 @@ "additionalProperties": false, "properties": { "Password": { - "markdownDescription": "The password that corresponds to the user name\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The password that corresponds to the user name\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Password", "type": "string" }, "Username": { - "markdownDescription": "The name of the user\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the user\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Username", "type": "string" } @@ -9686,28 +9930,38 @@ "type": "string" }, "ClusterIdentifier": { + "markdownDescription": "The unique ID that's assigned to an Amazon Redshift cluster\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClusterIdentifier", "type": "string" }, "DataApiRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API\\. For more information, and for the polices that you attach to this role, see [Allow Amazon AppFlow to access Amazon Redshift databases with the Data API](https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#access-redshift)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `arn:aws:iam:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataApiRoleArn", "type": "string" }, "DatabaseName": { + "markdownDescription": "The name of an Amazon Redshift database\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DatabaseName", "type": "string" }, "DatabaseUrl": { - "markdownDescription": "The JDBC URL of the Amazon Redshift cluster\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The JDBC URL of the Amazon Redshift cluster\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DatabaseUrl", "type": "string" }, "IsRedshiftServerless": { + "markdownDescription": "Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsRedshiftServerless", "type": "boolean" }, "RoleArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IAM role\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `arn:aws:iam:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of IAM role that grants Amazon Redshift read\\-only access to Amazon S3\\. For more information, and for the polices that you attach to this role, see [Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3](https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#redshift-access-s3)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `arn:aws:iam:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RoleArn", "type": "string" }, "WorkgroupName": { + "markdownDescription": "The name of an Amazon Redshift workgroup\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WorkgroupName", "type": "string" } }, @@ -9722,12 +9976,12 @@ "properties": { "BasicAuthCredentials": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.BasicAuthCredentials", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The SAPOData basic authentication credentials\\. \n*Required*: No \n*Type*: [BasicAuthCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-basicauthcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BasicAuthCredentials" }, "OAuthCredentials": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.OAuthCredentials", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The SAPOData OAuth type authentication credentials\\. \n*Required*: No \n*Type*: [OAuthCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OAuthCredentials" } }, @@ -9737,37 +9991,37 @@ "additionalProperties": false, "properties": { "ApplicationHostUrl": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The location of the SAPOData resource\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApplicationHostUrl", "type": "string" }, "ApplicationServicePath": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The application path to catalog service\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ApplicationServicePath", "type": "string" }, "ClientNumber": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The client number for the client creating the connection\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `3` \n*Pattern*: `^\\d{3}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientNumber", "type": "string" }, "LogonLanguage": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The logon language of SAPOData instance\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2` \n*Pattern*: `^[a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogonLanguage", "type": "string" }, "OAuthProperties": { "$ref": "#/definitions/AWS::AppFlow::ConnectorProfile.OAuthProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [OAuthProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The SAPOData OAuth properties required for OAuth type authentication\\. \n*Required*: No \n*Type*: [OAuthProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OAuthProperties" }, "PortNumber": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The port number of the SAPOData instance\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PortNumber", "type": "number" }, "PrivateLinkServiceName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The SAPOData Private Link service name to be used for private data transfers\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `^$|com.amazonaws.vpce.[\\w/!:@#.\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PrivateLinkServiceName", "type": "string" } @@ -9778,7 +10032,7 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "The credentials used to access protected Salesforce resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to access protected Salesforce resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, @@ -9793,7 +10047,7 @@ "title": "ConnectorOAuthRequest" }, "RefreshToken": { - "markdownDescription": "The credentials used to acquire new access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to acquire new access tokens\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RefreshToken", "type": "string" } @@ -9868,7 +10122,7 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "The credentials used to access protected Slack resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to access protected Slack resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, @@ -10026,7 +10280,7 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "The credentials used to access protected Zendesk resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The credentials used to access protected Zendesk resources\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, @@ -10125,7 +10379,9 @@ "type": "string" }, "MetadataCatalogConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.MetadataCatalogConfig" + "$ref": "#/definitions/AWS::AppFlow::Flow.MetadataCatalogConfig", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [MetadataCatalogConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-metadatacatalogconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetadataCatalogConfig" }, "SourceFlowConfig": { "$ref": "#/definitions/AWS::AppFlow::Flow.SourceFlowConfig", @@ -10193,6 +10449,8 @@ "type": "string" }, "TargetFileSize": { + "markdownDescription": "The desired file size, in MB, for each output file that Amazon AppFlow writes to the flow destination\\. For each file, Amazon AppFlow attempts to achieve the size that you specify\\. The actual file sizes might differ from this target based on the number and size of the records that each file contains\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetFileSize", "type": "number" } }, @@ -10221,6 +10479,8 @@ "type": "string" }, "CustomConnector": { + "markdownDescription": "Operators supported by the custom connector\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomConnector", "type": "string" }, "Datadog": { @@ -10249,6 +10509,8 @@ "type": "string" }, "Pardot": { + "markdownDescription": "The operation to be performed on the provided Salesforce Pardot source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | DIVISION | EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pardot", "type": "string" }, "S3": { @@ -10257,7 +10519,7 @@ "type": "string" }, "SAPOData": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided SAPOData source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SAPOData", "type": "string" }, @@ -10304,26 +10566,36 @@ "properties": { "CustomProperties": { "additionalProperties": true, + "markdownDescription": "The custom properties that are specific to the connector when it's used as a destination in the flow\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "CustomProperties", "type": "object" }, "EntityName": { + "markdownDescription": "The entity specified in the custom connector as a destination in the flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EntityName", "type": "string" }, "ErrorHandlingConfig": { - "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig" + "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig", + "markdownDescription": "The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ErrorHandlingConfig" }, "IdFieldNames": { "items": { "type": "string" }, + "markdownDescription": "The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete, or upsert\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IdFieldNames", "type": "array" }, "WriteOperationType": { + "markdownDescription": "Specifies the type of write operation to be performed in the custom connector when it's used as destination\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DELETE | INSERT | UPDATE | UPSERT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WriteOperationType", "type": "string" } }, @@ -10337,14 +10609,18 @@ "properties": { "CustomProperties": { "additionalProperties": true, + "markdownDescription": "Custom properties that are required to use the custom connector as a source\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "CustomProperties", "type": "object" }, "EntityName": { + "markdownDescription": "The entity specified in the custom connector as a source in the flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EntityName", "type": "string" } }, @@ -10371,7 +10647,9 @@ "additionalProperties": false, "properties": { "CustomConnector": { - "$ref": "#/definitions/AWS::AppFlow::Flow.CustomConnectorDestinationProperties" + "$ref": "#/definitions/AWS::AppFlow::Flow.CustomConnectorDestinationProperties", + "markdownDescription": "The properties that are required to query the custom Connector\\. \n*Required*: No \n*Type*: [CustomConnectorDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectordestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomConnector" }, "EventBridge": { "$ref": "#/definitions/AWS::AppFlow::Flow.EventBridgeDestinationProperties", @@ -10420,7 +10698,7 @@ }, "Zendesk": { "$ref": "#/definitions/AWS::AppFlow::Flow.ZendeskDestinationProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ZendeskDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties required to query Zendesk\\. \n*Required*: No \n*Type*: [ZendeskDestinationProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-zendeskdestinationproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Zendesk" } }, @@ -10430,6 +10708,8 @@ "additionalProperties": false, "properties": { "ApiVersion": { + "markdownDescription": "The API version that the destination connector uses\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApiVersion", "type": "string" }, "ConnectorProfileName": { @@ -10512,12 +10792,18 @@ "additionalProperties": false, "properties": { "DatabaseName": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DatabaseName", "type": "string" }, "RoleArn": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "TablePrefix": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TablePrefix", "type": "string" } }, @@ -10583,7 +10869,7 @@ "properties": { "ErrorHandlingConfig": { "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The settings that determine how Amazon AppFlow handles an error when placing data in the destination\\. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure\\. `ErrorHandlingConfig` is a part of the destination connector details\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ErrorHandlingConfig" }, "Object": { @@ -10615,7 +10901,9 @@ "additionalProperties": false, "properties": { "GlueDataCatalog": { - "$ref": "#/definitions/AWS::AppFlow::Flow.GlueDataCatalog" + "$ref": "#/definitions/AWS::AppFlow::Flow.GlueDataCatalog", + "markdownDescription": "Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the AWS Glue Data Catalog\\. \n*Required*: No \n*Type*: [GlueDataCatalog](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-gluedatacatalog.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GlueDataCatalog" } }, "type": "object" @@ -10624,6 +10912,8 @@ "additionalProperties": false, "properties": { "Object": { + "markdownDescription": "The object specified in the Salesforce Pardot flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Object", "type": "string" } }, @@ -10639,10 +10929,12 @@ "items": { "type": "string" }, + "markdownDescription": "Specifies whether the destination file path includes either or both of the following elements: \nEXECUTION\\_ID \nThe ID that Amazon AppFlow assigns to the flow run\\. \nSCHEMA\\_VERSION \nThe version number of your data schema\\. Amazon AppFlow assigns this version number\\. The version number increases by one when you change any of the following settings in your flow configuration: \n+ Source\\-to\\-destination field mappings\n+ Field data types\n+ Partition keys\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PathPrefixHierarchy", "type": "array" }, "PrefixFormat": { - "markdownDescription": "Determines the level of granularity that's included in the prefix\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAY | HOUR | MINUTE | MONTH | YEAR` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the level of granularity for the date and time that's included in the prefix\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAY | HOUR | MINUTE | MONTH | YEAR` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PrefixFormat", "type": "string" }, @@ -10712,7 +11004,7 @@ "additionalProperties": false, "properties": { "S3InputFileType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The file type that Amazon AppFlow gets from your Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CSV | JSON` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3InputFileType", "type": "string" } @@ -10738,6 +11030,8 @@ "title": "PrefixConfig" }, "PreserveSourceDataTyping": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PreserveSourceDataTyping", "type": "boolean" } }, @@ -10758,7 +11052,7 @@ }, "S3InputFormatConfig": { "$ref": "#/definitions/AWS::AppFlow::Flow.S3InputFormatConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [S3InputFormatConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3inputformatconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When you use Amazon S3 as the source, the configuration format that you provide the flow input data\\. \n*Required*: No \n*Type*: [S3InputFormatConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-s3inputformatconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3InputFormatConfig" } }, @@ -10773,14 +11067,14 @@ "properties": { "ErrorHandlingConfig": { "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The settings that determine how Amazon AppFlow handles an error when placing data in the destination\\. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure\\. `ErrorHandlingConfig` is a part of the destination connector details\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ErrorHandlingConfig" }, "IdFieldNames": { "items": { "type": "string" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of field names that can be used as an ID field when performing a write operation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdFieldNames", "type": "array" }, @@ -10795,7 +11089,7 @@ "title": "SuccessResponseHandlingConfig" }, "WriteOperationType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The possible write operations in the destination connector\\. When this value is not provided, this defaults to the `INSERT` operation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WriteOperationType", "type": "string" } @@ -10809,7 +11103,7 @@ "additionalProperties": false, "properties": { "ObjectPath": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object path specified in the SAPOData flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ObjectPath", "type": "string" } @@ -10823,6 +11117,8 @@ "additionalProperties": false, "properties": { "DataTransferApi": { + "markdownDescription": "Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce\\. \nAUTOMATIC \nThe default\\. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to Salesforce\\. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API\\. If your flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2\\.0\\. \nEach of these Salesforce APIs structures data differently\\. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next\\. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2\\.0 on the next day to transfer 1,100 records\\. For each of these flow runs, the respective Salesforce API formats the data differently\\. Some of the differences include how dates are formatted and null values are represented\\. Also, Bulk API 2\\.0 doesn't transfer Salesforce compound fields\\. \nBy choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output\\. \nBULKV2 \nAmazon AppFlow uses only Salesforce Bulk API 2\\.0\\. This API runs asynchronous data transfers, and it's optimal for large sets of data\\. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers\\. \nNote that Bulk API 2\\.0 does not transfer Salesforce compound fields\\. \nREST\\_SYNC \nAmazon AppFlow uses only Salesforce REST API\\. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2\\.0\\. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | BULKV2 | REST_SYNC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataTransferApi", "type": "string" }, "ErrorHandlingConfig": { @@ -10858,6 +11154,8 @@ "additionalProperties": false, "properties": { "DataTransferApi": { + "markdownDescription": "Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce\\. \nAUTOMATIC \nThe default\\. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from Salesforce\\. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API\\. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2\\.0\\. \nEach of these Salesforce APIs structures data differently\\. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next\\. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2\\.0 on the next day to transfer 1,100,000 records\\. For each of these flow runs, the respective Salesforce API formats the data differently\\. Some of the differences include how dates are formatted and null values are represented\\. Also, Bulk API 2\\.0 doesn't transfer Salesforce compound fields\\. \nBy choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output\\. \nBULKV2 \nAmazon AppFlow uses only Salesforce Bulk API 2\\.0\\. This API runs asynchronous data transfers, and it's optimal for large sets of data\\. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers\\. \nNote that Bulk API 2\\.0 does not transfer Salesforce compound fields\\. \nREST\\_SYNC \nAmazon AppFlow uses only Salesforce REST API\\. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2\\.0\\. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | BULKV2 | REST_SYNC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataTransferApi", "type": "string" }, "EnableDynamicFieldUpdate": { @@ -10890,18 +11188,22 @@ "type": "string" }, "FirstExecutionFrom": { + "markdownDescription": "Specifies the date range for the records to import from the connector in the first flow run\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FirstExecutionFrom", "type": "number" }, "FlowErrorDeactivationThreshold": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FlowErrorDeactivationThreshold", "type": "number" }, "ScheduleEndTime": { - "markdownDescription": "Specifies the scheduled end time for a schedule\\-triggered flow\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The time at which the scheduled flow ends\\. The time is formatted as a timestamp that follows the ISO 8601 standard, such as `2022-04-27T13:00:00-07:00`\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleEndTime", "type": "number" }, "ScheduleExpression": { - "markdownDescription": "The scheduling expression that determines the rate at which the scheduled flow will run, for example: `rate(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/5minutes.html)`\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The scheduling expression that determines the rate at which the schedule will run, for example `rate(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/5minutes.html)`\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleExpression", "type": "string" }, @@ -10911,12 +11213,12 @@ "type": "number" }, "ScheduleStartTime": { - "markdownDescription": "Specifies the scheduled start time for a schedule\\-triggered flow\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The time at which the scheduled flow starts\\. The time is formatted as a timestamp that follows the ISO 8601 standard, such as `2022-04-26T13:00:00-07:00`\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleStartTime", "type": "number" }, "TimeZone": { - "markdownDescription": "Specifies the time zone used when referring to the date and time of a scheduled\\-triggered flow, such as `America/New_York`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the time zone used when referring to the dates and times of a scheduled flow, such as `America/New_York`\\. This time zone is only a descriptive label\\. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow\\. \nIf you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps\\. For example, the UTC offsets for the `America/New_York` timezone are `-04:00` EDT and `-05:00 EST`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeZone", "type": "string" } @@ -11007,7 +11309,9 @@ "title": "Amplitude" }, "CustomConnector": { - "$ref": "#/definitions/AWS::AppFlow::Flow.CustomConnectorSourceProperties" + "$ref": "#/definitions/AWS::AppFlow::Flow.CustomConnectorSourceProperties", + "markdownDescription": "The properties that are applied when the custom connector is being used as a source\\. \n*Required*: No \n*Type*: [CustomConnectorSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-customconnectorsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomConnector" }, "Datadog": { "$ref": "#/definitions/AWS::AppFlow::Flow.DatadogSourceProperties", @@ -11035,7 +11339,9 @@ "title": "Marketo" }, "Pardot": { - "$ref": "#/definitions/AWS::AppFlow::Flow.PardotSourceProperties" + "$ref": "#/definitions/AWS::AppFlow::Flow.PardotSourceProperties", + "markdownDescription": "Specifies the information that is required for querying Salesforce Pardot\\. \n*Required*: No \n*Type*: [PardotSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-pardotsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pardot" }, "S3": { "$ref": "#/definitions/AWS::AppFlow::Flow.S3SourceProperties", @@ -11044,7 +11350,7 @@ }, "SAPOData": { "$ref": "#/definitions/AWS::AppFlow::Flow.SAPODataSourceProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SAPODataSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatasourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties that are applied when using SAPOData as a flow source\\. \n*Required*: No \n*Type*: [SAPODataSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-sapodatasourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SAPOData" }, "Salesforce": { @@ -11089,6 +11395,8 @@ "additionalProperties": false, "properties": { "ApiVersion": { + "markdownDescription": "The API version of the connector when it's used as a source in the flow\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApiVersion", "type": "string" }, "ConnectorProfileName": { @@ -11268,7 +11576,7 @@ }, "PrefixConfig": { "$ref": "#/definitions/AWS::AppFlow::Flow.PrefixConfig", - "markdownDescription": "Determines the prefix that Amazon AppFlow applies to the destination folder name\\. You can name your destination folders according to the flow frequency and date\\. \n*Required*: Yes \n*Type*: [PrefixConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-prefixconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination\\. \n*Required*: Yes \n*Type*: [PrefixConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-prefixconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PrefixConfig" } }, @@ -11281,22 +11589,22 @@ "additionalProperties": false, "properties": { "DocumentType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The document type specified in the Veeva document extract flow\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\s\\w_-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DocumentType", "type": "string" }, "IncludeAllVersions": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Boolean value to include All Versions of files in Veeva document extract flow\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeAllVersions", "type": "boolean" }, "IncludeRenditions": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Boolean value to include file renditions in Veeva document extract flow\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeRenditions", "type": "boolean" }, "IncludeSourceFiles": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Boolean value to include source files in Veeva document extract flow\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeSourceFiles", "type": "boolean" }, @@ -11316,24 +11624,24 @@ "properties": { "ErrorHandlingConfig": { "$ref": "#/definitions/AWS::AppFlow::Flow.ErrorHandlingConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The settings that determine how Amazon AppFlow handles an error when placing data in the destination\\. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure\\. `ErrorHandlingConfig` is a part of the destination connector details\\. \n*Required*: No \n*Type*: [ErrorHandlingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-flow-errorhandlingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ErrorHandlingConfig" }, "IdFieldNames": { "items": { "type": "string" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of field names that can be used as an ID field when performing a write operation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdFieldNames", "type": "array" }, "Object": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object specified in the Zendesk flow destination\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Object", "type": "string" }, "WriteOperationType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The possible write operations in the destination connector\\. When this value is not provided, this defaults to the `INSERT` operation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WriteOperationType", "type": "string" } @@ -11846,6 +12154,8 @@ "additionalProperties": false, "properties": { "Port": { + "markdownDescription": "The port number of the gateway route target\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "VirtualService": { @@ -11929,6 +12239,8 @@ "type": "array" }, "Port": { + "markdownDescription": "The gateway route port to be matched on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "ServiceName": { @@ -12095,6 +12407,8 @@ "title": "Path" }, "Port": { + "markdownDescription": "The port number to match on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "Prefix": { @@ -12287,7 +12601,7 @@ "additionalProperties": false, "properties": { "Type": { - "markdownDescription": "The egress filter type\\. By default, the type is `DROP_ALL`, which allows egress only from virtual nodes to other defined resources in the service mesh \\(and any traffic to `*.amazonaws.com` for AWS API calls\\)\\. You can set the egress filter type to `ALLOW_ALL` to allow egress to any endpoint inside or outside of the service mesh\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALLOW_ALL | DROP_ALL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The egress filter type\\. By default, the type is `DROP_ALL`, which allows egress only from virtual nodes to other defined resources in the service mesh \\(and any traffic to `*.amazonaws.com` for AWS API calls\\)\\. You can set the egress filter type to `ALLOW_ALL` to allow egress to any endpoint inside or outside of the service mesh\\. \nIf you specify any backends on a virtual node when using `ALLOW_ALL`, you must specifiy all egress for that virtual node as backends\\. Otherwise, `ALLOW_ALL` will no longer work for that virtual node\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALLOW_ALL | DROP_ALL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" } @@ -12301,6 +12615,8 @@ "additionalProperties": false, "properties": { "IpPreference": { + "markdownDescription": "The IP version to use to control traffic within the mesh\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IPv4_ONLY | IPv4_PREFERRED | IPv6_ONLY | IPv6_PREFERRED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IpPreference", "type": "string" } }, @@ -12315,7 +12631,9 @@ "title": "EgressFilter" }, "ServiceDiscovery": { - "$ref": "#/definitions/AWS::AppMesh::Mesh.MeshServiceDiscovery" + "$ref": "#/definitions/AWS::AppMesh::Mesh.MeshServiceDiscovery", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [MeshServiceDiscovery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-mesh-meshservicediscovery.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceDiscovery" } }, "type": "object" @@ -12545,6 +12863,8 @@ "type": "string" }, "Port": { + "markdownDescription": "The port number to match on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "ServiceName": { @@ -12813,6 +13133,8 @@ "title": "Path" }, "Port": { + "markdownDescription": "The port number to match on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "Prefix": { @@ -12931,7 +13253,9 @@ "title": "Action" }, "Match": { - "$ref": "#/definitions/AWS::AppMesh::Route.TcpRouteMatch" + "$ref": "#/definitions/AWS::AppMesh::Route.TcpRouteMatch", + "markdownDescription": "An object that represents the criteria for determining a request match\\. \n*Required*: No \n*Type*: [TcpRouteMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-tcproutematch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Match" }, "Timeout": { "$ref": "#/definitions/AWS::AppMesh::Route.TcpTimeout", @@ -12965,6 +13289,8 @@ "additionalProperties": false, "properties": { "Port": { + "markdownDescription": "The port number to match on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" } }, @@ -12985,6 +13311,8 @@ "additionalProperties": false, "properties": { "Port": { + "markdownDescription": "The targeted port of the weighted object\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "VirtualNode": { @@ -13099,9 +13427,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The specified key for the JSON\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "The specified value for the JSON\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -13118,9 +13450,13 @@ "items": { "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.JsonFormatRef" }, + "markdownDescription": "The logging format for JSON\\. \n*Required*: No \n*Type*: List of [JsonFormatRef](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-jsonformatref.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Json", "type": "array" }, "Text": { + "markdownDescription": "The logging format for text\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Text", "type": "string" } }, @@ -13260,7 +13596,9 @@ "additionalProperties": false, "properties": { "Format": { - "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.LoggingFormat" + "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.LoggingFormat", + "markdownDescription": "The specified format for the virtual gateway access logs\\. It can be either `json_format` or `text_format`\\. \n*Required*: No \n*Type*: [LoggingFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-loggingformat.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Format" }, "Path": { "markdownDescription": "The file path to write access logs to\\. You can use `/dev/stdout` to send access logs to standard out and configure your Envoy container to use a log driver, such as `awslogs`, to export the access logs to a log storage service such as Amazon CloudWatch Logs\\. You can also specify a path in the Envoy container's file system to write the files to disk\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -13569,7 +13907,7 @@ "items": { "$ref": "#/definitions/AWS::AppMesh::VirtualGateway.VirtualGatewayListener" }, - "markdownDescription": "The listeners that the mesh endpoint is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: Yes \n*Type*: List of [VirtualGatewayListener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistener.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The listeners that the mesh endpoint is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: Yes \n*Type*: List of [VirtualGatewayListener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewaylistener.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Listeners", "type": "array" }, @@ -13803,6 +14141,8 @@ "type": "array" }, "IpPreference": { + "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IPv4_ONLY | IPv4_PREFERRED | IPv6_ONLY | IPv6_PREFERRED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IpPreference", "type": "string" }, "NamespaceName": { @@ -13912,6 +14252,8 @@ "type": "string" }, "IpPreference": { + "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IPv4_ONLY | IPv4_PREFERRED | IPv6_ONLY | IPv6_PREFERRED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IpPreference", "type": "string" }, "ResponseType": { @@ -13949,7 +14291,9 @@ "additionalProperties": false, "properties": { "Format": { - "$ref": "#/definitions/AWS::AppMesh::VirtualNode.LoggingFormat" + "$ref": "#/definitions/AWS::AppMesh::VirtualNode.LoggingFormat", + "markdownDescription": "The specified format for the logs\\. The format is either `json_format` or `text_format`\\. \n*Required*: No \n*Type*: [LoggingFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-loggingformat.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Format" }, "Path": { "markdownDescription": "The file path to write access logs to\\. You can use `/dev/stdout` to send access logs to standard out and configure your Envoy container to use a log driver, such as `awslogs`, to export the access logs to a log storage service such as Amazon CloudWatch Logs\\. You can also specify a path in the Envoy container's file system to write the files to disk\\. \nThe Envoy process must have write permissions to the path that you specify here\\. Otherwise, Envoy fails to bootstrap properly\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -14046,9 +14390,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The specified key for the JSON\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "The specified value for the JSON\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -14270,9 +14618,13 @@ "items": { "$ref": "#/definitions/AWS::AppMesh::VirtualNode.JsonFormatRef" }, + "markdownDescription": "The logging format for JSON\\. \n*Required*: No \n*Type*: List of [JsonFormatRef](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-jsonformatref.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Json", "type": "array" }, "Text": { + "markdownDescription": "The logging format for text\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Text", "type": "string" } }, @@ -14390,7 +14742,7 @@ "properties": { "SubjectAlternativeNames": { "$ref": "#/definitions/AWS::AppMesh::VirtualNode.SubjectAlternativeNames", - "markdownDescription": "A reference to an object that represents the SANs for a Transport Layer Security \\(TLS\\) validation context\\. \n*Required*: No \n*Type*: [SubjectAlternativeNames](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-subjectalternativenames.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A reference to an object that represents the SANs for a Transport Layer Security \\(TLS\\) validation context\\. If you don't specify SANs on the *terminating* mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate\\. If you don't specify SANs on the *originating* mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration\\. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name\\. \n*Required*: No \n*Type*: [SubjectAlternativeNames](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-subjectalternativenames.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SubjectAlternativeNames" }, "Trust": { @@ -14555,7 +14907,7 @@ "items": { "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Backend" }, - "markdownDescription": "The backends that the virtual node is expected to send outbound traffic to\\. \n*Required*: No \n*Type*: List of [Backend](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backend.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The backends that the virtual node is expected to send outbound traffic to\\. \nApp Mesh doesn't validate the existence of those virtual services specified in backends\\. This is to prevent a cyclic dependency between virtual nodes and virtual services creation\\. Make sure the virtual service name is correct\\. The virtual service can be created afterwards if it doesn't already exist\\. \n*Required*: No \n*Type*: List of [Backend](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-backend.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Backends", "type": "array" }, @@ -14563,7 +14915,7 @@ "items": { "$ref": "#/definitions/AWS::AppMesh::VirtualNode.Listener" }, - "markdownDescription": "The listener that the virtual node is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: No \n*Type*: List of [Listener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The listener that the virtual node is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: No \n*Type*: List of [Listener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-listener.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Listeners", "type": "array" }, @@ -14603,7 +14955,7 @@ "title": "ClientPolicy" }, "VirtualServiceName": { - "markdownDescription": "The name of the virtual service that is acting as a virtual node backend\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the virtual service that is acting as a virtual node backend\\. \nApp Mesh doesn't validate the existence of those virtual services specified in backends\\. This is to prevent a cyclic dependency between virtual nodes and virtual services creation\\. Make sure the virtual service name is correct\\. The virtual service can be created afterwards if it doesn't already exist\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VirtualServiceName", "type": "string" } @@ -14745,7 +15097,7 @@ "items": { "$ref": "#/definitions/AWS::AppMesh::VirtualRouter.VirtualRouterListener" }, - "markdownDescription": "The listeners that the virtual router is expected to receive inbound traffic from\\. You can specify one listener\\. \n*Required*: Yes \n*Type*: List of [VirtualRouterListener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The listeners that the virtual router is expected to receive inbound traffic from\\. \n*Required*: Yes \n*Type*: List of [VirtualRouterListener](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Listeners", "type": "array" } @@ -14938,16 +15290,22 @@ "additionalProperties": false, "properties": { "ObservabilityConfigurationName": { + "markdownDescription": "A name for the observability configuration\\. When you use it for the first time in an AWS Region, App Runner creates revision number `1` of this name\\. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration\\. \nThe name `DefaultConfiguration` is reserved\\. You can't use it to create a new observability configuration, and you can't create a revision of it\\. \nWhen you want to use your own observability configuration for your App Runner service, *create a configuration with a different name*, and then provide it when you create or update your service\\.\nIf you don't specify a name, AWS CloudFormation generates a name for your observability configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `32` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9\\-_]{3,31}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ObservabilityConfigurationName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of metadata items that you can associate with your observability configuration resource\\. A tag is a key\\-value pair\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Tags", "type": "array" }, "TraceConfiguration": { - "$ref": "#/definitions/AWS::AppRunner::ObservabilityConfiguration.TraceConfiguration" + "$ref": "#/definitions/AWS::AppRunner::ObservabilityConfiguration.TraceConfiguration", + "markdownDescription": "The configuration of the tracing feature within this observability configuration\\. If you don't specify it, App Runner doesn't enable tracing\\. \n*Required*: No \n*Type*: [TraceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-observabilityconfiguration-traceconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TraceConfiguration" } }, "type": "object" @@ -14976,6 +15334,8 @@ "additionalProperties": false, "properties": { "Vendor": { + "markdownDescription": "The implementation provider chosen for tracing App Runner services\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AWSXRAY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Vendor", "type": "string" } }, @@ -15020,7 +15380,7 @@ "additionalProperties": false, "properties": { "AutoScalingConfigurationArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an App Runner automatic scaling configuration resource that you want to associate with the App Runner service\\. If not provided, App Runner associates the latest revision of a default auto scaling configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an App Runner automatic scaling configuration resource that you want to associate with your service\\. If not provided, App Runner associates the latest revision of a default auto scaling configuration\\. \nSpecify an ARN with a name and a revision number to associate that revision\\. For example: `arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3` \nSpecify just the name to associate the latest revision\\. For example: `arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability` \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutoScalingConfigurationArn", "type": "string" }, @@ -15036,7 +15396,7 @@ }, "InstanceConfiguration": { "$ref": "#/definitions/AWS::AppRunner::Service.InstanceConfiguration", - "markdownDescription": "The runtime configuration of instances \\(scaling units\\) of the App Runner service\\. \n*Required*: No \n*Type*: [InstanceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The runtime configuration of instances \\(scaling units\\) of your service\\. \n*Required*: No \n*Type*: [InstanceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-instanceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InstanceConfiguration" }, "NetworkConfiguration": { @@ -15045,10 +15405,12 @@ "title": "NetworkConfiguration" }, "ObservabilityConfiguration": { - "$ref": "#/definitions/AWS::AppRunner::Service.ServiceObservabilityConfiguration" + "$ref": "#/definitions/AWS::AppRunner::Service.ServiceObservabilityConfiguration", + "markdownDescription": "The observability configuration of your service\\. \n*Required*: No \n*Type*: [ServiceObservabilityConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-serviceobservabilityconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObservabilityConfiguration" }, "ServiceName": { - "markdownDescription": "A name for the App Runner service\\. It must be unique across all the running App Runner services in your AWS account in the AWS Region\\. \nIf you don't specify a name, AWS CloudFormation generates a name for your Service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `40` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9-_]{3,39}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A name for the App Runner service\\. It must be unique across all the running App Runner services in your AWS account in the AWS Region\\. \nIf you don't specify a name, AWS CloudFormation generates a name for your service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `40` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9-_]{3,39}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ServiceName", "type": "string" }, @@ -15131,7 +15493,7 @@ "additionalProperties": false, "properties": { "BuildCommand": { - "markdownDescription": "The command App Runner runs to build your application\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The command App Runner runs to build your application\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[^\\x0a\\x0d]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BuildCommand", "type": "string" }, @@ -15141,7 +15503,7 @@ "type": "string" }, "Runtime": { - "markdownDescription": "A runtime environment type for building and running an App Runner service\\. It represents a programming language runtime\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CORRETTO_11 | CORRETTO_8 | NODEJS_12 | NODEJS_14 | PYTHON_3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A runtime environment type for building and running an App Runner service\\. It represents a programming language runtime\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CORRETTO_11 | CORRETTO_8 | DOTNET_6 | GO_1 | NODEJS_12 | NODEJS_14 | NODEJS_16 | PHP_81 | PYTHON_3 | RUBY_31` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Runtime", "type": "string" }, @@ -15149,18 +15511,20 @@ "items": { "$ref": "#/definitions/AWS::AppRunner::Service.KeyValuePair" }, + "markdownDescription": "An array of key\\-value pairs representing the secrets and parameters that get referenced to your service as an environment variable\\. The supported values are either the full Amazon Resource Name \\(ARN\\) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store\\. \n+ If the AWS Systems Manager Parameter Store parameter exists in the same AWS Region as the service that you're launching, you can use either the full ARN or name of the secret\\. If the parameter exists in a different Region, then the full ARN must be specified\\. \n+ Currently, cross account referencing of AWS Systems Manager Parameter Store parameter is not supported\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RuntimeEnvironmentSecrets", "type": "array" }, "RuntimeEnvironmentVariables": { "items": { "$ref": "#/definitions/AWS::AppRunner::Service.KeyValuePair" }, - "markdownDescription": "The environment variables that are available to your running App Runner service\\. An array of key\\-value pairs\\. Keys with a prefix of `AWSAPPRUNNER` are reserved for system use and aren't valid\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The environment variables that are available to your running AWS App Runner service\\. An array of key\\-value pairs\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RuntimeEnvironmentVariables", "type": "array" }, "StartCommand": { - "markdownDescription": "The command App Runner runs to start your application\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The command App Runner runs to start your application\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[^\\x0a\\x0d]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartCommand", "type": "string" } @@ -15175,7 +15539,7 @@ "properties": { "CodeConfiguration": { "$ref": "#/definitions/AWS::AppRunner::Service.CodeConfiguration", - "markdownDescription": "Configuration for building and running the service from a source code repository\\. \n*Required*: No \n*Type*: [CodeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configuration for building and running the service from a source code repository\\. \n `CodeConfiguration` is required only for `CreateService` request\\.\n*Required*: No \n*Type*: [CodeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-codeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CodeConfiguration" }, "RepositoryUrl": { @@ -15276,18 +15640,20 @@ "items": { "$ref": "#/definitions/AWS::AppRunner::Service.KeyValuePair" }, + "markdownDescription": "An array of key\\-value pairs representing the secrets and parameters that get referenced to your service as an environment variable\\. The supported values are either the full Amazon Resource Name \\(ARN\\) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store\\. \n+ If the AWS Systems Manager Parameter Store parameter exists in the same AWS Region as the service that you're launching, you can use either the full ARN or name of the secret\\. If the parameter exists in a different Region, then the full ARN must be specified\\. \n+ Currently, cross account referencing of AWS Systems Manager Parameter Store parameter is not supported\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RuntimeEnvironmentSecrets", "type": "array" }, "RuntimeEnvironmentVariables": { "items": { "$ref": "#/definitions/AWS::AppRunner::Service.KeyValuePair" }, - "markdownDescription": "Environment variables that are available to your running App Runner service\\. An array of key\\-value pairs\\. Keys with a prefix of `AWSAPPRUNNER` are reserved for system use and aren't valid\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Environment variables that are available to your running App Runner service\\. An array of key\\-value pairs\\. \n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-keyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RuntimeEnvironmentVariables", "type": "array" }, "StartCommand": { - "markdownDescription": "An optional command that App Runner runs to start the application in the source image\\. If specified, this command overrides the Docker image\u2019s default start command\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `51200` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional command that App Runner runs to start the application in the source image\\. If specified, this command overrides the Docker image\u2019s default start command\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[^\\x0a\\x0d]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartCommand", "type": "string" } @@ -15323,6 +15689,8 @@ "additionalProperties": false, "properties": { "IsPubliclyAccessible": { + "markdownDescription": "Specifies whether your App Runner service is publicly accessible\\. To make the service publicly accessible set it to `True`\\. To make the service privately accessible, from only within an Amazon VPC set it to `False`\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsPubliclyAccessible", "type": "boolean" } }, @@ -15373,11 +15741,13 @@ "properties": { "EgressConfiguration": { "$ref": "#/definitions/AWS::AppRunner::Service.EgressConfiguration", - "markdownDescription": "Network configuration settings for outbound message traffic\\. \n*Required*: Yes \n*Type*: [EgressConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Network configuration settings for outbound message traffic\\. \n*Required*: No \n*Type*: [EgressConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-egressconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EgressConfiguration" }, "IngressConfiguration": { - "$ref": "#/definitions/AWS::AppRunner::Service.IngressConfiguration" + "$ref": "#/definitions/AWS::AppRunner::Service.IngressConfiguration", + "markdownDescription": "Network configuration settings for inbound message traffic\\. \n*Required*: No \n*Type*: [IngressConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-ingressconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IngressConfiguration" } }, "type": "object" @@ -15386,9 +15756,13 @@ "additionalProperties": false, "properties": { "ObservabilityConfigurationArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the observability configuration that is associated with the service\\. Specified only when `ObservabilityEnabled` is `true`\\. \nSpecify an ARN with a name and a revision number to associate that revision\\. For example: `arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3` \nSpecify just the name to associate the latest revision\\. For example: `arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing` \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObservabilityConfigurationArn", "type": "string" }, "ObservabilityEnabled": { + "markdownDescription": "When `true`, an observability configuration resource is associated with the service, and an `ObservabilityConfigurationArn` is specified\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObservabilityEnabled", "type": "boolean" } }, @@ -15490,7 +15864,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC\\. Specify IDs of subnets of a single Amazon VPC\\. App Runner determines the Amazon VPC from the subnets you specify\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC\\. Specify IDs of subnets of a single Amazon VPC\\. App Runner determines the Amazon VPC from the subnets you specify\\. \n App Runner currently only provides support for IPv4\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Subnets", "type": "array" }, @@ -15570,18 +15944,26 @@ "additionalProperties": false, "properties": { "IngressVpcConfiguration": { - "$ref": "#/definitions/AWS::AppRunner::VpcIngressConnection.IngressVpcConfiguration" + "$ref": "#/definitions/AWS::AppRunner::VpcIngressConnection.IngressVpcConfiguration", + "markdownDescription": "Specifications for the customer\u2019s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource\\. \n*Required*: Yes \n*Type*: [IngressVpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-vpcingressconnection-ingressvpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IngressVpcConfiguration" }, "ServiceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for this App Runner service that is used to create the VPC Ingress Connection resource\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Pattern*: `arn:aws(-[\\w]+)*:[a-z0-9-\\\\.]{0,63}:[a-z0-9-\\\\.]{0,63}:[0-9]{12}:(\\w|\\/|-){1,1011}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ServiceArn", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An optional list of metadata items that you can associate with the VPC Ingress Connection resource\\. A tag is a key\\-value pair\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Tags", "type": "array" }, "VpcIngressConnectionName": { + "markdownDescription": "The customer\\-provided VPC Ingress Connection name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `4` \n*Maximum*: `40` \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9\\-_]{3,39}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VpcIngressConnectionName", "type": "string" } }, @@ -15616,9 +15998,13 @@ "additionalProperties": false, "properties": { "VpcEndpointId": { + "markdownDescription": "The ID of the VPC endpoint that your App Runner service connects to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `51200` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcEndpointId", "type": "string" }, "VpcId": { + "markdownDescription": "The ID of the VPC that is used for the VPC endpoint\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `51200` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcId", "type": "string" } }, @@ -16123,7 +16509,9 @@ "additionalProperties": false, "properties": { "CertificateBasedAuthProperties": { - "$ref": "#/definitions/AWS::AppStream::DirectoryConfig.CertificateBasedAuthProperties" + "$ref": "#/definitions/AWS::AppStream::DirectoryConfig.CertificateBasedAuthProperties", + "markdownDescription": "The certificate\\-based authentication properties used to authenticate SAML 2\\.0 Identity Provider \\(IdP\\) user identities to Active Directory domain\\-joined streaming instances\\. \n*Required*: No \n*Type*: [CertificateBasedAuthProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-directoryconfig-certificatebasedauthproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertificateBasedAuthProperties" }, "DirectoryName": { "markdownDescription": "The fully qualified name of the directory \\(for example, corp\\.example\\.com\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -16176,9 +16564,13 @@ "additionalProperties": false, "properties": { "CertificateAuthorityArn": { + "markdownDescription": "The ARN of the AWS Certificate Manager Private CA resource\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^arn:aws(?:\\-cn|\\-iso\\-b|\\-iso|\\-us\\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\\\-]{0,1023}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertificateAuthorityArn", "type": "string" }, "Status": { + "markdownDescription": "The status of the certificate\\-based authentication properties\\. Fallback is turned on by default when certificate\\-based authentication is **Enabled**\\. Fallback allows users to log in using their AD domain password if certificate\\-based authentication is unsuccessful, or to unlock a desktop lock screen\\. **Enabled\\_no\\_directory\\_login\\_fallback** enables certificate\\-based authentication, but does not allow users to log in using their AD domain password\\. Users will be disconnected to re\\-authenticate using certificates\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED | ENABLED_NO_DIRECTORY_LOGIN_FALLBACK` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" } }, @@ -16433,7 +16825,9 @@ "type": "string" }, "SessionScriptS3Location": { - "$ref": "#/definitions/AWS::AppStream::Fleet.S3Location" + "$ref": "#/definitions/AWS::AppStream::Fleet.S3Location", + "markdownDescription": "The S3 location of the session scripts configuration zip file\\. This only applies to Elastic fleets\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appstream-fleet-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionScriptS3Location" }, "StreamView": { "markdownDescription": "The AppStream 2\\.0 view that is displayed to your users when they stream from the fleet\\. When `APP` is specified, only the windows of applications opened by users display\\. When `DESKTOP` is specified, the standard desktop that is provided by the operating system displays\\. \nThe default value is `APP`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `APP | DESKTOP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -16523,9 +16917,13 @@ "additionalProperties": false, "properties": { "S3Bucket": { + "markdownDescription": "The S3 bucket of the S3 object\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `^[0-9a-z\\.\\-]*(?/ is the final portion of the load balancer ARN\n+ targetgroup// is the final portion of the target group ARN\\.\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation\\. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1023` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceLabel", "type": "string" } @@ -21782,7 +22222,7 @@ "items": { "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy.PredictiveScalingMetricSpecification" }, - "markdownDescription": "An array that contains information about the metrics and target utilization to use for predictive scaling\\. \nAdding more than one predictive scaling metric specification to the array is currently not supported\\.\n*Required*: Yes \n*Type*: List of [PredictiveScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This structure includes the metrics and target utilization to use for predictive scaling\\. \nThis is an array, but we currently only support a single metric specification\\. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric\\. \n*Required*: Yes \n*Type*: List of [PredictiveScalingMetricSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingmetricspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricSpecifications", "type": "array" }, @@ -21873,17 +22313,17 @@ }, "PredefinedLoadMetricSpecification": { "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy.PredictiveScalingPredefinedLoadMetric", - "markdownDescription": "The load metric specification\\. \nIf you specify `PredefinedMetricPairSpecification`, don't specify this property\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedLoadMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The predefined load metric specification\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedLoadMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedloadmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PredefinedLoadMetricSpecification" }, "PredefinedMetricPairSpecification": { "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy.PredictiveScalingPredefinedMetricPair", - "markdownDescription": "The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use\\. \nWith predictive scaling, you must specify either a metric pair, or a load metric and a scaling metric individually\\. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy\\. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric\\.\n*Required*: No \n*Type*: [PredictiveScalingPredefinedMetricPair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedMetricPair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedmetricpair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PredefinedMetricPairSpecification" }, "PredefinedScalingMetricSpecification": { "$ref": "#/definitions/AWS::AutoScaling::ScalingPolicy.PredictiveScalingPredefinedScalingMetric", - "markdownDescription": "The scaling metric specification\\. \nIf you specify `PredefinedMetricPairSpecification`, don't specify this property\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedScalingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The predefined scaling metric specification\\. \n*Required*: No \n*Type*: [PredictiveScalingPredefinedScalingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-scalingpolicy-predictivescalingpredefinedscalingmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PredefinedScalingMetricSpecification" }, "TargetValue": { @@ -21925,7 +22365,7 @@ "type": "string" }, "ResourceLabel": { - "markdownDescription": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group\\. You can't specify a resource label unless the target group is attached to the Auto Scaling group\\. \nYou create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash \\(/\\)\\. The format of the resource label is: \n `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff`\\. \nWhere: \n+ app// is the final portion of the load balancer ARN\n+ targetgroup// is the final portion of the target group ARN\\.\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation\\. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group\\. You can't specify a resource label unless the target group is attached to the Auto Scaling group\\. \nYou create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash \\(/\\)\\. The format of the resource label is: \n `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff`\\. \nWhere: \n+ app// is the final portion of the load balancer ARN\n+ targetgroup// is the final portion of the target group ARN\\.\nTo find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation\\. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1023` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceLabel", "type": "string" } @@ -21963,12 +22403,12 @@ "type": "number" }, "MetricIntervalUpperBound": { - "markdownDescription": "The upper bound for the difference between the alarm threshold and the CloudWatch metric\\. If the metric value is above the breach threshold, the upper bound is exclusive \\(the metric must be less than the threshold plus the upper bound\\)\\. Otherwise, it is inclusive \\(the metric must be less than or equal to the threshold plus the upper bound\\)\\. A null value indicates positive infinity\\. \n*Required*: Conditional \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The upper bound for the difference between the alarm threshold and the CloudWatch metric\\. If the metric value is above the breach threshold, the upper bound is exclusive \\(the metric must be less than the threshold plus the upper bound\\)\\. Otherwise, it is inclusive \\(the metric must be less than or equal to the threshold plus the upper bound\\)\\. A null value indicates positive infinity\\. \nThe upper bound must be greater than the lower bound\\. \n*Required*: Conditional \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricIntervalUpperBound", "type": "number" }, "ScalingAdjustment": { - "markdownDescription": "The amount by which to scale\\. The adjustment is based on the value that you specified in the `AdjustmentType` property \\(either an absolute number or a percentage\\)\\. A positive value adds to the current capacity and a negative number subtracts from the current capacity\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount by which to scale, based on the specified adjustment type\\. A positive value adds to the current capacity while a negative number removes from the current capacity\\. \nThe amount by which to scale\\. The adjustment is based on the value that you specified in the `AdjustmentType` property \\(either an absolute number or a percentage\\)\\. A positive value adds to the current capacity and a negative number subtracts from the current capacity\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScalingAdjustment", "type": "number" } @@ -21997,7 +22437,7 @@ "title": "PredefinedMetricSpecification" }, "TargetValue": { - "markdownDescription": "The target value for the metric\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The target value for the metric\\. \nSome metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue\\. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one\\-minute interval\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TargetValue", "type": "number" } @@ -22048,7 +22488,7 @@ "type": "string" }, "DesiredCapacity": { - "markdownDescription": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain\\. It can scale beyond this capacity if you add more scaling conditions\\. \nYou must specify at least one of the following properties: `MaxSize`, `MinSize`, or `DesiredCapacity`\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain\\. It can scale beyond this capacity if you add more scaling conditions\\. \nYou must specify at least one of the following properties: `MaxSize`, `MinSize`, or `DesiredCapacity`\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DesiredCapacity", "type": "number" }, @@ -22058,27 +22498,27 @@ "type": "string" }, "MaxSize": { - "markdownDescription": "The maximum size of the Auto Scaling group\\. \nYou must specify at least one of the following properties: `MaxSize`, `MinSize`, or `DesiredCapacity`\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum size of the Auto Scaling group\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxSize", "type": "number" }, "MinSize": { - "markdownDescription": "The minimum size of the Auto Scaling group\\. \nYou must specify at least one of the following properties: `MaxSize`, `MinSize`, or `DesiredCapacity`\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The minimum size of the Auto Scaling group\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MinSize", "type": "number" }, "Recurrence": { - "markdownDescription": "The recurring schedule for this action\\. This format consists of five fields separated by white spaces: \\[Minute\\] \\[Hour\\] \\[Day\\_of\\_Month\\] \\[Month\\_of\\_Year\\] \\[Day\\_of\\_Week\\]\\. For more information about this format, see [Crontab](http://crontab.org)\\. \nWhen `StartTime` and `EndTime` are specified with `Recurrence`, they form the boundaries of when the recurring action starts and stops\\. \nCron expressions use Universal Coordinated Time \\(UTC\\) by default\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The recurring schedule for this action\\. This format consists of five fields separated by white spaces: \\[Minute\\] \\[Hour\\] \\[Day\\_of\\_Month\\] \\[Month\\_of\\_Year\\] \\[Day\\_of\\_Week\\]\\. The value must be in quotes \\(for example, `\"30 0 1 1,6,12 *\"`\\)\\. For more information about this format, see [Crontab](http://crontab.org)\\. \nWhen `StartTime` and `EndTime` are specified with `Recurrence`, they form the boundaries of when the recurring action starts and stops\\. \nCron expressions use Universal Coordinated Time \\(UTC\\) by default\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Recurrence", "type": "string" }, "StartTime": { - "markdownDescription": "The date and time for this action to start, in YYYY\\-MM\\-DDThh:mm:ssZ format in UTC/GMT only\\. For example, `\"2021-06-01T00:00:00Z\"`\\. \nIf you specify `Recurrence` and `StartTime`, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The date and time for this action to start, in YYYY\\-MM\\-DDThh:mm:ssZ format in UTC/GMT only and in quotes \\(for example, `\"2021-06-01T00:00:00Z\"`\\)\\. \nIf you specify `Recurrence` and `StartTime`, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartTime", "type": "string" }, "TimeZone": { - "markdownDescription": "Specifies the time zone for a cron expression\\. If a time zone is not provided, UTC is used by default\\. \nValid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database \\(such as `Etc/GMT+9` or `Pacific/Tahiti`\\)\\. For more information, see [https://en\\.wikipedia\\.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the time zone for a cron expression\\. If a time zone is not provided, UTC is used by default\\. \nValid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database \\(such as `Etc/GMT+9` or `Pacific/Tahiti`\\)\\. For more information, see [https://en\\.wikipedia\\.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeZone", "type": "string" } @@ -22145,7 +22585,7 @@ "additionalProperties": false, "properties": { "AutoScalingGroupName": { - "markdownDescription": "The name of the Auto Scaling group\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the Auto Scaling group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AutoScalingGroupName", "type": "string" }, @@ -22348,12 +22788,12 @@ "items": { "$ref": "#/definitions/AWS::AutoScalingPlans::ScalingPlan.MetricDimension" }, - "markdownDescription": "The dimensions of the metric\\. \nConditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification\\. \n*Required*: No \n*Type*: List of [MetricDimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The dimensions of the metric\\. \nConditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy\\. \n*Required*: No \n*Type*: List of [MetricDimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscalingplans-scalingplan-metricdimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Dimensions", "type": "array" }, "MetricName": { - "markdownDescription": "The name of the metric\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the metric\\. To get the exact metric name, namespace, and dimensions, inspect the [Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html) object that is returned by a call to [ListMetrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricName", "type": "string" }, @@ -22368,7 +22808,7 @@ "type": "string" }, "Unit": { - "markdownDescription": "The unit of the metric\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unit of the metric\\. For a complete list of the units that CloudWatch supports, see the [MetricDatum](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html) data type in the *Amazon CloudWatch API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Unit", "type": "string" } @@ -22768,7 +23208,7 @@ "type": "string" }, "StartWindowMinutes": { - "markdownDescription": "An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully\\. \nIf this value is included, it must be at least 60 minutes to avoid errors\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartWindowMinutes", "type": "number" }, @@ -22897,7 +23337,7 @@ "properties": { "Conditions": { "$ref": "#/definitions/AWS::Backup::BackupSelection.Conditions", - "markdownDescription": "A list of conditions that you define to assign resources to your backup plans using tags\\. For example, `\"StringEquals\": {\"Department\": \"accounting\"`\\. Condition operators are case sensitive\\. \n`Conditions` differs from `ListOfTags` as follows: \n+ When you specify more than one condition, you only assign the resources that match ALL conditions \\(using AND logic\\)\\.\n+ `Conditions` supports `StringEquals`, `StringLike`, `StringNotEquals`, and `StringNotLike`\\. `ListOfTags` only supports `StringEquals`\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of conditions that you define to assign resources to your backup plans using tags\\. For example, `\"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\", \"ConditionValue\": \"true\" },`\\. Condition operators are case sensitive\\. \n`Conditions` differs from `ListOfTags` as follows: \n+ When you specify more than one condition, you only assign the resources that match ALL conditions \\(using AND logic\\)\\.\n+ `Conditions` supports `StringEquals`, `StringLike`, `StringNotEquals`, and `StringNotLike`\\. `ListOfTags` only supports `StringEquals`\\.\n*Required*: No \n*Type*: [Conditions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Conditions" }, "IamRoleArn": { @@ -22909,7 +23349,7 @@ "items": { "$ref": "#/definitions/AWS::Backup::BackupSelection.ConditionResourceType" }, - "markdownDescription": "An array of conditions used to specify a set of resources to assign to a backup plan; for example, `\"STRINGEQUALS\": {\"Department\":\"accounting\"`\\. \n*Required*: No \n*Type*: List of [ConditionResourceType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of conditions that you define to assign resources to your backup plans using tags\\. For example, `\"StringEquals\": { \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\", \"ConditionValue\": \"true\" },`\\. Condition operators are case sensitive\\. \n`ListOfTags` differs from `Conditions` as follows: \n+ When you specify more than one condition, you assign all resources that match AT LEAST ONE condition \\(using OR logic\\)\\.\n+ `ListOfTags` only supports `StringEquals`\\. `Conditions` supports `StringEquals`, `StringLike`, `StringNotEquals`, and `StringNotLike`\\. \n*Required*: No \n*Type*: List of [ConditionResourceType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ListOfTags", "type": "array" }, @@ -22945,9 +23385,13 @@ "additionalProperties": false, "properties": { "ConditionKey": { + "markdownDescription": "The key in a key\\-value pair\\. For example, in the tag `Department: Accounting`, `Department` is the key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConditionKey", "type": "string" }, "ConditionValue": { + "markdownDescription": "The value in a key\\-value pair\\. For example, in the tag `Department: Accounting`, `Accounting` is the value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConditionValue", "type": "string" } }, @@ -22986,24 +23430,32 @@ "items": { "$ref": "#/definitions/AWS::Backup::BackupSelection.ConditionParameter" }, + "markdownDescription": "Filters the values of your tagged resources for only those resources that you tagged with the same value\\. Also called \"exact matching\\.\" \n*Required*: No \n*Type*: List of [ConditionParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StringEquals", "type": "array" }, "StringLike": { "items": { "$ref": "#/definitions/AWS::Backup::BackupSelection.ConditionParameter" }, + "markdownDescription": "Filters the values of your tagged resources for matching tag values with the use of a wildcard character \\(\\*\\) anywhere in the string\\. For example, \"prod\\*\" or \"\\*rod\\*\" matches the tag value \"production\"\\. \n*Required*: No \n*Type*: List of [ConditionParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StringLike", "type": "array" }, "StringNotEquals": { "items": { "$ref": "#/definitions/AWS::Backup::BackupSelection.ConditionParameter" }, + "markdownDescription": "Filters the values of your tagged resources for only those resources that you tagged that do not have the same value\\. Also called \"negated matching\\.\" \n*Required*: No \n*Type*: List of [ConditionParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StringNotEquals", "type": "array" }, "StringNotLike": { "items": { "$ref": "#/definitions/AWS::Backup::BackupSelection.ConditionParameter" }, + "markdownDescription": "Filters the values of your tagged resources for non\\-matching tag values with the use of a wildcard character \\(\\*\\) anywhere in the string\\. \n*Required*: No \n*Type*: List of [ConditionParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StringNotLike", "type": "array" } }, @@ -23111,17 +23563,17 @@ "additionalProperties": false, "properties": { "ChangeableForDays": { - "markdownDescription": "The AWS Backup Vault Lock configuration that specifies the number of days before the lock date\\. For example, setting `ChangeableForDays` to 30 on Jan\\. 1, 2022 at 8pm UTC will set the lock date to Jan\\. 31, 2022 at 8pm UTC\\. \nAWS Backup enforces a 72\\-hour cooling\\-off period before Vault Lock takes effect and becomes immutable\\. Therefore, you must set `ChangeableForDays` to 3 or greater\\. \nBefore the lock date, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration`\\. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted\\. \nIf this parameter is not specified, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration` at any time\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS Backup Vault Lock configuration that specifies the number of days before the lock date\\. For example, setting `ChangeableForDays` to 30 on Jan\\. 1, 2022 at 8pm UTC will set the lock date to Jan\\. 31, 2022 at 8pm UTC\\. \nAWS Backup enforces a 72\\-hour cooling\\-off period before Vault Lock takes effect and becomes immutable\\. Therefore, you must set `ChangeableForDays` to 3 or greater\\. \nBefore the lock date, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration`\\. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted\\. \nIf this parameter is not specified, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration` at any time\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ChangeableForDays", "type": "number" }, "MaxRetentionDays": { - "markdownDescription": "The AWS Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points\\. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years \\(1460 days\\)\\. \nIf this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault\\. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period\\. \nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period\\. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault\\. Recovery points already saved in the vault prior to Vault Lock are not affected\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points\\. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years \\(1460 days\\)\\. \nIf this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault\\. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period\\. \nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period\\. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault\\. Recovery points already saved in the vault prior to Vault Lock are not affected\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxRetentionDays", "type": "number" }, "MinRetentionDays": { - "markdownDescription": "The AWS Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points\\. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years \\(2555 days\\)\\. \nIf this parameter is not specified, Vault Lock will not enforce a minimum retention period\\. \nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period\\. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault\\. Recovery points already saved in the vault prior to Vault Lock are not affected\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points\\. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years \\(2555 days\\)\\. \nIf this parameter is not specified, Vault Lock will not enforce a minimum retention period\\. \nIf this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period\\. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault\\. Recovery points already saved in the vault prior to Vault Lock are not affected\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MinRetentionDays", "type": "number" } @@ -23269,18 +23721,24 @@ "items": { "type": "string" }, + "markdownDescription": "The ID of the only AWS resource that you want your control scope to contain\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ComplianceResourceIds", "type": "array" }, "ComplianceResourceTypes": { "items": { "type": "string" }, + "markdownDescription": "Describes whether the control scope includes one or more types of resources, such as `EFS` or `RDS`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ComplianceResourceTypes", "type": "array" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tag key\\-value pair applied to those AWS resources that you want to trigger an evaluation for a rule\\. A maximum of one key\\-value pair can be provided\\. The tag value is optional, but it cannot be an empty string\\. The structure to assign a tag is: `[{\"Key\":\"string\",\"Value\":\"string\"}]`\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -23304,7 +23762,7 @@ }, "ControlScope": { "$ref": "#/definitions/AWS::Backup::Framework.ControlScope", - "markdownDescription": "The scope of a control\\. The control scope defines what the control will evaluate\\. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans\\. For more information, see `ControlScope`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The scope of a control\\. The control scope defines what the control will evaluate\\. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans\\. For more information, see [`ControlScope`\\.](aws-backup/latest/devguide/API_ControlScope.html) \n*Required*: No \n*Type*: [ControlScope](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlscope.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ControlScope" } }, @@ -23350,7 +23808,7 @@ "properties": { "ReportDeliveryChannel": { "$ref": "#/definitions/AWS::Backup::ReportPlan.ReportDeliveryChannel", - "markdownDescription": "Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports\\. \n*Required*: Yes \n*Type*: [ReportDeliveryChannel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportdeliverychannel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReportDeliveryChannel" }, "ReportPlanDescription": { @@ -23373,7 +23831,7 @@ }, "ReportSetting": { "$ref": "#/definitions/AWS::Backup::ReportPlan.ReportSetting", - "markdownDescription": "Identifies the report template for the report\\. Reports are built using a report template\\. The report templates are: \n `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT` \nIf the report template is `RESOURCE_COMPLIANCE_REPORT` or `CONTROL_COMPLIANCE_REPORT`, this API resource also describes the report coverage by AWS Regions and frameworks\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Identifies the report template for the report\\. Reports are built using a report template\\. The report templates are: \n `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT` \nIf the report template is `RESOURCE_COMPLIANCE_REPORT` or `CONTROL_COMPLIANCE_REPORT`, this API resource also describes the report coverage by AWS Regions and frameworks\\. \n*Required*: Yes \n*Type*: [ReportSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReportSetting" } }, @@ -23411,12 +23869,18 @@ "items": { "type": "string" }, + "markdownDescription": "A list of the format of your reports: `CSV`, `JSON`, or both\\. If not specified, the default format is `CSV`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Formats", "type": "array" }, "S3BucketName": { + "markdownDescription": "The unique name of the S3 bucket that receives your reports\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3BucketName", "type": "string" }, "S3KeyPrefix": { + "markdownDescription": "The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3\\. The prefix is this part of the following path: s3://your\\-bucket\\-name/`prefix`/Backup/us\\-west\\-2/year/month/day/report\\-name\\. If not specified, there is no prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3KeyPrefix", "type": "string" } }, @@ -23432,27 +23896,37 @@ "items": { "type": "string" }, + "markdownDescription": "These are the accounts to be included in the report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Accounts", "type": "array" }, "FrameworkArns": { "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Names \\(ARNs\\) of the frameworks a report covers\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FrameworkArns", "type": "array" }, "OrganizationUnits": { "items": { "type": "string" }, + "markdownDescription": "These are the Organizational Units to be included in the report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationUnits", "type": "array" }, "Regions": { "items": { "type": "string" }, + "markdownDescription": "These are the Regions to be included in the report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Regions", "type": "array" }, "ReportTemplate": { + "markdownDescription": "Identifies the report template for the report\\. Reports are built using a report template\\. The report templates are: \n `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReportTemplate", "type": "string" } }, @@ -23522,7 +23996,7 @@ "type": "string" }, "State": { - "markdownDescription": "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\\. \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\\. \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\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \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\\. \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\\. \nCompute environments in a `DISABLED` state may continue to incur billing charges\\. To prevent additional charges, turn off and then delete the compute environment\\. For more information, see [State](https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state) in the * AWS Batch User Guide*\\.\nWhen an instance is idle, the instance scales down to the `minvCpus` value\\. However, the instance size doesn't change\\. For example, consider a `c5.8xlarge` instance with a `minvCpus` value of `4` and a `desiredvCpus` value of `36`\\. This instance doesn't scale down to a `c5.large` instance\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "State", "type": "string" }, @@ -23593,7 +24067,7 @@ "type": "number" }, "DesiredvCpus": { - "markdownDescription": "The desired number of Amazon EC2 vCPUS in the compute environment\\. AWS Batch modifies this value between the minimum and maximum values based on job queue demand\\. \nThis parameter isn't applicable to jobs that are running on Fargate resources\\. Don't specify it\\.\n AWS Batch doesn't support changing the desired number of vCPUs of an existing compute environment\\. Don't specify this parameter for compute environments using Amazon EKS clusters\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The desired number of Amazon EC2 vCPUS in the compute environment\\. AWS Batch modifies this value between the minimum and maximum values based on job queue demand\\. \nThis parameter isn't applicable to jobs that are running on Fargate resources\\. Don't specify it\\.\n AWS Batch doesn't support changing the desired number of vCPUs of an existing compute environment\\. Don't specify this parameter for compute environments using Amazon EKS clusters\\.\nWhen you update the `desiredvCpus` setting, the value must be between the `minvCpus` and `maxvCpus` values\\. \nAdditionally, the updated `desiredvCpus` value must be greater than or equal to the current `desiredvCpus` value\\. For more information, see [test](https://docs.aws.amazon.com/batch/latest/userguide/error-desired-vcpus-update.html) in the * AWS Batch User Guide*\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DesiredvCpus", "type": "number" }, @@ -25009,7 +25483,7 @@ "title": "ComputationPreference" }, "Description": { - "markdownDescription": "The billing group description\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the billing group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -25027,6 +25501,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -25190,7 +25666,7 @@ "additionalProperties": false, "properties": { "ExclusiveEndBillingPeriod": { - "markdownDescription": "The inclusive end billing period that defines a billing period range where a custom line is applied\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The exclusive end billing period that defines a billing period range where a custom line is applied\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ExclusiveEndBillingPeriod", "type": "string" }, @@ -25386,6 +25862,8 @@ "additionalProperties": false, "properties": { "BillingEntity": { + "markdownDescription": "The seller of services provided by AWS, their affiliates, or third\\-party providers selling services via AWS Marketplace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BillingEntity", "type": "string" }, "Description": { @@ -25394,7 +25872,7 @@ "type": "string" }, "ModifierPercentage": { - "markdownDescription": "A percentage modifier applied on the public pricing rates\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A percentage modifier applied on the public pricing rates\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ModifierPercentage", "type": "number" }, @@ -25404,6 +25882,8 @@ "type": "string" }, "Operation": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Operation", "type": "string" }, "Scope": { @@ -25425,7 +25905,9 @@ "type": "array" }, "Tiering": { - "$ref": "#/definitions/AWS::BillingConductor::PricingRule.Tiering" + "$ref": "#/definitions/AWS::BillingConductor::PricingRule.Tiering", + "markdownDescription": "The set of tiering configurations for the pricing rule\\. \n*Required*: No \n*Type*: [Tiering](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-pricingrule-tiering.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tiering" }, "Type": { "markdownDescription": "The type of pricing rule\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -25433,6 +25915,8 @@ "type": "string" }, "UsageType": { + "markdownDescription": "Usage Type is the unit that each service uses to measure the usage of a specific type of resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "UsageType", "type": "string" } }, @@ -25468,6 +25952,8 @@ "additionalProperties": false, "properties": { "Activated": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Activated", "type": "boolean" } }, @@ -25480,7 +25966,9 @@ "additionalProperties": false, "properties": { "FreeTier": { - "$ref": "#/definitions/AWS::BillingConductor::PricingRule.FreeTier" + "$ref": "#/definitions/AWS::BillingConductor::PricingRule.FreeTier", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [FreeTier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-pricingrule-freetier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FreeTier" } }, "type": "object" @@ -25564,10 +26052,14 @@ "additionalProperties": false, "properties": { "AutoAdjustType": { + "markdownDescription": "The string that defines whether your budget auto\\-adjusts based on historical or forecasted data\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FORECAST | HISTORICAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoAdjustType", "type": "string" }, "HistoricalOptions": { - "$ref": "#/definitions/AWS::Budgets::Budget.HistoricalOptions" + "$ref": "#/definitions/AWS::Budgets::Budget.HistoricalOptions", + "markdownDescription": "The parameters that define or describe the historical data that your auto\\-adjusting budget is based on\\. \n*Required*: No \n*Type*: [HistoricalOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-historicaloptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HistoricalOptions" } }, "required": [ @@ -25579,7 +26071,9 @@ "additionalProperties": false, "properties": { "AutoAdjustData": { - "$ref": "#/definitions/AWS::Budgets::Budget.AutoAdjustData" + "$ref": "#/definitions/AWS::Budgets::Budget.AutoAdjustData", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AutoAdjustData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-budgets-budget-autoadjustdata.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AutoAdjustData" }, "BudgetLimit": { "$ref": "#/definitions/AWS::Budgets::Budget.Spend", @@ -25597,7 +26091,7 @@ "type": "string" }, "CostFilters": { - "markdownDescription": "The cost filters, such as `Region`, `Service`, `member account`, `Tag`, or `Cost Category`, that are applied to a budget\\. \n AWS Budgets supports the following services as a `Service` filter for RI budgets: \n+ Amazon EC2\n+ Amazon Redshift\n+ Amazon Relational Database Service\n+ Amazon ElastiCache\n+ Amazon OpenSearch Service \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The cost filters, such as `Region`, `Service`, `member account`, `Tag`, or `Cost Category`, that are applied to a budget\\. \n AWS Budgets supports the following services as a `Service` filter for RI budgets: \n+ Amazon EC2\n+ Amazon Redshift\n+ Amazon Relational Database Service\n+ Amazon ElastiCache\n+ Amazon OpenSearch Service\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CostFilters", "type": "object" }, @@ -25693,6 +26187,8 @@ "additionalProperties": false, "properties": { "BudgetAdjustmentPeriod": { + "markdownDescription": "The number of budget periods included in the moving\\-average calculation that determines your auto\\-adjusted budget amount\\. The maximum value depends on the `TimeUnit` granularity of the budget: \n+ For the `DAILY` granularity, the maximum value is `60`\\.\n+ For the `MONTHLY` granularity, the maximum value is `12`\\.\n+ For the `QUARTERLY` granularity, the maximum value is `4`\\.\n+ For the `ANNUALLY` granularity, the maximum value is `1`\\.\n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `60` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BudgetAdjustmentPeriod", "type": "number" } }, @@ -26132,6 +26628,8 @@ "items": { "$ref": "#/definitions/AWS::CE::AnomalyMonitor.ResourceTag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ResourceTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalymonitor-resourcetag.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceTags", "type": "array" } }, @@ -26166,9 +26664,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The key that's associated with the tag\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "The value that's associated with the tag\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "string" } }, @@ -26214,7 +26716,7 @@ "additionalProperties": false, "properties": { "Frequency": { - "markdownDescription": "The frequency that anomaly reports are sent over email\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAILY | IMMEDIATE | WEEKLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The frequency that anomaly notifications are sent\\. Notifications are sent either over email \\(for DAILY and WEEKLY frequencies\\) or SNS \\(for IMMEDIATE frequency\\)\\. For more information, see [Creating an Amazon SNS topic for anomaly notifications](https://docs.aws.amazon.com/cost-management/latest/userguide/ad-SNS.html)\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAILY | IMMEDIATE | WEEKLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Frequency", "type": "string" }, @@ -26230,6 +26732,8 @@ "items": { "$ref": "#/definitions/AWS::CE::AnomalySubscription.ResourceTag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ResourceTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-anomalysubscription-resourcetag.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceTags", "type": "array" }, "Subscribers": { @@ -26246,11 +26750,13 @@ "type": "string" }, "Threshold": { - "markdownDescription": "The dollar value that triggers a notification if the threshold is exceeded\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "\\(deprecated\\) \nAn absolute dollar value that must be exceeded by the anomaly's total impact \\(see [Impact](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) for more details\\) for an anomaly notification to be generated\\. \nThis field has been deprecated\\. To specify a threshold, use ThresholdExpression\\. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression\\. \nOne of Threshold or ThresholdExpression is required for `AWS::CE::AnomalySubscription`\\. You cannot specify both\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Threshold", "type": "number" }, "ThresholdExpression": { + "markdownDescription": "An [Expression](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html) object in JSON string format used to specify the anomalies that you want to generate alerts for\\. This supports dimensions and nested expressions\\. The supported dimensions are `ANOMALY_TOTAL_IMPACT_ABSOLUTE` and `ANOMALY_TOTAL_IMPACT_PERCENTAGE`, corresponding to an anomaly\u2019s TotalImpact and TotalImpactPercentage, respectively \\(see [Impact](https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Impact.html) for more details\\)\\. The supported nested expression types are `AND` and `OR`\\. The match option `GREATER_THAN_OR_EQUAL` is required\\. Values must be numbers between 0 and 10,000,000,000 in string format\\. \nOne of Threshold or ThresholdExpression is required for `AWS::CE::AnomalySubscription`\\. You cannot specify both\\. \nFor further information, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-anomalysubscription.html#aws-resource-ce-anomalysubscription--examples) section of this page\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ThresholdExpression", "type": "string" } }, @@ -26287,9 +26793,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The key that's associated with the tag\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "The value that's associated with the tag\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "string" } }, @@ -26452,7 +26962,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of manifests that you want Amazon Web Services to create for this report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of manifests that you want AWS to create for this report\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdditionalArtifacts", "type": "array" }, @@ -26460,7 +26970,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AdditionalSchemaElements", "type": "array" }, @@ -26480,7 +26990,7 @@ "type": "string" }, "RefreshClosedReports": { - "markdownDescription": "Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months\\. These charges can include refunds, credits, or support fees\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months\\. These charges can include refunds, credits, or support fees\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RefreshClosedReports", "type": "boolean" }, @@ -26490,7 +27000,7 @@ "type": "string" }, "ReportVersioning": { - "markdownDescription": "Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CREATE_NEW_REPORT | OVERWRITE_REPORT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CREATE_NEW_REPORT | OVERWRITE_REPORT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ReportVersioning", "type": "string" }, @@ -26787,12 +27297,12 @@ "additionalProperties": false, "properties": { "ColumnName": { - "markdownDescription": "The name of the column\\. For more information, see [Identifiers](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.elements.identifier) in the *Amazon Keyspaces Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the column\\. For more information, see [Identifiers](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.elements.identifier) in the *Amazon Keyspaces Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "ColumnName", "type": "string" }, "ColumnType": { - "markdownDescription": "The data type of the column\\. For more information, see [Data types](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) in the *Amazon Keyspaces Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The data type of the column\\. For more information, see [Data types](https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types) in the *Amazon Keyspaces Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "ColumnType", "type": "string" } @@ -26956,7 +27466,7 @@ "additionalProperties": false, "properties": { "CertificateAuthorityArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the private certificate authority \\(CA\\) that will be used to issue the certificate\\. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate\\. For more information about private CAs, see the [AWS Certificate Manager Private Certificate Authority \\(PCA\\)](https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaWelcome.html) user guide\\. The ARN must have the following form: \n `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012` \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the private certificate authority \\(CA\\) that will be used to issue the certificate\\. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate\\. For more information about private CAs, see the [AWS Private Certificate Authority](https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html) user guide\\. The ARN must have the following form: \n `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012` \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:acm-pca:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CertificateAuthorityArn", "type": "string" }, @@ -27094,12 +27604,12 @@ "items": { "type": "string" }, - "markdownDescription": "The list of IAM policy ARNs that are applied as channel guardrails\\. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set\\. Currently, only 1 IAM policy is supported\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The list of IAM policy ARNs that are applied as channel guardrails\\. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "GuardrailPolicies", "type": "array" }, "IamRoleArn": { - "markdownDescription": "The ARN of the IAM role that defines the permissions for AWS Chatbot\\. \nThis is a user\\-definworked role that AWS Chatbot will assume\\. This is not the service\\-linked role\\. For more information, see [IAM Policies for AWS Chatbot](https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN of the IAM role that defines the permissions for AWS Chatbot\\. \nThis is a user\\-defined role that AWS Chatbot will assume\\. This is not the service\\-linked role\\. For more information, see [IAM Policies for AWS Chatbot](https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IamRoleArn", "type": "string" }, @@ -27197,7 +27707,7 @@ "additionalProperties": false, "properties": { "AutomaticStopTimeMinutes": { - "markdownDescription": "The number of minutes until the running instance is shut down after the environment was last used\\. \n*Required*: No \n*Type*: Integer \n*Maximum*: `20160` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The number of minutes until the running instance is shut down after the environment was last used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `20160` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AutomaticStopTimeMinutes", "type": "number" }, @@ -27485,7 +27995,7 @@ "type": "string" }, "TypeArn": { - "markdownDescription": "The Amazon Resource Number \\(ARN\\) for the hook to set `Configuration` for\\. \nYou must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Number \\(ARN\\) for the hook to set `Configuration` for\\. \nYou must specify either `TypeName` and `Configuration` or `TypeARN` and `Configuration`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TypeArn", "type": "string" }, @@ -28169,7 +28679,7 @@ "additionalProperties": false, "properties": { "LogGroupName": { - "markdownDescription": "The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's handlers\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon CloudWatch logs group to which CloudFormation sends error logging information when invoking the type's handlers\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\.\\-_/#A-Za-z0-9]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "LogGroupName", "type": "string" }, @@ -28350,7 +28860,7 @@ }, "ManagedExecution": { "$ref": "#/definitions/AWS::CloudFormation::StackSet.ManagedExecution", - "markdownDescription": "Describes whether StackSets performs non\\-conflicting operations concurrently and queues conflicting operations\\. \nWhen active, StackSets performs non\\-conflicting operations concurrently and queues conflicting operations\\. After conflicting operations finish, StackSets starts queued operations in request order\\. \nIf there are already running or queued operations, StackSets queues all incoming operations even if they are non\\-conflicting\\. \nYou can't modify your stack set's execution configuration while there are running or queued operations for that stack set\\.\nWhen inactive \\(default\\), StackSets performs one operation at a time in request order\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Describes whether StackSets performs non\\-conflicting operations concurrently and queues conflicting operations\\. \nWhen active, StackSets performs non\\-conflicting operations concurrently and queues conflicting operations\\. After conflicting operations finish, StackSets starts queued operations in request order\\. \nIf there are already running or queued operations, StackSets queues all incoming operations even if they are non\\-conflicting\\. \nYou can't modify your stack set's execution configuration while there are running or queued operations for that stack set\\.\nWhen inactive \\(default\\), StackSets performs one operation at a time in request order\\. \n*Required*: No \n*Type*: [ManagedExecution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-managedexecution.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ManagedExecution" }, "OperationPreferences": { @@ -28450,6 +28960,8 @@ "additionalProperties": false, "properties": { "AccountFilterType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccountFilterType", "type": "string" }, "Accounts": { @@ -28475,6 +28987,8 @@ "additionalProperties": false, "properties": { "Active": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Active", "type": "boolean" } }, @@ -28903,7 +29417,7 @@ "type": "string" }, "DefaultTTL": { - "markdownDescription": "The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated\\. CloudFront uses this value as the object\u2019s time to live \\(TTL\\) only when the origin does *not* send `Cache-Control` or `Expires` headers with the object\\. For more information, see [Managing How Long Content Stays in an Edge Cache \\(Expiration\\)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\. \nThe default value for this field is 86400 seconds \\(one day\\)\\. If the value of `MinTTL` is more than 86400 seconds, then the default value for this field is the same as the value of `MinTTL`\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated\\. CloudFront uses this value as the object's time to live \\(TTL\\) only when the origin does *not* send `Cache-Control` or `Expires` headers with the object\\. For more information, see [Managing How Long Content Stays in an Edge Cache \\(Expiration\\)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\. \nThe default value for this field is 86400 seconds \\(one day\\)\\. If the value of `MinTTL` is more than 86400 seconds, then the default value for this field is the same as the value of `MinTTL`\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DefaultTTL", "type": "number" }, @@ -28990,12 +29504,12 @@ "title": "CookiesConfig" }, "EnableAcceptEncodingBrotli": { - "markdownDescription": "A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin\\. \nThis field is related to the `EnableAcceptEncodingGzip` field\\. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following: \n+ Normalizes the value of the viewer\u2019s `Accept-Encoding` header\n+ Includes the normalized header in the cache key\n+ Includes the normalized header in the request to the origin, if a request is necessary\nFor more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*\\. \nIf you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy\\. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect\\. \nIf both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request\\. By default, it\u2019s not included in the cache key and it\u2019s not included in origin requests\\. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin\\. \nThis field is related to the `EnableAcceptEncodingGzip` field\\. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following: \n+ Normalizes the value of the viewer's `Accept-Encoding` header\n+ Includes the normalized header in the cache key\n+ Includes the normalized header in the request to the origin, if a request is necessary\nFor more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*\\. \nIf you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy\\. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect\\. \nIf both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request\\. By default, it's not included in the cache key and it's not included in origin requests\\. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableAcceptEncodingBrotli", "type": "boolean" }, "EnableAcceptEncodingGzip": { - "markdownDescription": "A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin\\. \nThis field is related to the `EnableAcceptEncodingBrotli` field\\. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following: \n+ Normalizes the value of the viewer\u2019s `Accept-Encoding` header\n+ Includes the normalized header in the cache key\n+ Includes the normalized header in the request to the origin, if a request is necessary\nFor more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*\\. \nIf you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy\\. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect\\. \nIf both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request\\. By default, it\u2019s not included in the cache key and it\u2019s not included in origin requests\\. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin\\. \nThis field is related to the `EnableAcceptEncodingBrotli` field\\. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following: \n+ Normalizes the value of the viewer's `Accept-Encoding` header\n+ Includes the normalized header in the cache key\n+ Includes the normalized header in the request to the origin, if a request is necessary\nFor more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide*\\. \nIf you set this value to `true`, and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy\\. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true`, so including this header in an origin request policy has no effect\\. \nIf both of these fields are `false`, then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request\\. By default, it's not included in the cache key and it's not included in origin requests\\. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableAcceptEncodingGzip", "type": "boolean" }, @@ -29157,7 +29671,9 @@ "additionalProperties": false, "properties": { "ContinuousDeploymentPolicyConfig": { - "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.ContinuousDeploymentPolicyConfig" + "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.ContinuousDeploymentPolicyConfig", + "markdownDescription": "Contains the configuration for a continuous deployment policy\\. \n*Required*: Yes \n*Type*: [ContinuousDeploymentPolicyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContinuousDeploymentPolicyConfig" } }, "required": [ @@ -29190,16 +29706,22 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "A Boolean that indicates whether this continuous deployment policy is enabled \\(in effect\\)\\. When this value is `true`, this policy is enabled and in effect\\. When this value is `false`, this policy is not enabled and has no effect\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "StagingDistributionDnsNames": { "items": { "type": "string" }, + "markdownDescription": "The CloudFront domain name of the staging distribution\\. For example: `d111111abcdef8.cloudfront.net`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StagingDistributionDnsNames", "type": "array" }, "TrafficConfig": { - "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.TrafficConfig" + "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.TrafficConfig", + "markdownDescription": "Contains the parameters for routing production traffic from your primary to staging distributions\\. \n*Required*: No \n*Type*: [TrafficConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-trafficconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrafficConfig" } }, "required": [ @@ -29212,9 +29734,13 @@ "additionalProperties": false, "properties": { "IdleTTL": { + "markdownDescription": "The amount of time after which you want sessions to cease if no requests are received\\. Allowed values are 300\u20133600 seconds \\(5\u201360 minutes\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IdleTTL", "type": "number" }, "MaximumTTL": { + "markdownDescription": "The maximum amount of time to consider requests from the viewer as being part of the same session\\. Allowed values are 300\u20133600 seconds \\(5\u201360 minutes\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumTTL", "type": "number" } }, @@ -29228,9 +29754,13 @@ "additionalProperties": false, "properties": { "Header": { + "markdownDescription": "The request header name that you want CloudFront to send to your staging distribution\\. The header must contain the prefix `aws-cf-cd-`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Header", "type": "string" }, "Value": { + "markdownDescription": "The request header value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -29244,9 +29774,13 @@ "additionalProperties": false, "properties": { "SessionStickinessConfig": { - "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.SessionStickinessConfig" + "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.SessionStickinessConfig", + "markdownDescription": "Session stickiness provides the ability to define multiple requests from a single viewer as a single session\\. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution\\. Define the session duration using TTL values\\. \n*Required*: No \n*Type*: [SessionStickinessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-sessionstickinessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionStickinessConfig" }, "Weight": { + "markdownDescription": "The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and \\.15\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Weight", "type": "number" } }, @@ -29259,12 +29793,18 @@ "additionalProperties": false, "properties": { "SingleHeaderConfig": { - "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.SingleHeaderConfig" + "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.SingleHeaderConfig", + "markdownDescription": "Determines which HTTP requests are sent to the staging distribution\\. \n*Required*: No \n*Type*: [SingleHeaderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleheaderconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SingleHeaderConfig" }, "SingleWeightConfig": { - "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.SingleWeightConfig" + "$ref": "#/definitions/AWS::CloudFront::ContinuousDeploymentPolicy.SingleWeightConfig", + "markdownDescription": "Contains the percentage of traffic to send to the staging distribution\\. \n*Required*: No \n*Type*: [SingleWeightConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-continuousdeploymentpolicy-singleweightconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SingleWeightConfig" }, "Type": { + "markdownDescription": "The type of traffic configuration\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SingleHeader | SingleWeight` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -29310,7 +29850,7 @@ "properties": { "DistributionConfig": { "$ref": "#/definitions/AWS::CloudFront::Distribution.DistributionConfig", - "markdownDescription": "The current configuration information for the distribution\\. Send a `GET` request to the `/CloudFront API version/distribution ID/config` resource\\. \n*Required*: Yes \n*Type*: [DistributionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The distribution's configuration\\. \n*Required*: Yes \n*Type*: [DistributionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DistributionConfig" }, "Tags": { @@ -29368,7 +29908,7 @@ "items": { "type": "string" }, - "markdownDescription": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods\\. There are two choices: \n+ CloudFront caches responses to `GET` and `HEAD` requests\\.\n+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` requests\\.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward Access\\-Control\\-Request\\-Method, Access\\-Control\\-Request\\-Headers, and Origin headers for the responses to be cached correctly\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods\\. There are two choices: \n+ CloudFront caches responses to `GET` and `HEAD` requests\\.\n+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` requests\\.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward Access\\-Control\\-Request\\-Method, Access\\-Control\\-Request\\-Headers, and Origin headers for the responses to be cached correctly\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CachedMethods", "type": "array" }, @@ -29439,7 +29979,7 @@ "type": "string" }, "SmoothStreaming": { - "markdownDescription": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior\\. If so, specify `true`; if not, specify `false`\\. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior\\. If so, specify `true`; if not, specify `false`\\. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SmoothStreaming", "type": "boolean" }, @@ -29460,12 +30000,12 @@ "items": { "type": "string" }, - "markdownDescription": "We recommend using `TrustedKeyGroups` instead of `TrustedSigners`\\.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer\u2019s AWS account\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "We recommend using `TrustedKeyGroups` instead of `TrustedSigners`\\.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS account\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TrustedSigners", "type": "array" }, "ViewerProtocolPolicy": { - "markdownDescription": "The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`\\. You can specify the following options: \n+ `allow-all`: Viewers can use HTTP or HTTPS\\.\n+ `redirect-to-https`: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 \\(Moved Permanently\\) to the viewer along with the HTTPS URL\\. The viewer then resubmits the request using the new URL\\. \n+ `https-only`: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 \\(Forbidden\\)\\. \nFor more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*\\. \nThe only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object\\. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects\u2019 cache because cached objects are protocol agnostic\\. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously\\. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `allow-all | https-only | redirect-to-https` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`\\. You can specify the following options: \n+ `allow-all`: Viewers can use HTTP or HTTPS\\.\n+ `redirect-to-https`: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 \\(Moved Permanently\\) to the viewer along with the HTTPS URL\\. The viewer then resubmits the request using the new URL\\.\n+ `https-only`: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 \\(Forbidden\\)\\.\nFor more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*\\. \nThe only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object\\. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic\\. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously\\. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `allow-all | https-only | redirect-to-https` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ViewerProtocolPolicy", "type": "string" } @@ -29518,7 +30058,7 @@ "type": "number" }, "ResponsePagePath": { - "markdownDescription": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by `ErrorCode`, for example, `/4xx-errors/403-forbidden.html`\\. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: \n+ The value of `PathPattern` matches the path to your custom error messages\\. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named `/4xx-errors`\\. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, `/4xx-errors/*`\\. \n+ The value of `TargetOriginId` specifies the value of the `ID` element for the origin that contains your custom error pages\\.\nIf you specify a value for `ResponsePagePath`, you must also specify a value for `ResponseCode`\\. \nWe recommend that you store custom error pages in an Amazon S3 bucket\\. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by `ErrorCode`, for example, `/4xx-errors/403-forbidden.html`\\. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: \n+ The value of `PathPattern` matches the path to your custom error messages\\. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named `/4xx-errors`\\. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, `/4xx-errors/*`\\.\n+ The value of `TargetOriginId` specifies the value of the `ID` element for the origin that contains your custom error pages\\.\nIf you specify a value for `ResponsePagePath`, you must also specify a value for `ResponseCode`\\. \nWe recommend that you store custom error pages in an Amazon S3 bucket\\. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResponsePagePath", "type": "string" } @@ -29542,7 +30082,7 @@ "type": "number" }, "OriginKeepaliveTimeout": { - "markdownDescription": "Specifies how long, in seconds, CloudFront persists its connection to the origin\\. The minimum timeout is 1 second, the maximum is 60 seconds, and the default \\(if you don\u2019t specify otherwise\\) is 5 seconds\\. \nFor more information, see [Origin Keep\\-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how long, in seconds, CloudFront persists its connection to the origin\\. The minimum timeout is 1 second, the maximum is 60 seconds, and the default \\(if you don't specify otherwise\\) is 5 seconds\\. \nFor more information, see [Origin Keep\\-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OriginKeepaliveTimeout", "type": "number" }, @@ -29552,7 +30092,7 @@ "type": "string" }, "OriginReadTimeout": { - "markdownDescription": "Specifies how long, in seconds, CloudFront waits for a response from the origin\\. This is also known as the *origin response timeout*\\. The minimum timeout is 1 second, the maximum is 60 seconds, and the default \\(if you don\u2019t specify otherwise\\) is 30 seconds\\. \nFor more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how long, in seconds, CloudFront waits for a response from the origin\\. This is also known as the *origin response timeout*\\. The minimum timeout is 1 second, the maximum is 60 seconds, and the default \\(if you don't specify otherwise\\) is 30 seconds\\. \nFor more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OriginReadTimeout", "type": "number" }, @@ -29590,7 +30130,7 @@ "items": { "type": "string" }, - "markdownDescription": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods\\. There are two choices: \n+ CloudFront caches responses to `GET` and `HEAD` requests\\.\n+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` requests\\.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward Access\\-Control\\-Request\\-Method, Access\\-Control\\-Request\\-Headers, and Origin headers for the responses to be cached correctly\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods\\. There are two choices: \n+ CloudFront caches responses to `GET` and `HEAD` requests\\.\n+ CloudFront caches responses to `GET`, `HEAD`, and `OPTIONS` requests\\.\nIf you pick the second choice for your Amazon S3 Origin, you may need to forward Access\\-Control\\-Request\\-Method, Access\\-Control\\-Request\\-Headers, and Origin headers for the responses to be cached correctly\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CachedMethods", "type": "array" }, @@ -29656,7 +30196,7 @@ "type": "string" }, "SmoothStreaming": { - "markdownDescription": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior\\. If so, specify `true`; if not, specify `false`\\. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior\\. If so, specify `true`; if not, specify `false`\\. If you specify `true` for `SmoothStreaming`, you can still distribute other content using this cache behavior if the content matches the value of `PathPattern`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SmoothStreaming", "type": "boolean" }, @@ -29677,12 +30217,12 @@ "items": { "type": "string" }, - "markdownDescription": "We recommend using `TrustedKeyGroups` instead of `TrustedSigners`\\.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer\u2019s AWS account\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "We recommend using `TrustedKeyGroups` instead of `TrustedSigners`\\.\nA list of AWS account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies\\. \nWhen a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior\\. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS account\\. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature\\. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TrustedSigners", "type": "array" }, "ViewerProtocolPolicy": { - "markdownDescription": "The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`\\. You can specify the following options: \n+ `allow-all`: Viewers can use HTTP or HTTPS\\.\n+ `redirect-to-https`: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 \\(Moved Permanently\\) to the viewer along with the HTTPS URL\\. The viewer then resubmits the request using the new URL\\.\n+ `https-only`: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 \\(Forbidden\\)\\.\nFor more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*\\. \nThe only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object\\. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects\u2019 cache because cached objects are protocol agnostic\\. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously\\. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `allow-all | https-only | redirect-to-https` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The protocol that viewers can use to access the files in the origin specified by `TargetOriginId` when a request matches the path pattern in `PathPattern`\\. You can specify the following options: \n+ `allow-all`: Viewers can use HTTP or HTTPS\\.\n+ `redirect-to-https`: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 \\(Moved Permanently\\) to the viewer along with the HTTPS URL\\. The viewer then resubmits the request using the new URL\\.\n+ `https-only`: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 \\(Forbidden\\)\\.\nFor more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*\\. \nThe only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object\\. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic\\. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously\\. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `allow-all | https-only | redirect-to-https` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ViewerProtocolPolicy", "type": "string" } @@ -29708,7 +30248,7 @@ "items": { "type": "string" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CNAMEs", "type": "array" }, @@ -29716,16 +30256,18 @@ "items": { "$ref": "#/definitions/AWS::CloudFront::Distribution.CacheBehavior" }, - "markdownDescription": "A complex type that contains zero or more `CacheBehavior` elements\\. \n*Required*: No \n*Type*: List of [CacheBehavior](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains zero or more `CacheBehavior` elements\\. \n*Required*: No \n*Type*: List of [CacheBehavior](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-cachebehavior.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CacheBehaviors", "type": "array" }, "Comment": { - "markdownDescription": "An optional comment to describe the distribution\\. The comment cannot be longer than 128 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A comment to describe the distribution\\. The comment cannot be longer than 128 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Comment", "type": "string" }, "ContinuousDeploymentPolicyId": { + "markdownDescription": "The identifier of a continuous deployment policy\\. For more information, see `CreateContinuousDeploymentPolicy`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContinuousDeploymentPolicyId", "type": "string" }, "CustomErrorResponses": { @@ -29738,16 +30280,16 @@ }, "CustomOrigin": { "$ref": "#/definitions/AWS::CloudFront::Distribution.LegacyCustomOrigin", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [LegacyCustomOrigin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacycustomorigin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [LegacyCustomOrigin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacycustomorigin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomOrigin" }, "DefaultCacheBehavior": { "$ref": "#/definitions/AWS::CloudFront::Distribution.DefaultCacheBehavior", - "markdownDescription": "A complex type that describes the default cache behavior if you don't specify a `CacheBehavior` element or if files don't match any of the values of `PathPattern` in `CacheBehavior` elements\\. You must create exactly one default cache behavior\\. \n*Required*: No \n*Type*: [DefaultCacheBehavior](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that describes the default cache behavior if you don't specify a `CacheBehavior` element or if files don't match any of the values of `PathPattern` in `CacheBehavior` elements\\. You must create exactly one default cache behavior\\. \n*Required*: Yes \n*Type*: [DefaultCacheBehavior](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-defaultcachebehavior.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DefaultCacheBehavior" }, "DefaultRootObject": { - "markdownDescription": "The object that you want CloudFront to request from your origin \\(for example, `index.html`\\) when a viewer requests the root URL for your distribution \\(`http://www.example.com`\\) instead of an object in your distribution \\(`http://www.example.com/product-description.html`\\)\\. Specifying a default root object avoids exposing the contents of your distribution\\. \nSpecify only the object name, for example, `index.html`\\. Don't add a `/` before the object name\\. \nIf you don't want to specify a default root object when you create a distribution, include an empty `DefaultRootObject` element\\. \nTo delete the default root object from an existing distribution, update the distribution configuration and include an empty `DefaultRootObject` element\\. \nTo replace the default root object, update the distribution configuration and specify the new object\\. \nFor more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object that you want CloudFront to request from your origin \\(for example, `index.html`\\) when a viewer requests the root URL for your distribution \\(`https://www.example.com`\\) instead of an object in your distribution \\(`https://www.example.com/product-description.html`\\)\\. Specifying a default root object avoids exposing the contents of your distribution\\. \nSpecify only the object name, for example, `index.html`\\. Don't add a `/` before the object name\\. \nIf you don't want to specify a default root object when you create a distribution, include an empty `DefaultRootObject` element\\. \nTo delete the default root object from an existing distribution, update the distribution configuration and include an empty `DefaultRootObject` element\\. \nTo replace the default root object, update the distribution configuration and specify the new object\\. \nFor more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DefaultRootObject", "type": "string" }, @@ -29757,12 +30299,12 @@ "type": "boolean" }, "HttpVersion": { - "markdownDescription": "\\(Optional\\) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront\\. The default value for new web distributions is `http1.1`\\. \nFor viewers and CloudFront to use HTTP/2, viewers must support TLS 1\\.2 or later, and must support server name identification \\(SNI\\)\\. \nIn general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency\\. You can improve performance by optimizing for HTTP/2\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `http1.1 | http2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "\\(Optional\\) Specify the maximum HTTP version\\(s\\) that you want viewers to use to communicate with CloudFront\\. The default value for new distributions is `http1.1`\\. \nFor viewers and CloudFront to use HTTP/2, viewers must support TLSv1\\.2 or later, and must support Server Name Indication \\(SNI\\)\\. \nFor viewers and CloudFront to use HTTP/3, viewers must support TLSv1\\.3 and Server Name Indication \\(SNI\\)\\. CloudFront supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection\\. For more information about connection migration, see [Connection Migration](https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000\\. For more information about supported TLSv1\\.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `http1.1 | http2 | http2and3 | http3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HttpVersion", "type": "string" }, "IPV6Enabled": { - "markdownDescription": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify `true`\\. If you specify `false`, CloudFront responds to IPv6 DNS requests with the DNS response code `NOERROR` and with no IP addresses\\. This allows viewers to submit a second request, for an IPv4 address for your distribution\\. \nIn general, you should enable IPv6 if you have users on IPv6 networks who want to access your content\\. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the `IpAddress` parameter to restrict the IP addresses that can access your content, don't enable IPv6\\. If you want to restrict access to some content by IP address and not restrict access to other content \\(or restrict access but not by IP address\\), you can create two distributions\\. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*\\. \nIf you're using an Amazon Route\u00a053 AWS Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: \n+ You enable IPv6 for the distribution\n+ You're using alternate domain names in the URLs for your objects\nFor more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the * Amazon Route\u00a053 AWS Integration Developer Guide*\\. \nIf you created a CNAME resource record set, either with Amazon Route\u00a053 AWS Integration or with another DNS service, you don't need to make any changes\\. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify `true`\\. If you specify `false`, CloudFront responds to IPv6 DNS requests with the DNS response code `NOERROR` and with no IP addresses\\. This allows viewers to submit a second request, for an IPv4 address for your distribution\\. \nIn general, you should enable IPv6 if you have users on IPv6 networks who want to access your content\\. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the `IpAddress` parameter to restrict the IP addresses that can access your content, don't enable IPv6\\. If you want to restrict access to some content by IP address and not restrict access to other content \\(or restrict access but not by IP address\\), you can create two distributions\\. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*\\. \nIf you're using an Amazon Route\u00a053 AWS Integration alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: \n+ You enable IPv6 for the distribution\n+ You're using alternate domain names in the URLs for your objects\nFor more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the * Amazon Route\u00a053 AWS Integration Developer Guide*\\. \nIf you created a CNAME resource record set, either with Amazon Route\u00a053 AWS Integration or with another DNS service, you don't need to make any changes\\. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IPV6Enabled", "type": "boolean" }, @@ -29780,7 +30322,7 @@ "items": { "$ref": "#/definitions/AWS::CloudFront::Distribution.Origin" }, - "markdownDescription": "A complex type that contains information about origins for this distribution\\. \n*Required*: No \n*Type*: List of [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains information about origins for this distribution\\. \n*Required*: No \n*Type*: List of [Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Origins", "type": "array" }, @@ -29796,19 +30338,21 @@ }, "S3Origin": { "$ref": "#/definitions/AWS::CloudFront::Distribution.LegacyS3Origin", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [LegacyS3Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacys3origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [LegacyS3Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-legacys3origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3Origin" }, "Staging": { + "markdownDescription": "A Boolean that indicates whether this is a staging distribution\\. When this value is `true`, this is a staging distribution\\. When this value is `false`, this is not a staging distribution\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Staging", "type": "boolean" }, "ViewerCertificate": { "$ref": "#/definitions/AWS::CloudFront::Distribution.ViewerCertificate", - "markdownDescription": "A complex type that determines the distribution\u2019s SSL/TLS configuration for communicating with viewers\\. \n*Required*: No \n*Type*: [ViewerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers\\. \n*Required*: No \n*Type*: [ViewerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-viewercertificate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ViewerCertificate" }, "WebACLId": { - "markdownDescription": "A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution\\. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example `arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a`\\. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example `473e64fd-f30b-4765-81a0-62ad96dd167a`\\. \n AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content\\. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code \\(Forbidden\\)\\. You can also configure CloudFront to return a custom error page when a request is blocked\\. For more information about AWS WAF, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution\\. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example `arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a`\\. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example `473e64fd-f30b-4765-81a0-62ad96dd167a`\\. \n AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content\\. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code \\(Forbidden\\)\\. You can also configure CloudFront to return a custom error page when a request is blocked\\. For more information about AWS WAF, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WebACLId", "type": "string" } @@ -29896,7 +30440,7 @@ "additionalProperties": false, "properties": { "EventType": { - "markdownDescription": "Specifies the event type that triggers a Lambda@Edge function invocation\\. You can specify the following values: \n+ `viewer-request`: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache\\. \n+ `origin-request`: The function executes only when CloudFront sends a request to your origin\\. When the requested object is in the edge cache, the function doesn't execute\\.\n+ `origin-response`: The function executes after CloudFront receives a response from the origin and before it caches the object in the response\\. When the requested object is in the edge cache, the function doesn't execute\\.\n+ `viewer-response`: The function executes before CloudFront returns the requested object to the viewer\\. The function executes regardless of whether the object was already in the edge cache\\.", + "markdownDescription": "Specifies the event type that triggers a Lambda@Edge function invocation\\. You can specify the following values: \n+ `viewer-request`: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache\\.\n+ `origin-request`: The function executes only when CloudFront sends a request to your origin\\. When the requested object is in the edge cache, the function doesn't execute\\.\n+ `origin-response`: The function executes after CloudFront receives a response from the origin and before it caches the object in the response\\. When the requested object is in the edge cache, the function doesn't execute\\.\n+ `viewer-response`: The function executes before CloudFront returns the requested object to the viewer\\. The function executes regardless of whether the object was already in the edge cache\\.", "title": "EventType", "type": "string" }, @@ -29917,22 +30461,22 @@ "additionalProperties": false, "properties": { "DNSName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DNSName", "type": "string" }, "HTTPPort": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HTTPPort", "type": "number" }, "HTTPSPort": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HTTPSPort", "type": "number" }, "OriginProtocolPolicy": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OriginProtocolPolicy", "type": "string" }, @@ -29940,7 +30484,7 @@ "items": { "type": "string" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OriginSSLProtocols", "type": "array" } @@ -29956,12 +30500,12 @@ "additionalProperties": false, "properties": { "DNSName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DNSName", "type": "string" }, "OriginAccessIdentity": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OriginAccessIdentity", "type": "string" } @@ -29999,12 +30543,12 @@ "additionalProperties": false, "properties": { "ConnectionAttempts": { - "markdownDescription": "The number of times that CloudFront attempts to connect to the origin\\. The minimum number is 1, the maximum is 3, and the default \\(if you don\u2019t specify otherwise\\) is 3\\. \nFor a custom origin \\(including an Amazon S3 bucket that\u2019s configured with static website hosting\\), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout)\\. \nFor more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of times that CloudFront attempts to connect to the origin\\. The minimum number is 1, the maximum is 3, and the default \\(if you don't specify otherwise\\) is 3\\. \nFor a custom origin \\(including an Amazon S3 bucket that's configured with static website hosting\\), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout)\\. \nFor more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectionAttempts", "type": "number" }, "ConnectionTimeout": { - "markdownDescription": "The number of seconds that CloudFront waits when trying to establish a connection to the origin\\. The minimum timeout is 1 second, the maximum is 10 seconds, and the default \\(if you don\u2019t specify otherwise\\) is 10 seconds\\. \nFor more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of seconds that CloudFront waits when trying to establish a connection to the origin\\. The minimum timeout is 1 second, the maximum is 10 seconds, and the default \\(if you don't specify otherwise\\) is 10 seconds\\. \nFor more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectionTimeout", "type": "number" }, @@ -30024,6 +30568,8 @@ "type": "string" }, "OriginAccessControlId": { + "markdownDescription": "The unique identifier of an origin access control for this origin\\. \nFor more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OriginAccessControlId", "type": "string" }, "OriginCustomHeaders": { @@ -30179,7 +30725,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "A flag that specifies whether Origin Shield is enabled\\. \nWhen it\u2019s enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin\\. When it\u2019s disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A flag that specifies whether Origin Shield is enabled\\. \nWhen it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin\\. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, @@ -30209,7 +30755,7 @@ "additionalProperties": false, "properties": { "OriginAccessIdentity": { - "markdownDescription": "The CloudFront origin access identity to associate with the origin\\. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront\\. The format of the value is: \norigin\\-access\\-identity/cloudfront/*ID\\-of\\-origin\\-access\\-identity* \nwhere ` ID-of-origin-access-identity ` is the value that CloudFront returned in the `ID` element when you created the origin access identity\\. \nIf you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty `OriginAccessIdentity` element\\. \nIf you want to use origin access control rather than origin access identity, specify an empty String for the `OriginAccessIdentity` element\\. \nTo delete the origin access identity from an existing distribution, update the distribution configuration and include an empty `OriginAccessIdentity` element\\. \nTo replace the origin access identity, update the distribution configuration and specify the new origin access identity\\. \nFor more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The CloudFront origin access identity to associate with the origin\\. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront\\. The format of the value is: \norigin\\-access\\-identity/cloudfront/*ID\\-of\\-origin\\-access\\-identity* \nwhere ` ID-of-origin-access-identity ` is the value that CloudFront returned in the `ID` element when you created the origin access identity\\. \nIf you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty `OriginAccessIdentity` element\\. \nTo delete the origin access identity from an existing distribution, update the distribution configuration and include an empty `OriginAccessIdentity` element\\. \nTo replace the origin access identity, update the distribution configuration and specify the new origin access identity\\. \nFor more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OriginAccessIdentity", "type": "string" } @@ -30258,12 +30804,12 @@ "type": "string" }, "MinimumProtocolVersion": { - "markdownDescription": "If the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\), specify the security policy that you want CloudFront to use for HTTPS connections with viewers\\. The security policy determines two settings: \n+ The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers\\.\n+ The ciphers that CloudFront can use to encrypt the content that it returns to viewers\\.\nFor more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*\\. \nOn the CloudFront console, this setting is called **Security Policy**\\.\nWhen you\u2019re using SNI only \\(you set `SSLSupportMethod` to `sni-only`\\), you must specify `TLSv1` or higher\\. \\(In CloudFormation, the field name is `SslSupportMethod`\\. Note the different capitalization\\.\\) \nIf the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net` \\(you set `CloudFrontDefaultCertificate` to `true`\\), CloudFront automatically sets the security policy to `TLSv1` regardless of the value that you set here\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `SSLv3 | TLSv1 | TLSv1.1_2016 | TLSv1.2_2018 | TLSv1.2_2019 | TLSv1.2_2021 | TLSv1_2016` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\), specify the security policy that you want CloudFront to use for HTTPS connections with viewers\\. The security policy determines two settings: \n+ The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers\\.\n+ The ciphers that CloudFront can use to encrypt the content that it returns to viewers\\.\nFor more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*\\. \nOn the CloudFront console, this setting is called **Security Policy**\\.\nWhen you're using SNI only \\(you set `SSLSupportMethod` to `sni-only`\\), you must specify `TLSv1` or higher\\. \\(In CloudFormation, the field name is `SslSupportMethod`\\. Note the different capitalization\\.\\) \nIf the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net` \\(you set `CloudFrontDefaultCertificate` to `true`\\), CloudFront automatically sets the security policy to `TLSv1` regardless of the value that you set here\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `SSLv3 | TLSv1 | TLSv1.1_2016 | TLSv1.2_2018 | TLSv1.2_2019 | TLSv1.2_2021 | TLSv1_2016` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MinimumProtocolVersion", "type": "string" }, "SslSupportMethod": { - "markdownDescription": "In CloudFormation, this field name is `SslSupportMethod`\\. Note the different capitalization\\.\nIf the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\), specify which viewers the distribution accepts HTTPS connections from\\. \n+ `sni-only` \u2013 The distribution accepts HTTPS connections from only viewers that support [server name indication \\(SNI\\)](https://en.wikipedia.org/wiki/Server_Name_Indication)\\. This is recommended\\. Most browsers and clients support SNI\\.\n+ `vip` \u2013 The distribution accepts HTTPS connections from all viewers including those that don\u2019t support SNI\\. This is not recommended, and results in additional monthly charges from CloudFront\\.\n+ `static-ip` \\- Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team\\. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [AWS Support Center](https://console.aws.amazon.com/support/home)\\.\nIf the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net`, don\u2019t set a value for this field\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `sni-only | static-ip | vip` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "In CloudFormation, this field name is `SslSupportMethod`\\. Note the different capitalization\\.\nIf the distribution uses `Aliases` \\(alternate domain names or CNAMEs\\), specify which viewers the distribution accepts HTTPS connections from\\. \n+ `sni-only` \u2013 The distribution accepts HTTPS connections from only viewers that support [server name indication \\(SNI\\)](https://en.wikipedia.org/wiki/Server_Name_Indication)\\. This is recommended\\. Most browsers and clients support SNI\\.\n+ `vip` \u2013 The distribution accepts HTTPS connections from all viewers including those that don't support SNI\\. This is not recommended, and results in additional monthly charges from CloudFront\\.\n+ `static-ip` \\- Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team\\. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [AWS Support Center](https://console.aws.amazon.com/support/home)\\.\nIf the distribution uses the CloudFront domain name such as `d111111abcdef8.cloudfront.net`, don't set a value for this field\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `sni-only | static-ip | vip` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SslSupportMethod", "type": "string" } @@ -30321,10 +30867,12 @@ "title": "FunctionConfig" }, "FunctionMetadata": { - "$ref": "#/definitions/AWS::CloudFront::Function.FunctionMetadata" + "$ref": "#/definitions/AWS::CloudFront::Function.FunctionMetadata", + "markdownDescription": "Contains metadata about a CloudFront function\\. \n*Required*: No \n*Type*: [FunctionMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-function-functionmetadata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FunctionMetadata" }, "Name": { - "markdownDescription": "A name to identify the function\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9-_]{1,64}$`", + "markdownDescription": "A name to identify the function\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9-_]{1,64}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" } @@ -30366,7 +30914,7 @@ "type": "string" }, "Runtime": { - "markdownDescription": "The function\u2019s runtime environment\\. The only valid value is `cloudfront-js-1.0`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `cloudfront-js-1.0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The function's runtime environment\\. The only valid value is `cloudfront-js-1.0`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `cloudfront-js-1.0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Runtime", "type": "string" } @@ -30519,10 +31067,14 @@ "additionalProperties": false, "properties": { "DistributionId": { + "markdownDescription": "The ID of the distribution that you are enabling metrics for\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DistributionId", "type": "string" }, "MonitoringSubscription": { - "$ref": "#/definitions/AWS::CloudFront::MonitoringSubscription.MonitoringSubscription" + "$ref": "#/definitions/AWS::CloudFront::MonitoringSubscription.MonitoringSubscription", + "markdownDescription": "A subscription configuration for additional CloudWatch metrics\\. \n*Required*: Yes \n*Type*: [MonitoringSubscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-monitoringsubscription-monitoringsubscription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MonitoringSubscription" } }, "required": [ @@ -30556,7 +31108,9 @@ "additionalProperties": false, "properties": { "RealtimeMetricsSubscriptionConfig": { - "$ref": "#/definitions/AWS::CloudFront::MonitoringSubscription.RealtimeMetricsSubscriptionConfig" + "$ref": "#/definitions/AWS::CloudFront::MonitoringSubscription.RealtimeMetricsSubscriptionConfig", + "markdownDescription": "A subscription configuration for additional CloudWatch metrics\\. \n*Required*: No \n*Type*: [RealtimeMetricsSubscriptionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-monitoringsubscription-realtimemetricssubscriptionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RealtimeMetricsSubscriptionConfig" } }, "type": "object" @@ -30565,6 +31119,8 @@ "additionalProperties": false, "properties": { "RealtimeMetricsSubscriptionStatus": { + "markdownDescription": "A flag that indicates whether additional CloudWatch metrics are enabled for a given CloudFront distribution\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Disabled | Enabled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RealtimeMetricsSubscriptionStatus", "type": "string" } }, @@ -30609,7 +31165,9 @@ "additionalProperties": false, "properties": { "OriginAccessControlConfig": { - "$ref": "#/definitions/AWS::CloudFront::OriginAccessControl.OriginAccessControlConfig" + "$ref": "#/definitions/AWS::CloudFront::OriginAccessControl.OriginAccessControlConfig", + "markdownDescription": "The origin access control\\. \n*Required*: Yes \n*Type*: [OriginAccessControlConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-originaccesscontrol-originaccesscontrolconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OriginAccessControlConfig" } }, "required": [ @@ -30642,18 +31200,28 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description of the origin access control\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A name to identify the origin access control\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "OriginAccessControlOriginType": { + "markdownDescription": "The type of origin that this origin access control is for\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `mediastore | s3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OriginAccessControlOriginType", "type": "string" }, "SigningBehavior": { + "markdownDescription": "Specifies which requests CloudFront signs \\(adds authentication information to\\)\\. Specify `always` for the most common use case\\. For more information, see [origin access control advanced settings](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html#oac-advanced-settings) in the *Amazon CloudFront Developer Guide*\\. \nThis field can have one of the following values: \n+ `always` \u2013 CloudFront signs all origin requests, overwriting the `Authorization` header from the viewer request if one exists\\.\n+ `never` \u2013 CloudFront doesn't sign any origin requests\\. This value turns off origin access control for all origins in all distributions that use this origin access control\\.\n+ `no-override` \u2013 If the viewer request doesn't contain the `Authorization` header, then CloudFront signs the origin request\\. If the viewer request contains the `Authorization` header, then CloudFront doesn't sign the origin request and instead passes along the `Authorization` header from the viewer request\\. **WARNING: To pass along the `Authorization` header from the viewer request, you *must* add the `Authorization` header to a [cache policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html) for all cache behaviors that use origins associated with this origin access control\\.** \n*Required*: Yes \n*Type*: String \n*Allowed values*: `always | never | no-override` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SigningBehavior", "type": "string" }, "SigningProtocol": { + "markdownDescription": "The signing protocol of the origin access control, which determines how CloudFront signs \\(authenticates\\) requests\\. The only valid value is `sigv4`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `sigv4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SigningProtocol", "type": "string" } }, @@ -30906,7 +31474,7 @@ "additionalProperties": false, "properties": { "CallerReference": { - "markdownDescription": "A string included in the request to help make sure that the request can\u2019t be replayed\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string included in the request to help make sure that the request can't be replayed\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CallerReference", "type": "string" }, @@ -31101,7 +31669,7 @@ "properties": { "ResponseHeadersPolicyConfig": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.ResponseHeadersPolicyConfig", - "markdownDescription": "A response headers policy configuration\\. \nA response headers policy contains information about a set of HTTP response headers and their values\\. CloudFront adds the headers in the policy to HTTP responses that it sends for requests that match a cache behavior that\u2019s associated with the policy\\. \n*Required*: Yes \n*Type*: [ResponseHeadersPolicyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A response headers policy configuration\\. \n*Required*: Yes \n*Type*: [ResponseHeadersPolicyConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-responseheaderspolicyconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResponseHeadersPolicyConfig" } }, @@ -31328,7 +31896,7 @@ "additionalProperties": false, "properties": { "FrameOption": { - "markdownDescription": "The value of the `X-Frame-Options` HTTP response header\\. Valid values are `DENY` and `SAMEORIGIN`\\. \nFor more information about these values, see [X\\-Frame\\-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DENY | SAMEORIGIN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value of the `X-Frame-Options` HTTP response header\\. Valid values are `DENY` and `SAMEORIGIN`\\. \nFor more information about these values, see [X\\-Frame\\-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DENY | SAMEORIGIN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FrameOption", "type": "string" }, @@ -31368,6 +31936,8 @@ "additionalProperties": false, "properties": { "Header": { + "markdownDescription": "The HTTP header name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Header", "type": "string" } }, @@ -31383,6 +31953,8 @@ "items": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.RemoveHeader" }, + "markdownDescription": "The list of HTTP header names\\. \n*Required*: Yes \n*Type*: List of [RemoveHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-removeheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Items", "type": "array" } }, @@ -31415,7 +31987,9 @@ "type": "string" }, "RemoveHeadersConfig": { - "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.RemoveHeadersConfig" + "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.RemoveHeadersConfig", + "markdownDescription": "A configuration for a set of HTTP headers to remove from the HTTP response\\. \n*Required*: No \n*Type*: [RemoveHeadersConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-removeheadersconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RemoveHeadersConfig" }, "SecurityHeadersConfig": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.SecurityHeadersConfig", @@ -31423,7 +31997,9 @@ "title": "SecurityHeadersConfig" }, "ServerTimingHeadersConfig": { - "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.ServerTimingHeadersConfig" + "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.ServerTimingHeadersConfig", + "markdownDescription": "A configuration for enabling the `Server-Timing` header in HTTP responses sent from CloudFront\\. \n*Required*: No \n*Type*: [ServerTimingHeadersConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-servertimingheadersconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerTimingHeadersConfig" } }, "required": [ @@ -31446,22 +32022,22 @@ }, "FrameOptions": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.FrameOptions", - "markdownDescription": "Determines whether CloudFront includes the `X-Frame-Options` HTTP response header and the header\u2019s value\\. \nFor more information about the `X-Frame-Options` HTTP response header, see [X\\-Frame\\-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [FrameOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-frameoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether CloudFront includes the `X-Frame-Options` HTTP response header and the header's value\\. \nFor more information about the `X-Frame-Options` HTTP response header, see [X\\-Frame\\-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [FrameOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-frameoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FrameOptions" }, "ReferrerPolicy": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.ReferrerPolicy", - "markdownDescription": "Determines whether CloudFront includes the `Referrer-Policy` HTTP response header and the header\u2019s value\\. \nFor more information about the `Referrer-Policy` HTTP response header, see [Referrer\\-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [ReferrerPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-referrerpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether CloudFront includes the `Referrer-Policy` HTTP response header and the header's value\\. \nFor more information about the `Referrer-Policy` HTTP response header, see [Referrer\\-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [ReferrerPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-referrerpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReferrerPolicy" }, "StrictTransportSecurity": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.StrictTransportSecurity", - "markdownDescription": "Determines whether CloudFront includes the `Strict-Transport-Security` HTTP response header and the header\u2019s value\\. \nFor more information about the `Strict-Transport-Security` HTTP response header, see [Strict\\-Transport\\-Security](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [StrictTransportSecurity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether CloudFront includes the `Strict-Transport-Security` HTTP response header and the header's value\\. \nFor more information about the `Strict-Transport-Security` HTTP response header, see [Strict\\-Transport\\-Security](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [StrictTransportSecurity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-stricttransportsecurity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StrictTransportSecurity" }, "XSSProtection": { "$ref": "#/definitions/AWS::CloudFront::ResponseHeadersPolicy.XSSProtection", - "markdownDescription": "Determines whether CloudFront includes the `X-XSS-Protection` HTTP response header and the header\u2019s value\\. \nFor more information about the `X-XSS-Protection` HTTP response header, see [X\\-XSS\\-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [XSSProtection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-xssprotection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether CloudFront includes the `X-XSS-Protection` HTTP response header and the header's value\\. \nFor more information about the `X-XSS-Protection` HTTP response header, see [X\\-XSS\\-Protection](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection) in the MDN Web Docs\\. \n*Required*: No \n*Type*: [XSSProtection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-responseheaderspolicy-xssprotection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "XSSProtection" } }, @@ -31471,9 +32047,13 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "A Boolean that determines whether CloudFront adds the `Server-Timing` header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "SamplingRate": { + "markdownDescription": "A number 0\u2013100 \\(inclusive\\) that specifies the percentage of responses that you want CloudFront to add the `Server-Timing` header to\\. When you set the sampling rate to 100, CloudFront adds the `Server-Timing` header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to\\. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior\\. You can set the sampling rate to any number 0\u2013100 with up to four decimal places\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SamplingRate", "type": "number" } }, @@ -31627,7 +32207,7 @@ "type": "string" }, "Enabled": { - "markdownDescription": "Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket\\. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify `false` for `Enabled`, and specify `empty Bucket` and `Prefix` elements\\. If you specify `false` for `Enabled` but you specify values for `Bucket` and `Prefix`, the values are automatically deleted\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket\\. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify `false` for `Enabled`, and specify `empty Bucket` and `Prefix` elements\\. If you specify `false` for `Enabled` but you specify values for `Bucket` and `Prefix`, the values are automatically deleted\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, @@ -31648,7 +32228,7 @@ "additionalProperties": false, "properties": { "DomainName": { - "markdownDescription": "The DNS name of the Amazon S3 origin\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The DNS name of the Amazon S3 origin\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DomainName", "type": "string" }, @@ -31671,12 +32251,12 @@ "items": { "type": "string" }, - "markdownDescription": "A complex type that contains information about CNAMEs \\(alternate domain names\\), if any, for this streaming distribution\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains information about CNAMEs \\(alternate domain names\\), if any, for this streaming distribution\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Aliases", "type": "array" }, "Comment": { - "markdownDescription": "Any comments you want to include about the streaming distribution\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Any comments you want to include about the streaming distribution\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Comment", "type": "string" }, @@ -31687,22 +32267,22 @@ }, "Logging": { "$ref": "#/definitions/AWS::CloudFront::StreamingDistribution.Logging", - "markdownDescription": "A complex type that controls whether access logs are written for the streaming distribution\\. \n*Required*: No \n*Type*: [Logging](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that controls whether access logs are written for the streaming distribution\\. \n*Required*: No \n*Type*: [Logging](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-logging.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Logging" }, "PriceClass": { - "markdownDescription": "A complex type that contains information about price class for this streaming distribution\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PriceClass_100 | PriceClass_200 | PriceClass_All` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains information about price class for this streaming distribution\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PriceClass_100 | PriceClass_200 | PriceClass_All` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PriceClass", "type": "string" }, "S3Origin": { "$ref": "#/definitions/AWS::CloudFront::StreamingDistribution.S3Origin", - "markdownDescription": "A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution\\. \n*Required*: Yes \n*Type*: [S3Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution\\. \n*Required*: Yes \n*Type*: [S3Origin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-s3origin.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3Origin" }, "TrustedSigners": { "$ref": "#/definitions/AWS::CloudFront::StreamingDistribution.TrustedSigners", - "markdownDescription": "A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content\\. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element\\. For more information, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: Yes \n*Type*: [TrustedSigners](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content\\. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element\\. For more information, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*\\. \n*Required*: Yes \n*Type*: [TrustedSigners](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-streamingdistribution-trustedsigners.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TrustedSigners" } }, @@ -31775,18 +32355,26 @@ "items": { "$ref": "#/definitions/AWS::CloudTrail::Channel.Destination" }, + "markdownDescription": "One or more event data stores to which events arriving through a channel will be logged\\. \n*Required*: No \n*Type*: List of [Destination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-channel-destination.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Destinations", "type": "array" }, "Name": { + "markdownDescription": "The name of the channel\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9._\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Source": { + "markdownDescription": "The name of the partner or external event source\\. You cannot change this name after you create the channel\\. A maximum of one channel is allowed per source\\. \n A source can be either `Custom` for all valid non\\-AWS events, or the name of a partner event source\\. For information about the source names for available partners, see [Additional information about integration partners](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-integration.html#cloudtrail-lake-partner-information) in the CloudTrail User Guide\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Source", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -31816,9 +32404,13 @@ "additionalProperties": false, "properties": { "Location": { + "markdownDescription": "For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel\\. For service\\-linked channels, the location is the name of the AWS service\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `1024` \n*Pattern*: `^[a-zA-Z0-9._/\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Location", "type": "string" }, "Type": { + "markdownDescription": "The type of destination for events arriving from a channel\\. For channels used for a CloudTrail Lake integration, the value is `EventDataStore`\\. For service\\-linked channels, the value is `AWS_SERVICE`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AWS_SERVICE | EVENT_DATA_STORE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -31867,30 +32459,46 @@ "items": { "$ref": "#/definitions/AWS::CloudTrail::EventDataStore.AdvancedEventSelector" }, + "markdownDescription": "The advanced event selectors to use to select the events for the data store\\. You can configure up to five advanced event selectors for each event data store\\. \n For more information about how to use advanced event selectors to log CloudTrail events, see [Log events by using advanced event selectors](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced) in the CloudTrail User Guide\\. \nFor more information about how to use advanced event selectors to include AWS Config configuration items in your event data store, see [Create an event data store for AWS Config configuration items](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-eds-config) in the CloudTrail User Guide\\. \nFor more information about how to use advanced event selectors to include non\\-AWS events in your event data store, see [Create an integration to log events from outside AWS](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-lake-cli.html#lake-cli-create-integration) in the CloudTrail User Guide\\. \n*Required*: No \n*Type*: List of [AdvancedEventSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedeventselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdvancedEventSelectors", "type": "array" }, "KmsKeyId": { + "markdownDescription": "Specifies the AWS KMS key ID to use to encrypt the events delivered by CloudTrail\\. The value can be an alias name prefixed by `alias/`, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier\\. \nDisabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key\\. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed\\. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store\\.\nCloudTrail also supports AWS KMS multi\\-Region keys\\. For more information about multi\\-Region keys, see [Using multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the * AWS Key Management Service Developer Guide*\\. \nExamples: \n+ `alias/MyAliasName` \n+ `arn:aws:kms:us-east-2:123456789012:alias/MyAliasName` \n+ `arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012` \n+ `12345678-1234-1234-1234-123456789012` \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `350` \n*Pattern*: `^[a-zA-Z0-9._/\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "MultiRegionEnabled": { + "markdownDescription": "Specifies whether the event data store includes events from all regions, or only from the region in which the event data store is created\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MultiRegionEnabled", "type": "boolean" }, "Name": { + "markdownDescription": "The name of the event data store\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9._\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "OrganizationEnabled": { + "markdownDescription": "Specifies whether an event data store collects events logged for an organization in AWS Organizations\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationEnabled", "type": "boolean" }, "RetentionPeriod": { + "markdownDescription": "The retention period of the event data store, in days\\. You can set a retention period of up to 2557 days, the equivalent of seven years\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `7` \n*Maximum*: `2557` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetentionPeriod", "type": "number" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TerminationProtectionEnabled": { + "markdownDescription": "Specifies whether termination protection is enabled for the event data store\\. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TerminationProtectionEnabled", "type": "boolean" } }, @@ -31923,9 +32531,13 @@ "items": { "$ref": "#/definitions/AWS::CloudTrail::EventDataStore.AdvancedFieldSelector" }, + "markdownDescription": "Contains all selector statements in an advanced event selector\\. \n*Required*: Yes \n*Type*: List of [AdvancedFieldSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-eventdatastore-advancedfieldselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FieldSelectors", "type": "array" }, "Name": { + "markdownDescription": "An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\"\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1000` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -31941,39 +32553,53 @@ "items": { "type": "string" }, + "markdownDescription": "An operator that includes events that match the last few characters of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndsWith", "type": "array" }, "Equals": { "items": { "type": "string" }, + "markdownDescription": "An operator that includes events that match the exact value of the event record field specified as the value of `Field`\\. This is the only valid operator that you can use with the `readOnly`, `eventCategory`, and `resources.type` fields\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Equals", "type": "array" }, "Field": { + "markdownDescription": "A field in a CloudTrail event record on which to filter events to be logged\\. For event data stores for AWS Config configuration items, Audit Manager evidence, or non\\-AWS events, the field is used only for selecting events as filtering is not supported\\. \n For CloudTrail event records, supported fields include `readOnly`, `eventCategory`, `eventSource` \\(for management events\\), `eventName`, `resources.type`, and `resources.ARN`\\. \n For event data stores for AWS Config configuration items, Audit Manager evidence, or non\\-AWS events, the only supported field is `eventCategory`\\. \n+ ** `readOnly` ** \\- Optional\\. Can be set to `Equals` a value of `true` or `false`\\. If you do not add this field, CloudTrail logs both `read` and `write` events\\. A value of `true` logs only `read` events\\. A value of `false` logs only `write` events\\.\n+ ** `eventSource` ** \\- For filtering management events only\\. This can be set only to `NotEquals` `kms.amazonaws.com`\\.\n+ ** `eventName` ** \\- Can use any operator\\. You can use it to \ufb01lter in or \ufb01lter out any data event logged to CloudTrail, such as `PutBucket` or `GetSnapshotBlock`\\. You can have multiple values for this \ufb01eld, separated by commas\\.\n+ ** `eventCategory` ** \\- This is required and must be set to `Equals`\\. \n + For CloudTrail event records, the value must be `Management` or `Data`\\. \n + For AWS Config configuration items, the value must be `ConfigurationItem`\\. \n + For Audit Manager evidence, the value must be `Evidence`\\. \n + For non\\-AWS events, the value must be `ActivityAuditLog`\\. \n+ ** `resources.type` ** \\- This \ufb01eld is required for CloudTrail data events\\. `resources.type` can only use the `Equals` operator, and the value can be one of the following:\n + `AWS::DynamoDB::Table` \n + `AWS::Lambda::Function` \n + `AWS::S3::Object` \n + `AWS::CloudTrail::Channel` \n + `AWS::Cognito::IdentityPool` \n + `AWS::DynamoDB::Stream` \n + `AWS::EC2::Snapshot` \n + `AWS::FinSpace::Environment` \n + `AWS::Glue::Table` \n + `AWS::KendraRanking::ExecutionPlan` \n + `AWS::ManagedBlockchain::Node` \n + `AWS::SageMaker::ExperimentTrialComponent` \n + `AWS::SageMaker::FeatureGroup` \n + `AWS::S3::AccessPoint` \n + `AWS::S3ObjectLambda::AccessPoint` \n + `AWS::S3Outposts::Object`", + "title": "Field", "type": "string" }, "NotEndsWith": { "items": { "type": "string" }, + "markdownDescription": "An operator that excludes events that match the last few characters of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotEndsWith", "type": "array" }, "NotEquals": { "items": { "type": "string" }, + "markdownDescription": "An operator that excludes events that match the exact value of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotEquals", "type": "array" }, "NotStartsWith": { "items": { "type": "string" }, + "markdownDescription": "An operator that excludes events that match the first few characters of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotStartsWith", "type": "array" }, "StartsWith": { "items": { "type": "string" }, + "markdownDescription": "An operator that includes events that match the first few characters of the event record field specified as the value of `Field`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StartsWith", "type": "array" } }, @@ -32018,9 +32644,13 @@ "additionalProperties": false, "properties": { "ResourceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the CloudTrail channel attached to the resource\\-based policy\\. The following is the format of a resource ARN: `arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._/\\-:]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceArn", "type": "string" }, "ResourcePolicy": { + "markdownDescription": "A JSON\\-formatted string for an AWS resource\\-based policy\\. \nThe following are requirements for the resource policy: \n+ Contains only one action: cloudtrail\\-data:PutAuditEvents \n+ Contains at least one statement\\. The policy can have a maximum of 20 statements\\. \n+ Each statement contains at least one principal\\. A statement can have a maximum of 50 principals\\. \n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `8192` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourcePolicy", "type": "object" } }, @@ -32087,12 +32717,12 @@ "additionalProperties": false, "properties": { "CloudWatchLogsLogGroupArn": { - "markdownDescription": "Specifies a log group name using an Amazon Resource Name \\(ARN\\), a unique identifier that represents the log group to which CloudTrail logs are delivered\\. Not required unless you specify `CloudWatchLogsRoleArn`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a log group name using an Amazon Resource Name \\(ARN\\), a unique identifier that represents the log group to which CloudTrail logs are delivered\\. You must use a log group that exists in your account\\. \nNot required unless you specify `CloudWatchLogsRoleArn`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchLogsLogGroupArn", "type": "string" }, "CloudWatchLogsRoleArn": { - "markdownDescription": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group\\. You must use a role that exists in your account\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchLogsRoleArn", "type": "string" }, @@ -32105,7 +32735,7 @@ "items": { "$ref": "#/definitions/AWS::CloudTrail::Trail.EventSelector" }, - "markdownDescription": "Use event selectors to further specify the management and data event settings for your trail\\. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events\\. When an event occurs in your account, CloudTrail evaluates the event selector for all trails\\. For each trail, if the event matches any event selector, the trail processes and logs the event\\. If the event doesn't match any event selector, the trail doesn't log the event\\. \nYou can configure up to five event selectors for a trail\\. \nYou cannot apply both event selectors and advanced event selectors to a trail\\. \n*Required*: No \n*Type*: List of [EventSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Use event selectors to further specify the management and data event settings for your trail\\. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events\\. When an event occurs in your account, CloudTrail evaluates the event selector for all trails\\. For each trail, if the event matches any event selector, the trail processes and logs the event\\. If the event doesn't match any event selector, the trail doesn't log the event\\. \nYou can configure up to five event selectors for a trail\\. \n*Required*: No \n*Type*: List of [EventSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-eventselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventSelectors", "type": "array" }, @@ -32118,7 +32748,7 @@ "items": { "$ref": "#/definitions/AWS::CloudTrail::Trail.InsightSelector" }, - "markdownDescription": "Specifies whether a trail has insight types specified in an `InsightSelector` list\\. \n*Required*: No \n*Type*: List of [InsightSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-insightselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A JSON string that contains the insight types you want to log on a trail\\. `ApiCallRateInsight` and `ApiErrorRateInsight` are valid insight types\\. \n*Required*: No \n*Type*: List of [InsightSelector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-insightselector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InsightSelectors", "type": "array" }, @@ -32133,7 +32763,7 @@ "type": "boolean" }, "IsOrganizationTrail": { - "markdownDescription": "Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account\\. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the management account for an organization in AWS Organizations\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account\\. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the management account or delegated administrator account for an organization in AWS Organizations\\. If the trail is not an organization trail and this is set to `true`, the trail will be created in all AWS accounts that belong to the organization\\. If the trail is an organization trail and this is set to `false`, the trail will remain in the current AWS account but be deleted from all member accounts in the organization\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsOrganizationTrail", "type": "boolean" }, @@ -32202,7 +32832,7 @@ "additionalProperties": false, "properties": { "Type": { - "markdownDescription": "The resource type in which you want to log data events\\. You can specify the following *basic* event selector resource types: \n+ `AWS::S3::Object` \n+ `AWS::Lambda::Function` \n+ `AWS::DynamoDB::Table` \nThe following resource types are also availble through *advanced* event selectors\\. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors\\. For more information, see [AdvancedFieldSelector:Field](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedFieldSelector.html#awscloudtrail-Type-AdvancedFieldSelector-Field)\\. \n+ `AWS::S3Outposts::Object` \n+ `AWS::ManagedBlockchain::Node` \n+ `AWS::S3ObjectLambda::AccessPoint` \n+ `AWS::EC2::Snapshot` \n+ `AWS::S3::AccessPoint` \n+ `AWS::DynamoDB::Stream` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The resource type in which you want to log data events\\. You can specify the following *basic* event selector resource types: \n+ `AWS::S3::Object` \n+ `AWS::Lambda::Function` \n+ `AWS::DynamoDB::Table` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" }, @@ -32210,7 +32840,7 @@ "items": { "type": "string" }, - "markdownDescription": "An array of Amazon Resource Name \\(ARN\\) strings or partial ARN strings for the specified objects\\. \n+ To log data events for all objects in all S3 buckets in your AWS account, specify the prefix as `arn:aws:s3:::`\\.\n**Note** \nThis also enables logging of data event activity performed by any user or role in your AWS account, even if that activity is performed on a bucket that belongs to another AWS account\\.\n+ To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as `arn:aws:s3:::bucket-1/`\\. The trail logs data events for all objects in this S3 bucket\\.\n+ To log data events for specific objects, specify the S3 bucket and object prefix such as `arn:aws:s3:::bucket-1/example-images`\\. The trail logs data events for objects in this S3 bucket that match the prefix\\.\n+ To log data events for all Lambda functions in your AWS account, specify the prefix as `arn:aws:lambda`\\.\n**Note** \nThis also enables logging of `Invoke` activity performed by any user or role in your AWS account, even if that activity is performed on a function that belongs to another AWS account\\. \n+ To log data events for a specific Lambda function, specify the function ARN\\.\n**Note** \nLambda function ARNs are exact\\. For example, if you specify a function ARN *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld*, data events will only be logged for *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld*\\. They will not be logged for *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld2*\\.\n+ To log data events for all DynamoDB tables in your AWS account, specify the prefix as `arn:aws:dynamodb`\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of Amazon Resource Name \\(ARN\\) strings or partial ARN strings for the specified objects\\. \n+ To log data events for all objects in all S3 buckets in your AWS account, specify the prefix as `arn:aws:s3`\\.\n**Note** \nThis also enables logging of data event activity performed by any user or role in your AWS account, even if that activity is performed on a bucket that belongs to another AWS account\\.\n+ To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as `arn:aws:s3:::bucket-1/`\\. The trail logs data events for all objects in this S3 bucket\\. \n+ To log data events for specific objects, specify the S3 bucket and object prefix such as `arn:aws:s3:::bucket-1/example-images`\\. The trail logs data events for objects in this S3 bucket that match the prefix\\.\n+ To log data events for all Lambda functions in your AWS account, specify the prefix as `arn:aws:lambda`\\.\n**Note** \nThis also enables logging of `Invoke` activity performed by any user or role in your AWS account, even if that activity is performed on a function that belongs to another AWS account\\. \n+ To log data events for a specific Lambda function, specify the function ARN\\.\n**Note** \nLambda function ARNs are exact\\. For example, if you specify a function ARN *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld*, data events will only be logged for *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld*\\. They will not be logged for *arn:aws:lambda:us\\-west\\-2:111111111111:function:helloworld2*\\.\n+ To log data events for all DynamoDB tables in your AWS account, specify the prefix as `arn:aws:dynamodb`\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -32227,7 +32857,7 @@ "items": { "$ref": "#/definitions/AWS::CloudTrail::Trail.DataResource" }, - "markdownDescription": "CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions\\. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail\\. This limit does not apply if you configure resource logging for all data events\\. \nFor more information, see [Data Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-data-events) and [Limits in AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) in the *AWS CloudTrail User Guide*\\. \n*Required*: Conditional \n*Type*: List of [DataResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "In AWS CloudFormation, CloudTrail supports data event logging for Amazon S3 objects, Amazon DynamoDB tables, and AWS Lambda functions\\. Currently, advanced event selectors for data events are not supported in AWS CloudFormation templates\\. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail\\. This limit does not apply if you configure resource logging for all data events\\. \nFor more information, see [Logging data events for trails](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) and [Limits in AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) in the *AWS CloudTrail User Guide*\\. \n*Required*: Conditional \n*Type*: List of [DataResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudtrail-trail-dataresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataResources", "type": "array" }, @@ -32240,7 +32870,7 @@ "type": "array" }, "IncludeManagementEvents": { - "markdownDescription": "Specify if you want your event selector to include management events for your trail\\. \n For more information, see [Management Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-management-events) in the * AWS CloudTrail User Guide*\\. \nBy default, the value is `true`\\. \nThe first copy of management events is free\\. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region\\. For more information about CloudTrail pricing, see [AWS CloudTrail Pricing](http://aws.amazon.com/cloudtrail/pricing/)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify if you want your event selector to include management events for your trail\\. \n For more information, see [Management Events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html) in the * AWS CloudTrail User Guide*\\. \nBy default, the value is `true`\\. \nThe first copy of management events is free\\. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region\\. For more information about CloudTrail pricing, see [AWS CloudTrail Pricing](http://aws.amazon.com/cloudtrail/pricing/)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeManagementEvents", "type": "boolean" }, @@ -32335,7 +32965,7 @@ "items": { "$ref": "#/definitions/AWS::CloudWatch::Alarm.Dimension" }, - "markdownDescription": "The dimensions for the metric associated with the alarm\\. For an alarm based on a math expression, you can't specify `Dimensions`\\. Instead, you use `Metrics`\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The dimensions for the metric associated with the alarm\\. For an alarm based on a math expression, you can't specify `Dimensions`\\. Instead, you use `Metrics`\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html) \n*Maximum*: `30` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Dimensions", "type": "array" }, @@ -32350,7 +32980,7 @@ "type": "number" }, "ExtendedStatistic": { - "markdownDescription": "The percentile statistic for the metric associated with the alarm\\. Specify a value between p0\\.0 and p100\\. \nFor an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both\\. \nFor an alarm based on a math expression, you can't specify `ExtendedStatistic`\\. Instead, you use `Metrics`\\. \n*Required*: No \n*Type*: String \n*Pattern*: `p(\\d{1,2}(\\.\\d{0,2})?|100)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The percentile statistic for the metric associated with the alarm\\. Specify a value between p0\\.0 and p100\\. \nFor an alarm based on a metric, you must specify either `Statistic` or `ExtendedStatistic` but not both\\. \nFor an alarm based on a math expression, you can't specify `ExtendedStatistic`\\. Instead, you use `Metrics`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExtendedStatistic", "type": "string" }, @@ -32455,7 +33085,7 @@ "type": "string" }, "Value": { - "markdownDescription": "The value for the dimension, from 1\u2013255 characters in length\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value for the dimension, from 1\u2013255 characters in length\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -32473,7 +33103,7 @@ "items": { "$ref": "#/definitions/AWS::CloudWatch::Alarm.Dimension" }, - "markdownDescription": "The metric dimensions that you want to be used for the metric that the alarm will watch\\.\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The metric dimensions that you want to be used for the metric that the alarm will watch\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-dimension.html) \n*Maximum*: `30` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Dimensions", "type": "array" }, @@ -32499,7 +33129,7 @@ "type": "string" }, "Expression": { - "markdownDescription": "The math expression to be performed on the returned data, if this object is performing a math expression\\. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions\\. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*\\. \nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The math expression to be performed on the returned data, if this object is performing a math expression\\. This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions\\. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*\\. \nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Expression", "type": "string" }, @@ -32689,7 +33319,7 @@ "type": "string" }, "Value": { - "markdownDescription": "The value of the dimension\\. Dimension values must contain only ASCII characters and must include at least one non\\-whitespace character\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The value of the dimension\\. Dimension values must contain only ASCII characters and must include at least one non\\-whitespace character\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Value", "type": "string" } @@ -32707,7 +33337,7 @@ "items": { "$ref": "#/definitions/AWS::CloudWatch::AnomalyDetector.Dimension" }, - "markdownDescription": "The dimensions for the metric\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html) \n*Maximum*: `10` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The dimensions for the metric\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html) \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Dimensions", "type": "array" }, @@ -32737,12 +33367,12 @@ "additionalProperties": false, "properties": { "AccountId": { - "markdownDescription": "The ID of the account where the metrics are located, if this is a cross\\-account alarm\\. \nUse this field only for `PutMetricAlarm` operations\\. It is not used in `GetMetricData` operations\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the account where the metrics are located\\. \nIf you are performing a `GetMetricData` operation in a monitoring account, use this to specify which account to retrieve this metric from\\. \nIf you are performing a `PutMetricAlarm` operation, use this to specify which account contains the metric that the alarm is watching\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AccountId", "type": "string" }, "Expression": { - "markdownDescription": "This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data\\. For more information about Metrics Insights queries, see [Metrics Insights query components and syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage) in the *Amazon CloudWatch User Guide*\\. \nA math expression can use the `Id` of the other metrics or queries to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions\\. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*\\. \nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data\\. For more information about Metrics Insights queries, see [Metrics Insights query components and syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage) in the *Amazon CloudWatch User Guide*\\. \nA math expression can use the `Id` of the other metrics or queries to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions\\. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide*\\. \nWithin each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Expression", "type": "string" }, @@ -32767,7 +33397,7 @@ "type": "number" }, "ReturnData": { - "markdownDescription": "When used in `GetMetricData`, this option indicates whether to return the timestamps and raw data values of this metric\\. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify `False`\\. If you omit this, the default of `True` is used\\. \nWhen used in `PutMetricAlarm`, specify `True` for the one expression result to use as the alarm\\. For all other metrics and expressions in the same `PutMetricAlarm` operation, specify `ReturnData` as False\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When used in `GetMetricData`, this option indicates whether to return the timestamps and raw data values of this metric\\. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify `false`\\. If you omit this, the default of `true` is used\\. \nWhen used in `PutMetricAlarm`, specify `true` for the one expression result to use as the alarm\\. For all other metrics and expressions in the same `PutMetricAlarm` operation, specify `ReturnData` as False\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReturnData", "type": "boolean" } @@ -32784,7 +33414,7 @@ "items": { "$ref": "#/definitions/AWS::CloudWatch::AnomalyDetector.MetricDataQuery" }, - "markdownDescription": "An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression\\. Each item in `MetricDataQueries` gets a metric or performs a math expression\\. One item in `MetricDataQueries` is the expression that provides the time series that the anomaly detector uses as input\\. Designate the expression by setting `ReturnData` to `True` for this object in the array\\. For all other expressions and metrics, set `ReturnData` to `False`\\. The designated expression must return a single time series\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataqueries.html) of [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression\\. Each item in `MetricDataQueries` gets a metric or performs a math expression\\. One item in `MetricDataQueries` is the expression that provides the time series that the anomaly detector uses as input\\. Designate the expression by setting `ReturnData` to `true` for this object in the array\\. For all other expressions and metrics, set `ReturnData` to `false`\\. The designated expression must return a single time series\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataqueries.html) of [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-metricdataquery.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MetricDataQueries", "type": "array" } @@ -32849,7 +33479,7 @@ "items": { "$ref": "#/definitions/AWS::CloudWatch::AnomalyDetector.Dimension" }, - "markdownDescription": "The metric dimensions to create the anomaly detection model for\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html) \n*Maximum*: `10` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The metric dimensions to create the anomaly detection model for\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-anomalydetector-dimension.html) \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Dimensions", "type": "array" }, @@ -32912,12 +33542,18 @@ "type": "boolean" }, "ActionsSuppressor": { + "markdownDescription": "Actions will be suppressed if the suppressor alarm is in the `ALARM` state\\. `ActionsSuppressor` can be an AlarmName or an Amazon Resource Name \\(ARN\\) from an existing alarm\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActionsSuppressor", "type": "string" }, "ActionsSuppressorExtensionPeriod": { + "markdownDescription": "The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the `ALARM` state\\. After this time, the composite alarm performs its actions\\. \n `ExtensionPeriod` is required only when `ActionsSuppressor` is specified\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActionsSuppressorExtensionPeriod", "type": "number" }, "ActionsSuppressorWaitPeriod": { + "markdownDescription": "The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the `ALARM` state\\. After this time, the composite alarm performs its actions\\. \n `WaitPeriod` is required only when `ActionsSuppressor` is specified\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActionsSuppressorWaitPeriod", "type": "number" }, "AlarmActions": { @@ -32934,7 +33570,7 @@ "type": "string" }, "AlarmName": { - "markdownDescription": "The name for the composite alarm\\. This name must be unique within your AWS account\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name for the composite alarm\\. This name must be unique within your AWS account\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AlarmName", "type": "string" }, @@ -33204,6 +33840,8 @@ "type": "array" }, "IncludeLinkedAccountsMetrics": { + "markdownDescription": "If you are creating a metric stream in a monitoring account, specify `true` to include metrics from source accounts that are linked to this monitoring account, in the metric stream\\. The default is `false`\\. \nFor more information about linking accounts, see [CloudWatch cross\\-account observability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html) \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludeLinkedAccountsMetrics", "type": "boolean" }, "Name": { @@ -33225,6 +33863,8 @@ "items": { "$ref": "#/definitions/AWS::CloudWatch::MetricStream.MetricStreamStatisticsConfiguration" }, + "markdownDescription": "By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed\\. You can use this parameter to have the metric stream also send additional statistics in the stream\\. This array can have up to 100 members\\. \nFor each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics\\. The additional statistics that you can stream depend on the stream's `OutputFormat`\\. If the `OutputFormat` is `json`, you can stream any additional statistic that is supported by CloudWatch, listed in [CloudWatch statistics definitions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html)\\. If the `OutputFormat` is `opentelemetry0`\\.7, you can stream percentile statistics *\\(p??\\)*\\. \n*Required*: No \n*Type*: List of [MetricStreamStatisticsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StatisticsConfigurations", "type": "array" }, "Tags": { @@ -33285,12 +33925,16 @@ "items": { "type": "string" }, + "markdownDescription": "The additional statistics to stream for the metrics listed in `IncludeMetrics`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalStatistics", "type": "array" }, "IncludeMetrics": { "items": { "$ref": "#/definitions/AWS::CloudWatch::MetricStream.MetricStreamStatisticsMetric" }, + "markdownDescription": "An array that defines the metrics that are to have additional statistics streamed\\. \n*Required*: Yes \n*Type*: List of [MetricStreamStatisticsMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-metricstream-metricstreamstatisticsmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludeMetrics", "type": "array" } }, @@ -33304,9 +33948,13 @@ "additionalProperties": false, "properties": { "MetricName": { + "markdownDescription": "The name of the metric\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetricName", "type": "string" }, "Namespace": { + "markdownDescription": "The namespace of the metric\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Namespace", "type": "string" } }, @@ -33455,7 +34103,7 @@ "items": { "type": "string" }, - "markdownDescription": "An array of external connections associated with the repository. Currently only one external connection is allowed per repository.\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of external connections associated with the repository\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExternalConnections", "type": "array" }, @@ -34822,12 +35470,12 @@ "additionalProperties": false, "properties": { "Type": { - "markdownDescription": "The minimum healthy instance type: \n+ HOST\\_COUNT: The minimum number of healthy instance as an absolute value\\.\n+ FLEET\\_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment\\.\nIn an example of nine instance, if a HOST\\_COUNT of six is specified, deploy to up to three instances at a time\\. The deployment is successful if six or more instances are deployed to successfully\\. Otherwise, the deployment fails\\. If a FLEET\\_PERCENT of 40 is specified, deploy to up to five instance at a time\\. The deployment is successful if four or more instance are deployed to successfully\\. Otherwise, the deployment fails\\. \nIn a call to `GetDeploymentConfig`, CodeDeployDefault\\.OneAtATime returns a minimum healthy instance type of MOST\\_CONCURRENCY and a value of 1\\. This means a deployment to only one instance at a time\\. \\(You cannot set the type to MOST\\_CONCURRENCY, only to HOST\\_COUNT or FLEET\\_PERCENT\\.\\) In addition, with CodeDeployDefault\\.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment\\. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful\\.\nFor more information, see [AWS CodeDeploy Instance Health](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html) in the *AWS CodeDeploy User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FLEET_PERCENT | HOST_COUNT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The minimum healthy instance type: \n+ HOST\\_COUNT: The minimum number of healthy instance as an absolute value\\.\n+ FLEET\\_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment\\.\nIn an example of nine instance, if a HOST\\_COUNT of six is specified, deploy to up to three instances at a time\\. The deployment is successful if six or more instances are deployed to successfully\\. Otherwise, the deployment fails\\. If a FLEET\\_PERCENT of 40 is specified, deploy to up to five instance at a time\\. The deployment is successful if four or more instance are deployed to successfully\\. Otherwise, the deployment fails\\. \nIn a call to `GetDeploymentConfig`, CodeDeployDefault\\.OneAtATime returns a minimum healthy instance type of MOST\\_CONCURRENCY and a value of 1\\. This means a deployment to only one instance at a time\\. \\(You cannot set the type to MOST\\_CONCURRENCY, only to HOST\\_COUNT or FLEET\\_PERCENT\\.\\) In addition, with CodeDeployDefault\\.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment\\. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful\\.\nFor more information, see [AWS CodeDeploy Instance Health](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html) in the *AWS CodeDeploy User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FLEET_PERCENT | HOST_COUNT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" }, "Value": { - "markdownDescription": "The minimum healthy instance value\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The minimum healthy instance value\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Value", "type": "number" } @@ -34842,12 +35490,12 @@ "additionalProperties": false, "properties": { "CanaryInterval": { - "markdownDescription": "The number of minutes between the first and second traffic shifts of a `TimeBasedCanary` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of minutes between the first and second traffic shifts of a `TimeBasedCanary` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CanaryInterval", "type": "number" }, "CanaryPercentage": { - "markdownDescription": "The percentage of traffic to shift in the first increment of a `TimeBasedCanary` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The percentage of traffic to shift in the first increment of a `TimeBasedCanary` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CanaryPercentage", "type": "number" } @@ -34862,12 +35510,12 @@ "additionalProperties": false, "properties": { "LinearInterval": { - "markdownDescription": "The number of minutes between each incremental traffic shift of a `TimeBasedLinear` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of minutes between each incremental traffic shift of a `TimeBasedLinear` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "LinearInterval", "type": "number" }, "LinearPercentage": { - "markdownDescription": "The percentage of traffic that is shifted at the start of each increment of a `TimeBasedLinear` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The percentage of traffic that is shifted at the start of each increment of a `TimeBasedLinear` deployment\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "LinearPercentage", "type": "number" } @@ -34883,16 +35531,16 @@ "properties": { "TimeBasedCanary": { "$ref": "#/definitions/AWS::CodeDeploy::DeploymentConfig.TimeBasedCanary", - "markdownDescription": "A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments\\. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file\\. \n*Required*: No \n*Type*: [TimeBasedCanary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedcanary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in two increments\\. The original and target Lambda function versions or ECS task sets are specified in the deployment's AppSpec file\\. \n*Required*: No \n*Type*: [TimeBasedCanary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedcanary.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TimeBasedCanary" }, "TimeBasedLinear": { "$ref": "#/definitions/AWS::CodeDeploy::DeploymentConfig.TimeBasedLinear", - "markdownDescription": "A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment\\. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file\\. \n*Required*: No \n*Type*: [TimeBasedLinear](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedlinear.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in equal increments, with an equal number of minutes between each increment\\. The original and target Lambda function versions or Amazon ECS task sets are specified in the deployment's AppSpec file\\. \n*Required*: No \n*Type*: [TimeBasedLinear](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-timebasedlinear.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TimeBasedLinear" }, "Type": { - "markdownDescription": "The type of traffic shifting \\(`TimeBasedCanary` or `TimeBasedLinear`\\) used by a deployment configuration\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AllAtOnce | TimeBasedCanary | TimeBasedLinear` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of traffic shifting \\(`TimeBasedCanary` or `TimeBasedLinear`\\) used by a deployment configuration\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AllAtOnce | TimeBasedCanary | TimeBasedLinear` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -35025,6 +35673,8 @@ "title": "OnPremisesTagSet" }, "OutdatedInstancesStrategy": { + "markdownDescription": "Indicates what happens when new Amazon EC2 instances are launched mid\\-deployment and do not receive the deployed application revision\\. \nIf this option is set to `UPDATE` or is unspecified, CodeDeploy initiates one or more 'auto\\-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances\\. \nIf this option is set to `IGNORE`, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances\\. This may result in instances having different revisions\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IGNORE | UPDATE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OutdatedInstancesStrategy", "type": "string" }, "ServiceRoleArn": { @@ -35036,6 +35686,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them\\. Each tag consists of a key and an optional value, both of which you define\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TriggerConfigurations": { @@ -35092,7 +35744,7 @@ "items": { "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.Alarm" }, - "markdownDescription": "A list of alarms configured for the deployment group\\. A maximum of 10 alarms can be added to a deployment group\\. \n*Required*: No \n*Type*: List of [Alarm](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of alarms configured for the deployment or deployment group\\. A maximum of 10 alarms can be added\\. \n*Required*: No \n*Type*: List of [Alarm](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-alarm.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Alarms", "type": "array" }, @@ -35355,6 +36007,8 @@ "items": { "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TargetGroupPairInfo" }, + "markdownDescription": "The target group pair information\\. This is an array of `TargeGroupPairInfo` objects with a maximum size of one\\. \n*Required*: No \n*Type*: List of [TargetGroupPairInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgrouppairinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetGroupPairInfoList", "type": "array" } }, @@ -35480,16 +36134,22 @@ "additionalProperties": false, "properties": { "ProdTrafficRoute": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TrafficRoute" + "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TrafficRoute", + "markdownDescription": "The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete\\. \n*Required*: No \n*Type*: [TrafficRoute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-trafficroute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ProdTrafficRoute" }, "TargetGroups": { "items": { "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TargetGroupInfo" }, + "markdownDescription": "One pair of target groups\\. One is associated with the original task set\\. The second is associated with the task set that serves traffic after the deployment is complete\\. \n*Required*: No \n*Type*: List of [TargetGroupInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-targetgroupinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetGroups", "type": "array" }, "TestTrafficRoute": { - "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TrafficRoute" + "$ref": "#/definitions/AWS::CodeDeploy::DeploymentGroup.TrafficRoute", + "markdownDescription": "An optional path used by a load balancer to route test traffic after an Amazon ECS deployment\\. Validation can occur while test traffic is served during a deployment\\. \n*Required*: No \n*Type*: [TrafficRoute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-trafficroute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TestTrafficRoute" } }, "type": "object" @@ -35501,6 +36161,8 @@ "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of one listener\\. The listener identifies the route between a target group and a load balancer\\. This is an array of strings with a maximum size of one\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ListenerArns", "type": "array" } }, @@ -35567,7 +36229,7 @@ "properties": { "AgentPermissions": { "$ref": "#/definitions/AWS::CodeGuruProfiler::ProfilingGroup.AgentPermissions", - "markdownDescription": "The agent permissions attached to this profiling group\\. This action group grants `ConfigureAgent` and `PostAgentProfile` permissions to perform actions required by the profiling agent\\. The Json consists of key `Principals`\\. \n*Principals*: A list of string ARNs for the roles and users you want to grant access to the profiling group\\. Wildcards are not supported in the ARNs\\. You are allowed to provide up to 50 ARNs\\. An empty list is not permitted\\. This is a required key\\. \nFor more information, see [Resource\\-based policies in CodeGuru Profiler](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html) in the *Amazon CodeGuru Profiler user guide*, [ConfigureAgent](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html), and [PostAgentProfile](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The agent permissions attached to this profiling group\\. This action group grants `ConfigureAgent` and `PostAgentProfile` permissions to perform actions required by the profiling agent\\. The Json consists of key `Principals`\\. \n*Principals*: A list of string ARNs for the roles and users you want to grant access to the profiling group\\. Wildcards are not supported in the ARNs\\. You are allowed to provide up to 50 ARNs\\. An empty list is not permitted\\. This is a required key\\. \nFor more information, see [Resource\\-based policies in CodeGuru Profiler](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html) in the *Amazon CodeGuru Profiler user guide*, [ConfigureAgent](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html), and [PostAgentProfile](https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html)\\. \n*Required*: No \n*Type*: [AgentPermissions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeguruprofiler-profilinggroup-agentpermissions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AgentPermissions" }, "AnomalyDetectionNotificationConfiguration": { @@ -35630,6 +36292,8 @@ "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Principals", "type": "array" } }, @@ -35869,12 +36533,12 @@ "additionalProperties": false, "properties": { "MaximumCount": { - "markdownDescription": "The maximum number of artifacts allowed for the action type\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum number of artifacts allowed for the action type\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaximumCount", "type": "number" }, "MinimumCount": { - "markdownDescription": "The minimum number of artifacts allowed for the action type\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The minimum number of artifacts allowed for the action type\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MinimumCount", "type": "number" } @@ -35889,37 +36553,37 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "The description of the action configuration property that is displayed to users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `160` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the action configuration property that is displayed to users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `160` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Description", "type": "string" }, "Key": { - "markdownDescription": "Whether the configuration property is a key\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Whether the configuration property is a key\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Key", "type": "boolean" }, "Name": { - "markdownDescription": "The name of the action configuration property\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the action configuration property\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, "Queryable": { - "markdownDescription": "Indicates that the property is used with `PollForJobs`\\. When creating a custom action, an action can have up to one queryable property\\. If it has one, that property must be both required and not secret\\. \nIf you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions\\. The value must be less than or equal to twenty \\(20\\) characters\\. The value can contain only alphanumeric characters, underscores, and hyphens\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates that the property is used with `PollForJobs`\\. When creating a custom action, an action can have up to one queryable property\\. If it has one, that property must be both required and not secret\\. \nIf you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions\\. The value must be less than or equal to twenty \\(20\\) characters\\. The value can contain only alphanumeric characters, underscores, and hyphens\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Queryable", "type": "boolean" }, "Required": { - "markdownDescription": "Whether the configuration property is a required value\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Whether the configuration property is a required value\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Required", "type": "boolean" }, "Secret": { - "markdownDescription": "Whether the configuration property is secret\\. Secrets are hidden from all calls except for `GetJobDetails`, `GetThirdPartyJobDetails`, `PollForJobs`, and `PollForThirdPartyJobs`\\. \nWhen updating a pipeline, passing \\* \\* \\* \\* \\* without changing any other values of the action preserves the previous value of the secret\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Whether the configuration property is secret\\. Secrets are hidden from all calls except for `GetJobDetails`, `GetThirdPartyJobDetails`, `PollForJobs`, and `PollForThirdPartyJobs`\\. \nWhen updating a pipeline, passing \\* \\* \\* \\* \\* without changing any other values of the action preserves the previous value of the secret\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Secret", "type": "boolean" }, "Type": { - "markdownDescription": "The type of the configuration property\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Boolean | Number | String` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of the configuration property\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Boolean | Number | String` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -35936,22 +36600,22 @@ "additionalProperties": false, "properties": { "EntityUrlTemplate": { - "markdownDescription": "The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group\\. This link is provided as part of the action display in the pipeline\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group\\. This link is provided as part of the action display in the pipeline\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EntityUrlTemplate", "type": "string" }, "ExecutionUrlTemplate": { - "markdownDescription": "The URL returned to the CodePipeline console that contains a link to the top\\-level landing page for the external system, such as the console page for CodeDeploy\\. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The URL returned to the CodePipeline console that contains a link to the top\\-level landing page for the external system, such as the console page for CodeDeploy\\. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ExecutionUrlTemplate", "type": "string" }, "RevisionUrlTemplate": { - "markdownDescription": "The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RevisionUrlTemplate", "type": "string" }, "ThirdPartyConfigurationUrl": { - "markdownDescription": "The URL of a sign\\-up page where users can sign up for an external service and perform initial configuration of the action provided by that service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The URL of a sign\\-up page where users can sign up for an external service and perform initial configuration of the action provided by that service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ThirdPartyConfigurationUrl", "type": "string" } @@ -36090,7 +36754,7 @@ "items": { "$ref": "#/definitions/AWS::CodePipeline::Pipeline.InputArtifact" }, - "markdownDescription": "The name or ID of the artifact consumed by the action, such as a test or build artifact\\. \nFor a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource\\. For more information, see the [CodeBuild action reference page](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeBuild.html) in the *AWS CodePipeline User Guide*\\.\n*Required*: No \n*Type*: List of [InputArtifact](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name or ID of the artifact consumed by the action, such as a test or build artifact\\. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of input artifacts\\. To refer to the action configuration specification by action provider, see the [Action structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) in the *AWS CodePipeline User Guide*\\. \nFor a CodeBuild action with multiple input artifacts, one of your input sources must be designated the PrimarySource\\. For more information, see the [CodeBuild action reference page](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeBuild.html) in the *AWS CodePipeline User Guide*\\.\n*Required*: No \n*Type*: List of [InputArtifact](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-inputartifacts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InputArtifacts", "type": "array" }, @@ -36108,7 +36772,7 @@ "items": { "$ref": "#/definitions/AWS::CodePipeline::Pipeline.OutputArtifact" }, - "markdownDescription": "The name or ID of the result of the action declaration, such as a test or build artifact\\. \n*Required*: No \n*Type*: List of [OutputArtifact](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name or ID of the result of the action declaration, such as a test or build artifact\\. While the field is not a required parameter, most actions have an action configuration that requires a specified quantity of output artifacts\\. To refer to the action configuration specification by action provider, see the [Action structure reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference.html) in the *AWS CodePipeline User Guide*\\. \n*Required*: No \n*Type*: List of [OutputArtifact](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stages-actions-outputartifacts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OutputArtifacts", "type": "array" }, @@ -36235,7 +36899,7 @@ "additionalProperties": false, "properties": { "Id": { - "markdownDescription": "The ID used to identify the key\\. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN\\. \nAliases are recognized only in the account that created the AWS KMS key\\. For cross\\-account actions, you can only use the key ID or key ARN to identify the key\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID used to identify the key\\. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN\\. \nAliases are recognized only in the account that created the AWS KMS key\\. For cross\\-account actions, you can only use the key ID or key ARN to identify the key\\. Cross\\-account actions involve using the role from the other account \\(AccountB\\), so specifying the key ID will use the key from the other account \\(AccountB\\)\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Id", "type": "string" }, @@ -36255,7 +36919,7 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of the artifact to be worked on \\(for example, \"My App\"\\)\\. \nThe input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact\\. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z0-9_\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the artifact to be worked on \\(for example, \"My App\"\\)\\. \nArtifacts are the files that are worked on by actions in the pipeline\\. See the action configuration for each action for details about artifact parameters\\. For example, the S3 source action input artifact is a file name \\(or file path\\), and the files are generally provided as a ZIP file\\. Example artifact name: SampleApp\\_Windows\\.zip \nThe input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact\\. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z0-9_\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" } @@ -36516,7 +37180,7 @@ "title": "Code" }, "ConnectionArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectionArn", "type": "string" }, @@ -36738,7 +37402,7 @@ "additionalProperties": false, "properties": { "CreatedBy": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CreatedBy", "type": "string" }, @@ -36748,7 +37412,7 @@ "type": "string" }, "EventTypeId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventTypeId", "type": "string" }, @@ -36756,7 +37420,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of event types associated with this notification rule\\. For a complete list of event types and IDs, see [Notification concepts](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api) in the *Developer Tools Console User Guide*\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of event types associated with this notification rule\\. For a complete list of event types and IDs, see [Notification concepts](https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api) in the *Developer Tools Console User Guide*\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventTypeIds", "type": "array" }, @@ -36776,12 +37440,12 @@ "type": "string" }, "Tags": { - "markdownDescription": "A list of tags to apply to this notification rule\\. Key names cannot start with \"`aws`\"\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of tags to apply to this notification rule\\. Key names cannot start with \"`aws`\"\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "object" }, "TargetAddress": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TargetAddress", "type": "string" }, @@ -36789,7 +37453,7 @@ "items": { "$ref": "#/definitions/AWS::CodeStarNotifications::NotificationRule.Target" }, - "markdownDescription": "A list of Amazon Resource Names \\(ARNs\\) of AWS Chatbot topics and AWS Chatbot clients to associate with the notification rule\\. \n*Required*: Yes \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestarnotifications-notificationrule-target.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of Amazon Resource Names \\(ARNs\\) of Amazon Simple Notification Service topics and AWS Chatbot clients to associate with the notification rule\\. \n*Required*: Yes \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestarnotifications-notificationrule-target.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Targets", "type": "array" } @@ -37248,25 +37912,27 @@ "type": "array" }, "DeletionProtection": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeletionProtection", "type": "string" }, "DeviceConfiguration": { "$ref": "#/definitions/AWS::Cognito::UserPool.DeviceConfiguration", - "markdownDescription": "The device configuration\\. \n*Required*: No \n*Type*: [DeviceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The device\\-remembering configuration for a user pool\\. A null value indicates that you have deactivated device remembering in your user pool\\. \nWhen you provide a value for any `DeviceConfiguration` field, you activate the Amazon Cognito device\\-remembering feature\\.\n*Required*: No \n*Type*: [DeviceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeviceConfiguration" }, "EmailConfiguration": { "$ref": "#/definitions/AWS::Cognito::UserPool.EmailConfiguration", - "markdownDescription": "The email configuration\\. \n*Required*: No \n*Type*: [EmailConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The email configuration of your user pool\\. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool\\. \n*Required*: No \n*Type*: [EmailConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailConfiguration" }, "EmailVerificationMessage": { - "markdownDescription": "A string representing the email verification message\\. EmailVerificationMessage is allowed only if [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This parameter is no longer used\\. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailVerificationMessage", "type": "string" }, "EmailVerificationSubject": { - "markdownDescription": "A string representing the email verification subject\\. EmailVerificationSubject is allowed only if [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This parameter is no longer used\\. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailVerificationSubject", "type": "string" }, @@ -37284,7 +37950,7 @@ "title": "LambdaConfig" }, "MfaConfiguration": { - "markdownDescription": "The multi\\-factor \\(MFA\\) configuration\\. Valid values include: \n+ `OFF` MFA won't be used for any users\\.\n+ `ON` MFA is required for all users to sign in\\.\n+ `OPTIONAL` MFA will be required only for individual users who have an MFA factor activated\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `OFF | ON | OPTIONAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The multi\\-factor authentication \\(MFA\\) configuration\\. Valid values include: \n+ `OFF` MFA won't be used for any users\\.\n+ `ON` MFA is required for all users to sign in\\.\n+ `OPTIONAL` MFA will be required only for individual users who have an MFA factor activated\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `OFF | ON | OPTIONAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MfaConfiguration", "type": "string" }, @@ -37297,7 +37963,7 @@ "items": { "$ref": "#/definitions/AWS::Cognito::UserPool.SchemaAttribute" }, - "markdownDescription": "", + "markdownDescription": "The schema attributes for the new user pool\\. These attributes can be standard or custom attributes\\. \n During a user pool update, you can add new schema attributes but you cannot modify or delete an existing schema attribute\\.\n*Required*: No \n*Type*: List of [SchemaAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Schema", "type": "array" }, @@ -37308,16 +37974,18 @@ }, "SmsConfiguration": { "$ref": "#/definitions/AWS::Cognito::UserPool.SmsConfiguration", - "markdownDescription": "The SMS configuration\\. \n*Required*: No \n*Type*: [SmsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service\\. To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management \\(IAM\\) role in your AWS account\\. \n*Required*: No \n*Type*: [SmsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-smsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SmsConfiguration" }, "SmsVerificationMessage": { - "markdownDescription": "A string representing the SMS verification message\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `140` \n*Pattern*: `.*\\{####\\}.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This parameter is no longer used\\. See [VerificationMessageTemplateType](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `140` \n*Pattern*: `.*\\{####\\}.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SmsVerificationMessage", "type": "string" }, "UserAttributeUpdateSettings": { - "$ref": "#/definitions/AWS::Cognito::UserPool.UserAttributeUpdateSettings" + "$ref": "#/definitions/AWS::Cognito::UserPool.UserAttributeUpdateSettings", + "markdownDescription": "The settings for updates to user attributes\\. These settings include the property `AttributesRequireVerificationBeforeUpdate`, a user\\-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes\\. For more information, see [ Verifying updates to email addresses and phone numbers](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates)\\. \n*Required*: No \n*Type*: [UserAttributeUpdateSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-userattributeupdatesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserAttributeUpdateSettings" }, "UserPoolAddOns": { "$ref": "#/definitions/AWS::Cognito::UserPool.UserPoolAddOns", @@ -37403,7 +38071,7 @@ "title": "InviteMessageTemplate" }, "UnusedAccountValidityDays": { - "markdownDescription": "The user account expiration limit, in days, after which the account is no longer usable\\. To reset the account after that time limit, you must call `AdminCreateUser` again, specifying `\"RESEND\"` for the `MessageAction` parameter\\. The default value for this parameter is 7\\. \nIf you set a value for `TemporaryPasswordValidityDays` in `PasswordPolicy`, that value will be used, and `UnusedAccountValidityDays` will be no longer be an available parameter for that user pool\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `365` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable\\. To reset the account after that time limit, you must call `AdminCreateUser` again, specifying `\"RESEND\"` for the `MessageAction` parameter\\. The default value for this parameter is 7\\. \nIf you set a value for `TemporaryPasswordValidityDays` in `PasswordPolicy`, that value will be used, and `UnusedAccountValidityDays` will be no longer be an available parameter for that user pool\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `365` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UnusedAccountValidityDays", "type": "number" } @@ -37446,12 +38114,12 @@ "additionalProperties": false, "properties": { "ChallengeRequiredOnNewDevice": { - "markdownDescription": "When true, device authentication can replace SMS and time\\-based one\\-time password \\(TOTP\\) factors for multi\\-factor authentication \\(MFA\\)\\. \nUsers that sign in with devices that have not been confirmed or remembered will still have to provide a second factor, whether or not ChallengeRequiredOnNewDevice is true, when your user pool requires MFA\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When true, a remembered device can sign in with device authentication instead of SMS and time\\-based one\\-time password \\(TOTP\\) factors for multi\\-factor authentication \\(MFA\\)\\. \nWhether or not `ChallengeRequiredOnNewDevice` is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ChallengeRequiredOnNewDevice", "type": "boolean" }, "DeviceOnlyRememberedOnUserPrompt": { - "markdownDescription": "When true, users can opt in to remembering their device\\. Your app code must use callback functions to return the user's choice\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a [ ConfirmDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) API request\\. In your app, create a prompt for your user to choose whether they want to remember their device\\. Return the user's choice in an [ UpdateDeviceStatus](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) API request\\. \nWhen `DeviceOnlyRememberedOnUserPrompt` is `false`, Amazon Cognito immediately remembers devices that you register in a `ConfirmDevice` API request\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeviceOnlyRememberedOnUserPrompt", "type": "boolean" } @@ -37467,7 +38135,7 @@ "type": "string" }, "EmailSendingAccount": { - "markdownDescription": "Specifies whether Amazon Cognito emails your users by using its built\\-in email functionality or your Amazon Simple Email Service email configuration\\. Specify one of the following values: \nCOGNITO\\_DEFAULT \nWhen Amazon Cognito emails your users, it uses its built\\-in email functionality\\. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool\\. For typical production environments, the default email limit is less than the required delivery volume\\. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration\\. \nTo look up the email delivery limit for the default option, see [Limits in ](https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html) in the * Developer Guide*\\. \nThe default FROM address is `no-reply@verificationemail.com`\\. To customize the FROM address, provide the Amazon Resource Name \\(ARN\\) of an Amazon SES verified email address for the `SourceArn` parameter\\. \n If EmailSendingAccount is COGNITO\\_DEFAULT, you can't use the following parameters: \n+ EmailVerificationMessage\n+ EmailVerificationSubject\n+ InviteMessageTemplate\\.EmailMessage\n+ InviteMessageTemplate\\.EmailSubject\n+ VerificationMessageTemplate\\.EmailMessage\n+ VerificationMessageTemplate\\.EmailMessageByLink\n+ VerificationMessageTemplate\\.EmailSubject,\n+ VerificationMessageTemplate\\.EmailSubjectByLink\nDEVELOPER EmailSendingAccount is required\\. \nDEVELOPER \nWhen Amazon Cognito emails your users, it uses your Amazon SES configuration\\. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address\\. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account\\. \nIf you use this option, you must provide the ARN of an Amazon SES verified email address for the `SourceArn` parameter\\. \nBefore Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf\\. When you update your user pool with this option, Amazon Cognito creates a *service\\-linked role*, which is a type of role, in your AWS account\\. This role contains the permissions that allow to access Amazon SES and send email messages with your address\\. For more information about the service\\-linked role that Amazon Cognito creates, see [Using Service\\-Linked Roles for Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html) in the *Amazon Cognito Developer Guide*\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `COGNITO_DEFAULT | DEVELOPER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether Amazon Cognito uses its built\\-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration\\. Specify one of the following values: \nCOGNITO\\_DEFAULT \nWhen Amazon Cognito emails your users, it uses its built\\-in email functionality\\. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool\\. For typical production environments, the default email limit is less than the required delivery volume\\. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration\\. \nTo look up the email delivery limit for the default option, see [Limits](https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html) in the *Amazon Cognito Developer Guide*\\. \nThe default FROM address is `no-reply@verificationemail.com`\\. To customize the FROM address, provide the Amazon Resource Name \\(ARN\\) of an Amazon SES verified email address for the `SourceArn` parameter\\. \nDEVELOPER \nWhen Amazon Cognito emails your users, it uses your Amazon SES configuration\\. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address\\. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account\\. \nIf you use this option, provide the ARN of an Amazon SES verified email address for the `SourceArn` parameter\\. \nBefore Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf\\. When you update your user pool with this option, Amazon Cognito creates a *service\\-linked role*, which is a type of role in your AWS account\\. This role contains the permissions that allow you to access Amazon SES and send email messages from your email address\\. For more information about the service\\-linked role that Amazon Cognito creates, see [Using Service\\-Linked Roles for Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/using-service-linked-roles.html) in the *Amazon Cognito Developer Guide*\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `COGNITO_DEFAULT | DEVELOPER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailSendingAccount", "type": "string" }, @@ -37482,7 +38150,7 @@ "type": "string" }, "SourceArn": { - "markdownDescription": "The ARN of a verified email address in Amazon SES\\. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the `EmailSendingAccount` parameter: \n+ If you specify `COGNITO_DEFAULT`, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built\\-in email account\\.\n+ If you specify `DEVELOPER`, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf\\.\n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN of a verified email address in Amazon SES\\. Amazon Cognito uses this email address in one of the following ways, depending on the value that you specify for the `EmailSendingAccount` parameter: \n+ If you specify `COGNITO_DEFAULT`, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built\\-in email account\\.\n+ If you specify `DEVELOPER`, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf\\.\nThe Region value of the `SourceArn` parameter must indicate a supported AWS Region of your user pool\\. Typically, the Region in the `SourceArn` and the user pool Region are the same\\. For more information, see [Amazon SES email configuration regions](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html#user-pool-email-developer-region-mapping) in the [Amazon Cognito Developer Guide](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceArn", "type": "string" } @@ -37626,7 +38294,7 @@ "type": "boolean" }, "TemporaryPasswordValidityDays": { - "markdownDescription": "The number of days a temporary password is valid in the password policy\\. If the user doesn't sign in during this time, an administrator must reset their password\\. \nWhen you set `TemporaryPasswordValidityDays` for a user pool, you can no longer set the deprecated `UnusedAccountValidityDays` value for that user pool\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `365` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of days a temporary password is valid in the password policy\\. If the user doesn't sign in during this time, an administrator must reset their password\\. \nWhen you set `TemporaryPasswordValidityDays` for a user pool, you can no longer set a value for the legacy `UnusedAccountValidityDays` parameter in that user pool\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `365` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TemporaryPasswordValidityDays", "type": "number" } @@ -37674,7 +38342,7 @@ "type": "boolean" }, "Mutable": { - "markdownDescription": "Specifies whether the value of the attribute can be changed\\. \nFor any user pool attribute that is mapped to an identity provider attribute, you must set this parameter to `true`\\. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider\\. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute\\. For more information, see [Specifying Identity Provider Attribute Mappings for Your User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the value of the attribute can be changed\\. \nFor any user pool attribute that is mapped to an IdP attribute, you must set this parameter to `true`\\. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP\\. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute\\. For more information, see [Specifying Identity Provider Attribute Mappings for Your User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Mutable", "type": "boolean" }, @@ -37715,7 +38383,7 @@ "type": "string" }, "SnsRegion": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS Region to use with Amazon SNS integration\\. You can choose the same Region as your user pool, or a supported **Legacy Amazon SNS alternate Region**\\. \n Amazon Cognito resources in the Asia Pacific \\(Seoul\\) AWS Region must use your Amazon SNS configuration in the Asia Pacific \\(Tokyo\\) Region\\. For more information, see [SMS message settings for Amazon Cognito user pools](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `5` \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SnsRegion", "type": "string" } @@ -37745,6 +38413,8 @@ "items": { "type": "string" }, + "markdownDescription": "Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute\\. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address\\. Amazon Cognito doesn\u2019t change the value of the attribute until your user responds to the verification message and confirms the new value\\. \nYou can verify an updated email address or phone number with a [VerifyUserAttribute](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html) API request\\. You can also call the [AdminUpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html) API and set `email_verified` or `phone_number_verified` to true\\. \nWhen `AttributesRequireVerificationBeforeUpdate` is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them\\. In a user pool where `AttributesRequireVerificationBeforeUpdate` is false, API operations that change attribute values can immediately update a user\u2019s `email` or `phone_number` attribute\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AttributesRequireVerificationBeforeUpdate", "type": "array" } }, @@ -37768,7 +38438,7 @@ "additionalProperties": false, "properties": { "CaseSensitive": { - "markdownDescription": "Specifies whether username case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs\\. \nValid values include: \n+ ** `True` **: Enables case sensitivity for all username input\\. When this option is set to `True`, users must sign in using the exact capitalization of their given username, such as \u201cUserName\u201d\\. This is the default value\\.\n+ ** `False` **: Enables case insensitivity for all username input\\. For example, when this option is set to `False`, users can sign in using either \"username\" or \"Username\"\\. This option also enables both `preferred_username` and `email` alias to be case insensitive, in addition to the `username` attribute\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs\\. For most use cases, set case sensitivity to `False` \\(case insensitive\\) as a best practice\\. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name\\. \nValid values include: \nTrue \nEnables case sensitivity for all username input\\. When this option is set to `True`, users must sign in using the exact capitalization of their given username, such as \u201cUserName\u201d\\. This is the default value\\. \nFalse \nEnables case insensitivity for all username input\\. For example, when this option is set to `False`, users can sign in using `username`, `USERNAME`, or `UserName`\\. This option also enables both `preferred_username` and `email` alias to be case insensitive, in addition to the `username` attribute\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CaseSensitive", "type": "boolean" } @@ -37784,27 +38454,27 @@ "type": "string" }, "EmailMessage": { - "markdownDescription": "The email message template\\. EmailMessage is allowed only if [ EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailMessage", "type": "string" }, "EmailMessageByLink": { - "markdownDescription": "The email message template for sending a confirmation link to the user\\. EmailMessageByLink is allowed only if [ EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{##[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*##\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `20000` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{##[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*##\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailMessageByLink", "type": "string" }, "EmailSubject": { - "markdownDescription": "The subject line for the email message template\\. EmailSubject is allowed only if [EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailSubject", "type": "string" }, "EmailSubjectByLink": { - "markdownDescription": "The subject line for the email message template for sending a confirmation link to the user\\. EmailSubjectByLink is allowed only [ EmailSendingAccount](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) is DEVELOPER\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `140` \n*Pattern*: `[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EmailSubjectByLink", "type": "string" }, "SmsMessage": { - "markdownDescription": "The SMS message template\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `140` \n*Pattern*: `.*\\{####\\}.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The template for SMS messages that Amazon Cognito sends to your users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `140` \n*Pattern*: `.*\\{####\\}.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SmsMessage", "type": "string" } @@ -37847,7 +38517,7 @@ "additionalProperties": false, "properties": { "AccessTokenValidity": { - "markdownDescription": "The time limit, after which the access token is no longer valid and cannot be used\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The access token time limit\\. After this limit expires, your user can't use their access token\\. To specify the time unit for `AccessTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request\\. \nFor example, when you set `AccessTokenValidity` to `10` and `TokenValidityUnits` to `hours`, your user can authorize access with their access token for 10 hours\\. \nThe default time unit for `AccessTokenValidity` in an API request is hours\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessTokenValidity", "type": "number" }, @@ -37855,7 +38525,7 @@ "items": { "type": "string" }, - "markdownDescription": "The allowed OAuth flows\\. \nSet to `code` to initiate a code grant flow, which provides an authorization code as the response\\. This code can be exchanged for access tokens with the token endpoint\\. \nSet to `implicit` to specify that the client should get the access token \\(and, optionally, ID token, based on scopes\\) directly\\. \nSet to `client_credentials` to specify that the client should get the access token \\(and, optionally, ID token, based on scopes\\) from the token endpoint using a combination of client and client\\_secret\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The allowed OAuth flows\\. \ncode \nUse a code grant flow, which provides an authorization code as the response\\. This code can be exchanged for access tokens with the `/oauth2/token` endpoint\\. \nimplicit \nIssue the access token \\(and, optionally, ID token, based on scopes\\) directly to your user\\. \nclient\\_credentials \nIssue the access token from the `/oauth2/token` endpoint directly to a non\\-person user using a combination of the client ID and client secret\\.\n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowedOAuthFlows", "type": "array" }, @@ -37868,23 +38538,25 @@ "items": { "type": "string" }, - "markdownDescription": "The allowed OAuth scopes\\. Possible values provided by OAuth are: `phone`, `email`, `openid`, and `profile`\\. Possible values provided by AWS are: `aws.cognito.signin.user.admin`\\. Custom scopes created in Resource Servers are also supported\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The allowed OAuth scopes\\. Possible values provided by OAuth are `phone`, `email`, `openid`, and `profile`\\. Possible values provided by AWS are `aws.cognito.signin.user.admin`\\. Custom scopes created in Resource Servers are also supported\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowedOAuthScopes", "type": "array" }, "AnalyticsConfiguration": { "$ref": "#/definitions/AWS::Cognito::UserPoolClient.AnalyticsConfiguration", - "markdownDescription": "The Amazon Pinpoint analytics configuration for collecting metrics for this user pool\\. \nIn AWS Regions where isn't available, User Pools only supports sending events to Amazon Pinpoint projects in AWS Region us\\-east\\-1\\. In Regions where is available, User Pools will support sending events to Amazon Pinpoint projects within that same Region\\. \n*Required*: No \n*Type*: [AnalyticsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign\\. \nIn AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us\\-east\\-1\\. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region\\.\n*Required*: No \n*Type*: [AnalyticsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-analyticsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AnalyticsConfiguration" }, "AuthSessionValidity": { + "markdownDescription": "Amazon Cognito creates a session token for each API request in an authentication flow\\. `AuthSessionValidity` is the duration, in minutes, of that session token\\. Your user pool native user must respond to each authentication challenge before the session expires\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `3` \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AuthSessionValidity", "type": "number" }, "CallbackURLs": { "items": { "type": "string" }, - "markdownDescription": "A list of allowed redirect \\(callback\\) URLs for the identity providers\\. \nA redirect URI must: \n+ Be an absolute URI\\.\n+ Be registered with the authorization server\\.\n+ Not include a fragment component\\.\nSee [OAuth 2\\.0 \\- Redirection Endpoint](https://tools.ietf.org/html/rfc6749#section-3.1.2)\\. \nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only\\. \nApp callback URLs such as myapp://example are also supported\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of allowed redirect \\(callback\\) URLs for the IdPs\\. \nA redirect URI must: \n+ Be an absolute URI\\.\n+ Be registered with the authorization server\\.\n+ Not include a fragment component\\.\nSee [OAuth 2\\.0 \\- Redirection Endpoint](https://tools.ietf.org/html/rfc6749#section-3.1.2)\\. \nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only\\. \nApp callback URLs such as myapp://example are also supported\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CallbackURLs", "type": "array" }, @@ -37899,6 +38571,8 @@ "type": "string" }, "EnablePropagateAdditionalUserContextData": { + "markdownDescription": "Activates the propagation of additional user context data\\. For more information about propagation of user context data, see [ Adding advanced security to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html)\\. If you don\u2019t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security\\. You can only activate `EnablePropagateAdditionalUserContextData` in an app client that has a client secret\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnablePropagateAdditionalUserContextData", "type": "boolean" }, "EnableTokenRevocation": { @@ -37910,7 +38584,7 @@ "items": { "type": "string" }, - "markdownDescription": "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\\. Note that values with `ALLOW_` prefix must be used only along with the `ALLOW_` prefix\\. \nValid values include: \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*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The authentication flows that you want your user pool client to support\\. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password \\(SRP\\), a user name and password, or a custom authentication process that you define with Lambda functions\\. \nIf you don't specify a value for `ExplicitAuthFlows`, your user client supports `ALLOW_REFRESH_TOKEN_AUTH`, `ALLOW_USER_SRP_AUTH`, and `ALLOW_CUSTOM_AUTH`\\.\nValid values include: \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, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password \\(SRP\\) protocol to securely transmit the password\\.\n+ `ALLOW_CUSTOM_AUTH`: Enable 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\\.\nIn some environments, you will see the values `ADMIN_NO_SRP_AUTH`, `CUSTOM_AUTH_FLOW_ONLY`, or `USER_PASSWORD_AUTH`\\. You can't assign these legacy `ExplicitAuthFlows` values to user pool clients at the same time as values that begin with `ALLOW_`, like `ALLOW_USER_SRP_AUTH`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExplicitAuthFlows", "type": "array" }, @@ -37920,7 +38594,7 @@ "type": "boolean" }, "IdTokenValidity": { - "markdownDescription": "The time limit, after which the ID token is no longer valid and cannot be used\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID token time limit\\. After this limit expires, your user can't use their ID token\\. To specify the time unit for `IdTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request\\. \nFor example, when you set `IdTokenValidity` as `10` and `TokenValidityUnits` as `hours`, your user can authenticate their session with their ID token for 10 hours\\. \nThe default time unit for `AccessTokenValidity` in an API request is hours\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdTokenValidity", "type": "number" }, @@ -37928,7 +38602,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of allowed logout URLs for the identity providers\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of allowed logout URLs for the IdPs\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogoutURLs", "type": "array" }, @@ -37946,7 +38620,7 @@ "type": "array" }, "RefreshTokenValidity": { - "markdownDescription": "The time limit, in days, after which the refresh token is no longer valid and can't be used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `315360000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The refresh token time limit\\. After this limit expires, your user can't use their refresh token\\. To specify the time unit for `RefreshTokenValidity` as `seconds`, `minutes`, `hours`, or `days`, set a `TokenValidityUnits` value in your API request\\. \nFor example, when you set `RefreshTokenValidity` as `10` and `TokenValidityUnits` as `days`, your user can refresh their session and retrieve new access and ID tokens for 10 days\\. \nThe default time unit for `RefreshTokenValidity` in an API request is days\\. You can't set `RefreshTokenValidity` to 0\\. If you do, Amazon Cognito overrides the value with the default value of 30 days\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RefreshTokenValidity", "type": "number" }, @@ -37954,13 +38628,13 @@ "items": { "type": "string" }, - "markdownDescription": "A list of provider names for the identity providers that are supported on this client\\. The following are supported: `COGNITO`, `Facebook`, `SignInWithApple`, `Google` and `LoginWithAmazon`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of provider names for the identity providers \\(IdPs\\) that are supported on this client\\. The following are supported: `COGNITO`, `Facebook`, `Google`, `SignInWithApple`, and `LoginWithAmazon`\\. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example `MySAMLIdP` or `MyOIDCIdP`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SupportedIdentityProviders", "type": "array" }, "TokenValidityUnits": { "$ref": "#/definitions/AWS::Cognito::UserPoolClient.TokenValidityUnits", - "markdownDescription": "The units in which the validity times are represented in\\. Default for RefreshToken is days, and default for ID and access tokens are hours\\. \n*Required*: No \n*Type*: [TokenValidityUnits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The units in which the validity times are represented\\. The default unit for RefreshToken is days, and default for ID and access tokens are hours\\. \n*Required*: No \n*Type*: [TokenValidityUnits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpoolclient-tokenvalidityunits.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TokenValidityUnits" }, "UserPoolId": { @@ -37972,7 +38646,7 @@ "items": { "type": "string" }, - "markdownDescription": "The user pool attributes that the app client can write to\\. \nIf your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes\\. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider\\. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute\\. For more information, see [Specifying Identity Provider Attribute Mappings for Your User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user pool attributes that the app client can write to\\. \nIf your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes\\. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP\\. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute\\. For more information, see [Specifying IdP Attribute Mappings for Your user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WriteAttributes", "type": "array" } @@ -38027,7 +38701,7 @@ "type": "string" }, "UserDataShared": { - "markdownDescription": "If `UserDataShared` is `true`, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If `UserDataShared` is `true`, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UserDataShared", "type": "boolean" } @@ -38038,17 +38712,17 @@ "additionalProperties": false, "properties": { "AccessToken": { - "markdownDescription": "A time unit in \u201cseconds\u201d, \u201cminutes\u201d, \u201chours\u201d or \u201cdays\u201d for the value in AccessTokenValidity, defaults to hours\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A time unit of `seconds`, `minutes`, `hours`, or `days` for the value that you set in the `AccessTokenValidity` parameter\\. The default `AccessTokenValidity` time unit is hours\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `days | hours | minutes | seconds` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessToken", "type": "string" }, "IdToken": { - "markdownDescription": "A time unit in \u201cseconds\u201d, \u201cminutes\u201d, \u201chours\u201d or \u201cdays\u201d for the value in IdTokenValidity, defaults to hours\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A time unit of `seconds`, `minutes`, `hours`, or `days` for the value that you set in the `IdTokenValidity` parameter\\. The default `IdTokenValidity` time unit is hours\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `days | hours | minutes | seconds` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdToken", "type": "string" }, "RefreshToken": { - "markdownDescription": "A time unit in \u201cseconds\u201d, \u201cminutes\u201d, \u201chours\u201d or \u201cdays\u201d for the value in RefreshTokenValidity, defaults to days\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A time unit of `seconds`, `minutes`, `hours`, or `days` for the value that you set in the `RefreshTokenValidity` parameter\\. The default `RefreshTokenValidity` time unit is days\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `days | hours | minutes | seconds` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RefreshToken", "type": "string" } @@ -38190,7 +38864,7 @@ "type": "string" }, "Precedence": { - "markdownDescription": "A non\\-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool\\. Zero is the highest precedence value\\. Groups with lower `Precedence` values take precedence over groups with higher ornull `Precedence` values\\. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims\\. \nTwo groups can have the same `Precedence` value\\. If this happens, neither group takes precedence over the other\\. If two groups with the same `Precedence` have the same role ARN, that role is used in the `cognito:preferred_role` claim in tokens for users in each group\\. If the two groups have different role ARNs, the `cognito:preferred_role` claim isn't set in users' tokens\\. \nThe default `Precedence` value is null\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A non\\-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool\\. Zero is the highest precedence value\\. Groups with lower `Precedence` values take precedence over groups with higher or null `Precedence` values\\. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the `cognito:roles` and `cognito:preferred_role` claims\\. \nTwo groups can have the same `Precedence` value\\. If this happens, neither group takes precedence over the other\\. If two groups with the same `Precedence` have the same role ARN, that role is used in the `cognito:preferred_role` claim in tokens for users in each group\\. If the two groups have different role ARNs, the `cognito:preferred_role` claim isn't set in users' tokens\\. \nThe default `Precedence` value is null\\. The maximum `Precedence` value is `2^31-1`\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Precedence", "type": "number" }, @@ -38267,7 +38941,7 @@ "additionalProperties": false, "properties": { "AttributeMapping": { - "markdownDescription": "A mapping of identity provider attributes to standard and custom user pool attributes\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A mapping of IdP attributes to standard and custom user pool attributes\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeMapping", "type": "object" }, @@ -38275,22 +38949,22 @@ "items": { "type": "string" }, - "markdownDescription": "A list of identity provider identifiers\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of IdP identifiers\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdpIdentifiers", "type": "array" }, "ProviderDetails": { - "markdownDescription": "The identity provider details\\. The following list describes the provider detail keys for each identity provider type\\. \n+ For Google and Login with Amazon:\n + client\\_id\n + client\\_secret\n + authorize\\_scopes\n+ For Facebook:\n + client\\_id\n + client\\_secret\n + authorize\\_scopes\n + api\\_version\n+ For Sign in with Apple:\n + client\\_id\n + team\\_id\n + key\\_id\n + private\\_key\n + authorize\\_scopes\n+ For OpenID Connect \\(OIDC\\) providers:\n + client\\_id\n + client\\_secret\n + attributes\\_request\\_method\n + oidc\\_issuer\n + authorize\\_scopes\n + authorize\\_url *if not available from discovery URL specified by oidc\\_issuer key* \n + token\\_url *if not available from discovery URL specified by oidc\\_issuer key* \n + attributes\\_url *if not available from discovery URL specified by oidc\\_issuer key* \n + jwks\\_uri *if not available from discovery URL specified by oidc\\_issuer key* \n + attributes\\_url\\_add\\_attributes *a read\\-only property that is set automatically* \n+ For SAML providers:\n + MetadataFile OR MetadataURL\n + IDPSignout \\(optional\\)\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The IdP details\\. The following list describes the provider detail keys for each IdP type\\. \n+ For Google and Login with Amazon:\n + client\\_id\n + client\\_secret\n + authorize\\_scopes\n+ For Facebook:\n + client\\_id\n + client\\_secret\n + authorize\\_scopes\n + api\\_version\n+ For Sign in with Apple:\n + client\\_id\n + team\\_id\n + key\\_id\n + private\\_key\n + authorize\\_scopes\n+ For OpenID Connect \\(OIDC\\) providers:\n + client\\_id\n + client\\_secret\n + attributes\\_request\\_method\n + oidc\\_issuer\n + authorize\\_scopes\n + The following keys are only present if Amazon Cognito didn't discover them at the `oidc_issuer` URL\\.\n + authorize\\_url \n + token\\_url \n + attributes\\_url \n + jwks\\_uri \n + Amazon Cognito sets the value of the following keys automatically\\. They are read\\-only\\.\n + attributes\\_url\\_add\\_attributes \n+ For SAML providers:\n + MetadataFile or MetadataURL\n + IDPSignout *optional* \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProviderDetails", "type": "object" }, "ProviderName": { - "markdownDescription": "The identity provider name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Pattern*: `[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The IdP name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `32` \n*Pattern*: `[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ProviderName", "type": "string" }, "ProviderType": { - "markdownDescription": "The identity provider type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Facebook | Google | LoginWithAmazon | OIDC | SAML | SignInWithApple` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The IdP type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Facebook | Google | LoginWithAmazon | OIDC | SAML | SignInWithApple` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ProviderType", "type": "string" }, @@ -38527,7 +39201,7 @@ "additionalProperties": false, "properties": { "EventAction": { - "markdownDescription": "The event action\\. \n+ `BLOCK` Choosing this action will block the request\\.\n+ `MFA_IF_CONFIGURED` Present an MFA challenge if user has configured it, else allow the request\\.\n+ `MFA_REQUIRED` Present an MFA challenge if user has configured it, else block the request\\.\n+ `NO_ACTION` Allow the user to sign in\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `BLOCK | MFA_IF_CONFIGURED | MFA_REQUIRED | NO_ACTION` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action to take in response to the account takeover action\\. Valid values are as follows: \n+ `BLOCK` Choosing this action will block the request\\.\n+ `MFA_IF_CONFIGURED` Present an MFA challenge if user has configured it, else allow the request\\.\n+ `MFA_REQUIRED` Present an MFA challenge if user has configured it, else block the request\\.\n+ `NO_ACTION` Allow the user to sign in\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `BLOCK | MFA_IF_CONFIGURED | MFA_REQUIRED | NO_ACTION` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventAction", "type": "string" }, @@ -39131,7 +39805,7 @@ }, "Source": { "$ref": "#/definitions/AWS::Config::ConfigRule.Source", - "markdownDescription": "Provides the rule owner \\(AWS or customer\\), the rule identifier, and the notifications that cause the function to evaluate your AWS resources\\. \n*Required*: Yes \n*Type*: [Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides the rule owner \\(` AWS ` for managed rules, `CUSTOM_POLICY` for Custom Policy rules, and `CUSTOM_LAMBDA` for Custom Lambda rules\\), the rule identifier, and the notifications that cause the function to evaluate your AWS resources\\. \n*Required*: Yes \n*Type*: [Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Source" } }, @@ -39165,12 +39839,18 @@ "additionalProperties": false, "properties": { "EnableDebugLogDelivery": { + "markdownDescription": "The boolean expression for enabling debug logging for your AWS Config Custom Policy rule\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableDebugLogDelivery", "type": "boolean" }, "PolicyRuntime": { + "markdownDescription": "The runtime system for your AWS Config Custom Policy rule\\. Guard is a policy\\-as\\-code language that allows you to write policies that are enforced by AWS Config Custom Policy rules\\. For more information about Guard, see the [Guard GitHub Repository](https://github.com/aws-cloudformation/cloudformation-guard)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `guard\\-2\\.x\\.x` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyRuntime", "type": "string" }, "PolicyText": { + "markdownDescription": "The policy definition containing the logic for your AWS Config Custom Policy rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyText", "type": "string" } }, @@ -39209,10 +39889,12 @@ "additionalProperties": false, "properties": { "CustomPolicyDetails": { - "$ref": "#/definitions/AWS::Config::ConfigRule.CustomPolicyDetails" + "$ref": "#/definitions/AWS::Config::ConfigRule.CustomPolicyDetails", + "markdownDescription": "Provides the runtime system, policy definition, and whether debug logging is enabled\\. Required when owner is set to `CUSTOM_POLICY`\\. \n*Required*: No \n*Type*: [CustomPolicyDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-custompolicydetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomPolicyDetails" }, "Owner": { - "markdownDescription": "Indicates whether AWS or the customer owns and manages the AWS Config rule\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AWS | CUSTOM_LAMBDA` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether AWS or the customer owns and manages the AWS Config rule\\. \n AWS Config Managed Rules are predefined rules owned by AWS\\. For more information, see [AWS Config Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html) in the * AWS Config developer guide*\\. \n AWS Config Custom Rules are rules that you can develop either with Guard \\(`CUSTOM_POLICY`\\) or AWS Lambda \\(`CUSTOM_LAMBDA`\\)\\. For more information, see [AWS Config Custom Rules ](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html) in the * AWS Config developer guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AWS | CUSTOM_LAMBDA | CUSTOM_POLICY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Owner", "type": "string" }, @@ -39220,12 +39902,12 @@ "items": { "$ref": "#/definitions/AWS::Config::ConfigRule.SourceDetail" }, - "markdownDescription": "Provides the source and type of the event that causes AWS Config to evaluate your AWS resources\\. \n*Required*: No \n*Type*: List of [SourceDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source-sourcedetails.html) \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides the source and the message types that cause AWS Config to evaluate your AWS resources against a rule\\. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic\\. \nIf the owner is set to `CUSTOM_POLICY`, the only acceptable values for the AWS Config rule trigger message type are `ConfigurationItemChangeNotification` and `OversizedConfigurationItemChangeNotification`\\. \n*Required*: No \n*Type*: List of [SourceDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-source-sourcedetails.html) \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceDetails", "type": "array" }, "SourceIdentifier": { - "markdownDescription": "For AWS Config managed rules, a predefined identifier from a list\\. For example, `IAM_PASSWORD_POLICY` is a managed rule\\. To reference a managed rule, see [Using AWS Config managed rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html)\\. \nFor custom rules, the identifier is the Amazon Resource Name \\(ARN\\) of the rule's AWS Lambda function, such as `arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "For AWS Config Managed rules, a predefined identifier from a list\\. For example, `IAM_PASSWORD_POLICY` is a managed rule\\. To reference a managed rule, see [List of AWS Config Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html)\\. \nFor AWS Config Custom Lambda rules, the identifier is the Amazon Resource Name \\(ARN\\) of the rule's AWS Lambda function, such as `arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name`\\. \nFor AWS Config Custom Policy rules, this field will be ignored\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceIdentifier", "type": "string" } @@ -39571,7 +40253,9 @@ "type": "string" }, "TemplateSSMDocumentDetails": { - "$ref": "#/definitions/AWS::Config::ConformancePack.TemplateSSMDocumentDetails" + "$ref": "#/definitions/AWS::Config::ConformancePack.TemplateSSMDocumentDetails", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [TemplateSSMDocumentDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-conformancepack-templatessmdocumentdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TemplateSSMDocumentDetails" } }, "required": [ @@ -39624,9 +40308,13 @@ "additionalProperties": false, "properties": { "DocumentName": { + "markdownDescription": "The name or Amazon Resource Name \\(ARN\\) of the SSM document to use to create a conformance pack\\. If you use the document name, AWS Config checks only your account and AWS Region for the SSM document\\. If you want to use an SSM document from another Region or account, you must provide the ARN\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,200}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DocumentName", "type": "string" }, "DocumentVersion": { + "markdownDescription": "The version of the SSM document to use to create a conformance pack\\. By default, AWS Config uses the latest version\\. \nThis field is optional\\.\n*Required*: No \n*Type*: String \n*Pattern*: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DocumentVersion", "type": "string" } }, @@ -39678,12 +40366,12 @@ "type": "string" }, "S3BucketName": { - "markdownDescription": "The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files\\. \nIf you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config\\. For more information, see [Permissions for the Amazon S3 Bucket](https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html) in the AWS Config Developer Guide\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files\\. \nIf you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config\\. For more information, see [Permissions for the Amazon S3 Bucket](https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html) in the * AWS Config Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3BucketName", "type": "string" }, "S3KeyPrefix": { - "markdownDescription": "The prefix for the specified Amazon S3 bucket\\. Do not include 'AWSLogs/' in your value as it is prepended automatically\\. Ex: BucketName/S3KeyPrefix/AWSLogs/sourceAccountID/Config/Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The prefix for the specified Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3KeyPrefix", "type": "string" }, @@ -39693,7 +40381,7 @@ "type": "string" }, "SnsTopicARN": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes\\. \nIf you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config\\. For more information, see [Permissions for the Amazon SNS Topic](https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html) in the AWS Config Developer Guide\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes\\. \nIf you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config\\. For more information, see [Permissions for the Amazon SNS Topic](https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html) in the * AWS Config Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SnsTopicARN", "type": "string" } @@ -39774,17 +40462,19 @@ "items": { "type": "string" }, - "markdownDescription": "A comma\\-separated list of accounts excluded from organization config rule\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A comma\\-separated list of accounts excluded from organization AWS Config rule\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExcludedAccounts", "type": "array" }, "OrganizationConfigRuleName": { - "markdownDescription": "The name that you assign to organization config rule\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name that you assign to organization AWS Config rule\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "OrganizationConfigRuleName", "type": "string" }, "OrganizationCustomPolicyRuleMetadata": { - "$ref": "#/definitions/AWS::Config::OrganizationConfigRule.OrganizationCustomPolicyRuleMetadata" + "$ref": "#/definitions/AWS::Config::OrganizationConfigRule.OrganizationCustomPolicyRuleMetadata", + "markdownDescription": "An object that specifies metadata for your organization's AWS Config Custom Policy rule\\. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of AWS resource, and organization trigger types that initiate AWS Config to evaluate AWS resources against a rule\\. \n*Required*: No \n*Type*: [OrganizationCustomPolicyRuleMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustompolicyrulemetadata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationCustomPolicyRuleMetadata" }, "OrganizationCustomRuleMetadata": { "$ref": "#/definitions/AWS::Config::OrganizationConfigRule.OrganizationCustomRuleMetadata", @@ -39830,42 +40520,64 @@ "items": { "type": "string" }, + "markdownDescription": "A list of accounts that you can enable debug logging for your organization AWS Config Custom Policy rule\\. List is null when debug logging is enabled for all accounts\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DebugLogDeliveryAccounts", "type": "array" }, "Description": { + "markdownDescription": "The description that you provide for your organization AWS Config Custom Policy rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "InputParameters": { + "markdownDescription": "A string, in JSON format, that is passed to your organization AWS Config Custom Policy rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputParameters", "type": "string" }, "MaximumExecutionFrequency": { + "markdownDescription": "The maximum frequency with which AWS Config runs evaluations for a rule\\. Your AWS Config Custom Policy rule is triggered when AWS Config delivers the configuration snapshot\\. For more information, see [ConfigSnapshotDeliveryProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-deliverychannel.html#cfn-config-deliverychannel-configsnapshotdeliveryproperties)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `One_Hour | Six_Hours | Three_Hours | Twelve_Hours | TwentyFour_Hours` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumExecutionFrequency", "type": "string" }, "OrganizationConfigRuleTriggerTypes": { "items": { "type": "string" }, + "markdownDescription": "The type of notification that initiates AWS Config to run an evaluation for a rule\\. For AWS Config Custom Policy rules, AWS Config supports change\\-initiated notification types: \n+ `ConfigurationItemChangeNotification` \\- Initiates an evaluation when AWS Config delivers a configuration item as a result of a resource change\\.\n+ `OversizedConfigurationItemChangeNotification` \\- Initiates an evaluation when AWS Config delivers an oversized configuration item\\. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationConfigRuleTriggerTypes", "type": "array" }, "PolicyText": { + "markdownDescription": "The policy definition containing the logic for your organization AWS Config Custom Policy rule\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyText", "type": "string" }, "ResourceIdScope": { + "markdownDescription": "The ID of the AWS resource that was evaluated\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `768` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceIdScope", "type": "string" }, "ResourceTypesScope": { "items": { "type": "string" }, + "markdownDescription": "The type of the AWS resource that was evaluated\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceTypesScope", "type": "array" }, "Runtime": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Runtime", "type": "string" }, "TagKeyScope": { + "markdownDescription": "One part of a key\\-value pair that make up a tag\\. A key is a general label that acts like a category for more specific tag values\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TagKeyScope", "type": "string" }, "TagValueScope": { + "markdownDescription": "The optional part of a key\\-value pair that make up a tag\\. A value acts as a descriptor within a tag category \\(key\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TagValueScope", "type": "string" } }, @@ -39879,12 +40591,12 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "The description that you provide for organization config rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description that you provide for your organization AWS Config rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "InputParameters": { - "markdownDescription": "A string, in JSON format, that is passed to organization config rule Lambda function\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string, in JSON format, that is passed to your organization AWS Config rule Lambda function\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InputParameters", "type": "string" }, @@ -39940,17 +40652,17 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "The description that you provide for organization config rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description that you provide for your organization AWS Config rule\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "InputParameters": { - "markdownDescription": "A string, in JSON format, that is passed to organization config rule Lambda function\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string, in JSON format, that is passed to your organization AWS Config rule Lambda function\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InputParameters", "type": "string" }, "MaximumExecutionFrequency": { - "markdownDescription": "The maximum frequency with which AWS Config runs evaluations for a rule\\. You are using an AWS Config managed rule that is triggered at a periodic frequency\\. \nBy default, rules with a periodic trigger are evaluated every 24 hours\\. To change the frequency, specify a valid value for the `MaximumExecutionFrequency` parameter\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `One_Hour | Six_Hours | Three_Hours | Twelve_Hours | TwentyFour_Hours` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum frequency with which AWS Config runs evaluations for a rule\\. This is for an AWS Config managed rule that is triggered at a periodic frequency\\. \nBy default, rules with a periodic trigger are evaluated every 24 hours\\. To change the frequency, specify a valid value for the `MaximumExecutionFrequency` parameter\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `One_Hour | Six_Hours | Three_Hours | Twelve_Hours | TwentyFour_Hours` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaximumExecutionFrequency", "type": "string" }, @@ -40167,7 +40879,7 @@ "type": "number" }, "Parameters": { - "markdownDescription": "An object of the RemediationParameterValue\\. \nThe type is a map of strings to RemediationParameterValue\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An object of the RemediationParameterValue\\. For more information, see [RemediationParameterValue](https://docs.aws.amazon.com/config/latest/APIReference/API_RemediationParameterValue.html)\\. \nThe type is a map of strings to RemediationParameterValue\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Parameters", "type": "object" }, @@ -40415,9 +41127,13 @@ "additionalProperties": false, "properties": { "InstanceId": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Minimum*: `1` \n*Maximum*: `100` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InstanceId", "type": "string" }, "Origin": { + "markdownDescription": "Domain name to be added to the allow\\-list of the instance\\. \n*Maximum*: `267` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Origin", "type": "string" } }, @@ -40484,12 +41200,12 @@ "additionalProperties": false, "properties": { "Content": { - "markdownDescription": "The content of the contact flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The content of the flow\\. \nFor more information, see [Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html) in the *Amazon Connect Administrator Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Content", "type": "string" }, "Description": { - "markdownDescription": "The description of the contact flow\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the flow\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -40499,12 +41215,12 @@ "type": "string" }, "Name": { - "markdownDescription": "The name of the contact flow\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the flow\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "State": { - "markdownDescription": "The state of the contact flow\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | ARCHIVED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The state of the flow\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | ARCHIVED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "State", "type": "string" }, @@ -40517,7 +41233,7 @@ "type": "array" }, "Type": { - "markdownDescription": "The type of the contact flow\\. For descriptions of the available types, see [Choose a Contact Flow Type](https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) in the *Amazon Connect Administrator Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AGENT_HOLD | AGENT_TRANSFER | AGENT_WHISPER | CONTACT_FLOW | CUSTOMER_HOLD | CUSTOMER_QUEUE | CUSTOMER_WHISPER | OUTBOUND_WHISPER | QUEUE_TRANSFER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of the flow\\. For descriptions of the available types, see [Choose a flow type](https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) in the *Amazon Connect Administrator Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AGENT_HOLD | AGENT_TRANSFER | AGENT_WHISPER | CONTACT_FLOW | CUSTOMER_HOLD | CUSTOMER_QUEUE | CUSTOMER_WHISPER | OUTBOUND_WHISPER | QUEUE_TRANSFER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -40587,12 +41303,12 @@ "additionalProperties": false, "properties": { "Content": { - "markdownDescription": "The content of the contact flow module\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The content of the flow module\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Content", "type": "string" }, "Description": { - "markdownDescription": "The description of the contact flow module\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the flow module\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -40602,12 +41318,12 @@ "type": "string" }, "Name": { - "markdownDescription": "The name of the contact flow module\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `127` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the flow module\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `127` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "State": { - "markdownDescription": "The state of the contact flow module\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | ARCHIVED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The state of the flow module\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | ARCHIVED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "State", "type": "string" }, @@ -40710,7 +41426,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -40831,15 +41547,23 @@ "additionalProperties": false, "properties": { "Attributes": { - "$ref": "#/definitions/AWS::Connect::Instance.Attributes" + "$ref": "#/definitions/AWS::Connect::Instance.Attributes", + "markdownDescription": "A toggle for an individual feature at the instance level\\. \n*Required*: Yes \n*Type*: [Attributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instance-attributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Attributes" }, "DirectoryId": { + "markdownDescription": "The identifier for the directory\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DirectoryId", "type": "string" }, "IdentityManagementType": { + "markdownDescription": "The identity management type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONNECT_MANAGED | EXISTING_DIRECTORY | SAML` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IdentityManagementType", "type": "string" }, "InstanceAlias": { + "markdownDescription": "The alias of instance\\. `InstanceAlias` is only required when `IdentityManagementType` is `CONNECT_MANAGED` or `SAML`\\. `InstanceAlias` is not required when `IdentityManagementType` is `EXISTING_DIRECTORY`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `62` \n*Pattern*: `^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InstanceAlias", "type": "string" } }, @@ -40874,24 +41598,38 @@ "additionalProperties": false, "properties": { "AutoResolveBestVoices": { + "markdownDescription": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoResolveBestVoices", "type": "boolean" }, "ContactLens": { + "markdownDescription": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContactLens", "type": "boolean" }, "ContactflowLogs": { + "markdownDescription": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContactflowLogs", "type": "boolean" }, "EarlyMedia": { + "markdownDescription": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EarlyMedia", "type": "boolean" }, "InboundCalls": { + "markdownDescription": "*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InboundCalls", "type": "boolean" }, "OutboundCalls": { + "markdownDescription": "*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OutboundCalls", "type": "boolean" }, "UseCustomTTSVoices": { + "markdownDescription": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseCustomTTSVoices", "type": "boolean" } }, @@ -40937,24 +41675,38 @@ "additionalProperties": false, "properties": { "InstanceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InstanceArn", "type": "string" }, "KinesisFirehoseConfig": { - "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.KinesisFirehoseConfig" + "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.KinesisFirehoseConfig", + "markdownDescription": "The configuration of the Kinesis Firehose delivery stream\\. \n*Required*: No \n*Type*: [KinesisFirehoseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisfirehoseconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KinesisFirehoseConfig" }, "KinesisStreamConfig": { - "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.KinesisStreamConfig" + "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.KinesisStreamConfig", + "markdownDescription": "The configuration of the Kinesis data stream\\. \n*Required*: No \n*Type*: [KinesisStreamConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisstreamconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KinesisStreamConfig" }, "KinesisVideoStreamConfig": { - "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.KinesisVideoStreamConfig" + "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.KinesisVideoStreamConfig", + "markdownDescription": "The configuration of the Kinesis video stream\\. \n*Required*: No \n*Type*: [KinesisVideoStreamConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-kinesisvideostreamconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KinesisVideoStreamConfig" }, "ResourceType": { + "markdownDescription": "A valid resource type\\. Following are the valid resource types: `CHAT_TRANSCRIPTS` \\| `CALL_RECORDINGS` \\| `SCHEDULED_REPORTS` \\| `MEDIA_STREAMS` \\| `CONTACT_TRACE_RECORDS` \\| `AGENT_EVENTS` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceType", "type": "string" }, "S3Config": { - "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.S3Config" + "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.S3Config", + "markdownDescription": "The S3 bucket configuration\\. \n*Required*: No \n*Type*: [S3Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-s3config.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3Config" }, "StorageType": { + "markdownDescription": "A valid storage type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KINESIS_FIREHOSE | KINESIS_STREAM | KINESIS_VIDEO_STREAM | S3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageType", "type": "string" } }, @@ -40990,9 +41742,13 @@ "additionalProperties": false, "properties": { "EncryptionType": { + "markdownDescription": "The type of encryption\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionType", "type": "string" }, "KeyId": { + "markdownDescription": "The full ARN of the encryption key\\. \nBe sure to provide the full ARN of the encryption key, not just the ID\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KeyId", "type": "string" } }, @@ -41006,6 +41762,8 @@ "additionalProperties": false, "properties": { "FirehoseArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the delivery stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FirehoseArn", "type": "string" } }, @@ -41018,6 +41776,8 @@ "additionalProperties": false, "properties": { "StreamArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the data stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StreamArn", "type": "string" } }, @@ -41030,12 +41790,18 @@ "additionalProperties": false, "properties": { "EncryptionConfig": { - "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.EncryptionConfig" + "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.EncryptionConfig", + "markdownDescription": "The encryption configuration\\. \n*Required*: No \n*Type*: [EncryptionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-encryptionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionConfig" }, "Prefix": { + "markdownDescription": "The prefix of the video stream\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Prefix", "type": "string" }, "RetentionPeriodHours": { + "markdownDescription": "The number of hours data is retained in the stream\\. Kinesis Video Streams retains the data in a data store that is associated with the stream\\. \nThe default value is 0, indicating that the stream does not persist data\\. \n*Required*: Yes \n*Type*: Double \n*Minimum*: `0` \n*Maximum*: `87600` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetentionPeriodHours", "type": "number" } }, @@ -41049,13 +41815,19 @@ "additionalProperties": false, "properties": { "BucketName": { + "markdownDescription": "The S3 bucket name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketName", "type": "string" }, "BucketPrefix": { + "markdownDescription": "The S3 bucket prefix\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketPrefix", "type": "string" }, "EncryptionConfig": { - "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.EncryptionConfig" + "$ref": "#/definitions/AWS::Connect::InstanceStorageConfig.EncryptionConfig", + "markdownDescription": "The Amazon S3 encryption configuration\\. \n*Required*: No \n*Type*: [EncryptionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-instancestorageconfig-encryptionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionConfig" } }, "required": [ @@ -41100,12 +41872,18 @@ "additionalProperties": false, "properties": { "InstanceId": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Minimum*: `1` \n*Maximum*: `100` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InstanceId", "type": "string" }, "IntegrationArn": { + "markdownDescription": "ARN of the integration being associated with the instance\\. \n*Minimum*: `1` \n*Maximum*: `140` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IntegrationArn", "type": "string" }, "IntegrationType": { + "markdownDescription": "Specifies the integration type to be associated with the instance\\. \n*Allowed Values*: `LEX_BOT` \\| `LAMBDA_FUNCTION` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IntegrationType", "type": "string" } }, @@ -41173,24 +41951,36 @@ "additionalProperties": false, "properties": { "CountryCode": { + "markdownDescription": "The ISO country code\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AD | AE | AF | AG | AI | AL | AM | AN | AO | AQ | AR | AS | AT | AU | AW | AZ | BA | BB | BD | BE | BF | BG | BH | BI | BJ | BL | BM | BN | BO | BR | BS | BT | BW | BY | BZ | CA | CC | CD | CF | CG | CH | CI | CK | CL | CM | CN | CO | CR | CU | CV | CW | CX | CY | CZ | DE | DJ | DK | DM | DO | DZ | EC | EE | EG | EH | ER | ES | ET | FI | FJ | FK | FM | FO | FR | GA | GB | GD | GE | GG | GH | GI | GL | GM | GN | GQ | GR | GT | GU | GW | GY | HK | HN | HR | HT | HU | ID | IE | IL | IM | IN | IO | IQ | IR | IS | IT | JE | JM | JO | JP | KE | KG | KH | KI | KM | KN | KP | KR | KW | KY | KZ | LA | LB | LC | LI | LK | LR | LS | LT | LU | LV | LY | MA | MC | MD | ME | MF | MG | MH | MK | ML | MM | MN | MO | MP | MR | MS | MT | MU | MV | MW | MX | MY | MZ | NA | NC | NE | NG | NI | NL | NO | NP | NR | NU | NZ | OM | PA | PE | PF | PG | PH | PK | PL | PM | PN | PR | PT | PW | PY | QA | RE | RO | RS | RU | RW | SA | SB | SC | SD | SE | SG | SH | SI | SJ | SK | SL | SM | SN | SO | SR | ST | SV | SX | SY | SZ | TC | TD | TG | TH | TJ | TK | TL | TM | TN | TO | TR | TT | TV | TW | TZ | UA | UG | US | UY | UZ | VA | VC | VE | VG | VI | VN | VU | WF | WS | YE | YT | ZA | ZM | ZW` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CountryCode", "type": "string" }, "Description": { + "markdownDescription": "The description of the phone number\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `^[\\W\\S_]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Description", "type": "string" }, "Prefix": { + "markdownDescription": "The prefix of the phone number\\. If provided, it must contain `+` as part of the country code\\. \n*Pattern*: `^\\\\+[0-9]{1,15}` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Prefix", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TargetArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for Amazon Connect instances or traffic distribution group that phone numbers are claimed to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetArn", "type": "string" }, "Type": { + "markdownDescription": "The type of phone number\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DID | TOLL_FREE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -41281,7 +42071,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags used to organize, track, or control access for this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -41318,7 +42108,7 @@ "additionalProperties": false, "properties": { "PhoneNumber": { - "markdownDescription": "The phone number in E\\.164 format\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The phone number in E\\.164 format\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\\\+[1-9]\\\\d{1,14}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PhoneNumber", "type": "string" } @@ -41332,7 +42122,7 @@ "additionalProperties": false, "properties": { "ContactFlowArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the contact flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContactFlowArn", "type": "string" }, @@ -41381,7 +42171,7 @@ "additionalProperties": false, "properties": { "ContactFlowArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the contact flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContactFlowArn", "type": "string" }, @@ -41433,28 +42223,42 @@ "additionalProperties": false, "properties": { "Actions": { - "$ref": "#/definitions/AWS::Connect::Rule.Actions" + "$ref": "#/definitions/AWS::Connect::Rule.Actions", + "markdownDescription": "A list of actions to be run when the rule is triggered\\. \n*Required*: Yes \n*Type*: [Actions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-actions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Actions" }, "Function": { + "markdownDescription": "The conditions of the rule\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Function", "type": "string" }, "InstanceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InstanceArn", "type": "string" }, "Name": { + "markdownDescription": "The name of the rule\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "PublishStatus": { + "markdownDescription": "The publish status of the rule\\. \n*Allowed values*: `DRAFT` \\| `PUBLISHED` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PublishStatus", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TriggerEventSource": { - "$ref": "#/definitions/AWS::Connect::Rule.RuleTriggerEventSource" + "$ref": "#/definitions/AWS::Connect::Rule.RuleTriggerEventSource", + "markdownDescription": "The event source to trigger the rule\\. \n*Required*: Yes \n*Type*: [RuleTriggerEventSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-ruletriggereventsource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TriggerEventSource" } }, "required": [ @@ -41495,24 +42299,32 @@ "items": { "type": "object" }, + "markdownDescription": "Information about the contact category action\\. The syntax can be empty, for example, `{}`\\. \n*Required*: No \n*Type*: List of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssignContactCategoryActions", "type": "array" }, "EventBridgeActions": { "items": { "$ref": "#/definitions/AWS::Connect::Rule.EventBridgeAction" }, + "markdownDescription": "Information about the EventBridge action\\. \n*Required*: No \n*Type*: List of [EventBridgeAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-eventbridgeaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventBridgeActions", "type": "array" }, "SendNotificationActions": { "items": { "$ref": "#/definitions/AWS::Connect::Rule.SendNotificationAction" }, + "markdownDescription": "Information about the send notification action\\. \n*Required*: No \n*Type*: List of [SendNotificationAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-sendnotificationaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SendNotificationActions", "type": "array" }, "TaskActions": { "items": { "$ref": "#/definitions/AWS::Connect::Rule.TaskAction" }, + "markdownDescription": "Information about the task action\\. This field is required if `TriggerEventSource` is one of the following values: `OnZendeskTicketCreate` \\| `OnZendeskTicketStatusUpdate` \\| `OnSalesforceCaseCreate` \n*Required*: No \n*Type*: List of [TaskAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-taskaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TaskActions", "type": "array" } }, @@ -41522,6 +42334,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -41537,15 +42351,19 @@ "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the user account\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserArns", "type": "array" }, "UserTags": { "additionalProperties": true, + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. Amazon Connect users with the specified tags will be notified\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "UserTags", "type": "object" } }, @@ -41555,9 +42373,13 @@ "additionalProperties": false, "properties": { "Type": { + "markdownDescription": "The type of the reference\\. `DATE` must be of type Epoch timestamp\\. \n*Allowed values*: `URL` \\| `ATTACHMENT` \\| `NUMBER` \\| `STRING` \\| `DATE` \\| `EMAIL` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "Value": { + "markdownDescription": "A valid value for the reference\\. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel \\(CCP\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -41571,9 +42393,13 @@ "additionalProperties": false, "properties": { "EventSourceName": { + "markdownDescription": "The name of the event source\\. \n*Allowed values*: `OnPostCallAnalysisAvailable` \\| `OnRealTimeCallAnalysisAvailable` \\| `OnPostChatAnalysisAvailable` \\| `OnZendeskTicketCreate` \\| `OnZendeskTicketStatusUpdate` \\| `OnSalesforceCaseCreate` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EventSourceName", "type": "string" }, "IntegrationAssociationArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the integration association\\. `IntegrationAssociationArn` is required if `TriggerEventSource` is one of the following values: `OnZendeskTicketCreate` \\| `OnZendeskTicketStatusUpdate` \\| `OnSalesforceCaseCreate` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IntegrationAssociationArn", "type": "string" } }, @@ -41586,18 +42412,28 @@ "additionalProperties": false, "properties": { "Content": { + "markdownDescription": "Notification content\\. Supports variable injection\\. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Content", "type": "string" }, "ContentType": { + "markdownDescription": "Content type format\\. \n*Allowed value*: `PLAIN_TEXT` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContentType", "type": "string" }, "DeliveryMethod": { + "markdownDescription": "Notification delivery method\\. \n*Allowed value*: `EMAIL` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeliveryMethod", "type": "string" }, "Recipient": { - "$ref": "#/definitions/AWS::Connect::Rule.NotificationRecipientType" + "$ref": "#/definitions/AWS::Connect::Rule.NotificationRecipientType", + "markdownDescription": "Notification recipient\\. \n*Required*: Yes \n*Type*: [NotificationRecipientType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-notificationrecipienttype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Recipient" }, "Subject": { + "markdownDescription": "The subject of the email if the delivery method is `EMAIL`\\. Supports variable injection\\. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Subject", "type": "string" } }, @@ -41613,21 +42449,29 @@ "additionalProperties": false, "properties": { "ContactFlowArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContactFlowArn", "type": "string" }, "Description": { + "markdownDescription": "The description\\. Supports variable injection\\. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name\\. Supports variable injection\\. For more information, see [JSONPath reference](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html) in the *Amazon Connect Administrators Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "References": { "additionalProperties": false, + "markdownDescription": "Information about the reference when the `referenceType` is `URL`\\. Otherwise, null\\. `URL` is the only accepted type\\. \\(Supports variable injection in the `Value` field\\.\\) \n*Required*: No \n*Type*: Map of [Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-reference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::Connect::Rule.Reference" } }, + "title": "References", "type": "object" } }, @@ -41673,9 +42517,13 @@ "additionalProperties": false, "properties": { "InstanceId": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the instance\\. \n*Minimum*: `1` \n*Maximum*: `100` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InstanceId", "type": "string" }, "Key": { + "markdownDescription": "A valid security key in PEM format\\. \n*Minimum*: `1` \n*Maximum*: `1024` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" } }, @@ -41742,42 +42590,62 @@ "additionalProperties": false, "properties": { "ClientToken": { + "markdownDescription": "A unique, case\\-sensitive identifier that you provide to ensure the idempotency of the request\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientToken", "type": "string" }, "Constraints": { - "$ref": "#/definitions/AWS::Connect::TaskTemplate.Constraints" + "$ref": "#/definitions/AWS::Connect::TaskTemplate.Constraints", + "markdownDescription": "Constraints that are applicable to the fields listed\\. \nThe values can be represented in either JSON or YAML format\\. For an example of the JSON configuration, see *Examples* at the bottom of this page\\. \n*Required*: No \n*Type*: [Constraints](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-constraints.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Constraints" }, "ContactFlowArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow that runs by default when a task is created by referencing this template\\. `ContactFlowArn` is not required when there is a field with `fieldType` = `QUICK_CONNECT`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContactFlowArn", "type": "string" }, "Defaults": { "items": { "$ref": "#/definitions/AWS::Connect::TaskTemplate.DefaultFieldValue" }, + "markdownDescription": "The default values for fields when a task is created by referencing this template\\. \n*Required*: No \n*Type*: List of [DefaultFieldValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-defaultfieldvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Defaults", "type": "array" }, "Description": { + "markdownDescription": "The description of the task template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Fields": { "items": { "$ref": "#/definitions/AWS::Connect::TaskTemplate.Field" }, + "markdownDescription": "Fields that are part of the template\\. A template requires at least one field that has type `Name`\\. \n*Required*: No \n*Type*: List of [Field](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-field.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Fields", "type": "array" }, "InstanceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon Connect instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InstanceArn", "type": "string" }, "Name": { + "markdownDescription": "The name of the task template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Status": { + "markdownDescription": "The status of the task template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -41814,18 +42682,24 @@ "items": { "$ref": "#/definitions/AWS::Connect::TaskTemplate.InvisibleFieldInfo" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [InvisibleFieldInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-invisiblefieldinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InvisibleFields", "type": "array" }, "ReadOnlyFields": { "items": { "$ref": "#/definitions/AWS::Connect::TaskTemplate.ReadOnlyFieldInfo" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ReadOnlyFieldInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-readonlyfieldinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReadOnlyFields", "type": "array" }, "RequiredFields": { "items": { "$ref": "#/definitions/AWS::Connect::TaskTemplate.RequiredFieldInfo" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [RequiredFieldInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-requiredfieldinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RequiredFields", "type": "array" } }, @@ -41835,10 +42709,14 @@ "additionalProperties": false, "properties": { "DefaultValue": { + "markdownDescription": "Default value for the field\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultValue", "type": "string" }, "Id": { - "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier" + "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier", + "markdownDescription": "Identifier of a field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id" } }, "required": [ @@ -41851,18 +42729,26 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the field\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Id": { - "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier" + "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier", + "markdownDescription": "The unique identifier for the field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id" }, "SingleSelectOptions": { "items": { "type": "string" }, + "markdownDescription": "A list of options for a single select field\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SingleSelectOptions", "type": "array" }, "Type": { + "markdownDescription": "Indicates the type of field\\. Following are the valid field types: `NAME` `DESCRIPTION` \\| `SCHEDULED_TIME` \\| `QUICK_CONNECT` \\| `URL` \\| `NUMBER` \\| `TEXT` \\| `TEXT_AREA` \\| `DATE_TIME` \\| `BOOLEAN` \\| `SINGLE_SELECT` \\| `EMAIL` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -41876,6 +42762,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the task template field\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -41888,7 +42776,9 @@ "additionalProperties": false, "properties": { "Id": { - "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier" + "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier", + "markdownDescription": "Identifier of the invisible field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id" } }, "required": [ @@ -41900,7 +42790,9 @@ "additionalProperties": false, "properties": { "Id": { - "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier" + "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier", + "markdownDescription": "Identifier of the read\\-only field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id" } }, "required": [ @@ -41912,7 +42804,9 @@ "additionalProperties": false, "properties": { "Id": { - "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier" + "$ref": "#/definitions/AWS::Connect::TaskTemplate.FieldIdentifier", + "markdownDescription": "The unique identifier for the field\\. \n*Required*: Yes \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-tasktemplate-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id" } }, "required": [ @@ -42061,9 +42955,13 @@ "type": "string" }, "Mobile": { + "markdownDescription": "The user's mobile number\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\\\+[1-9]\\\\d{1,14}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Mobile", "type": "string" }, "SecondaryEmail": { + "markdownDescription": "The user's secondary email address\\. If you provide a secondary email, the user receives email notifications \\-\\- other than password reset notifications \\-\\- to this email address instead of to their primary email address\\. \n*Pattern*: `(?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,63}` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecondaryEmail", "type": "string" } }, @@ -42073,7 +42971,7 @@ "additionalProperties": false, "properties": { "AfterContactWorkTimeLimit": { - "markdownDescription": "The After Call Work \\(ACW\\) timeout setting, in seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The After Call Work \\(ACW\\) timeout setting, in seconds\\. \nWhen returned by a `SearchUsers` call, `AfterContactWorkTimeLimit` is returned in milliseconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AfterContactWorkTimeLimit", "type": "number" }, @@ -42083,7 +42981,7 @@ "type": "boolean" }, "DeskPhoneNumber": { - "markdownDescription": "The phone number for the user's desk phone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The phone number for the user's desk phone\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\\\+[1-9]\\\\d{1,14}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeskPhoneNumber", "type": "string" }, @@ -42212,21 +43110,31 @@ "additionalProperties": false, "properties": { "ConnectInstanceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon Connect instance\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConnectInstanceArn", "type": "string" }, "DialerConfig": { - "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.DialerConfig" + "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.DialerConfig", + "markdownDescription": "Contains information about the dialer configuration\\. \n*Required*: Yes \n*Type*: [DialerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-dialerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DialerConfig" }, "Name": { + "markdownDescription": "The name of the campaign\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "OutboundCallConfig": { - "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.OutboundCallConfig" + "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.OutboundCallConfig", + "markdownDescription": "Contains information about the outbound call configuration\\. \n*Required*: Yes \n*Type*: [OutboundCallConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-outboundcallconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OutboundCallConfig" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. For example, \\{ \"tags\": \\{\"key1\":\"value1\", \"key2\":\"value2\"\\} \\}\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -42263,6 +43171,8 @@ "additionalProperties": false, "properties": { "EnableAnswerMachineDetection": { + "markdownDescription": "Whether answering machine detection is enabled\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableAnswerMachineDetection", "type": "boolean" } }, @@ -42275,10 +43185,14 @@ "additionalProperties": false, "properties": { "PredictiveDialerConfig": { - "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.PredictiveDialerConfig" + "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.PredictiveDialerConfig", + "markdownDescription": "The configuration of the predictive dialer\\. \n*Required*: No \n*Type*: [PredictiveDialerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-predictivedialerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PredictiveDialerConfig" }, "ProgressiveDialerConfig": { - "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.ProgressiveDialerConfig" + "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.ProgressiveDialerConfig", + "markdownDescription": "The configuration of the progressive dialer\\. \n*Required*: No \n*Type*: [ProgressiveDialerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-progressivedialerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ProgressiveDialerConfig" } }, "type": "object" @@ -42287,15 +43201,23 @@ "additionalProperties": false, "properties": { "AnswerMachineDetectionConfig": { - "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.AnswerMachineDetectionConfig" + "$ref": "#/definitions/AWS::ConnectCampaigns::Campaign.AnswerMachineDetectionConfig", + "markdownDescription": "Whether answering machine detection has been enabled\\. \n*Required*: No \n*Type*: [AnswerMachineDetectionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connectcampaigns-campaign-answermachinedetectionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AnswerMachineDetectionConfig" }, "ConnectContactFlowArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectContactFlowArn", "type": "string" }, "ConnectQueueArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the queue\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectQueueArn", "type": "string" }, "ConnectSourcePhoneNumber": { + "markdownDescription": "The phone number associated with the outbound call\\. This is the caller ID that is displayed to customers when an agent calls them\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectSourcePhoneNumber", "type": "string" } }, @@ -42309,6 +43231,8 @@ "additionalProperties": false, "properties": { "BandwidthAllocation": { + "markdownDescription": "Bandwidth allocation for the predictive dialer\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BandwidthAllocation", "type": "number" } }, @@ -42321,6 +43245,8 @@ "additionalProperties": false, "properties": { "BandwidthAllocation": { + "markdownDescription": "Bandwidth allocation for the progressive dialer\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BandwidthAllocation", "type": "number" } }, @@ -42365,9 +43291,13 @@ "additionalProperties": false, "properties": { "ControlIdentifier": { + "markdownDescription": "The ARN of the control\\. Only **Strongly recommended** and **Elective** controls are permitted, with the exception of the **Region deny** guardrail\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ControlIdentifier", "type": "string" }, "TargetIdentifier": { + "markdownDescription": "The ARN of the organizational unit\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TargetIdentifier", "type": "string" } }, @@ -42530,7 +43460,7 @@ }, "FlowDefinition": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.FlowDefinition", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [FlowDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The configuration that controls how Customer Profiles retrieves data from the source\\. \n*Required*: No \n*Type*: [FlowDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FlowDefinition" }, "ObjectTypeName": { @@ -42542,7 +43472,7 @@ "items": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.ObjectTypeMapping" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [ObjectTypeMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object type mapping\\. \n*Required*: No \n*Type*: List of [ObjectTypeMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ObjectTypeNames", "type": "array" }, @@ -42590,27 +43520,27 @@ "additionalProperties": false, "properties": { "Marketo": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided Marketo source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | DIVISION | GREATER_THAN | LESS_THAN | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Marketo", "type": "string" }, "S3": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided Amazon S3 source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3", "type": "string" }, "Salesforce": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided Salesforce source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Salesforce", "type": "string" }, "ServiceNow": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided ServiceNow source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | BETWEEN | CONTAINS | DIVISION | EQUAL_TO | GREATER_THAN | GREATER_THAN_OR_EQUAL_TO | LESS_THAN | LESS_THAN_OR_EQUAL_TO | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | NOT_EQUAL_TO | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceNow", "type": "string" }, "Zendesk": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided Zendesk source fields\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADDITION | DIVISION | GREATER_THAN | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | MULTIPLICATION | NO_OP | PROJECTION | SUBTRACTION | VALIDATE_NON_NEGATIVE | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NUMERIC` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Zendesk", "type": "string" } @@ -42621,36 +43551,36 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description of the flow you want to create\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `[\\w!@#\\-.?,\\s]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "FlowName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The specified name of the flow\\. Use underscores \\(\\_\\) or hyphens \\(\\-\\) only\\. Spaces are not allowed\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9][\\w!@#.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FlowName", "type": "string" }, "KmsArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS Key Management Service \\(KMS\\) key you provide for encryption\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:aws:kms:.*:[0-9]+:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KmsArn", "type": "string" }, "SourceFlowConfig": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.SourceFlowConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [SourceFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The configuration that controls how Customer Profiles retrieves data from the source\\. \n*Required*: Yes \n*Type*: [SourceFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceFlowConfig" }, "Tasks": { "items": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.Task" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: List of [Task](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of tasks that Customer Profiles performs while transferring the data in the flow run\\. \n*Required*: Yes \n*Type*: List of [Task](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tasks", "type": "array" }, "TriggerConfig": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.TriggerConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [TriggerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The trigger settings that determine how and when the flow runs\\. \n*Required*: Yes \n*Type*: [TriggerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TriggerConfig" } }, @@ -42667,7 +43597,7 @@ "additionalProperties": false, "properties": { "DatetimeTypeFieldName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DatetimeTypeFieldName", "type": "string" } @@ -42678,7 +43608,7 @@ "additionalProperties": false, "properties": { "Object": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object specified in the Marketo flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Object", "type": "string" } @@ -42692,12 +43622,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Value": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -42712,12 +43642,12 @@ "additionalProperties": false, "properties": { "BucketName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon S3 bucket name where the source files are stored\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BucketName", "type": "string" }, "BucketPrefix": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object key for the Amazon S3 bucket in which the source files are stored\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BucketPrefix", "type": "string" } @@ -42731,17 +43661,17 @@ "additionalProperties": false, "properties": { "EnableDynamicFieldUpdate": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The flag that enables dynamic fetching of new \\(recently added\\) fields in the Salesforce objects while running a flow\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableDynamicFieldUpdate", "type": "boolean" }, "IncludeDeletedRecords": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether Amazon AppFlow includes deleted files in the flow run\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeDeletedRecords", "type": "boolean" }, "Object": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object specified in the Salesforce flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Object", "type": "string" } @@ -42755,37 +43685,37 @@ "additionalProperties": false, "properties": { "DataPullMode": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Complete | Incremental` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataPullMode", "type": "string" }, "FirstExecutionFrom": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the date range for the records to import from the connector in the first flow run\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FirstExecutionFrom", "type": "number" }, "ScheduleEndTime": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the scheduled end time for a scheduled\\-trigger flow\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleEndTime", "type": "number" }, "ScheduleExpression": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The scheduling expression that determines the rate at which the schedule will run, for example rate \\(5 minutes\\)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleExpression", "type": "string" }, "ScheduleOffset": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the optional offset that is added to the time interval for a schedule\\-triggered flow\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleOffset", "type": "number" }, "ScheduleStartTime": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the scheduled start time for a scheduled\\-trigger flow\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScheduleStartTime", "type": "number" }, "Timezone": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the time zone used when referring to the date and time of a scheduled\\-triggered flow, such as America/New\\_York\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Timezone", "type": "string" } @@ -42799,7 +43729,7 @@ "additionalProperties": false, "properties": { "Object": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object specified in the ServiceNow flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Object", "type": "string" } @@ -42814,27 +43744,27 @@ "properties": { "Marketo": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.MarketoSourceProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [MarketoSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-marketosourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties that are applied when Marketo is being used as a source\\. \n*Required*: No \n*Type*: [MarketoSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-marketosourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Marketo" }, "S3": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.S3SourceProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [S3SourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties that are applied when Amazon S3 is being used as the flow source\\. \n*Required*: No \n*Type*: [S3SourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3" }, "Salesforce": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.SalesforceSourceProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SalesforceSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties that are applied when Salesforce is being used as a source\\. \n*Required*: No \n*Type*: [SalesforceSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Salesforce" }, "ServiceNow": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.ServiceNowSourceProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ServiceNowSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-servicenowsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties that are applied when ServiceNow is being used as a source\\. \n*Required*: No \n*Type*: [ServiceNowSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-servicenowsourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceNow" }, "Zendesk": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.ZendeskSourceProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ZendeskSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-zendesksourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The properties that are applied when using Zendesk as a flow source\\. \n*Required*: No \n*Type*: [ZendeskSourceProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-zendesksourceproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Zendesk" } }, @@ -42844,23 +43774,23 @@ "additionalProperties": false, "properties": { "ConnectorProfileName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the Amazon AppFlow connector profile\\. This name must be unique for each connector profile in the AWS account\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `[\\w/!@#+=.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectorProfileName", "type": "string" }, "ConnectorType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of connector, such as Salesforce, Marketo, and so on\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Marketo | S3 | Salesforce | Servicenow | Zendesk` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectorType", "type": "string" }, "IncrementalPullConfig": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.IncrementalPullConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [IncrementalPullConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-incrementalpullconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Defines the configuration for a scheduled incremental data pull\\. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull\\. \n*Required*: No \n*Type*: [IncrementalPullConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-incrementalpullconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncrementalPullConfig" }, "SourceConnectorProperties": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.SourceConnectorProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [SourceConnectorProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the information that is required to query a particular source connector\\. \n*Required*: Yes \n*Type*: [SourceConnectorProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceConnectorProperties" } }, @@ -42875,11 +43805,11 @@ "properties": { "ConnectorOperator": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.ConnectorOperator", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ConnectorOperator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operation to be performed on the provided source fields\\. \n*Required*: No \n*Type*: [ConnectorOperator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConnectorOperator" }, "DestinationField": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A field in a destination connector, or a field value against which Amazon AppFlow validates a source field\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DestinationField", "type": "string" }, @@ -42887,7 +43817,7 @@ "items": { "type": "string" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The source fields to which a particular task is applied\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceFields", "type": "array" }, @@ -42895,12 +43825,12 @@ "items": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.TaskPropertiesMap" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [TaskPropertiesMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A map used to store task\\-related information\\. The service looks for particular information based on the TaskType\\. \n*Required*: No \n*Type*: List of [TaskPropertiesMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TaskProperties", "type": "array" }, "TaskType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the particular task implementation that Amazon AppFlow performs\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Arithmetic | Filter | Map | Mask | Merge | Truncate | Validate` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TaskType", "type": "string" } @@ -42915,12 +43845,12 @@ "additionalProperties": false, "properties": { "OperatorPropertyKey": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The task property key\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OperatorPropertyKey", "type": "string" }, "Property": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The task property value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Property", "type": "string" } @@ -42936,11 +43866,11 @@ "properties": { "TriggerProperties": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.TriggerProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [TriggerProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the configuration details of a schedule\\-triggered flow that you define\\. Currently, these settings only apply to the Scheduled trigger type\\. \n*Required*: No \n*Type*: [TriggerProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TriggerProperties" }, "TriggerType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the type of flow trigger\\. It can be OnDemand, Scheduled, or Event\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Event | OnDemand | Scheduled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TriggerType", "type": "string" } @@ -42955,7 +43885,7 @@ "properties": { "Scheduled": { "$ref": "#/definitions/AWS::CustomerProfiles::Integration.ScheduledTriggerProperties", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [ScheduledTriggerProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the configuration details of a schedule\\-triggered flow that you define\\. \n*Required*: No \n*Type*: [ScheduledTriggerProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Scheduled" } }, @@ -42965,7 +43895,7 @@ "additionalProperties": false, "properties": { "Object": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The object specified in the Zendesk flow source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Object", "type": "string" } @@ -43591,7 +44521,9 @@ "additionalProperties": false, "properties": { "RetentionArchiveTier": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.RetentionArchiveTier" + "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.RetentionArchiveTier", + "markdownDescription": "Information about retention period in the Amazon EBS Snapshots Archive\\. For more information, see [Archive Amazon EBS snapshots](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/snapshot-archive.html)\\. \n*Required*: Yes \n*Type*: [RetentionArchiveTier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retentionarchivetier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetentionArchiveTier" } }, "required": [ @@ -43603,7 +44535,9 @@ "additionalProperties": false, "properties": { "RetainRule": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.ArchiveRetainRule" + "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.ArchiveRetainRule", + "markdownDescription": "Information about the retention period for the snapshot archiving rule\\. \n*Required*: Yes \n*Type*: [ArchiveRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-archiveretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetainRule" } }, "required": [ @@ -43630,7 +44564,7 @@ "type": "string" }, "Location": { - "markdownDescription": "Specifies the destination for snapshots created by the policy\\. To create snapshots in the same Region as the source resource, specify `CLOUD`\\. To create snapshots on the same Outpost as the source resource, specify `OUTPOST_LOCAL`\\. If you omit this parameter, `CLOUD` is used by default\\. \nIf the policy targets resources in an AWS Region, then you must create snapshots in the same Region as the source resource\\. \nIf the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CLOUD | OUTPOST_LOCAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot policies only\\]** Specifies the destination for snapshots created by the policy\\. To create snapshots in the same Region as the source resource, specify `CLOUD`\\. To create snapshots on the same Outpost as the source resource, specify `OUTPOST_LOCAL`\\. If you omit this parameter, `CLOUD` is used by default\\. \nIf the policy targets resources in an AWS Region, then you must create snapshots in the same Region as the source resource\\. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CLOUD | OUTPOST_LOCAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Location", "type": "string" }, @@ -43638,7 +44572,7 @@ "items": { "type": "string" }, - "markdownDescription": "The time, in UTC, to start the operation\\. The supported format is hh:mm\\. \nThe operation occurs within a one\\-hour window following the specified time\\. If you do not specify a time, Amazon DLM selects a time within the next 24 hours\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The time, in UTC, to start the operation\\. The supported format is hh:mm\\. \nThe operation occurs within a one\\-hour window following the specified time\\. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Times", "type": "array" } @@ -43655,7 +44589,7 @@ }, "RetainRule": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule", - "markdownDescription": "Specifies the retention rule for cross\\-Region snapshot copies\\. \n*Required*: No \n*Type*: [CrossRegionCopyRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a retention rule for cross\\-Region snapshot copies created by snapshot or event\\-based policies, or cross\\-Region AMI copies created by AMI policies\\. After the retention period expires, the cross\\-Region copy is deleted\\. \n*Required*: No \n*Type*: [CrossRegionCopyRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RetainRule" }, "Target": { @@ -43679,7 +44613,7 @@ "type": "number" }, "IntervalUnit": { - "markdownDescription": "The unit of time in which to measure the **Interval**\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unit of time in which to measure the **Interval**\\. For example, to deprecate a cross\\-Region AMI copy after 3 months, specify `Interval=3` and `IntervalUnit=MONTHS`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IntervalUnit", "type": "string" } @@ -43694,12 +44628,12 @@ "additionalProperties": false, "properties": { "Interval": { - "markdownDescription": "The amount of time to retain each snapshot\\. The maximum is 100 years\\. This is equivalent to 1200 months, 5200 weeks, or 36500 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of time to retain a cross\\-Region snapshot or AMI copy\\. The maximum is 100 years\\. This is equivalent to 1200 months, 5200 weeks, or 36500 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Interval", "type": "number" }, "IntervalUnit": { - "markdownDescription": "The unit of time for time\\-based retention\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unit of time for time\\-based retention\\. For example, to retain a cross\\-Region copy for 3 months, specify `Interval=3` and `IntervalUnit=MONTHS`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IntervalUnit", "type": "string" } @@ -43719,13 +44653,13 @@ "type": "string" }, "CopyTags": { - "markdownDescription": "Indicates whether to copy all user\\-defined tags from the source snapshot to the cross\\-Region snapshot copy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether to copy all user\\-defined tags from the source snapshot or AMI to the cross\\-Region copy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CopyTags", "type": "boolean" }, "DeprecateRule": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.CrossRegionCopyDeprecateRule", - "markdownDescription": "The AMI deprecation rule for cross\\-Region AMI copies created by the rule\\. \n*Required*: No \n*Type*: [CrossRegionCopyDeprecateRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopydeprecaterule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[AMI policies only\\]** The AMI deprecation rule for cross\\-Region AMI copies created by the rule\\. \n*Required*: No \n*Type*: [CrossRegionCopyDeprecateRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopydeprecaterule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeprecateRule" }, "Encrypted": { @@ -43735,7 +44669,7 @@ }, "RetainRule": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.CrossRegionCopyRetainRule", - "markdownDescription": "The retention rule that indicates how long snapshot copies are to be retained in the destination Region\\. \n*Required*: No \n*Type*: [CrossRegionCopyRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The retention rule that indicates how long the cross\\-Region snapshot or AMI copies are to be retained in the destination Region\\. \n*Required*: No \n*Type*: [CrossRegionCopyRetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyretainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RetainRule" }, "Target": { @@ -43744,7 +44678,7 @@ "type": "string" }, "TargetRegion": { - "markdownDescription": "Avoid using this parameter when creating new policies\\. Instead, use **Target** to specify a target Region or a target Outpost for snapshot copies\\. \nFor policies created before the **Target** parameter was introduced, this parameter indicates the target Region for snapshot copies\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `16` \n*Pattern*: `([a-z]+-){2,3}\\d` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Avoid using this parameter when creating new policies\\. Instead, use **Target** to specify a target Region or a target Outpost for snapshot copies\\. \nFor policies created before the **Target** parameter was introduced, this parameter indicates the target Region for snapshot copies\\.\n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `16` \n*Pattern*: `([a-z]+-){2,3}\\d` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TargetRegion", "type": "string" } @@ -43874,7 +44808,7 @@ "additionalProperties": false, "properties": { "ExcludeBootVolume": { - "markdownDescription": "\\[EBS Snapshot Management \u2013 Instance policies only\\] Indicates whether to exclude the root volume from snapshots created using [CreateSnapshots](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSnapshots.html)\\. The default is false\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot policies that target instances only\\]** Indicates whether to exclude the root volume from multi\\-volume snapshot sets\\. The default is `false`\\. If you specify `true`, then the root volumes attached to targeted instances will be excluded from the multi\\-volume snapshot sets created by the policy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExcludeBootVolume", "type": "boolean" }, @@ -43882,10 +44816,12 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "**\\[Snapshot policies that target instances only\\]** The tags used to identify data \\(non\\-root\\) volumes to exclude from multi\\-volume snapshot sets\\. \nIf you create a snapshot lifecycle policy that targets instances and you specify tags for this parameter, then data volumes with the specified tags that are attached to targeted instances will be excluded from the multi\\-volume snapshot sets created by the policy\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExcludeDataVolumeTags", "type": "array" }, "NoReboot": { - "markdownDescription": "Applies to AMI lifecycle policies only\\. Indicates whether targeted instances are rebooted when the lifecycle policy runs\\. `true` indicates that targeted instances are not rebooted when the policy runs\\. `false` indicates that target instances are rebooted when the policy runs\\. The default is `true` \\(instances are not rebooted\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[AMI policies only\\]** Indicates whether targeted instances are rebooted when the lifecycle policy runs\\. `true` indicates that targeted instances are not rebooted when the policy runs\\. `false` indicates that target instances are rebooted when the policy runs\\. The default is `true` \\(instances are not rebooted\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NoReboot", "type": "boolean" } @@ -43899,22 +44835,22 @@ "items": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.Action" }, - "markdownDescription": "The actions to be performed when the event\\-based policy is triggered\\. You can specify only one action per policy\\. \nThis parameter is required for event\\-based policies only\\. If you are creating a snapshot or AMI policy, omit this parameter\\. \n*Required*: No \n*Type*: List of [Action](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-action.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Event\\-based policies only\\]** The actions to be performed when the event\\-based policy is activated\\. You can specify only one action per policy\\. \n*Required*: No \n*Type*: List of [Action](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-action.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Actions", "type": "array" }, "EventSource": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.EventSource", - "markdownDescription": "The event that triggers the event\\-based policy\\. \nThis parameter is required for event\\-based policies only\\. If you are creating a snapshot or AMI policy, omit this parameter\\. \n*Required*: No \n*Type*: [EventSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventsource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Event\\-based policies only\\]** The event that activates the event\\-based policy\\. \n*Required*: No \n*Type*: [EventSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-eventsource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventSource" }, "Parameters": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.Parameters", - "markdownDescription": "A set of optional parameters for snapshot and AMI lifecycle policies\\. \nThis parameter is required for snapshot and AMI policies only\\. If you are creating an event\\-based policy, omit this parameter\\. \nIf you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require\\. You can't omit this parameter or set its values to null\\.\n*Required*: No \n*Type*: [Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot and AMI policies only\\]** A set of optional parameters for snapshot and AMI lifecycle policies\\. \nIf you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require\\. You can't omit this parameter or set its values to null\\.\n*Required*: No \n*Type*: [Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-parameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Parameters" }, "PolicyType": { - "markdownDescription": "The valid target resource types and actions a policy can manage\\. Specify `EBS_SNAPSHOT_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots\\. Specify `IMAGE_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of EBS\\-backed AMIs\\. Specify `EVENT_BASED_POLICY ` to create an event\\-based policy that performs specific actions when a defined event occurs in your AWS account\\. \nThe default is `EBS_SNAPSHOT_MANAGEMENT`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EBS_SNAPSHOT_MANAGEMENT | EVENT_BASED_POLICY | IMAGE_MANAGEMENT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[All policy types\\]** The valid target resource types and actions a policy can manage\\. Specify `EBS_SNAPSHOT_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots\\. Specify `IMAGE_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of EBS\\-backed AMIs\\. Specify `EVENT_BASED_POLICY ` to create an event\\-based policy that performs specific actions when a defined event occurs in your AWS account\\. \nThe default is `EBS_SNAPSHOT_MANAGEMENT`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EBS_SNAPSHOT_MANAGEMENT | EVENT_BASED_POLICY | IMAGE_MANAGEMENT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PolicyType", "type": "string" }, @@ -43922,7 +44858,7 @@ "items": { "type": "string" }, - "markdownDescription": "The location of the resources to backup\\. If the source resources are located in an AWS Region, specify `CLOUD`\\. If the source resources are located on an Outpost in your account, specify `OUTPOST`\\. \nIf you specify `OUTPOST`, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot and AMI policies only\\]** The location of the resources to backup\\. If the source resources are located in an AWS Region, specify `CLOUD`\\. If the source resources are located on an Outpost in your account, specify `OUTPOST`\\. \nIf you specify `OUTPOST`, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceLocations", "type": "array" }, @@ -43930,7 +44866,7 @@ "items": { "type": "string" }, - "markdownDescription": "The target resource type for snapshot and AMI lifecycle policies\\. Use `VOLUME `to create snapshots of individual volumes or use `INSTANCE` to create multi\\-volume snapshots from the volumes for an instance\\. \nThis parameter is required for snapshot and AMI policies only\\. If you are creating an event\\-based policy, omit this parameter\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot policies only\\]** The target resource type for snapshot and AMI lifecycle policies\\. Use `VOLUME `to create snapshots of individual volumes or use `INSTANCE` to create multi\\-volume snapshots from the volumes for an instance\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceTypes", "type": "array" }, @@ -43938,7 +44874,7 @@ "items": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.Schedule" }, - "markdownDescription": "The schedules of policy\\-defined actions for snapshot and AMI lifecycle policies\\. A policy can have up to four schedules\u2014one mandatory schedule and up to three optional schedules\\. \nThis parameter is required for snapshot and AMI policies only\\. If you are creating an event\\-based policy, omit this parameter\\. \n*Required*: No \n*Type*: List of [Schedule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html) \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot and AMI policies only\\]** The schedules of policy\\-defined actions for snapshot and AMI lifecycle policies\\. A policy can have up to four schedules\u2014one mandatory schedule and up to three optional schedules\\. \n*Required*: No \n*Type*: List of [Schedule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html) \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Schedules", "type": "array" }, @@ -43946,7 +44882,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The single tag that identifies targeted resources for this policy\\. \nThis parameter is required for snapshot and AMI policies only\\. If you are creating an event\\-based policy, omit this parameter\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot and AMI policies only\\]** The single tag that identifies targeted resources for this policy\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TargetTags", "type": "array" } @@ -43957,17 +44893,17 @@ "additionalProperties": false, "properties": { "Count": { - "markdownDescription": "The number of snapshots to retain for each volume, up to a maximum of 1000\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of snapshots to retain for each volume, up to a maximum of 1000\\. For example if you want to retain a maximum of three snapshots, specify `3`\\. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an [ArchiveRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-archiverule)\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Count", "type": "number" }, "Interval": { - "markdownDescription": "The amount of time to retain each snapshot\\. The maximum is 100 years\\. This is equivalent to 1200 months, 5200 weeks, or 36500 days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of time to retain each snapshot\\. The maximum is 100 years\\. This is equivalent to 1200 months, 5200 weeks, or 36500 days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Interval", "type": "number" }, "IntervalUnit": { - "markdownDescription": "The unit of time for time\\-based retention\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unit of time for time\\-based retention\\. For example, to retain snapshots for 3 months, specify `Interval=3` and `IntervalUnit=MONTHS`\\. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an [ArchiveRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-schedule.html#cfn-dlm-lifecyclepolicy-schedule-archiverule)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IntervalUnit", "type": "string" } @@ -43978,12 +44914,18 @@ "additionalProperties": false, "properties": { "Count": { + "markdownDescription": "The maximum number of snapshots to retain in the archive storage tier for each volume\\. The count must ensure that each snapshot remains in the archive tier for at least 90 days\\. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Count", "type": "number" }, "Interval": { + "markdownDescription": "Specifies the period of time to retain snapshots in the archive tier\\. After this period expires, the snapshot is permanently deleted\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Interval", "type": "number" }, "IntervalUnit": { + "markdownDescription": "The unit of time in which to measure the **Interval**\\. For example, to retain a snapshots in the archive tier for 6 months, specify `Interval=6` and `IntervalUnit=MONTHS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DAYS | MONTHS | WEEKS | YEARS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntervalUnit", "type": "string" } }, @@ -43993,7 +44935,9 @@ "additionalProperties": false, "properties": { "ArchiveRule": { - "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.ArchiveRule" + "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.ArchiveRule", + "markdownDescription": "**\\[Snapshot policies that target volumes only\\]** The snapshot archiving rule for the schedule\\. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met\\. Snapshots are then retained in the archive tier for the archive retention period that you specify\\. \nFor more information about using snapshot archiving, see [Considerations for snapshot lifecycle policies](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-ami-policy.html#dlm-archive)\\. \n*Required*: No \n*Type*: [ArchiveRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-archiverule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ArchiveRule" }, "CopyTags": { "markdownDescription": "Copy all user\\-defined tags on a source volume to snapshots of the volume created by this policy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -44009,18 +44953,18 @@ "items": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.CrossRegionCopyRule" }, - "markdownDescription": "The rule for cross\\-Region snapshot copies\\. \nYou can only specify cross\\-Region copy rules for policies that create snapshots in a Region\\. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost\\. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts\\. \n*Required*: No \n*Type*: List of [CrossRegionCopyRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html) \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a rule for copying snapshots or AMIs across regions\\. \nYou can't specify cross\\-Region copy rules for policies that create snapshots on an Outpost\\. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts\\.\n*Required*: No \n*Type*: List of [CrossRegionCopyRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-crossregioncopyrule.html) \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrossRegionCopyRules", "type": "array" }, "DeprecateRule": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.DeprecateRule", - "markdownDescription": "The AMI deprecation rule for the schedule\\. \n*Required*: No \n*Type*: [DeprecateRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[AMI policies only\\]** The AMI deprecation rule for the schedule\\. \n*Required*: No \n*Type*: [DeprecateRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-deprecaterule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeprecateRule" }, "FastRestoreRule": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.FastRestoreRule", - "markdownDescription": "The rule for enabling fast snapshot restore\\. \n*Required*: No \n*Type*: [FastRestoreRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot policies only\\]** The rule for enabling fast snapshot restore\\. \n*Required*: No \n*Type*: [FastRestoreRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-fastrestorerule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FastRestoreRule" }, "Name": { @@ -44030,14 +44974,14 @@ }, "RetainRule": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.RetainRule", - "markdownDescription": "The retention rule\\. \n*Required*: No \n*Type*: [RetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The retention rule for snapshots or AMIs created by the policy\\. \n*Required*: No \n*Type*: [RetainRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-retainrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RetainRule" }, "ShareRules": { "items": { "$ref": "#/definitions/AWS::DLM::LifecyclePolicy.ShareRule" }, - "markdownDescription": "The rule for sharing snapshots with other AWS accounts\\. \n*Required*: No \n*Type*: List of [ShareRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[Snapshot policies only\\]** The rule for sharing snapshots with other AWS accounts\\. \n*Required*: No \n*Type*: List of [ShareRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-sharerule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ShareRules", "type": "array" }, @@ -44053,7 +44997,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "A collection of key/value pairs with values determined dynamically when the policy is executed\\. Keys may be any valid Amazon EC2 tag key\\. Values must be in one of the two following formats: `$(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/instance-id.html)` or `$(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/timestamp.html)`\\. Variable tags are only valid for EBS Snapshot Management \u2013 Instance policies\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `45` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**\\[AMI policies and snapshot policies that target instances only\\]** A collection of key/value pairs with values determined dynamically when the policy is executed\\. Keys may be any valid Amazon EC2 tag key\\. Values must be in one of the two following formats: `$(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/instance-id.html)` or `$(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/timestamp.html)`\\. Variable tags are only valid for EBS Snapshot Management \u2013 Instance policies\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `45` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VariableTags", "type": "array" } @@ -44125,12 +45069,12 @@ "type": "string" }, "CertificatePem": { - "markdownDescription": "The contents of the \\.pem X\\.509 certificate file for the certificate\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The contents of a `.pem` file, which contains an X\\.509 certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CertificatePem", "type": "string" }, "CertificateWallet": { - "markdownDescription": "The location of the imported Oracle Wallet certificate for use with SSL\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The location of an imported Oracle Wallet certificate for use with SSL\\. An example is: `filebase64(\"${path.root}/rds-ca-2019-root.sso\")` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CertificateWallet", "type": "string" } @@ -44198,23 +45142,23 @@ "type": "string" }, "DatabaseName": { - "markdownDescription": "The name of the endpoint database\\. For a MySQL source or target endpoint, do not specify DatabaseName\\. To migrate to a specific database, use this setting and `targetDbType`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the endpoint database\\. For a MySQL source or target endpoint, don't specify `DatabaseName`\\. To migrate to a specific database, use this setting and `targetDbType`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DatabaseName", "type": "string" }, "DocDbSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.DocDbSettings", - "markdownDescription": "Settings in JSON format for the source DocumentDB endpoint\\. For more information about the available settings, see the configuration properties section in [ Using DocumentDB as a Target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [DocDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target DocumentDB endpoint\\. For more information about other available settings, see [ Using extra connections attributes with Amazon DocumentDB as a source](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html#CHAP_Source.DocumentDB.ECAs) and [ Using Amazon DocumentDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DocumentDB.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [DocDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DocDbSettings" }, "DynamoDbSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.DynamoDbSettings", - "markdownDescription": "Settings in JSON format for the target Amazon DynamoDB endpoint\\. For information about other available settings, see [Using Object Mapping to Migrate Data to DynamoDB](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [DynamoDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the target Amazon DynamoDB endpoint\\. For information about other available settings, see [ Using object mapping to migrate data to DynamoDB](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html#CHAP_Target.DynamoDB.ObjectMapping) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [DynamoDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DynamoDbSettings" }, "ElasticsearchSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.ElasticsearchSettings", - "markdownDescription": "Settings in JSON format for the target OpenSearch endpoint\\. For more information about the available settings, see [Extra Connection Attributes When Using OpenSearch as a Target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) in the * AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [ElasticsearchSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the target OpenSearch endpoint\\. For more information about the available settings, see [ Extra connection attributes when using OpenSearch as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [ElasticsearchSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ElasticsearchSettings" }, "EndpointIdentifier": { @@ -44228,63 +45172,63 @@ "type": "string" }, "EngineName": { - "markdownDescription": "The type of engine for the endpoint\\. Valid values, depending on the `EndpointType` value, include `\"mysql\"`, `\"oracle\"`, `\"postgres\"`, `\"mariadb\"`, `\"aurora\"`, `\"aurora-postgresql\"`, `\"opensearch\"`, `\"redshift\"`, `\"s3\"`, `\"db2\"`, `\"azuredb\"`, `\"sybase\"`, `\"dynamodb\"`, `\"mongodb\"`, `\"kinesis\"`, `\"kafka\"`, `\"elasticsearch\"`, `\"docdb\"`, `\"sqlserver\"`, and `\"neptune\"`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of engine for the endpoint, depending on the `EndpointType` value\\. \n*Valid values*: `mysql` \\| `oracle` \\| `postgres` \\| `mariadb` \\| `aurora` \\| `aurora-postgresql` \\| `opensearch` \\| `redshift` \\| `s3` \\| `db2` \\| `azuredb` \\| `sybase` \\| `dynamodb` \\| `mongodb` \\| `kinesis` \\| `kafka` \\| `elasticsearch` \\| `docdb` \\| `sqlserver` \\| `neptune` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EngineName", "type": "string" }, "ExtraConnectionAttributes": { - "markdownDescription": "Additional attributes associated with the connection\\. Each attribute is specified as a name\\-value pair associated by an equal sign \\(=\\)\\. Multiple attributes are separated by a semicolon \\(;\\) with no additional white space\\. For information on the attributes available for connecting your source or target endpoint, see [Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Additional attributes associated with the connection\\. Each attribute is specified as a name\\-value pair associated by an equal sign \\(=\\)\\. Multiple attributes are separated by a semicolon \\(;\\) with no additional white space\\. For information on the attributes available for connecting your source or target endpoint, see [ Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExtraConnectionAttributes", "type": "string" }, "GcpMySQLSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.GcpMySQLSettings", - "markdownDescription": "Settings in JSON format for the source GCP MySQL endpoint\\. \n*Required*: No \n*Type*: [GcpMySQLSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source GCP MySQL endpoint\\. These settings are much the same as the settings for any MySQL\\-compatible endpoint\\. For more information, see [ Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [GcpMySQLSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "GcpMySQLSettings" }, "IbmDb2Settings": { "$ref": "#/definitions/AWS::DMS::Endpoint.IbmDb2Settings", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [IbmDb2Settings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source IBM Db2 LUW endpoint\\. For information about other available settings, see [ Extra connection attributes when using Db2 LUW as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.html#CHAP_Source.DB2.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [IbmDb2Settings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IbmDb2Settings" }, "KafkaSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.KafkaSettings", - "markdownDescription": "Settings in JSON format for the target Apache Kafka endpoint\\. For more information about the available settings, see [Using object mapping to migrate data to a Kafka topic](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [KafkaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the target Apache Kafka endpoint\\. For more information about other available settings, see [ Using object mapping to migrate data to a Kafka topic](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [KafkaSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KafkaSettings" }, "KinesisSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.KinesisSettings", - "markdownDescription": "Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams\\. For more information about the available settings, see [Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [KinesisSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams\\. For more information about other available settings, see [ Using object mapping to migrate data to a Kinesis data stream](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [KinesisSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KinesisSettings" }, "KmsKeyId": { - "markdownDescription": "An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint\\. \nIf you don't specify a value for the `KmsKeyId` parameter, then AWS DMS uses your default encryption key\\. \n AWS KMS creates the default encryption key for your AWS account\\. Your AWS account has a different default encryption key for each AWS Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint\\. \nIf you don't specify a value for the `KmsKeyId` parameter, AWS DMS uses your default encryption key\\. \nAWS KMS creates the default encryption key for your AWS account\\. Your AWS account has a different default encryption key for each AWS Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" }, "MicrosoftSqlServerSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.MicrosoftSqlServerSettings", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [MicrosoftSqlServerSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target Microsoft SQL Server endpoint\\. For information about other available settings, see [ Extra connection attributes when using SQL Server as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.html#CHAP_Source.SQLServer.ConnectionAttrib) and [ Extra connection attributes when using SQL Server as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.html#CHAP_Target.SQLServer.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [MicrosoftSqlServerSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MicrosoftSqlServerSettings" }, "MongoDbSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.MongoDbSettings", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [MongoDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source MongoDB endpoint\\. For more information about the available settings, see [ Using MongoDB as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html#CHAP_Source.MongoDB.Configuration) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [MongoDbSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MongoDbSettings" }, "MySqlSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.MySqlSettings", - "markdownDescription": "Settings in JSON format for the source and target MySQL endpoint\\. For information about other available settings, see [Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) and [Extra connection attributes when using a MySQL\\-compatible database as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [MySqlSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target MySQL endpoint\\. For information about other available settings, see [ Extra connection attributes when using MySQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.html#CHAP_Source.MySQL.ConnectionAttrib) and [ Extra connection attributes when using a MySQL\\-compatible database as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.html#CHAP_Target.MySQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [MySqlSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MySqlSettings" }, "NeptuneSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.NeptuneSettings", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [NeptuneSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the target Amazon Neptune endpoint\\. For more information about the available settings, see [ Specifying endpoint settings for Amazon Neptune as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [NeptuneSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NeptuneSettings" }, "OracleSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.OracleSettings", - "markdownDescription": "Settings in JSON format for the source and target Oracle endpoint\\. For information about other available settings, see [Extra connection attributes when using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) and [ Extra connection attributes when using Oracle as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [OracleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target Oracle endpoint\\. For information about other available settings, see [ Extra connection attributes when using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.ConnectionAttrib) and [ Extra connection attributes when using Oracle as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.html#CHAP_Target.Oracle.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [OracleSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OracleSettings" }, "Password": { @@ -44299,27 +45243,27 @@ }, "PostgreSqlSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.PostgreSqlSettings", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [PostgreSqlSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target PostgreSQL endpoint\\. \nFor information about other available settings, see [ Extra connection attributes when using PostgreSQL as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) and [ Extra connection attributes when using PostgreSQL as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.html#CHAP_Target.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [PostgreSqlSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PostgreSqlSettings" }, "RedisSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.RedisSettings", - "markdownDescription": "Settings in JSON format for the target Redis endpoint\\. \n*Required*: No \n*Type*: [RedisSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the target Redis endpoint\\. For information about other available settings, see [ Specifying endpoint settings for Redis as a target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redis.html#CHAP_Target.Redis.EndpointSettings) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [RedisSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RedisSettings" }, "RedshiftSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.RedshiftSettings", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [RedshiftSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the Amazon Redshift endpoint\\. \nFor more information about other available settings, see [ Extra connection attributes when using Amazon Redshift as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redshift.html#CHAP_Target.Redshift.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [RedshiftSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RedshiftSettings" }, "ResourceIdentifier": { - "markdownDescription": "A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. \nFor example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceIdentifier", "type": "string" }, "S3Settings": { "$ref": "#/definitions/AWS::DMS::Endpoint.S3Settings", - "markdownDescription": "Settings in JSON format for the target Amazon S3 endpoint\\. For more information about the available settings, see [Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [S3Settings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target Amazon S3 endpoint\\. For more information about other available settings, see [ Extra connection attributes when using Amazon S3 as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.S3.html#CHAP_Source.S3.Configuring) and [ Extra connection attributes when using Amazon S3 as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring) in the*AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [S3Settings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3Settings" }, "ServerName": { @@ -44328,20 +45272,20 @@ "type": "string" }, "SslMode": { - "markdownDescription": "The Secure Sockets Layer \\(SSL\\) mode to use for the SSL connection\\. The default is `none`\\. \nWhen `engine_name` is set to S3, then the only allowed value is `none`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `none | require | verify-ca | verify-full` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Secure Sockets Layer \\(SSL\\) mode to use for the SSL connection\\. The default is `none`\\. \nWhen `engine_name` is set to S3, the only allowed value is `none`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `none | require | verify-ca | verify-full` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SslMode", "type": "string" }, "SybaseSettings": { "$ref": "#/definitions/AWS::DMS::Endpoint.SybaseSettings", - "markdownDescription": "Settings in JSON format for the source and target SAP ASE endpoint\\. For information about other available settings, see [Extra connection attributes when using SAP ASE as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) and [Extra connection attributes when using SAP ASE as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: [SybaseSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings in JSON format for the source and target SAP ASE endpoint\\. For information about other available settings, see [ Extra connection attributes when using SAP ASE as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.html#CHAP_Source.SAP.ConnectionAttrib) and [ Extra connection attributes when using SAP ASE as a target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.html#CHAP_Target.SAP.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: [SybaseSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SybaseSettings" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "One or more tags to be assigned to the endpoint\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "One or more tags to be assigned to the endpoint\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -44382,21 +45326,27 @@ "additionalProperties": false, "properties": { "DocsToInvestigate": { + "markdownDescription": "Indicates the number of documents to preview to determine the document organization\\. Use this setting when `NestingLevel` is set to `\"one\"`\\. \nMust be a positive value greater than `0`\\. Default value is `1000`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DocsToInvestigate", "type": "number" }, "ExtractDocId": { + "markdownDescription": "Specifies the document ID\\. Use this setting when `NestingLevel` is set to `\"none\"`\\. \nDefault value is `\"false\"`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExtractDocId", "type": "boolean" }, "NestingLevel": { + "markdownDescription": "Specifies either document or table mode\\. \nDefault value is `\"none\"`\\. Specify `\"none\"` to use document mode\\. Specify `\"one\"` to use table mode\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `none | one` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NestingLevel", "type": "string" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the DocumentDB endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the DocumentDB endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" } @@ -44418,7 +45368,7 @@ "additionalProperties": false, "properties": { "EndpointUri": { - "markdownDescription": "The endpoint for the OpenSearch cluster\\. AWS DMS uses HTTPS if a transport protocol \\(http/https\\) is not specified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The endpoint for the OpenSearch cluster\\. AWS DMS uses HTTPS if a transport protocol \\(either HTTP or HTTPS\\) isn't specified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EndpointUri", "type": "string" }, @@ -44428,7 +45378,7 @@ "type": "number" }, "FullLoadErrorPercentage": { - "markdownDescription": "The maximum percentage of records that can fail to be written before a full load operation stops\\. \nTo avoid early failure, this counter is only effective after 1000 records are transferred\\. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window\\. If transfer of all records fail in the last 10 minutes, the full load operation stops\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum percentage of records that can fail to be written before a full load operation stops\\. \nTo avoid early failure, this counter is only effective after 1,000 records are transferred\\. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window\\. If transfer of all records fail in the last 10 minutes, the full load operation stops\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FullLoadErrorPercentage", "type": "number" }, @@ -44479,17 +45429,17 @@ "type": "string" }, "Port": { - "markdownDescription": "*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The port used by the endpoint database\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Port", "type": "number" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret.` The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. For more information on creating this `SecretsManagerSecret` and the `SecretsManagerAccessRoleArn` and `SecretsManagerSecretId` required to access it, see [Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the AWS Database Migration Service User Guide\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret.` The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "The full ARN, partial ARN, or friendly name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, @@ -44499,7 +45449,7 @@ "type": "string" }, "ServerTimezone": { - "markdownDescription": "Specifies the time zone for the source MySQL database\\. \nExample: `serverTimezone=US/Pacific;` \nNote: Do not enclose time zones in single quotes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the time zone for the source MySQL database\\. Don't enclose time zones in single quotation marks\\. \nExample: `serverTimezone=US/Pacific;` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServerTimezone", "type": "string" }, @@ -44515,22 +45465,28 @@ "additionalProperties": false, "properties": { "CurrentLsn": { + "markdownDescription": "For ongoing replication \\(CDC\\), use CurrentLSN to specify a log sequence number \\(LSN\\) where you want the replication to start\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CurrentLsn", "type": "string" }, "MaxKBytesPerRead": { + "markdownDescription": "Maximum number of bytes per read, as a NUMBER value\\. The default is 64 KB\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxKBytesPerRead", "type": "number" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value ofthe AWS Secrets Manager secret that allows access to the Db2 LUW endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the IBMDB2 endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "SetDataCaptureChanges": { + "markdownDescription": "Enables ongoing replication \\(CDC\\) as a BOOLEAN value\\. The default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SetDataCaptureChanges", "type": "boolean" } }, @@ -44540,7 +45496,7 @@ "additionalProperties": false, "properties": { "Broker": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A comma\\-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance\\. Specify each broker location in the form `broker-hostname-or-ip:port`\\. For example, `\"ec2-12-345-678-901.compute-1.amazonaws.com:2345\"`\\. For more information and examples of specifying a list of broker locations, see [ Using Apache Kafka as a target for AWS Database Migration Service](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Broker", "type": "string" }, @@ -44555,6 +45511,8 @@ "type": "boolean" }, "IncludePartitionValue": { + "markdownDescription": "Shows the partition value within the Kafka message output unless the partition type is `schema-table-type`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludePartitionValue", "type": "boolean" }, "IncludeTableAlterOperations": { @@ -44568,9 +45526,13 @@ "type": "boolean" }, "MessageFormat": { + "markdownDescription": "The output format for the records created on the endpoint\\. The message format is `JSON` \\(default\\) or `JSON_UNFORMATTED` \\(a single line with no tab\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `json | json-unformatted` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageFormat", "type": "string" }, "MessageMaxBytes": { + "markdownDescription": "The maximum size in bytes for records created on the endpoint The default is 1,000,000\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageMaxBytes", "type": "number" }, "NoHexPrefix": { @@ -44584,12 +45546,12 @@ "type": "boolean" }, "SaslPassword": { - "markdownDescription": "The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL\\-SSL authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL\\-SSL authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SaslPassword", "type": "string" }, "SaslUserName": { - "markdownDescription": "The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL\\-SSL authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL\\-SSL authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SaslUserName", "type": "string" }, @@ -44619,7 +45581,7 @@ "type": "string" }, "Topic": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The topic to which you migrate the data\\. If you don't specify a topic, AWS DMS specifies `\"kafka-default-topic\"` as the migration topic\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Topic", "type": "string" } @@ -44640,6 +45602,8 @@ "type": "boolean" }, "IncludePartitionValue": { + "markdownDescription": "Shows the partition value within the Kinesis message output, unless the partition type is `schema-table-type`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludePartitionValue", "type": "boolean" }, "IncludeTableAlterOperations": { @@ -44653,7 +45617,7 @@ "type": "boolean" }, "MessageFormat": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `json | json-unformatted` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The output format for the records created on the endpoint\\. The message format is `JSON` \\(default\\) or `JSON_UNFORMATTED` \\(a single line with no tab\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `json | json-unformatted` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageFormat", "type": "string" }, @@ -44668,12 +45632,12 @@ "type": "boolean" }, "ServiceAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the IAM role that AWS DMS uses to write to the Kinesis data stream\\. The role must allow the `iam:PassRole` action\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceAccessRoleArn", "type": "string" }, "StreamArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the Amazon Kinesis Data Streams endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamArn", "type": "string" } @@ -44684,34 +45648,48 @@ "additionalProperties": false, "properties": { "BcpPacketSize": { + "markdownDescription": "The maximum size of the packets \\(in bytes\\) used to transfer data using BCP\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BcpPacketSize", "type": "number" }, "ControlTablesFileGroup": { + "markdownDescription": "Specifies a file group for the AWS DMS internal tables\\. When the replication task starts, all the internal AWS DMS control tables \\(awsdms\\_ apply\\_exception, awsdms\\_apply, awsdms\\_changes\\) are created for the specified file group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ControlTablesFileGroup", "type": "string" }, "QuerySingleAlwaysOnNode": { + "markdownDescription": "Cleans and recreates table metadata information on the replication instance when a mismatch occurs\\. An example is a situation where running an alter DDL statement on a table might result in different information about the table cached in the replication instance\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "QuerySingleAlwaysOnNode", "type": "boolean" }, "ReadBackupOnly": { + "markdownDescription": "When this attribute is set to `Y`, AWS DMS only reads changes from transaction log backups and doesn't read from the active transaction log file during ongoing replication\\. Setting this parameter to `Y` enables you to control active transaction log file growth during full load and ongoing replication tasks\\. However, it can add some source latency to ongoing replication\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReadBackupOnly", "type": "boolean" }, "SafeguardPolicy": { + "markdownDescription": "Use this attribute to minimize the need to access the backup log and enable AWS DMS to prevent truncation using one of the following two methods\\. \n *Start transactions in the database:* This is the default method\\. When this method is used, AWS DMS prevents TLOG truncation by mimicking a transaction in the database\\. As long as such a transaction is open, changes that appear after the transaction started aren't truncated\\. If you need Microsoft Replication to be enabled in your database, then you must choose this method\\. \n *Exclusively use sp\\_repldone within a single task*: When this method is used, AWS DMS reads the changes and then uses sp\\_repldone to mark the TLOG transactions as ready for truncation\\. Although this method doesn't involve any transactional activities, it can only be used when Microsoft Replication isn't running\\. Also, when using this method, only one AWS DMS task can access the database at any given time\\. Therefore, if you need to run parallel AWS DMS tasks against the same database, use the default method\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SafeguardPolicy", "type": "string" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the SQL Server endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MicrosoftSQLServer endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "UseBcpFullLoad": { + "markdownDescription": "Use this to attribute to transfer data for full\\-load operations using BCP\\. When the target table contains an identity column that does not exist in the source table, you must disable the use BCP for loading table option\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseBcpFullLoad", "type": "boolean" }, "UseThirdPartyBackupDevice": { + "markdownDescription": "When this attribute is set to `Y`, DMS processes third\\-party transaction log backups if they are created in native format\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseThirdPartyBackupDevice", "type": "boolean" } }, @@ -44721,67 +45699,67 @@ "additionalProperties": false, "properties": { "AuthMechanism": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `default | mongodb_cr | scram_sha_1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The authentication mechanism you use to access the MongoDB source endpoint\\. \nFor the default value, in MongoDB version 2\\.x, `\"default\"` is `\"mongodb_cr\"`\\. For MongoDB version 3\\.x or later, `\"default\"` is `\"scram_sha_1\"`\\. This setting isn't used when `AuthType` is set to `\"no\"`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `default | mongodb_cr | scram_sha_1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthMechanism", "type": "string" }, "AuthSource": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The MongoDB database name\\. This setting isn't used when `AuthType` is set to `\"no\"`\\. \nThe default is `\"admin\"`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthSource", "type": "string" }, "AuthType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `no | password` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The authentication type you use to access the MongoDB source endpoint\\. \nWhen set to `\"no\"`, user name and password parameters are not used and can be empty\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `no | password` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthType", "type": "string" }, "DatabaseName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The database name on the MongoDB source endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DatabaseName", "type": "string" }, "DocsToInvestigate": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates the number of documents to preview to determine the document organization\\. Use this setting when `NestingLevel` is set to `\"one\"`\\. \nMust be a positive value greater than `0`\\. Default value is `1000`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DocsToInvestigate", "type": "string" }, "ExtractDocId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the document ID\\. Use this setting when `NestingLevel` is set to `\"none\"`\\. \nDefault value is `\"false\"`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExtractDocId", "type": "string" }, "NestingLevel": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `none | one` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies either document or table mode\\. \nDefault value is `\"none\"`\\. Specify `\"none\"` to use document mode\\. Specify `\"one\"` to use table mode\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `none | one` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NestingLevel", "type": "string" }, "Password": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The password for the user account you use to access the MongoDB source endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Password", "type": "string" }, "Port": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The port value for the MongoDB source endpoint\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Port", "type": "number" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MongoDB endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MongoDB endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "ServerName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the server on the MongoDB source endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServerName", "type": "string" }, "Username": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user name you use to access the MongoDB source endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Username", "type": "string" } @@ -44792,34 +45770,48 @@ "additionalProperties": false, "properties": { "AfterConnectScript": { + "markdownDescription": "Specifies a script to run immediately after AWS DMS connects to the endpoint\\. The migration task continues running regardless if the SQL statement succeeds or fails\\. \nFor this parameter, provide the code of the script itself, not the name of a file containing the script\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AfterConnectScript", "type": "string" }, "CleanSourceMetadataOnMismatch": { + "markdownDescription": "Cleans and recreates table metadata information on the replication instance when a mismatch occurs\\. For example, in a situation where running an alter DDL on the table could result in different information about the table cached in the replication instance\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CleanSourceMetadataOnMismatch", "type": "boolean" }, "EventsPollInterval": { + "markdownDescription": "Specifies how often to check the binary log for new changes/events when the database is idle\\. The default is five seconds\\. \nExample: `eventsPollInterval=5;` \nIn the example, AWS DMS checks for changes in the binary logs every five seconds\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventsPollInterval", "type": "number" }, "MaxFileSize": { + "markdownDescription": "Specifies the maximum size \\(in KB\\) of any \\.csv file used to transfer data to a MySQL\\-compatible database\\. \nExample: `maxFileSize=512` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxFileSize", "type": "number" }, "ParallelLoadThreads": { + "markdownDescription": "Improves performance when loading data into the MySQL\\-compatible target database\\. Specifies how many threads to use to load the data into the MySQL\\-compatible target database\\. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread\\. The default is one\\. \nExample: `parallelLoadThreads=1` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ParallelLoadThreads", "type": "number" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the MySQL endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "ServerTimezone": { + "markdownDescription": "Specifies the time zone for the source MySQL database\\. \nExample: `serverTimezone=US/Pacific;` \nNote: Do not enclose time zones in single quotes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerTimezone", "type": "string" }, "TargetDbType": { + "markdownDescription": "Specifies where to migrate source tables on the target, either to a single database or multiple databases\\. If you specify `SPECIFIC_DATABASE`, specify the database name using the `DatabaseName` parameter of the `Endpoint` object\\. \nExample: `targetDbType=MULTIPLE_DATABASES` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetDbType", "type": "string" } }, @@ -44834,7 +45826,7 @@ "type": "number" }, "IamAuthEnabled": { - "markdownDescription": "If you want AWS Identity and Access Management \\(IAM\\) authorization enabled for this endpoint, set this parameter to `true`\\. Then attach the appropriate IAM policy document to your service role specified by `ServiceAccessRoleArn`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If you want IAM authorization enabled for this endpoint, set this parameter to `true`\\. Then attach the appropriate IAM policy document to your service role specified by `ServiceAccessRoleArn`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IamAuthEnabled", "type": "boolean" }, @@ -44859,7 +45851,7 @@ "type": "string" }, "ServiceAccessRoleArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the service role that you created for the Neptune target endpoint\\. The role must allow the `iam:PassRole` action\\. For more information, see [Creating an IAM Service Role for Accessing Amazon Neptune as a Target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole) in the * AWS Database Migration Service User Guide\\. * \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the service role that you created for the Neptune target endpoint\\. The role must allow the `iam:PassRole` action\\. \nFor more information, see [ Creating an IAM Service Role for Accessing Amazon Neptune as a Target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceAccessRoleArn", "type": "string" } @@ -44870,119 +45862,181 @@ "additionalProperties": false, "properties": { "AccessAlternateDirectly": { + "markdownDescription": "Set this attribute to `false` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessAlternateDirectly", "type": "boolean" }, "AddSupplementalLogging": { + "markdownDescription": "Set this attribute to set up table\\-level supplemental logging for the Oracle database\\. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task\\. \nIf you use this option, you still need to enable database\\-level supplemental logging\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AddSupplementalLogging", "type": "boolean" }, "AdditionalArchivedLogDestId": { + "markdownDescription": "Set this attribute with `ArchivedLogDestId` in a primary/ standby setup\\. This attribute is useful in the case of a switchover\\. In this case, AWS DMS needs to know which destination to get archive redo logs from to read changes\\. This need arises because the previous primary instance is now a standby instance after switchover\\. \nAlthough AWS DMS supports the use of the Oracle `RESETLOGS` option to open the database, never use `RESETLOGS` unless necessary\\. For additional information about `RESETLOGS`, see [RMAN Data Repair Concepts](https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the *Oracle Database Backup and Recovery User's Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalArchivedLogDestId", "type": "number" }, "AllowSelectNestedTables": { + "markdownDescription": "Set this attribute to `true` to enable replication of Oracle tables containing columns that are nested tables or defined types\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowSelectNestedTables", "type": "boolean" }, "ArchivedLogDestId": { + "markdownDescription": "Specifies the ID of the destination for the archived redo logs\\. This value should be the same as a number in the dest\\_id column of the v$archived\\_log view\\. If you work with an additional redo log destination, use the `AdditionalArchivedLogDestId` option to specify the additional destination ID\\. Doing this improves performance by ensuring that the correct logs are accessed from the outset\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ArchivedLogDestId", "type": "number" }, "ArchivedLogsOnly": { + "markdownDescription": "When this field is set to `Y`, AWS DMS only accesses the archived redo logs\\. If the archived redo logs are stored on Automatic Storage Management \\(ASM\\) only, the AWS DMS user account needs to be granted ASM privileges\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ArchivedLogsOnly", "type": "boolean" }, "AsmPassword": { + "markdownDescription": "For an Oracle source endpoint, your Oracle Automatic Storage Management \\(ASM\\) password\\. You can set this value from the ` asm_user_password ` value\\. You set this value as part of the comma\\-separated value that you set to the `Password` request parameter when you create the endpoint to access transaction logs using Binary Reader\\. For more information, see [Configuration for change data capture \\(CDC\\) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AsmPassword", "type": "string" }, "AsmServer": { + "markdownDescription": "For an Oracle source endpoint, your ASM server address\\. You can set this value from the `asm_server` value\\. You set `asm_server` as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM\\. For more information, see [Configuration for change data capture \\(CDC\\) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AsmServer", "type": "string" }, "AsmUser": { + "markdownDescription": "For an Oracle source endpoint, your ASM user name\\. You can set this value from the `asm_user` value\\. You set `asm_user` as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM\\. For more information, see [Configuration for change data capture \\(CDC\\) on an Oracle source database](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AsmUser", "type": "string" }, "CharLengthSemantics": { + "markdownDescription": "Specifies whether the length of a character column is in bytes or in characters\\. To indicate that the character column length is in characters, set this attribute to `CHAR`\\. Otherwise, the character column length is in bytes\\. \nExample: `charLengthSemantics=CHAR;` \n*Required*: No \n*Type*: String \n*Allowed values*: `byte | char | default` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CharLengthSemantics", "type": "string" }, "DirectPathNoLog": { + "markdownDescription": "When set to `true`, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DirectPathNoLog", "type": "boolean" }, "DirectPathParallelLoad": { + "markdownDescription": "When set to `true`, this attribute specifies a parallel load when `useDirectPathFullLoad` is set to `Y`\\. This attribute also only applies when you use the AWS DMS parallel load feature\\. Note that the target table cannot have any constraints or indexes\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DirectPathParallelLoad", "type": "boolean" }, "EnableHomogenousTablespace": { + "markdownDescription": "Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableHomogenousTablespace", "type": "boolean" }, "ExtraArchivedLogDestIds": { "items": { "type": "number" }, + "markdownDescription": "Specifies the IDs of one more destinations for one or more archived redo logs\\. These IDs are the values of the `dest_id` column in the `v$archived_log` view\\. Use this setting with the `archivedLogDestId` extra connection attribute in a primary\\-to\\-single setup or a primary\\-to\\-multiple\\-standby setup\\. \nThis setting is useful in a switchover when you use an Oracle Data Guard database as a source\\. In this case, AWS DMS needs information about what destination to get archive redo logs from to read changes\\. AWS DMS needs this because after the switchover the previous primary is a standby instance\\. For example, in a primary\\-to\\-single standby setup you might apply the following settings\\. \n `archivedLogDestId=1; ExtraArchivedLogDestIds=[2]` \nIn a primary\\-to\\-multiple\\-standby setup, you might apply the following settings\\. \n `archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]` \nAlthough AWS DMS supports the use of the Oracle `RESETLOGS` option to open the database, never use `RESETLOGS` unless it's necessary\\. For more information about `RESETLOGS`, see [ RMAN Data Repair Concepts](https://docs.oracle.com/en/database/oracle/oracle-database/19/bradv/rman-data-repair-concepts.html#GUID-1805CCF7-4AF2-482D-B65A-998192F89C2B) in the *Oracle Database Backup and Recovery User's Guide*\\. \n*Required*: No \n*Type*: List of Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExtraArchivedLogDestIds", "type": "array" }, "FailTasksOnLobTruncation": { + "markdownDescription": "When set to `true`, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified `LobMaxSize`\\. \nIf a task is set to limited LOB mode and this option is set to `true`, the task fails instead of truncating the LOB data\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailTasksOnLobTruncation", "type": "boolean" }, "NumberDatatypeScale": { + "markdownDescription": "Specifies the number scale\\. You can select a scale up to 38, or you can select FLOAT\\. By default, the NUMBER data type is converted to precision 38, scale 10\\. \nExample: `numberDataTypeScale=12` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NumberDatatypeScale", "type": "number" }, "OraclePathPrefix": { + "markdownDescription": "Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This value specifies the default Oracle root used to access the redo logs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OraclePathPrefix", "type": "string" }, "ParallelAsmReadThreads": { + "markdownDescription": "Set this attribute to change the number of threads that DMS configures to perform a change data capture \\(CDC\\) load using Oracle Automatic Storage Management \\(ASM\\)\\. You can specify an integer value between 2 \\(the default\\) and 8 \\(the maximum\\)\\. Use this attribute together with the `readAheadBlocks` attribute\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ParallelAsmReadThreads", "type": "number" }, "ReadAheadBlocks": { + "markdownDescription": "Set this attribute to change the number of read\\-ahead blocks that DMS configures to perform a change data capture \\(CDC\\) load using Oracle Automatic Storage Management \\(ASM\\)\\. You can specify an integer value between 1000 \\(the default\\) and 200,000 \\(the maximum\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReadAheadBlocks", "type": "number" }, "ReadTableSpaceName": { + "markdownDescription": "When set to `true`, this attribute supports tablespace replication\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReadTableSpaceName", "type": "boolean" }, "ReplacePathPrefix": { + "markdownDescription": "Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This setting tells DMS instance to replace the default Oracle root with the specified `usePathPrefix` setting to access the redo logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReplacePathPrefix", "type": "boolean" }, "RetryInterval": { + "markdownDescription": "Specifies the number of seconds that the system waits before resending a query\\. \nExample: `retryInterval=6;` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetryInterval", "type": "number" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the Oracle endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerOracleAsmAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Required only if your Oracle endpoint uses Advanced Storage Manager \\(ASM\\)\\. The full ARN of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the `SecretsManagerOracleAsmSecret`\\. This `SecretsManagerOracleAsmSecret` has the secret value that allows access to the Oracle ASM of the endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerOracleAsmSecretId`\\. Or you can specify clear\\-text values for `AsmUserName`, `AsmPassword`, and `AsmServerName`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerOracleAsmSecret`, the corresponding `SecretsManagerOracleAsmAccessRoleArn`, and the `SecretsManagerOracleAsmSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerOracleAsmAccessRoleArn", "type": "string" }, "SecretsManagerOracleAsmSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Required only if your Oracle endpoint uses Advanced Storage Manager \\(ASM\\)\\. The full ARN, partial ARN, or display name of the `SecretsManagerOracleAsmSecret` that contains the Oracle ASM connection details for the Oracle endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerOracleAsmSecretId", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the Oracle endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "SecurityDbEncryption": { + "markdownDescription": "For an Oracle source endpoint, the transparent data encryption \\(TDE\\) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader\\. It is also the ` TDE_Password ` part of the comma\\-separated value you set to the `Password` request parameter when you create the endpoint\\. The `SecurityDbEncryptian` setting is related to this `SecurityDbEncryptionName` setting\\. For more information, see [ Supported encryption methods for using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) in the * AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityDbEncryption", "type": "string" }, "SecurityDbEncryptionName": { + "markdownDescription": "For an Oracle source endpoint, the name of a key used for the transparent data encryption \\(TDE\\) of the columns and tablespaces in an Oracle source database that is encrypted using TDE\\. The key value is the value of the `SecurityDbEncryption` setting\\. For more information on setting the key name value of `SecurityDbEncryptionName`, see the information and example for setting the `securityDbEncryptionName` extra connection attribute in [ Supported encryption methods for using Oracle as a source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) in the * AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityDbEncryptionName", "type": "string" }, "SpatialDataOptionToGeoJsonFunctionName": { + "markdownDescription": "Use this attribute to convert `SDO_GEOMETRY` to `GEOJSON` format\\. By default, DMS calls the `SDO2GEOJSON` custom function if present and accessible\\. Or you can create your own custom function that mimics the operation of `SDOGEOJSON` and set `SpatialDataOptionToGeoJsonFunctionName` to call it instead\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SpatialDataOptionToGeoJsonFunctionName", "type": "string" }, "StandbyDelayTime": { + "markdownDescription": "Use this attribute to specify a time in minutes for the delay in standby sync\\. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases\\. \nIn AWS DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes\\. Doing this eliminates the need to connect to an active database that might be in production\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StandbyDelayTime", "type": "number" }, "UseAlternateFolderForOnline": { + "markdownDescription": "Set this attribute to `true` in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This tells the DMS instance to use any specified prefix replacement to access all online redo logs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseAlternateFolderForOnline", "type": "boolean" }, "UseBFile": { + "markdownDescription": "Set this attribute to Y to capture change data using the Binary Reader utility\\. Set `UseLogminerReader` to N to set this attribute to Y\\. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes\\. For more information about using this setting with Oracle Automatic Storage Management \\(ASM\\), see [ Using Oracle LogMiner or AWS DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseBFile", "type": "boolean" }, "UseDirectPathFullLoad": { + "markdownDescription": "Set this attribute to Y to have AWS DMS use a direct path full load\\. Specify this value to use the direct path protocol in the Oracle Call Interface \\(OCI\\)\\. By using this OCI protocol, you can bulk\\-load Oracle target tables during a full load\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseDirectPathFullLoad", "type": "boolean" }, "UseLogminerReader": { + "markdownDescription": "Set this attribute to Y to capture change data using the Oracle LogMiner utility \\(the default\\)\\. Set this attribute to N if you want to access the redo logs as a binary file\\. When you set `UseLogminerReader` to N, also set `UseBfile` to Y\\. For more information on this setting and using Oracle ASM, see [ Using Oracle LogMiner or AWS DMS Binary Reader for CDC](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC) in the * AWS DMS User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseLogminerReader", "type": "boolean" }, "UsePathPrefix": { + "markdownDescription": "Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source\\. This value specifies the path prefix used to replace the default Oracle root to access the redo logs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UsePathPrefix", "type": "string" } }, @@ -44992,46 +46046,68 @@ "additionalProperties": false, "properties": { "AfterConnectScript": { + "markdownDescription": "For use with change data capture \\(CDC\\) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data\\. \nExample: `afterConnectScript=SET session_replication_role='replica'` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AfterConnectScript", "type": "string" }, "CaptureDdls": { + "markdownDescription": "To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts\\. You can later remove these artifacts\\. \nIf this value is set to `N`, you don't have to create tables or triggers on the source database\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CaptureDdls", "type": "boolean" }, "DdlArtifactsSchema": { + "markdownDescription": "The schema in which the operational DDL database artifacts are created\\. \nExample: `ddlArtifactsSchema=xyzddlschema;` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DdlArtifactsSchema", "type": "string" }, "ExecuteTimeout": { + "markdownDescription": "Sets the client statement timeout for the PostgreSQL instance, in seconds\\. The default value is 60 seconds\\. \nExample: `executeTimeout=100;` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExecuteTimeout", "type": "number" }, "FailTasksOnLobTruncation": { + "markdownDescription": "When set to `true`, this value causes a task to fail if the actual size of a LOB column is greater than the specified `LobMaxSize`\\. \nIf task is set to Limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailTasksOnLobTruncation", "type": "boolean" }, "HeartbeatEnable": { + "markdownDescription": "The write\\-ahead log \\(WAL\\) heartbeat feature mimics a dummy transaction\\. By doing this, it prevents idle logical replication slots from holding onto old WAL logs, which can result in storage full situations on the source\\. This heartbeat keeps `restart_lsn` moving and prevents storage full scenarios\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HeartbeatEnable", "type": "boolean" }, "HeartbeatFrequency": { + "markdownDescription": "Sets the WAL heartbeat frequency \\(in minutes\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HeartbeatFrequency", "type": "number" }, "HeartbeatSchema": { + "markdownDescription": "Sets the schema in which the heartbeat artifacts are created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HeartbeatSchema", "type": "string" }, "MaxFileSize": { + "markdownDescription": "Specifies the maximum size \\(in KB\\) of any \\.csv file used to transfer data to PostgreSQL\\. \nExample: `maxFileSize=512` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxFileSize", "type": "number" }, "PluginName": { + "markdownDescription": "Specifies the plugin to use to create a replication slot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PluginName", "type": "string" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the PostgreSQL endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the PostgreSQL endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "SlotName": { + "markdownDescription": "Sets the name of a previously created logical replication slot for a change data capture \\(CDC\\) load of the PostgreSQL source instance\\. \nWhen used with the `CdcStartPosition` request parameter for the AWS DMS API , this attribute also makes it possible to use native CDC start points\\. DMS verifies that the specified logical replication slot exists before starting the CDC load task\\. It also verifies that the task was created with a valid setting of `CdcStartPosition`\\. If the specified slot doesn't exist or the task doesn't have a valid `CdcStartPosition` setting, DMS raises an error\\. \nFor more information about setting the `CdcStartPosition` request parameter, see [Determining a CDC native start point](dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native) in the * AWS Database Migration Service User Guide*\\. For more information about using `CdcStartPosition`, see [CreateReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html), [StartReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html), and [ModifyReplicationTask](https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SlotName", "type": "string" } }, @@ -45082,82 +46158,128 @@ "additionalProperties": false, "properties": { "AcceptAnyDate": { + "markdownDescription": "A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error\\. You can choose `true` or `false` \\(the default\\)\\. \nThis parameter applies only to TIMESTAMP and DATE columns\\. Always use ACCEPTANYDATE with the DATEFORMAT parameter\\. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AcceptAnyDate", "type": "boolean" }, "AfterConnectScript": { + "markdownDescription": "Code to run after connecting\\. This parameter should contain the code itself, not the name of a file containing the code\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AfterConnectScript", "type": "string" }, "BucketFolder": { + "markdownDescription": "An S3 folder where the comma\\-separated\\-value \\(\\.csv\\) files are stored before being uploaded to the target Redshift cluster\\. \nFor full load mode, AWS DMS converts source records into \\.csv files and loads them to the *BucketFolder/TableID* path\\. AWS DMS uses the Redshift `COPY` command to upload the \\.csv files to the target table\\. The files are deleted once the `COPY` operation has finished\\. For more information, see [COPY](https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html) in the *Amazon Redshift Database Developer Guide*\\. \nFor change\\-data\\-capture \\(CDC\\) mode, AWS DMS creates a *NetChanges* table, and loads the \\.csv files to this *BucketFolder/NetChangesTableID* path\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketFolder", "type": "string" }, "BucketName": { + "markdownDescription": "The name of the intermediate S3 bucket used to store \\.csv files before uploading data to Redshift\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketName", "type": "string" }, "CaseSensitiveNames": { + "markdownDescription": "If Amazon Redshift is configured to support case sensitive schema names, set `CaseSensitiveNames` to `true`\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CaseSensitiveNames", "type": "boolean" }, "CompUpdate": { + "markdownDescription": "If you set `CompUpdate` to `true` Amazon Redshift applies automatic compression if the table is empty\\. This applies even if the table columns already have encodings other than `RAW`\\. If you set `CompUpdate` to `false`, automatic compression is disabled and existing column encodings aren't changed\\. The default is `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CompUpdate", "type": "boolean" }, "ConnectionTimeout": { + "markdownDescription": "A value that sets the amount of time to wait \\(in milliseconds\\) before timing out, beginning from when you initially establish a connection\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConnectionTimeout", "type": "number" }, "DateFormat": { + "markdownDescription": "The date format that you are using\\. Valid values are `auto` \\(case\\-sensitive\\), your date format string enclosed in quotes, or NULL\\. If this parameter is left unset \\(NULL\\), it defaults to a format of 'YYYY\\-MM\\-DD'\\. Using `auto` recognizes most strings, even some that aren't supported when you use a date format string\\. \nIf your date and time values use formats different from each other, set this to `auto`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DateFormat", "type": "string" }, "EmptyAsNull": { + "markdownDescription": "A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL\\. A value of `true` sets empty CHAR and VARCHAR fields to null\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EmptyAsNull", "type": "boolean" }, "EncryptionMode": { + "markdownDescription": "The type of server\\-side encryption that you want to use for your data\\. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3\\. You can choose either `SSE_S3` \\(the default\\) or `SSE_KMS`\\. \nFor the `ModifyEndpoint` operation, you can change the existing value of the `EncryptionMode` parameter from `SSE_KMS` to `SSE_S3`\\. But you can\u2019t change the existing value from `SSE_S3` to `SSE_KMS`\\.\nTo use `SSE_S3`, create an AWS Identity and Access Management \\(IAM\\) role with a policy that allows `\"arn:aws:s3:::*\"` to use the following actions: `\"s3:PutObject\", \"s3:ListBucket\"` \n*Required*: No \n*Type*: String \n*Allowed values*: `sse-kms | sse-s3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionMode", "type": "string" }, "ExplicitIds": { + "markdownDescription": "This setting is only valid for a full\\-load migration task\\. Set `ExplicitIds` to `true` to have tables with `IDENTITY` columns override their auto\\-generated values with explicit values loaded from the source data files used to populate the tables\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExplicitIds", "type": "boolean" }, "FileTransferUploadStreams": { + "markdownDescription": "The number of threads used to upload a single file\\. This parameter accepts a value from 1 through 64\\. It defaults to 10\\. \nThe number of parallel streams used to upload a single \\.csv file to an S3 bucket using S3 Multipart Upload\\. For more information, see [Multipart upload overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html)\\. \n `FileTransferUploadStreams` accepts a value from 1 through 64\\. It defaults to 10\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FileTransferUploadStreams", "type": "number" }, "LoadTimeout": { + "markdownDescription": "The amount of time to wait \\(in milliseconds\\) before timing out of operations performed by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LoadTimeout", "type": "number" }, "MaxFileSize": { + "markdownDescription": "The maximum size \\(in KB\\) of any \\.csv file used to load data on an S3 bucket and transfer data to Amazon Redshift\\. It defaults to 1048576KB \\(1 GB\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxFileSize", "type": "number" }, "RemoveQuotes": { + "markdownDescription": "A value that specifies to remove surrounding quotation marks from strings in the incoming data\\. All characters within the quotation marks, including delimiters, are retained\\. Choose `true` to remove quotation marks\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RemoveQuotes", "type": "boolean" }, "ReplaceChars": { + "markdownDescription": "A value that specifies to replaces the invalid characters specified in `ReplaceInvalidChars`, substituting the specified characters instead\\. The default is `\"?\"`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReplaceChars", "type": "string" }, "ReplaceInvalidChars": { + "markdownDescription": "A list of characters that you want to replace\\. Use with `ReplaceChars`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReplaceInvalidChars", "type": "string" }, "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the Amazon Redshift endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the Amazon Redshift endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" }, "ServerSideEncryptionKmsKeyId": { + "markdownDescription": "The AWS KMS key ID\\. If you are using `SSE_KMS` for the `EncryptionMode`, provide this key ID\\. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerSideEncryptionKmsKeyId", "type": "string" }, "ServiceAccessRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IAM role that has access to the Amazon Redshift service\\. The role must allow the `iam:PassRole` action\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceAccessRoleArn", "type": "string" }, "TimeFormat": { + "markdownDescription": "The time format that you want to use\\. Valid values are `auto` \\(case\\-sensitive\\), `'timeformat_string'`, `'epochsecs'`, or `'epochmillisecs'`\\. It defaults to 10\\. Using `auto` recognizes most strings, even some that aren't supported when you use a time format string\\. \nIf your date and time values use formats different from each other, set this parameter to `auto`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TimeFormat", "type": "string" }, "TrimBlanks": { + "markdownDescription": "A value that specifies to remove the trailing white space characters from a VARCHAR string\\. This parameter applies only to columns with a VARCHAR data type\\. Choose `true` to remove unneeded white space\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrimBlanks", "type": "boolean" }, "TruncateColumns": { + "markdownDescription": "A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column\\. This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less\\. Choose `true` to truncate data\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TruncateColumns", "type": "boolean" }, "WriteBufferSize": { + "markdownDescription": "The size \\(in KB\\) of the in\\-memory file write buffer used when generating \\.csv files on the local disk at the DMS replication instance\\. The default value is 1000 \\(buffer size is 1000KB\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WriteBufferSize", "type": "number" } }, @@ -45172,27 +46294,27 @@ "type": "boolean" }, "BucketFolder": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional parameter to set a folder name in the S3 bucket\\. If provided, tables are created in the path `bucketFolder/schema_name/table_name/`\\. If this parameter isn't specified, the path used is `schema_name/table_name/`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BucketFolder", "type": "string" }, "BucketName": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BucketName", "type": "string" }, "CannedAclForObjects": { - "markdownDescription": "A value that enables AWS DMS to specify a predefined \\(canned\\) access control list for objects created in an Amazon S3 bucket as \\.csv or \\.parquet files\\. For more information about Amazon S3 canned ACLs, see [Canned ACL](http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 Developer Guide\\.* \nThe default value is NONE\\. Valid values include NONE, PRIVATE, PUBLIC\\_READ, PUBLIC\\_READ\\_WRITE, AUTHENTICATED\\_READ, AWS\\_EXEC\\_READ, BUCKET\\_OWNER\\_READ, and BUCKET\\_OWNER\\_FULL\\_CONTROL\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `authenticated-read | aws-exec-read | bucket-owner-full-control | bucket-owner-read | none | private | public-read | public-read-write` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that enables AWS DMS to specify a predefined \\(canned\\) access control list \\(ACL\\) for objects created in an Amazon S3 bucket as \\.csv or \\.parquet files\\. For more information about Amazon S3 canned ACLs, see [ Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 Developer Guide*\\. \nThe default value is NONE\\. Valid values include NONE, PRIVATE, PUBLIC\\_READ, PUBLIC\\_READ\\_WRITE, AUTHENTICATED\\_READ, AWS\\_EXEC\\_READ, BUCKET\\_OWNER\\_READ, and BUCKET\\_OWNER\\_FULL\\_CONTROL\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `authenticated-read | aws-exec-read | bucket-owner-full-control | bucket-owner-read | none | private | public-read | public-read-write` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CannedAclForObjects", "type": "string" }, "CdcInsertsAndUpdates": { - "markdownDescription": "A value that enables a change data capture \\(CDC\\) load to write INSERT and UPDATE operations to \\.csv or \\.parquet \\(columnar storage\\) output files\\. The default setting is `false`, but when `CdcInsertsAndUpdates` is set to `true` or `y`, only INSERTs and UPDATEs from the source database are migrated to the \\.csv or \\.parquet file\\. \nFor \\.csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the `IncludeOpForFullLoad` parameter\\. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to either `I` or `U` to indicate INSERT and UPDATE operations at the source\\. But if `IncludeOpForFullLoad` is set to `false`, CDC records are written without an indication of INSERT or UPDATE operations at the source\\. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the * AWS Database Migration Service User Guide\\.*\\. \n AWS DMS supports the use of the `CdcInsertsAndUpdates` parameter in versions 3\\.3\\.1 and later\\. \n `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint\\. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that enables a change data capture \\(CDC\\) load to write INSERT and UPDATE operations to \\.csv or \\.parquet \\(columnar storage\\) output files\\. The default setting is `false`, but when `CdcInsertsAndUpdates` is set to `true` or `y`, only INSERTs and UPDATEs from the source database are migrated to the \\.csv or \\.parquet file\\. \nFor \\.csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the `IncludeOpForFullLoad` parameter\\. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to either `I` or `U` to indicate INSERT and UPDATE operations at the source\\. But if `IncludeOpForFullLoad` is set to `false`, CDC records are written without an indication of INSERT or UPDATE operations at the source\\. For more information about how these settings work together, see [ Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide*\\. \n AWS DMS supports the use of the `CdcInsertsAndUpdates` parameter in versions 3\\.3\\.1 and later\\. \n `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint\\. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdcInsertsAndUpdates", "type": "boolean" }, "CdcInsertsOnly": { - "markdownDescription": "A value that enables a change data capture \\(CDC\\) load to write only INSERT operations to \\.csv or columnar storage \\(\\.parquet\\) output files\\. By default \\(the `false` setting\\), the first field in a \\.csv or \\.parquet record contains the letter I \\(INSERT\\), U \\(UPDATE\\), or D \\(DELETE\\)\\. These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target\\. \nIf `CdcInsertsOnly` is set to `true` or `y`, only INSERTs from the source database are migrated to the \\.csv or \\.parquet file\\. For \\.csv format only, how these INSERTs are recorded depends on the value of `IncludeOpForFullLoad`\\. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to I to indicate the INSERT operation at the source\\. If `IncludeOpForFullLoad` is set to `false`, every CDC record is written without a first field to indicate the INSERT operation at the source\\. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the * AWS Database Migration Service User Guide\\.*\\. \n AWS DMS supports the interaction described preceding between the `CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in versions 3\\.1\\.4 and later\\. \n `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint\\. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that enables a change data capture \\(CDC\\) load to write only INSERT operations to \\.csv or columnar storage \\(\\.parquet\\) output files\\. By default \\(the `false` setting\\), the first field in a \\.csv or \\.parquet record contains the letter I \\(INSERT\\), U \\(UPDATE\\), or D \\(DELETE\\)\\. These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target\\. \nIf `CdcInsertsOnly` is set to `true` or `y`, only INSERTs from the source database are migrated to the \\.csv or \\.parquet file\\. For \\.csv format only, how these INSERTs are recorded depends on the value of `IncludeOpForFullLoad`\\. If `IncludeOpForFullLoad` is set to `true`, the first field of every CDC record is set to I to indicate the INSERT operation at the source\\. If `IncludeOpForFullLoad` is set to `false`, every CDC record is written without a first field to indicate the INSERT operation at the source\\. For more information about how these settings work together, see [ Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide*\\. \nAWS DMS supports the interaction described preceding between the `CdcInsertsOnly` and `IncludeOpForFullLoad` parameters in versions 3\\.1\\.4 and later\\. \n `CdcInsertsOnly` and `CdcInsertsAndUpdates` can't both be set to `true` for the same endpoint\\. Set either `CdcInsertsOnly` or `CdcInsertsAndUpdates` to `true` for the same endpoint, but not both\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdcInsertsOnly", "type": "boolean" }, @@ -45202,22 +46324,22 @@ "type": "number" }, "CdcMinFileSize": { - "markdownDescription": "Minimum file size, defined in megabytes, to reach for a file output to Amazon S3\\. \nWhen `CdcMinFileSize` and `CdcMaxBatchInterval` are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template\\. \nThe default value is 32 MB\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Minimum file size, defined in kilobytes, to reach for a file output to Amazon S3\\. \nWhen `CdcMinFileSize` and `CdcMaxBatchInterval` are both specified, the file write is triggered by whichever parameter condition is met first within an AWS DMS CloudFormation template\\. \nThe default value is 32 MB\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdcMinFileSize", "type": "number" }, "CdcPath": { - "markdownDescription": "Specifies the folder path of CDC files\\. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional\\. If `CdcPath` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint\\. For an S3 target if you set [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) to `true`, AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load\\. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) and [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName)\\. \nFor example, if you specify `CdcPath` as `MyChangedData`, and you specify `BucketName` as `MyTargetBucket` but do not specify `BucketFolder`, AWS DMS creates the CDC folder path following: `MyTargetBucket/MyChangedData`\\. \nIf you specify the same `CdcPath`, and you specify `BucketName` as `MyTargetBucket` and `BucketFolder` as `MyTargetData`, AWS DMS creates the CDC folder path following: `MyTargetBucket/MyTargetData/MyChangedData`\\. \nFor more information on CDC including transaction order on an S3 target, see [Capturing data changes \\(CDC\\) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath)\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.2 and later\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the folder path of CDC files\\. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional\\. If `CdcPath` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint\\. For an S3 target if you set [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-PreserveTransactions) to `true`, AWS DMS verifies that you have set this parameter to a folder path on your S3 target where AWS DMS can save the transaction order for the CDC load\\. AWS DMS creates this CDC folder path in either your S3 target working directory or the S3 target location specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketFolder) and [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-BucketName)\\. \nFor example, if you specify `CdcPath` as `MyChangedData`, and you specify `BucketName` as `MyTargetBucket` but do not specify `BucketFolder`, AWS DMS creates the CDC folder path following: `MyTargetBucket/MyChangedData`\\. \nIf you specify the same `CdcPath`, and you specify `BucketName` as `MyTargetBucket` and `BucketFolder` as `MyTargetData`, AWS DMS creates the CDC folder path following: `MyTargetBucket/MyTargetData/MyChangedData`\\. \nFor more information on CDC including transaction order on an S3 target, see [ Capturing data changes \\(CDC\\) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath)\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.2 and later\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdcPath", "type": "string" }, "CompressionType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `gzip | none` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional parameter\\. When set to GZIP it enables the service to compress the target files\\. To allow the service to write the target files uncompressed, either set this parameter to NONE \\(the default\\) or don't specify the parameter at all\\. This parameter applies to both \\.csv and \\.parquet file formats\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `gzip | none` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CompressionType", "type": "string" }, "CsvDelimiter": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The delimiter used to separate columns in the \\.csv file for both source and target\\. The default is a comma\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CsvDelimiter", "type": "string" }, @@ -45232,7 +46354,7 @@ "type": "string" }, "CsvRowDelimiter": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The delimiter used to separate rows in the \\.csv file for both source and target\\. \nThe default is a carriage return \\(`\\n`\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CsvRowDelimiter", "type": "string" }, @@ -45252,7 +46374,7 @@ "type": "string" }, "DatePartitionEnabled": { - "markdownDescription": "When set to `true`, this parameter partitions S3 bucket folders based on transaction commit dates\\. The default value is `false`\\. For more information about date\\-based folder partitioning, see [Using date\\-based folder partitioning](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When set to `true`, this parameter partitions S3 bucket folders based on transaction commit dates\\. The default value is `false`\\. For more information about date\\-based folder partitioning, see [ Using date\\-based folder partitioning](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.DatePartitioning)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DatePartitionEnabled", "type": "boolean" }, @@ -45262,7 +46384,7 @@ "type": "string" }, "DatePartitionTimezone": { - "markdownDescription": "When creating an S3 target endpoint, set `DatePartitionTimezone` to convert the current UTC time into a specified time zone\\. The conversion occurs when a date partition folder is created and a CDC filename is generated\\. The time zone format is Area/Location\\. Use this parameter when `DatePartitionedEnabled` is set to `true`, as shown in the following example\\. \n `s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\", \"DatePartitionDelimiter\": \"SLASH\", \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\": \"dms-nattarat-test\"}'` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When creating an S3 target endpoint, set `DatePartitionTimezone` to convert the current UTC time into a specified time zone\\. The conversion occurs when a date partition folder is created and a change data capture \\(CDC\\) file name is generated\\. The time zone format is Area/Location\\. Use this parameter when `DatePartitionedEnabled` is set to `true`, as shown in the following example\\. \n `s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\", \"DatePartitionDelimiter\": \"SLASH\", \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\": \"dms-nattarat-test\"}'` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DatePartitionTimezone", "type": "string" }, @@ -45277,17 +46399,17 @@ "type": "boolean" }, "EncodingType": { - "markdownDescription": "The type of encoding you are using: \n+ `RLE_DICTIONARY` uses a combination of bit\\-packing and run\\-length encoding to store repeated values more efficiently\\. This is the default\\.\n+ `PLAIN` doesn't use encoding at all\\. Values are stored as they are\\.\n+ `PLAIN_DICTIONARY` builds a dictionary of the values encountered in a given column\\. The dictionary is stored in a dictionary page for each column chunk\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `plain | plain-dictionary | rle-dictionary` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of encoding that you're using: \n+ `RLE_DICTIONARY` uses a combination of bit\\-packing and run\\-length encoding to store repeated values more efficiently\\. This is the default\\.\n+ `PLAIN` doesn't use encoding at all\\. Values are stored as they are\\.\n+ `PLAIN_DICTIONARY` builds a dictionary of the values encountered in a given column\\. The dictionary is stored in a dictionary page for each column chunk\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `plain | plain-dictionary | rle-dictionary` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EncodingType", "type": "string" }, "EncryptionMode": { - "markdownDescription": "The type of server\\-side encryption that you want to use for your data\\. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3\\. You can choose either `SSE_S3` \\(the default\\) or `SSE_KMS`\\. \nFor the `ModifyEndpoint` operation, you can change the existing value of the `EncryptionMode` parameter from `SSE_KMS` to `SSE_S3`\\. But you can\u2019t change the existing value from `SSE_S3` to `SSE_KMS`\\.\nTo use `SSE_S3`, you need an AWS Identity and Access Management \\(IAM\\) role with permission to allow `\"arn:aws:s3:::dms-*\"` to use the following actions: \n+ `s3:CreateBucket` \n+ `s3:ListBucket` \n+ `s3:DeleteBucket` \n+ `s3:GetBucketLocation` \n+ `s3:GetObject` \n+ `s3:PutObject` \n+ `s3:DeleteObject` \n+ `s3:GetObjectVersion` \n+ `s3:GetBucketPolicy` \n+ `s3:PutBucketPolicy` \n+ `s3:DeleteBucketPolicy` \n*Required*: No \n*Type*: String \n*Allowed values*: `sse-kms | sse-s3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of server\\-side encryption that you want to use for your data\\. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3\\. You can choose either `SSE_S3` \\(the default\\) or `SSE_KMS`\\. \nFor the `ModifyEndpoint` operation, you can change the existing value of the `EncryptionMode` parameter from `SSE_KMS` to `SSE_S3`\\. But you can\u2019t change the existing value from `SSE_S3` to `SSE_KMS`\\.\nTo use `SSE_S3`, you need an IAM role with permission to allow `\"arn:aws:s3:::dms-*\"` to use the following actions: \n+ `s3:CreateBucket` \n+ `s3:ListBucket` \n+ `s3:DeleteBucket` \n+ `s3:GetBucketLocation` \n+ `s3:GetObject` \n+ `s3:PutObject` \n+ `s3:DeleteObject` \n+ `s3:GetObjectVersion` \n+ `s3:GetBucketPolicy` \n+ `s3:PutBucketPolicy` \n+ `s3:DeleteBucketPolicy` \n*Required*: No \n*Type*: String \n*Allowed values*: `sse-kms | sse-s3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EncryptionMode", "type": "string" }, "ExternalTableDefinition": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The external table definition\\. \nConditional: If `S3` is used as a source then `ExternalTableDefinition` is required\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExternalTableDefinition", "type": "string" }, @@ -45297,7 +46419,7 @@ "type": "number" }, "IncludeOpForFullLoad": { - "markdownDescription": "A value that enables a full load to write INSERT operations to the comma\\-separated value \\(\\.csv\\) output files only to indicate how the rows were added to the source database\\. \n AWS DMS supports the `IncludeOpForFullLoad` parameter in versions 3\\.1\\.4 and later\\.\nFor full load, records can only be inserted\\. By default \\(the `false` setting\\), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database\\. If `IncludeOpForFullLoad` is set to `true` or `y`, the INSERT is recorded as an I annotation in the first field of the \\.csv file\\. This allows the format of your target records from a full load to be consistent with the target records from a CDC load\\. \nThis setting works together with the `CdcInsertsOnly` and the `CdcInsertsAndUpdates` parameters for output to \\.csv files only\\. For more information about how these settings work together, see [Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the * AWS Database Migration Service User Guide\\.*\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that enables a full load to write INSERT operations to the comma\\-separated value \\(\\.csv\\) output files only to indicate how the rows were added to the source database\\. \n AWS DMS supports the `IncludeOpForFullLoad` parameter in versions 3\\.1\\.4 and later\\.\nFor full load, records can only be inserted\\. By default \\(the `false` setting\\), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database\\. If `IncludeOpForFullLoad` is set to `true` or `y`, the INSERT is recorded as an I annotation in the first field of the \\.csv file\\. This allows the format of your target records from a full load to be consistent with the target records from a CDC load\\. \nThis setting works together with the `CdcInsertsOnly` and the `CdcInsertsAndUpdates` parameters for output to \\.csv files only\\. For more information about how these settings work together, see [ Indicating Source DB Operations in Migrated S3 Data](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeOpForFullLoad", "type": "boolean" }, @@ -45317,7 +46439,7 @@ "type": "string" }, "PreserveTransactions": { - "markdownDescription": "If set to `true`, AWS DMS saves the transaction order for a change data capture \\(CDC\\) load on the Amazon S3 target specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath)\\. For more information, see [Capturing data changes \\(CDC\\) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath)\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.2 and later\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If this setting is set to `true`, AWS DMS saves the transaction order for a change data capture \\(CDC\\) load on the Amazon S3 target specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CdcPath)\\. For more information, see [ Capturing data changes \\(CDC\\) including transaction order on the S3 target](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.EndpointSettings.CdcPath)\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.2 and later\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PreserveTransactions", "type": "boolean" }, @@ -45332,22 +46454,22 @@ "type": "number" }, "ServerSideEncryptionKmsKeyId": { - "markdownDescription": "If you are using `SSE_KMS` for the `EncryptionMode`, provide the AWS KMS key ID\\. The key that you use needs an attached policy that enables AWS Identity and Access Management \\(IAM\\) user permissions and allows use of the key\\. \nHere is a CLI example: `aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value ` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If you are using `SSE_KMS` for the `EncryptionMode`, provide the AWS KMS key ID\\. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key\\. \nHere is a CLI example: `aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value ` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServerSideEncryptionKmsKeyId", "type": "string" }, "ServiceAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A required parameter that specifies the Amazon Resource Name \\(ARN\\) used by the service to access the IAM role\\. The role must allow the `iam:PassRole` action\\. It enables AWS DMS to read and write objects from an S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceAccessRoleArn", "type": "string" }, "TimestampColumnName": { - "markdownDescription": "A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target\\. \n AWS DMS supports the `TimestampColumnName` parameter in versions 3\\.1\\.4 and later\\.\nDMS includes an additional `STRING` column in the \\.csv or \\.parquet object files of your migrated data when you set `TimestampColumnName` to a nonblank value\\. \nFor a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS\\. \nFor a change data capture \\(CDC\\) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database\\. \nThe string format for this timestamp column value is `yyyy-MM-dd HH:mm:ss.SSSSSS`\\. By default, the precision of this value is in microseconds\\. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database\\. \nWhen the `AddColumnName` parameter is set to `true`, DMS also includes a name for the timestamp column that you set with `TimestampColumnName`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target\\. \n AWS DMS supports the `TimestampColumnName` parameter in versions 3\\.1\\.4 and later\\.\nAWS DMS includes an additional `STRING` column in the \\.csv or \\.parquet object files of your migrated data when you set `TimestampColumnName` to a nonblank value\\. \nFor a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS\\. \nFor a change data capture \\(CDC\\) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database\\. \nThe string format for this timestamp column value is `yyyy-MM-dd HH:mm:ss.SSSSSS`\\. By default, the precision of this value is in microseconds\\. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database\\. \nWhen the `AddColumnName` parameter is set to `true`, DMS also includes a name for the timestamp column that you set with `TimestampColumnName`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimestampColumnName", "type": "string" }, "UseCsvNoSupValue": { - "markdownDescription": "This setting applies if the S3 output files during a change data capture \\(CDC\\) load are written in \\.csv format\\. If set to `true` for columns not included in the supplemental log, AWS DMS uses the value specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue)\\. If not set or set to `false`, AWS DMS uses the null value for these columns\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.1 and later\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This setting applies if the S3 output files during a change data capture \\(CDC\\) load are written in \\.csv format\\. If this setting is set to `true` for columns not included in the supplemental log, AWS DMS uses the value specified by [https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue](https://docs.aws.amazon.com/dms/latest/APIReference/API_S3Settings.html#DMS-Type-S3Settings-CsvNoSupValue)\\. If this setting isn't set or is set to `false`, AWS DMS uses the null value for these columns\\. \nThis setting is supported in AWS DMS versions 3\\.4\\.1 and later\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UseCsvNoSupValue", "type": "boolean" }, @@ -45363,12 +46485,12 @@ "additionalProperties": false, "properties": { "SecretsManagerAccessRoleArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret`\\. The role must allow the `iam:PassRole` action\\. `SecretsManagerSecret` has the value of the AWS Secrets Manager secret that allows access to the SAP ASE endpoint\\. \nYou can specify one of two sets of values for these permissions\\. You can specify the values for this setting and `SecretsManagerSecretId`\\. Or you can specify clear\\-text values for `UserName`, `Password`, `ServerName`, and `Port`\\. You can't specify both\\. \nFor more information on creating this `SecretsManagerSecret`, the corresponding `SecretsManagerAccessRoleArn`, and the `SecretsManagerSecretId` that is required to access it, see [ Using secrets to access AWS Database Migration Service resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerAccessRoleArn", "type": "string" }, "SecretsManagerSecretId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the SAP SAE endpoint connection details\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsManagerSecretId", "type": "string" } @@ -45419,12 +46541,12 @@ "items": { "type": "string" }, - "markdownDescription": "A list of event categories for a source type that you want to subscribe to\\. If you don't specify this property, you are notified about all event categories\\. For more information, see [Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS DMS User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of event categories for a source type that you want to subscribe to\\. If you don't specify this property, you are notified about all event categories\\. For more information, see [ Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html) in the *AWS DMS User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventCategories", "type": "array" }, "SnsTopicArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon SNS topic created for event notification\\. The ARN is created by Amazon SNS when you create a topic and subscribe to it\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon SNS topic created for event notification\\. The ARN is created by Amazon SNS when you create a topic and subscribe to it\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SnsTopicArn", "type": "string" }, @@ -45437,7 +46559,7 @@ "type": "array" }, "SourceType": { - "markdownDescription": "The type of AWS DMS resource that generates the events\\. For example, if you want to be notified of events generated by a replication instance, you set this parameter to `replication-instance`\\. If this value isn't specified, all events are returned\\. \nValid values: `replication-instance` \\| `replication-task` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of AWS DMS resource that generates the events\\. For example, if you want to be notified of events generated by a replication instance, you set this parameter to `replication-instance`\\. If this value isn't specified, all events are returned\\. \n*Valid values*: `replication-instance` \\| `replication-task` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceType", "type": "string" }, @@ -45450,7 +46572,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "One or more tags to be assigned to the event subscription\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "One or more tags to be assigned to the event subscription\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -45527,12 +46649,12 @@ "type": "boolean" }, "AutoMinorVersionUpgrade": { - "markdownDescription": "A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window\\. This parameter defaults to `true`\\. \nDefault: `true` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window\\. This parameter defaults to `true`\\. \nDefault: `true` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutoMinorVersionUpgrade", "type": "boolean" }, "AvailabilityZone": { - "markdownDescription": "The Availability Zone that the replication instance will be created in\\. \nThe default value is a random, system\\-chosen Availability Zone in the endpoint's , for example: `us-east-1d` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Availability Zone that the replication instance will be created in\\. \nThe default value is a random, system\\-chosen Availability Zone in the endpoint's AWS Region, for example `us-east-1d`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AvailabilityZone", "type": "string" }, @@ -45542,32 +46664,32 @@ "type": "string" }, "KmsKeyId": { - "markdownDescription": "An AWS KMS key identifier that is used to encrypt the data on the replication instance\\. \nIf you don't specify a value for the `KmsKeyId` parameter, then AWS DMS uses your default encryption key\\. \n AWS KMS creates the default encryption key for your AWS account\\. Your AWS account has a different default encryption key for each AWS Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An AWS KMS key identifier that is used to encrypt the data on the replication instance\\. \nIf you don't specify a value for the `KmsKeyId` parameter, AWS DMS uses your default encryption key\\. \nAWS KMS creates the default encryption key for your AWS account\\. Your AWS account has a different default encryption key for each AWS Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" }, "MultiAZ": { - "markdownDescription": "Specifies whether the replication instance is a Multi\\-AZ deployment\\. You can't set the `AvailabilityZone` parameter if the Multi\\-AZ parameter is set to `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the replication instance is a Multi\\-AZ deployment\\. You can't set the `AvailabilityZone` parameter if the Multi\\-AZ parameter is set to `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MultiAZ", "type": "boolean" }, "PreferredMaintenanceWindow": { - "markdownDescription": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \n Format: `ddd:hh24:mi-ddd:hh24:mi` \nDefault: A 30\\-minute window selected at random from an 8\\-hour block of time per AWS Region, occurring on a random day of the week\\. \nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun \nConstraints: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The weekly time range during which system maintenance can occur, in UTC\\. \n*Format*: `ddd:hh24:mi-ddd:hh24:mi` \n*Default*: A 30\\-minute window selected at random from an 8\\-hour block of time per AWS Region, occurring on a random day of the week\\. \n*Valid days* \\(`ddd`\\): `Mon` \\| `Tue` \\| `Wed` \\| `Thu` \\| `Fri` \\| `Sat` \\| `Sun` \n*Constraints*: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PreferredMaintenanceWindow", "type": "string" }, "PubliclyAccessible": { - "markdownDescription": "Specifies the accessibility options for the replication instance\\. A value of `true` represents an instance with a public IP address\\. A value of `false` represents an instance with a private IP address\\. The default value is `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the accessibility options for the replication instance\\. A value of `true` represents an instance with a public IP address\\. A value of `false` represents an instance with a private IP address\\. The default value is `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PubliclyAccessible", "type": "boolean" }, "ReplicationInstanceClass": { - "markdownDescription": "The compute and memory capacity of the replication instance as defined for the specified replication instance class\\. For example to specify the instance class dms\\.c4\\.large, set this parameter to `\"dms.c4.large\"`\\. \nFor more information on the settings and capacities for the available replication instance classes, see [ Selecting the right AWS DMS replication instance for your migration](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The compute and memory capacity of the replication instance as defined for the specified replication instance class\\. For example, to specify the instance class dms\\.c4\\.large, set this parameter to `\"dms.c4.large\"`\\. For more information on the settings and capacities for the available replication instance classes, see [ Selecting the right AWS DMS replication instance for your migration](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth) in the *AWS Database Migration Service User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReplicationInstanceClass", "type": "string" }, "ReplicationInstanceIdentifier": { - "markdownDescription": "The replication instance identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain 1\\-63 alphanumeric characters or hyphens\\.\n+ First character must be a letter\\.\n+ Can't end with a hyphen or contain two consecutive hyphens\\.\nExample: `myrepinstance` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The replication instance identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain 1\\-63 alphanumeric characters or hyphens\\.\n+ First character must be a letter\\.\n+ Can't end with a hyphen or contain two consecutive hyphens\\.\nExample: `myrepinstance` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReplicationInstanceIdentifier", "type": "string" }, @@ -45577,7 +46699,7 @@ "type": "string" }, "ResourceIdentifier": { - "markdownDescription": "A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceIdentifier", "type": "string" }, @@ -45585,7 +46707,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "One or more tags to be assigned to the replication instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "One or more tags to be assigned to the replication instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -45593,7 +46715,7 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies the VPC security group to be used with the replication instance\\. The VPC security group must work with the VPC containing the replication instance\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the virtual private cloud \\(VPC\\) security group to be used with the replication instance\\. The VPC security group must work with the VPC containing the replication instance\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VpcSecurityGroupIds", "type": "array" } @@ -45665,7 +46787,7 @@ "type": "string" }, "ReplicationSubnetGroupIdentifier": { - "markdownDescription": "The identifier for the replication subnet group\\. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the identifier\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The identifier for the replication subnet group\\. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the identifier\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ReplicationSubnetGroupIdentifier", "type": "string" }, @@ -45681,7 +46803,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "One or more tags to be assigned to the subnet group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "One or more tags to be assigned to the subnet group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -45749,7 +46871,7 @@ "additionalProperties": false, "properties": { "CdcStartPosition": { - "markdownDescription": "Indicates when you want a change data capture \\(CDC\\) operation to start\\. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start\\. Specifying both values results in an error\\. \n The value can be in date, checkpoint, or LSN/SCN format\\. \nDate Example: \\-\\-cdc\\-start\\-position \u201c2018\\-03\\-08T12:12:12\u201d \nCheckpoint Example: \\-\\-cdc\\-start\\-position \"checkpoint:V1\\#27\\#mysql\\-bin\\-changelog\\.157832:1975:\\-1:2002:677883278264080:mysql\\-bin\\-changelog\\.157832:1876\\#0\\#0\\#\\*\\#0\\#93\" \nLSN Example: \\-\\-cdc\\-start\\-position \u201cmysql\\-bin\\-changelog\\.000024:373\u201d \nWhen you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint\\. You can verify this by setting the `slotName` extra connection attribute to the name of this logical replication slot\\. For more information, see [Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates when you want a change data capture \\(CDC\\) operation to start\\. Use either `CdcStartPosition` or `CdcStartTime` to specify when you want a CDC operation to start\\. Specifying both values results in an error\\. \n The value can be in date, checkpoint, log sequence number \\(LSN\\), or system change number \\(SCN\\) format\\. \nHere is a date example: `--cdc-start-position \"2018-03-08T12:12:12\"` \nHere is a checkpoint example: `--cdc-start-position \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"` \nHere is an LSN example: `--cdc-start-position \u201cmysql-bin-changelog.000024:373\u201d` \nWhen you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint\\. You can verify this by setting the `slotName` extra connection attribute to the name of this logical replication slot\\. For more information, see [ Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide*\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdcStartPosition", "type": "string" }, @@ -45759,7 +46881,7 @@ "type": "number" }, "CdcStopPosition": { - "markdownDescription": "Indicates when you want a change data capture \\(CDC\\) operation to stop\\. The value can be either server time or commit time\\. \nServer time example: \\-\\-cdc\\-stop\\-position \u201cserver\\_time:2018\\-02\\-09T12:12:12\u201d \nCommit time example: \\-\\-cdc\\-stop\\-position \u201ccommit\\_time: 2018\\-02\\-09T12:12:12 \u201c \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates when you want a change data capture \\(CDC\\) operation to stop\\. The value can be either server time or commit time\\. \nHere is a server time example: `--cdc-stop-position \"server_time:2018-02-09T12:12:12\"` \nHere is a commit time example: `--cdc-stop-position \"commit_time: 2018-02-09T12:12:12\"` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdcStopPosition", "type": "string" }, @@ -45779,12 +46901,12 @@ "type": "string" }, "ReplicationTaskSettings": { - "markdownDescription": "Overall settings for the task, in JSON format\\. For more information, see [Specifying Task Settings for AWS Database Migration Service Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Overall settings for the task, in JSON format\\. For more information, see [ Specifying Task Settings for AWS Database Migration Service Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReplicationTaskSettings", "type": "string" }, "ResourceIdentifier": { - "markdownDescription": "A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object\\. The value for this parameter can have up to 31 characters\\. It can contain only ASCII letters, digits, and hyphen \\('\\-'\\)\\. Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1`\\. \nFor example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1`\\. If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceIdentifier", "type": "string" }, @@ -45794,7 +46916,7 @@ "type": "string" }, "TableMappings": { - "markdownDescription": "The table mappings for the task, in JSON format\\. For more information, see [Using Table Mapping to Specify Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) in the * AWS Database Migration Service User Guide\\.* \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The table mappings for the task, in JSON format\\. For more information, see [ Using Table Mapping to Specify Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) in the *AWS Database Migration Service User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TableMappings", "type": "string" }, @@ -45802,7 +46924,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "One or more tags to be assigned to the replication task\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "One or more tags to be assigned to the replication task\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -45812,7 +46934,7 @@ "type": "string" }, "TaskData": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TaskData", "type": "string" } @@ -45883,7 +47005,7 @@ "additionalProperties": false, "properties": { "Format": { - "markdownDescription": "The file format of a dataset that is created from an Amazon S3 file or folder\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CSV | EXCEL | JSON | PARQUET` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The file format of a dataset that is created from an Amazon S3 file or folder\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CSV | EXCEL | JSON | ORC | PARQUET` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Format", "type": "string" }, @@ -46392,7 +47514,7 @@ }, "OutputLocation": { "$ref": "#/definitions/AWS::DataBrew::Job.OutputLocation", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [OutputLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputlocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [OutputLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputlocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OutputLocation" }, "Outputs": { @@ -46733,7 +47855,7 @@ "type": "string" }, "BucketOwner": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BucketOwner", "type": "string" }, @@ -46842,7 +47964,7 @@ "properties": { "Parameters": { "additionalProperties": true, - "markdownDescription": "A map that includes overrides of an evaluation\u2019s parameters\\. \n*Required*: Yes \n*Type*: [ParameterMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-parametermap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A map that includes overrides of an evaluation\u2019s parameters\\. \n*Required*: Yes \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -47120,7 +48242,7 @@ }, "Parameters": { "$ref": "#/definitions/AWS::DataBrew::Recipe.RecipeParameters", - "markdownDescription": "Contextual parameters for the transformation\\. \n*Required*: No \n*Type*: [ParameterMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-parametermap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contextual parameters for the transformation\\. \n*Required*: No \n*Type*: [RecipeParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-recipeparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Parameters" } }, @@ -47184,10 +48306,14 @@ "additionalProperties": false, "properties": { "DataCatalogInputDefinition": { - "$ref": "#/definitions/AWS::DataBrew::Recipe.DataCatalogInputDefinition" + "$ref": "#/definitions/AWS::DataBrew::Recipe.DataCatalogInputDefinition", + "markdownDescription": "The AWS Glue Data Catalog parameters for the data\\. \n*Required*: No \n*Type*: [DataCatalogInputDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-datacataloginputdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataCatalogInputDefinition" }, "S3InputDefinition": { - "$ref": "#/definitions/AWS::DataBrew::Recipe.S3Location" + "$ref": "#/definitions/AWS::DataBrew::Recipe.S3Location", + "markdownDescription": "The Amazon S3 location where the data is stored\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3InputDefinition" } }, "type": "object" @@ -47342,7 +48468,7 @@ }, "Input": { "$ref": "#/definitions/AWS::DataBrew::Recipe.Input", - "markdownDescription": "The input location to load the dataset from \\- Amazon S3 or AWS Glue Data Catalog\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The input location to load the dataset from \\- Amazon S3 or AWS Glue Data Catalog\\. \n*Required*: No \n*Type*: [Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-recipe-input.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Input" }, "Interval": { @@ -48006,7 +49132,7 @@ "additionalProperties": false, "properties": { "CronExpression": { - "markdownDescription": "The dates and times when the job is to run\\. For more information, see [Cron expressions](https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) in the * AWS Glue DataBrew Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The dates and times when the job is to run\\. For more information, see [Working with cron expressions for recipe jobs](https://docs.aws.amazon.com/databrew/latest/dg/jobs.recipe.html#jobs.cron) in the * AWS Glue DataBrew Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CronExpression", "type": "string" }, @@ -48113,7 +49239,7 @@ "items": { "$ref": "#/definitions/AWS::DataPipeline::Pipeline.ParameterObject" }, - "markdownDescription": "The parameter objects used with the pipeline\\. \n*Required*: Yes \n*Type*: List of [ParameterObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The parameter objects used with the pipeline\\. \n*Required*: No \n*Type*: List of [ParameterObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ParameterObjects", "type": "array" }, @@ -48121,7 +49247,7 @@ "items": { "$ref": "#/definitions/AWS::DataPipeline::Pipeline.ParameterValue" }, - "markdownDescription": "The parameter values used with the pipeline\\. \n*Required*: No \n*Type*: List of [ParameterValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalues.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The parameter values used with the pipeline\\. \n*Required*: No \n*Type*: List of [ParameterValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ParameterValues", "type": "array" }, @@ -48129,7 +49255,7 @@ "items": { "$ref": "#/definitions/AWS::DataPipeline::Pipeline.PipelineObject" }, - "markdownDescription": "The objects that define the pipeline\\. These objects overwrite the existing pipeline definition\\. Not all objects, fields, and values can be updated\\. For information about restrictions, see [Editing Your Pipeline](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-manage-pipeline-modify-console.html) in the *AWS Data Pipeline Developer Guide*\\. \n*Required*: No \n*Type*: List of [PipelineObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The objects that define the pipeline\\. These objects overwrite the existing pipeline definition\\. Not all objects, fields, and values can be updated\\. For information about restrictions, see [Editing Your Pipeline](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-manage-pipeline-modify-console.html) in the *AWS Data Pipeline Developer Guide*\\. \n*Required*: No \n*Type*: List of [PipelineObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PipelineObjects", "type": "array" }, @@ -48137,7 +49263,7 @@ "items": { "$ref": "#/definitions/AWS::DataPipeline::Pipeline.PipelineTag" }, - "markdownDescription": "A list of arbitrary tags \\(key\\-value pairs\\) to associate with the pipeline, which you can use to control permissions\\. For more information, see [Controlling Access to Pipelines and Resources](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the *AWS Data Pipeline Developer Guide*\\. \n*Required*: No \n*Type*: List of [PipelineTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of arbitrary tags \\(key\\-value pairs\\) to associate with the pipeline, which you can use to control permissions\\. For more information, see [Controlling Access to Pipelines and Resources](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the *AWS Data Pipeline Developer Guide*\\. \n*Required*: No \n*Type*: List of [PipelineTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetag.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PipelineTags", "type": "array" } @@ -48219,7 +49345,7 @@ "items": { "$ref": "#/definitions/AWS::DataPipeline::Pipeline.ParameterAttribute" }, - "markdownDescription": "The attributes of the parameter object\\. \n*Required*: Yes \n*Type*: List of [ParameterAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobjects-attributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The attributes of the parameter object\\. \n*Required*: Yes \n*Type*: List of [ParameterAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterattribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Attributes", "type": "array" }, @@ -48262,7 +49388,7 @@ "items": { "$ref": "#/definitions/AWS::DataPipeline::Pipeline.Field" }, - "markdownDescription": "Key\\-value pairs that define the properties of the object\\. \n*Required*: Yes \n*Type*: List of [Field](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobjects-fields.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Key\\-value pairs that define the properties of the object\\. \n*Required*: Yes \n*Type*: List of [Field](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-field.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Fields", "type": "array" }, @@ -48340,7 +49466,7 @@ "additionalProperties": false, "properties": { "ActivationKey": { - "markdownDescription": "Your agent activation key\\. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address \\(port 80\\)\\. Alternatively, you can get it from the DataSync console\\. \nThe redirect URL returned in the response provides you the activation key for your agent in the query string parameter `activationKey`\\. It might also include other activation\\-related parameters; however, these are merely defaults\\. The arguments you pass to this API call determine the actual configuration of your agent\\. \nFor more information, see [Creating and activating an agent](https://docs.aws.amazon.com/datasync/latest/userguide/activating-agent.html) in the * AWS DataSync User Guide\\.* \n*Required*: Yes \n*Type*: String \n*Maximum*: `29` \n*Pattern*: `[A-Z0-9]{5}(-[A-Z0-9]{5}){4}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Your agent activation key\\. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address \\(port 80\\)\\. Alternatively, you can get it from the DataSync console\\. \nThe redirect URL returned in the response provides you the activation key for your agent in the query string parameter `activationKey`\\. It might also include other activation\\-related parameters; however, these are merely defaults\\. The arguments you pass to this API call determine the actual configuration of your agent\\. \nFor more information, see [Creating and activating an agent](https://docs.aws.amazon.com/datasync/latest/userguide/activating-agent.html) in the * AWS DataSync User Guide\\.* \n*Required*: No \n*Type*: String \n*Maximum*: `29` \n*Pattern*: `[A-Z0-9]{5}(-[A-Z0-9]{5}){4}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ActivationKey", "type": "string" }, @@ -48437,26 +49563,32 @@ "additionalProperties": false, "properties": { "AccessPointArn": { + "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of the access point that DataSync uses to access the Amazon EFS file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AccessPointArn", "type": "string" }, "Ec2Config": { "$ref": "#/definitions/AWS::DataSync::LocationEFS.Ec2Config", - "markdownDescription": "The subnet and security group that the Amazon EFS file system uses\\. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified\\. \nThe exact relationship between security group M \\(of the mount target\\) and security group S \\(which you provide for DataSync to use at this stage\\) is as follows: \n+ Security group M \\(which you associate with the mount target\\) must allow inbound access for the Transmission Control Protocol \\(TCP\\) on the NFS port \\(2049\\) from security group S\\. You can enable inbound connections either by IP address \\(CIDR range\\) or security group\\. \n+ Security group S \\(provided to DataSync to access EFS\\) should have a rule that enables outbound connections to the NFS port on one of the file system\u2019s mount targets\\. You can enable outbound connections either by IP address \\(CIDR range\\) or security group\\.", + "markdownDescription": "Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system\\. \n*Required*: Yes \n*Type*: [Ec2Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationefs-ec2config.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Ec2Config" }, "EfsFilesystemArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the Amazon EFS file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the ARN for the Amazon EFS file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EfsFilesystemArn", "type": "string" }, "FileSystemAccessRoleArn": { + "markdownDescription": "Specifies an AWS Identity and Access Management \\(IAM\\) role that DataSync assumes when mounting the Amazon EFS file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemAccessRoleArn", "type": "string" }, "InTransitEncryption": { + "markdownDescription": "Specifies whether you want DataSync to use Transport Layer Security \\(TLS\\) 1\\.2 encryption when it copies data to or from the Amazon EFS file system\\. \nIf you specify an access point using `AccessPointArn` or an IAM role using `FileSystemAccessRoleArn`, you must set this parameter to `TLS1_2`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | TLS1_2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InTransitEncryption", "type": "string" }, "Subdirectory": { - "markdownDescription": "A subdirectory in the location\u2019s path\\. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination\\. By default, AWS DataSync uses the root directory\\. \n `Subdirectory` must be specified with forward slashes\\. For example, `/path/to/folder`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a mount path for your Amazon EFS file system\\. This is where DataSync reads or writes data \\(depending on if this is a source or destination location\\)\\. By default, DataSync uses the root directory, but you can also include subdirectories\\. \nYou must specify a value with forward slashes \\(for example, `/path/to/folder`\\)\\.\n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Subdirectory", "type": "string" }, @@ -48464,7 +49596,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The key\\-value pair that represents a tag that you want to add to the resource\\. The value can be an empty string\\. This value helps you manage, filter, and search for your resources\\. We recommend that you create a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the key\\-value pair that represents a tag that you want to add to the resource\\. The value can be an empty string\\. This value helps you manage, filter, and search for your resources\\. We recommend that you create a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -48502,12 +49634,12 @@ "items": { "type": "string" }, - "markdownDescription": "The Amazon Resource Names \\(ARNs\\) of the security groups that are configured for the Amazon EC2 resource\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the Amazon Resource Names \\(ARNs\\) of the security groups associated with an Amazon EFS file system's mount target\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SecurityGroupArns", "type": "array" }, "SubnetArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the subnet that DataSync uses to access the target EFS file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the ARN of a subnet where DataSync creates the [network interfaces](datasync/latest/userguide/datasync-network.html#required-network-interfaces) for managing traffic during your transfer\\. \nThe subnet must be located: \n+ In the same virtual private cloud \\(VPC\\) as the Amazon EFS file system\\.\n+ In the same Availability Zone as at least one mount target for the Amazon EFS file system\\.\nYou don't need to specify a subnet that includes a file system mount target\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SubnetArn", "type": "string" } @@ -48554,7 +49686,7 @@ "additionalProperties": false, "properties": { "FsxFilesystemArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the FSx for Lustre file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the FSx for Lustre file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "FsxFilesystemArn", "type": "string" }, @@ -48562,7 +49694,7 @@ "items": { "type": "string" }, - "markdownDescription": "The ARNs of the security groups that are used to configure the FSx for Lustre file system\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Length constraints*: Maximum length of 128\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARNs of the security groups that are used to configure the FSx for Lustre file system\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Length constraints*: Maximum length of 128\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SecurityGroupArns", "type": "array" }, @@ -48642,24 +49774,34 @@ "additionalProperties": false, "properties": { "Protocol": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.Protocol" + "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.Protocol", + "markdownDescription": "Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system\\. \n*Required*: No \n*Type*: [Protocol](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-protocol.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Protocol" }, "SecurityGroupArns": { "items": { "type": "string" }, + "markdownDescription": "Specifies the Amazon Resource Names \\(ARNs\\) of the security groups that DataSync can use to access your FSx for ONTAP file system\\. You must configure the security groups to allow outbound traffic on the following ports \\(depending on the protocol that you're using\\): \n+ **Network File System \\(NFS\\)**: TCP ports 111, 635, and 2049\n+ **Server Message Block \\(SMB\\)**: TCP port 445\nYour file system's security groups must also allow inbound traffic on the same port\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SecurityGroupArns", "type": "array" }, "StorageVirtualMachineArn": { + "markdownDescription": "Specifies the ARN of the storage virtual machine \\(SVM\\) in your file system where you want to copy data to or from\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `162` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StorageVirtualMachineArn", "type": "string" }, "Subdirectory": { + "markdownDescription": "Specifies a path to the file share in the SVM where you'll copy your data\\. \nYou can specify a junction path \\(also known as a mount point\\), qtree path \\(for NFS file shares\\), or share name \\(for SMB file shares\\)\\. For example, your mount path might be `/vol1`, `/vol1/tree1`, or `/share1`\\. \nDon't specify a junction path in the SVM's root volume\\. For more information, see [Managing FSx for ONTAP storage virtual machines](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) in the *Amazon FSx for NetApp ONTAP User Guide*\\.\n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Subdirectory", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Specifies labels that help you categorize, filter, and search for your AWS resources\\. We recommend creating at least a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -48694,7 +49836,9 @@ "additionalProperties": false, "properties": { "MountOptions": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.NfsMountOptions" + "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.NfsMountOptions", + "markdownDescription": "Specifies how DataSync can access a location using the NFS protocol\\. \n*Required*: Yes \n*Type*: [NfsMountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfsmountoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MountOptions" } }, "required": [ @@ -48706,6 +49850,8 @@ "additionalProperties": false, "properties": { "Version": { + "markdownDescription": "Specifies the NFS version that you want DataSync to use when mounting your NFS share\\. If the server refuses to use the version specified, the task fails\\. \nYou can specify the following options: \n+ `AUTOMATIC` \\(default\\): DataSync chooses NFS version 4\\.1\\.\n+ `NFS3`: Stateless protocol version that allows for asynchronous writes on the server\\.\n+ `NFSv4_0`: Stateful, firewall\\-friendly protocol version that supports delegations and pseudo file systems\\.\n+ `NFSv4_1`: Stateful protocol version that supports sessions, directory delegations, and parallel data processing\\. NFS version 4\\.1 also includes all features available in version 4\\.0\\.\nDataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Version", "type": "string" } }, @@ -48715,10 +49861,14 @@ "additionalProperties": false, "properties": { "NFS": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.NFS" + "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.NFS", + "markdownDescription": "Specifies the Network File System \\(NFS\\) protocol configuration that DataSync uses to access your FSx for ONTAP file system's storage virtual machine \\(SVM\\)\\. \n*Required*: No \n*Type*: [NFS](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-nfs.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NFS" }, "SMB": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.SMB" + "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.SMB", + "markdownDescription": "Specifies the Server Message Block \\(SMB\\) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM\\. \n*Required*: No \n*Type*: [SMB](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SMB" } }, "type": "object" @@ -48727,15 +49877,23 @@ "additionalProperties": false, "properties": { "Domain": { + "markdownDescription": "Specifies the fully qualified domain name \\(FQDN\\) of the Microsoft Active Directory that your storage virtual machine \\(SVM\\) belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^[A-Za-z0-9]((\\.|-+)?[A-Za-z0-9]){0,252}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Domain", "type": "string" }, "MountOptions": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.SmbMountOptions" + "$ref": "#/definitions/AWS::DataSync::LocationFSxONTAP.SmbMountOptions", + "markdownDescription": "Specifies how DataSync can access a location using the SMB protocol\\. \n*Required*: Yes \n*Type*: [SmbMountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smbmountoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MountOptions" }, "Password": { + "markdownDescription": "Specifies the password of a user who has permission to access your SVM\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Password", "type": "string" }, "User": { + "markdownDescription": "Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM\\. \nIf you provide a user in your Active Directory, note the following: \n+ If you're using AWS Directory Service for Microsoft Active Directory, the user must be a member of the AWS Delegated FSx Administrators group\\.\n+ If you're using a self\\-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system\\.\nMake sure that the user has the permissions it needs to copy the data you want: \n+ `SE_TCB_NAME`: Required to set object ownership and file metadata\\. With this privilege, you also can copy NTFS discretionary access lists \\(DACLs\\)\\.\n+ `SE_SECURITY_NAME`: May be needed to copy NTFS system access control lists \\(SACLs\\)\\. This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group\\. If you configure your task to copy SACLs, make sure that the user has the required privileges\\. For information about copying SACLs, see [Ownership and permissions\\-related options](https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions)\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "User", "type": "string" } }, @@ -48750,6 +49908,8 @@ "additionalProperties": false, "properties": { "Version": { + "markdownDescription": "By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server\\. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically\\. \nThese are the following options for configuring the SMB version: \n+ `AUTOMATIC` \\(default\\): DataSync and the SMB file server negotiate a protocol version that they mutually support\\. \\(DataSync supports SMB versions 1\\.0 and later\\.\\)", + "title": "Version", "type": "string" } }, @@ -48791,24 +49951,34 @@ "additionalProperties": false, "properties": { "FsxFilesystemArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the FSx for OpenZFS file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FsxFilesystemArn", "type": "string" }, "Protocol": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxOpenZFS.Protocol" + "$ref": "#/definitions/AWS::DataSync::LocationFSxOpenZFS.Protocol", + "markdownDescription": "The type of protocol that AWS DataSync uses to access your file system\\. \n*Required*: Yes \n*Type*: [Protocol](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-protocol.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Protocol" }, "SecurityGroupArns": { "items": { "type": "string" }, + "markdownDescription": "The ARNs of the security groups that are used to configure the FSx for OpenZFS file system\\. \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$` \n*Length constraints*: Maximum length of 128\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SecurityGroupArns", "type": "array" }, "Subdirectory": { + "markdownDescription": "A subdirectory in the location's path that must begin with `/fsx`\\. DataSync uses this subdirectory to read or write data \\(depending on whether the file system is a source or destination location\\)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,4096}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Subdirectory", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The key\\-value pair that represents a tag that you want to add to the resource\\. The value can be an empty string\\. This value helps you manage, filter, and search for your resources\\. We recommend that you create a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -48843,6 +50013,8 @@ "additionalProperties": false, "properties": { "Version": { + "markdownDescription": "The specific NFS version that you want DataSync to use to mount your NFS share\\. If the server refuses to use the version specified, the sync will fail\\. If you don't specify a version, DataSync defaults to `AUTOMATIC`\\. That is, DataSync automatically selects a version based on negotiation with the NFS server\\. \nYou can specify the following NFS versions: \n+ **[NFSv3](https://tools.ietf.org/html/rfc1813)**: Stateless protocol version that allows for asynchronous writes on the server\\.\n+ **[NFSv4\\.0](https://tools.ietf.org/html/rfc3530)**: Stateful, firewall\\-friendly protocol version that supports delegations and pseudo file systems\\.\n+ **[NFSv4\\.1](https://tools.ietf.org/html/rfc5661)**: Stateful protocol version that supports sessions, directory delegations, and parallel data processing\\. Version 4\\.1 also includes all features available in version 4\\.0\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Version", "type": "string" } }, @@ -48852,7 +50024,9 @@ "additionalProperties": false, "properties": { "MountOptions": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxOpenZFS.MountOptions" + "$ref": "#/definitions/AWS::DataSync::LocationFSxOpenZFS.MountOptions", + "markdownDescription": "Represents the mount options that are available for DataSync to access an NFS location\\. \n*Required*: Yes \n*Type*: [MountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-mountoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MountOptions" } }, "required": [ @@ -48864,7 +50038,9 @@ "additionalProperties": false, "properties": { "NFS": { - "$ref": "#/definitions/AWS::DataSync::LocationFSxOpenZFS.NFS" + "$ref": "#/definitions/AWS::DataSync::LocationFSxOpenZFS.NFS", + "markdownDescription": "Represents the Network File System \\(NFS\\) protocol that DataSync uses to access your FSx for OpenZFS file system\\. \n*Required*: No \n*Type*: [NFS](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxopenzfs-nfs.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NFS" } }, "type": "object" @@ -48905,17 +50081,17 @@ "additionalProperties": false, "properties": { "Domain": { - "markdownDescription": "The name of the Windows domain that the FSx for Windows File Server belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the name of the Windows domain that the FSx for Windows File Server belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^[A-Za-z0-9]((\\.|-+)?[A-Za-z0-9]){0,252}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Domain", "type": "string" }, "FsxFilesystemArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the FSx for Windows File Server file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) for the FSx for Windows File Server file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "FsxFilesystemArn", "type": "string" }, "Password": { - "markdownDescription": "The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the password of the user who has the permissions to access files and folders in the file system\\. \n*Required*: No \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Password", "type": "string" }, @@ -48928,7 +50104,7 @@ "type": "array" }, "Subdirectory": { - "markdownDescription": "A subdirectory in the location's path\\. This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a mount path for your file system using forward slashes\\. This is where DataSync reads or writes data \\(depending on if this is a source or destination location\\)\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Subdirectory", "type": "string" }, @@ -48936,7 +50112,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The key\\-value pair that represents a tag that you want to add to the resource\\. The value can be an empty string\\. This value helps you manage, filter, and search for your resources\\. We recommend that you create a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies labels that help you categorize, filter, and search for your AWS resources\\. We recommend creating at least a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -49017,7 +50193,7 @@ "type": "array" }, "AuthenticationType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthenticationType", "type": "string" }, @@ -49193,12 +50369,12 @@ "title": "OnPremConfig" }, "ServerHostname": { - "markdownDescription": "The name of the NFS server\\. This value is the IP address or Domain Name Service \\(DNS\\) name of the NFS server\\. An agent that is installed on\\-premises uses this host name to mount the NFS server in a network\\. \nIf you are copying data to or from your AWS Snowcone device, see [NFS Server on AWS Snowcone](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) for more information\\. \nThis name must either be DNS\\-compliant or must be an IP version 4 \\(IPv4\\) address\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the NFS server\\. This value is the IP address or Domain Name Service \\(DNS\\) name of the NFS server\\. An agent that is installed on\\-premises uses this hostname to mount the NFS server in a network\\. \nIf you are copying data to or from your AWS Snowcone device, see [NFS Server on AWS Snowcone](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) for more information\\. \nThis name must either be DNS\\-compliant or must be an IP version 4 \\(IPv4\\) address\\.\n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ServerHostname", "type": "string" }, "Subdirectory": { - "markdownDescription": "The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination\\. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path\\. The path should be such that it can be mounted by other NFS clients in your network\\. \nTo see all the paths exported by your NFS server, run \"`showmount -e nfs-server-name`\" from an NFS client that has access to your server\\. You can specify any directory that appears in the results, and any subdirectory of that directory\\. Ensure that the NFS export is accessible without Kerberos authentication\\. \nTo transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data\\. To ensure this, either configure the NFS export with `no_root_squash,` or ensure that the permissions for all of the files that you want DataSync allow read access for all users\\. Doing either enables the agent to read the files\\. For the agent to access directories, you must additionally enable all execute access\\. \nIf you are copying data to or from your AWS Snowcone device, see [NFS Server on AWS Snowcone](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) for more information\\. \nFor information about NFS export configuration, see [18\\.7\\. The /etc/exports Configuration File](http://web.mit.edu/rhel-doc/5/RHEL-5-manual/Deployment_Guide-en-US/s1-nfs-server-config-exports.html) in the Red Hat Enterprise Linux documentation\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination\\. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path\\. The path should be such that it can be mounted by other NFS clients in your network\\. \nTo see all the paths exported by your NFS server, run \"`showmount -e nfs-server-name`\" from an NFS client that has access to your server\\. You can specify any directory that appears in the results, and any subdirectory of that directory\\. Ensure that the NFS export is accessible without Kerberos authentication\\. \nTo transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data\\. To ensure this, either configure the NFS export with `no_root_squash,` or ensure that the permissions for all of the files that you want DataSync allow read access for all users\\. Doing either enables the agent to read the files\\. For the agent to access directories, you must additionally enable all execute access\\. \nIf you are copying data to or from your AWS Snowcone device, see [NFS Server on AWS Snowcone](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) for more information\\. \nFor information about NFS export configuration, see [18\\.7\\. The /etc/exports Configuration File](http://web.mit.edu/rhel-doc/5/RHEL-5-manual/Deployment_Guide-en-US/s1-nfs-server-config-exports.html) in the Red Hat Enterprise Linux documentation\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Subdirectory", "type": "string" }, @@ -49241,7 +50417,7 @@ "additionalProperties": false, "properties": { "Version": { - "markdownDescription": "The specific NFS version that you want DataSync to use to mount your NFS share\\. If the server refuses to use the version specified, the sync will fail\\. If you don't specify a version, DataSync defaults to `AUTOMATIC`\\. That is, DataSync automatically selects a version based on negotiation with the NFS server\\. \nYou can specify the following NFS versions: \n+ ** [NFSv3](https://tools.ietf.org/html/rfc1813) ** \\- stateless protocol version that allows for asynchronous writes on the server\\.\n+ ** [NFSv4\\.0](https://tools.ietf.org/html/rfc3530) ** \\- stateful, firewall\\-friendly protocol version that supports delegations and pseudo file systems\\.\n+ ** [NFSv4\\.1](https://tools.ietf.org/html/rfc5661) ** \\- stateful protocol version that supports sessions, directory delegations, and parallel data processing\\. Version 4\\.1 also includes all features available in version 4\\.0\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the NFS version that you want DataSync to use when mounting your NFS share\\. If the server refuses to use the version specified, the task fails\\. \nYou can specify the following options: \n+ `AUTOMATIC` \\(default\\): DataSync chooses NFS version 4\\.1\\.\n+ `NFS3`: Stateless protocol version that allows for asynchronous writes on the server\\.\n+ `NFSv4_0`: Stateful, firewall\\-friendly protocol version that supports delegations and pseudo file systems\\.\n+ `NFSv4_1`: Stateful protocol version that supports sessions, directory delegations, and parallel data processing\\. NFS version 4\\.1 also includes all features available in version 4\\.0\\.\nDataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -49301,7 +50477,7 @@ "additionalProperties": false, "properties": { "AccessKey": { - "markdownDescription": "Optional\\. The access key is used if credentials are required to access the self\\-managed object storage server\\. If your object storage requires a user name and password to authenticate, use `AccessKey` and `SecretKey` to provide the user name and password, respectively\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `200` \n*Pattern*: `^.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the access key \\(for example, a user name\\) if credentials are required to authenticate with the object storage server\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `200` \n*Pattern*: `^.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessKey", "type": "string" }, @@ -49309,40 +50485,42 @@ "items": { "type": "string" }, - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the agents associated with the self\\-managed object storage server location\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the Amazon Resource Names \\(ARNs\\) of the DataSync agents that can securely connect with your location\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AgentArns", "type": "array" }, "BucketName": { - "markdownDescription": "The bucket on the self\\-managed object storage server that is used to read data from\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the name of the object storage bucket involved in the transfer\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "BucketName", "type": "string" }, "SecretKey": { - "markdownDescription": "Optional\\. The secret key is used if credentials are required to access the self\\-managed object storage server\\. If your object storage requires a user name and password to authenticate, use `AccessKey` and `SecretKey` to provide the user name and password, respectively\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `200` \n*Pattern*: `^.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the secret key \\(for example, a password\\) if credentials are required to authenticate with the object storage server\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `200` \n*Pattern*: `^.+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretKey", "type": "string" }, "ServerCertificate": { + "markdownDescription": "Specifies a certificate to authenticate with an object storage system that uses a private or self\\-signed certificate authority \\(CA\\)\\. You must specify a Base64\\-encoded `.pem` file \\(for example, `file:///home/user/.ssh/storage_sys_certificate.pem`\\)\\. The certificate can be up to 32768 bytes \\(before Base64 encoding\\)\\. \nTo use this parameter, configure `ServerProtocol` to `HTTPS`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerCertificate", "type": "string" }, "ServerHostname": { - "markdownDescription": "The name of the self\\-managed object storage server\\. This value is the IP address or Domain Name Service \\(DNS\\) name of the object storage server\\. An agent uses this host name to mount the object storage server in a network\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the domain name or IP address of the object storage server\\. A DataSync agent uses this hostname to mount the object storage server in a network\\. \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ServerHostname", "type": "string" }, "ServerPort": { - "markdownDescription": "The port that your self\\-managed object storage server accepts inbound network traffic on\\. The server port is set by default to TCP 80 \\(HTTP\\) or TCP 443 \\(HTTPS\\)\\. You can specify a custom port if your self\\-managed object storage server requires one\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65536` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the port that your object storage server accepts inbound network traffic on \\(for example, port 443\\)\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65536` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServerPort", "type": "number" }, "ServerProtocol": { - "markdownDescription": "The protocol that the object storage server uses to communicate\\. Valid values are HTTP or HTTPS\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HTTP | HTTPS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the protocol that your object storage server uses to communicate\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HTTP | HTTPS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServerProtocol", "type": "string" }, "Subdirectory": { - "markdownDescription": "The subdirectory in the self\\-managed object storage server that is used to read data from\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the object prefix for your object storage server\\. If this is a source location, DataSync only copies objects with this prefix\\. If this is a destination location, DataSync writes all objects with this prefix\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Subdirectory", "type": "string" }, @@ -49350,7 +50528,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The key\\-value pair that represents the tag that you want to add to the location\\. The value can be an empty string\\. We recommend using tags to name your resources\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the key\\-value pair that represents a tag that you want to add to the resource\\. Tags can help you manage, filter, and search for your resources\\. We recommend creating a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -49417,7 +50595,7 @@ "additionalProperties": false, "properties": { "S3BucketArn": { - "markdownDescription": "The ARN of the Amazon S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `156` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Maximum*: `156` \n*Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\\-0-9]*:[0-9]*:.*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "S3BucketArn", "type": "string" }, @@ -49427,7 +50605,7 @@ "title": "S3Config" }, "S3StorageClass": { - "markdownDescription": "The Amazon S3 storage class that you want to store your files in when this location is used as a task destination\\. For buckets in AWS Regions, the storage class defaults to S3 Standard\\. \nFor more information about S3 storage classes, see [Amazon S3 Storage Classes](http://aws.amazon.com/s3/storage-classes/)\\. Some storage classes have behaviors that can affect your S3 storage costs\\. 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)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEEP_ARCHIVE | GLACIER | INTELLIGENT_TIERING | ONEZONE_IA | OUTPOSTS | STANDARD | STANDARD_IA` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon S3 storage class that you want to store your files in when this location is used as a task destination\\. For buckets in AWS Regions, the storage class defaults to S3 Standard\\. \nFor more information about S3 storage classes, see [Amazon S3 Storage Classes](http://aws.amazon.com/s3/storage-classes/)\\. Some storage classes have behaviors that can affect your S3 storage costs\\. 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)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEEP_ARCHIVE | GLACIER | GLACIER_INSTANT_RETRIEVAL | INTELLIGENT_TIERING | ONEZONE_IA | OUTPOSTS | STANDARD | STANDARD_IA` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "S3StorageClass", "type": "string" }, @@ -49529,27 +50707,27 @@ "type": "array" }, "Domain": { - "markdownDescription": "The name of the Windows domain that the SMB server belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the Windows domain name that your SMB file server belongs to\\. \nFor more information, see [required permissions](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions) for SMB locations\\. \n*Required*: No \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^[A-Za-z0-9]((\\.|-+)?[A-Za-z0-9]){0,252}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Domain", "type": "string" }, "MountOptions": { "$ref": "#/definitions/AWS::DataSync::LocationSMB.MountOptions", - "markdownDescription": "The mount options used by DataSync to access the SMB server\\. \n*Required*: No \n*Type*: [MountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-mountoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the version of the SMB protocol that DataSync uses to access your SMB file server\\. \n*Required*: No \n*Type*: [MountOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationsmb-mountoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MountOptions" }, "Password": { - "markdownDescription": "The password of the user who can mount the share and has the permissions to access files and folders in the SMB share\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The password of the user who can mount the share and has the permissions to access files and folders in the SMB share\\. \n*Required*: No \n*Type*: String \n*Maximum*: `104` \n*Pattern*: `^.{0,104}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Password", "type": "string" }, "ServerHostname": { - "markdownDescription": "The name of the SMB server\\. This value is the IP address or Domain Name Service \\(DNS\\) name of the SMB server\\. An agent that is installed on\\-premises uses this hostname to mount the SMB server in a network\\. \nThis name must either be DNS\\-compliant or must be an IP version 4 \\(IPv4\\) address\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the Domain Name Service \\(DNS\\) name or IP address of the SMB file server that your DataSync agent will mount\\. \nYou can't specify an IP version 6 \\(IPv6\\) address\\.\n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ServerHostname", "type": "string" }, "Subdirectory": { - "markdownDescription": "The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination\\. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path\\. The path should be such that it can be mounted by other SMB clients in your network\\. \n `Subdirectory` must be specified with forward slashes\\. For example, `/path/to/folder`\\.\nTo transfer all the data in the folder you specified, DataSync must have permissions to mount the SMB share, as well as to access all the data in that share\\. To ensure this, either make sure that the user name and password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share\\. Doing either one enables the agent to access the data\\. For the agent to access directories, you must additionally enable all execute access\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination\\. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path\\. The path should be such that it can be mounted by other SMB clients in your network\\. \n `Subdirectory` must be specified with forward slashes\\. For example, `/path/to/folder`\\.\nTo transfer all the data in the folder you specified, DataSync must have permissions to mount the SMB share, as well as to access all the data in that share\\. To ensure this, either make sure that the user name and password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share\\. Doing either one enables the agent to access the data\\. For the agent to access directories, you must additionally enable all execute access\\. \n*Required*: No \n*Type*: String \n*Maximum*: `4096` \n*Pattern*: `^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Subdirectory", "type": "string" }, @@ -49557,7 +50735,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The key\\-value pair that represents the tag that you want to add to the location\\. The value can be an empty string\\. We recommend using tags to name your resources\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies labels that help you categorize, filter, and search for your AWS resources\\. We recommend creating at least a name tag for your location\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -49598,7 +50776,7 @@ "additionalProperties": false, "properties": { "Version": { - "markdownDescription": "The specific SMB version that you want DataSync to use to mount your SMB share\\. If you don't specify a version, DataSync defaults to `AUTOMATIC`\\. That is, DataSync automatically selects a version based on negotiation with the SMB server\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AUTOMATIC | SMB2 | SMB3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server\\. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically\\. \nThese are the following options for configuring the SMB version: \n+ `AUTOMATIC` \\(default\\): DataSync and the SMB file server negotiate a protocol version that they mutually support\\. \\(DataSync supports SMB versions 1\\.0 and later\\.\\)", "title": "Version", "type": "string" } @@ -49654,7 +50832,7 @@ "items": { "$ref": "#/definitions/AWS::DataSync::Task.FilterRule" }, - "markdownDescription": "A list of filter rules that determines which files to exclude from a task\\. The list should contain a single filter string that consists of the patterns to exclude\\. The patterns are delimited by \"\\|\" \\(that is, a pipe\\), for example, `\"/folder1|/folder2\"`\\. \n \n*Required*: No \n*Type*: List of [FilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of filter rules that exclude specific data during your transfer\\. For more information and examples, see [Filtering data transferred by DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)\\. \n*Required*: No \n*Type*: List of [FilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Excludes", "type": "array" }, @@ -49662,7 +50840,7 @@ "items": { "$ref": "#/definitions/AWS::DataSync::Task.FilterRule" }, - "markdownDescription": "A list of filter rules that determines which files to include when running a task\\. The pattern contains a single filter string that consists of the patterns to include\\. The patterns are delimited by \"\\|\" \\(that is, a pipe\\), for example, `\"/folder1|/folder2\"`\\. \n*Required*: No \n*Type*: List of [FilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of filter rules that include specific data during your transfer\\. For more information and examples, see [Filtering data transferred by DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)\\. \n*Required*: No \n*Type*: List of [FilterRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Includes", "type": "array" }, @@ -49673,7 +50851,7 @@ }, "Options": { "$ref": "#/definitions/AWS::DataSync::Task.Options", - "markdownDescription": "The set of configuration options that control the behavior of a single execution of the task that occurs when you call `StartTaskExecution`\\. You can configure these options to preserve metadata such as user ID \\(UID\\) and group ID \\(GID\\), file permissions, data integrity verification, and so on\\. \nFor each individual task execution, you can override these options by specifying the `OverrideOptions` before starting the task execution\\. For more information, see the [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) operation\\. \n*Required*: No \n*Type*: [Options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the configuration options for a task\\. Some options include preserving file or object metadata and verifying data integrity\\. \nYou can also override these options before starting an individual run of a task \\(also known as a *task execution*\\)\\. For more information, see [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html)\\. \n*Required*: No \n*Type*: [Options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Options" }, "Schedule": { @@ -49690,7 +50868,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The key\\-value pair that represents the tag that you want to add to the resource\\. The value can be an empty string\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the tags that you want to apply to the Amazon Resource Name \\(ARN\\) representing the task\\. \n *Tags* are key\\-value pairs that help you manage, filter, and search for your DataSync resources\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -49731,7 +50909,7 @@ "type": "string" }, "Value": { - "markdownDescription": "A single filter string that consists of the patterns to include or exclude\\. The patterns are delimited by \"\\|\" \\(that is, a pipe\\), for example: `/folder1|/folder2` \n \n*Required*: No \n*Type*: String \n*Maximum*: `409600` \n*Pattern*: `^[^\\x00]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A single filter string that consists of the patterns to include or exclude\\. The patterns are delimited by \"\\|\" \\(that is, a pipe\\), for example: `/folder1|/folder2` \n \n*Required*: No \n*Type*: String \n*Maximum*: `102400` \n*Pattern*: `^[^\\x00]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -49757,7 +50935,7 @@ "type": "string" }, "LogLevel": { - "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `BASIC | OFF | TRANSFER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group\\. To specify the log group, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn)\\. \nIf you set `LogLevel` to `OFF`, no logs are published\\. `BASIC` publishes logs on errors for individual files transferred\\. `TRANSFER` publishes logs for every file or object that is transferred and integrity checked\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `BASIC | OFF | TRANSFER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogLevel", "type": "string" }, @@ -49767,10 +50945,12 @@ "type": "string" }, "ObjectTags": { + "markdownDescription": "Specifies whether object tags are preserved when transferring between object storage systems\\. If you want your DataSync task to ignore object tags, specify the `NONE` value\\. \nDefault Value: `PRESERVE` \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | PRESERVE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObjectTags", "type": "string" }, "OverwriteMode": { - "markdownDescription": "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\\. \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*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS | NEVER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether data at the destination location should be overwritten or preserved\\. If set to `NEVER`, a destination file for example 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\\. \nSome storage classes have specific behaviors that can affect your Amazon 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)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS | NEVER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OverwriteMode", "type": "string" }, @@ -49795,7 +50975,7 @@ "type": "string" }, "TaskQueueing": { - "markdownDescription": "A value that determines whether tasks should be queued before executing the tasks\\. If set to `ENABLED`, the tasks will be queued\\. The default is `ENABLED`\\. \nIf you use the same agent to run multiple tasks, you can enable the tasks to run in series\\. For more information, see [Queueing task executions](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether tasks should be queued before executing the tasks\\. The default is `ENABLED`, which means the tasks will be queued\\. \nIf you use the same agent to run multiple tasks, you can enable the tasks to run in series\\. For more information, see [Queueing task executions](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TaskQueueing", "type": "string" }, @@ -50057,7 +51237,9 @@ "additionalProperties": false, "properties": { "Filters": { - "$ref": "#/definitions/AWS::DevOpsGuru::NotificationChannel.NotificationFilterConfig" + "$ref": "#/definitions/AWS::DevOpsGuru::NotificationChannel.NotificationFilterConfig", + "markdownDescription": "The filter configurations for the Amazon SNS notification topic you use with DevOps Guru\\. If you do not provide filter configurations, the default configurations are to receive notifications for all message types of `High` or `Medium` severity\\. \n*Required*: No \n*Type*: [NotificationFilterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-notificationchannel-notificationfilterconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Filters" }, "Sns": { "$ref": "#/definitions/AWS::DevOpsGuru::NotificationChannel.SnsChannelConfig", @@ -50074,12 +51256,16 @@ "items": { "type": "string" }, + "markdownDescription": "The events that you want to receive notifications for\\. For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MessageTypes", "type": "array" }, "Severities": { "items": { "type": "string" }, + "markdownDescription": "The severity levels that you want to receive notifications for\\. For example, you can choose to receive notifications only for insights with `HIGH` and `MEDIUM` severity levels\\. For more information, see [Understanding insight severities](https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Severities", "type": "array" } }, @@ -50189,6 +51375,8 @@ "items": { "$ref": "#/definitions/AWS::DevOpsGuru::ResourceCollection.TagCollection" }, + "markdownDescription": "The AWS tags used to filter the resources in the resource collection\\. \nTags help you identify and organize your AWS resources\\. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related\\. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function\\. For more information about using tags, see the [Tagging best practices](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html) whitepaper\\. \nEach AWS tag has two parts\\. \n+ A tag *key* \\(for example, `CostCenter`, `Environment`, `Project`, or `Secret`\\)\\. Tag *keys* are case\\-sensitive\\.\n+ An optional field known as a tag *value* \\(for example, `111122223333`, `Production`, or a team name\\)\\. Omitting the tag *value* is the same as using an empty string\\. Like tag *keys*, tag *values* are case\\-sensitive\\.\nTogether these are known as *key*\\-*value* pairs\\. \nThe string used for a *key* in a tag that you use to define your resource coverage must begin with the prefix `Devops-guru-`\\. The tag *key* might be `DevOps-Guru-deployment-application` or `devops-guru-rds-application`\\. When you create a *key*, the case of characters in the *key* can be whatever you choose\\. After you create a *key*, it is case\\-sensitive\\. For example, DevOps Guru works with a *key* named `devops-guru-rds` and a *key* named `DevOps-Guru-RDS`, and these act as two different *keys*\\. Possible *key*/*value* pairs in your application might be `Devops-Guru-production-application/RDS` or `Devops-Guru-production-application/containers`\\.\n*Required*: No \n*Type*: List of [TagCollection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsguru-resourcecollection-tagcollection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -50198,12 +51386,16 @@ "additionalProperties": false, "properties": { "AppBoundaryKey": { + "markdownDescription": "An AWS tag *key* that is used to identify the AWS resources that DevOps Guru analyzes\\. All AWS resources in your account and Region tagged with this *key* make up your DevOps Guru application and analysis boundary\\. \nThe string used for a *key* in a tag that you use to define your resource coverage must begin with the prefix `Devops-guru-`\\. The tag *key* might be `DevOps-Guru-deployment-application` or `devops-guru-rds-application`\\. When you create a *key*, the case of characters in the *key* can be whatever you choose\\. After you create a *key*, it is case\\-sensitive\\. For example, DevOps Guru works with a *key* named `devops-guru-rds` and a *key* named `DevOps-Guru-RDS`, and these act as two different *keys*\\. Possible *key*/*value* pairs in your application might be `Devops-Guru-production-application/RDS` or `Devops-Guru-production-application/containers`\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppBoundaryKey", "type": "string" }, "TagValues": { "items": { "type": "string" }, + "markdownDescription": "The values in an AWS tag collection\\. \nThe tag's *value* is an optional field used to associate a string with the tag *key* \\(for example, `111122223333`, `Production`, or a team name\\)\\. The *key* and *value* are the tag's *key* pair\\. Omitting the tag *value* is the same as using an empty string\\. Like tag *keys*, tag *values* are case\\-sensitive\\. You can specify a maximum of 256 characters for a tag value\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TagValues", "type": "array" } }, @@ -50387,7 +51579,7 @@ "type": "string" }, "Password": { - "markdownDescription": "The password for the directory administrator\\. The directory creation process creates a directory administrator account with the user name `Administrator` and this password\\. \nIf you need to change the password for the administrator account, see the [ResetUserPassword](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html) API call in the *AWS Directory Service API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `(?=^.{8,64}$)((?=.*\\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[^A-Za-z0-9\\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\\s]))^.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The password for the directory administrator\\. The directory creation process creates a directory administrator account with the user name `Administrator` and this password\\. \nIf you need to change the password for the administrator account, see the [ResetUserPassword](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html) API call in the *AWS Directory Service API Reference*\\. \n*Required*: No \n*Type*: String \n*Pattern*: `(?=^.{8,64}$)((?=.*\\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[^A-Za-z0-9\\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\\s]))^.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Password", "type": "string" }, @@ -50442,12 +51634,12 @@ "items": { "type": "string" }, - "markdownDescription": "The identifiers of the subnets for the directory servers\\. The two subnets must be in different Availability Zones\\. AWS Directory Service specifies a directory server and a DNS server in each of these subnets\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifiers of the subnets for the directory servers\\. The two subnets must be in different Availability Zones\\. AWS Directory Service specifies a directory server and a DNS server in each of these subnets\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SubnetIds", "type": "array" }, "VpcId": { - "markdownDescription": "The identifier of the VPC in which to create the directory\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of the VPC in which to create the directory\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VpcId", "type": "string" } @@ -50507,7 +51699,7 @@ "type": "number" }, "CopyTagsToSnapshot": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CopyTagsToSnapshot", "type": "boolean" }, @@ -50575,9 +51767,13 @@ "type": "string" }, "RestoreToTime": { + "markdownDescription": "The date and time to restore the cluster to\\. \nValid values: A time in Universal Coordinated Time \\(UTC\\) format\\. \nConstraints: \n+ Must be before the latest restorable time for the instance\\.\n+ Must be specified if the `UseLatestRestorableTime` parameter is not provided\\.\n+ Cannot be specified if the `UseLatestRestorableTime` parameter is `true`\\.\n+ Cannot be specified if the `RestoreType` parameter is `copy-on-write`\\.\nExample: `2015-03-07T23:45:00Z` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RestoreToTime", "type": "string" }, "RestoreType": { + "markdownDescription": "The type of restore to be performed\\. You can specify one of the following values: \n+ `full-copy` \\- The new DB cluster is restored as a full copy of the source DB cluster\\.\n+ `copy-on-write` \\- The new DB cluster is restored as a clone of the source DB cluster\\.\nConstraints: You can't specify `copy-on-write` if the engine version of the source DB cluster is earlier than 1\\.11\\. \nIf you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RestoreType", "type": "string" }, "SnapshotIdentifier": { @@ -50586,6 +51782,8 @@ "type": "string" }, "SourceDBClusterIdentifier": { + "markdownDescription": "The identifier of the source cluster from which to restore\\. \nConstraints: \n+ Must match the identifier of an existing `DBCluster`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceDBClusterIdentifier", "type": "string" }, "StorageEncrypted": { @@ -50602,6 +51800,8 @@ "type": "array" }, "UseLatestRestorableTime": { + "markdownDescription": "A value that is set to `true` to restore the cluster to the latest restorable backup time, and `false` otherwise\\. \nDefault: `false` \nConstraints: Cannot be specified if the `RestoreToTime` parameter is provided\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseLatestRestorableTime", "type": "boolean" }, "VpcSecurityGroupIds": { @@ -50788,6 +51988,8 @@ "type": "string" }, "EnablePerformanceInsights": { + "markdownDescription": "A value that indicates whether to enable Performance Insights for the DB Instance\\. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnablePerformanceInsights", "type": "boolean" }, "PreferredMaintenanceWindow": { @@ -50956,45 +52158,67 @@ "additionalProperties": false, "properties": { "AdminUserName": { + "markdownDescription": "The name of the Amazon DocumentDB elastic clusters administrator\\. \n*Constraints*: \n+ Must be from 1 to 63 letters or numbers\\.\n+ The first character must be a letter\\.\n+ Cannot be a reserved word\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AdminUserName", "type": "string" }, "AdminUserPassword": { + "markdownDescription": "The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters\\. \n*Constraints*: \n+ Must contain from 8 to 100 characters\\.\n+ Cannot contain a forward slash \\(/\\), double quote \\(\"\\), or the \"at\" symbol \\(@\\)\\.\n+ A valid `AdminUserName` entry is also required\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdminUserPassword", "type": "string" }, "AuthType": { + "markdownDescription": "The authentication type used to determine where to fetch the password used for accessing the elastic cluster\\. Valid types are `PLAIN_TEXT` or `SECRET_ARN`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AuthType", "type": "string" }, "ClusterName": { + "markdownDescription": "The name of the new elastic cluster\\. This parameter is stored as a lowercase string\\. \n*Constraints*: \n+ Must contain from 1 to 63 letters, numbers, or hyphens\\.\n+ The first character must be a letter\\.\n+ Cannot end with a hyphen or contain two consecutive hyphens\\.\n*Example*: `my-cluster` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ClusterName", "type": "string" }, "KmsKeyId": { + "markdownDescription": "The KMS key identifier to use to encrypt the new elastic cluster\\. \nThe KMS key identifier is the Amazon Resource Name \\(ARN\\) for the KMS encryption key\\. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key\\. \nIf an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account\\. Your account has a different default encryption key for each Amazon Region\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" }, "PreferredMaintenanceWindow": { + "markdownDescription": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \n*Format*: `ddd:hh24:mi-ddd:hh24:mi` \n*Default*: a 30\\-minute window selected at random from an 8\\-hour block of time for each AWS Region, occurring on a random day of the week\\. \n*Valid days*: Mon, Tue, Wed, Thu, Fri, Sat, Sun \n*Constraints*: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PreferredMaintenanceWindow", "type": "string" }, "ShardCapacity": { + "markdownDescription": "The number of vCPUs assigned to each elastic cluster shard\\. Maximum is 64\\. Allowed values are 2, 4, 8, 16, 32, 64\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ShardCapacity", "type": "number" }, "ShardCount": { + "markdownDescription": "The number of shards assigned to the elastic cluster\\. Maximum is 32\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ShardCount", "type": "number" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "The Amazon EC2 subnet IDs for the new elastic cluster\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetIds", "type": "array" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags to be assigned to the new elastic cluster\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "VpcSecurityGroupIds": { "items": { "type": "string" }, + "markdownDescription": "A list of EC2 VPC security groups to associate with the new elastic cluster\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcSecurityGroupIds", "type": "array" } }, @@ -51072,7 +52296,7 @@ "type": "array" }, "BillingMode": { - "markdownDescription": "Specifies how you are charged for read and write throughput and how you manage capacity\\. Valid values are: \n+ `PAY_PER_REQUEST`\n+ `PROVISIONED`\nAll replicas in your global table will have the same billing mode\\. If you use `PROVISIONED` billing mode, you must provide an auto scaling configuration via the `WriteProvisionedThroughputSettings` property\\. The default value of this property is `PROVISIONED`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PAY_PER_REQUEST | PROVISIONED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how you are charged for read and write throughput and how you manage capacity\\. Valid values are: \n+ `PAY_PER_REQUEST`\n+ `PROVISIONED`\nAll replicas in your global table will have the same billing mode\\. If you use `PROVISIONED` billing mode, you must provide an auto scaling configuration via the `WriteProvisionedThroughputSettings` property\\. The default value of this property is `PROVISIONED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BillingMode", "type": "string" }, @@ -51119,7 +52343,7 @@ "title": "StreamSpecification" }, "TableName": { - "markdownDescription": "A name for the global table\\. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name\\. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A name for the global table\\. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID as the table name\\. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TableName", "type": "string" }, @@ -51166,12 +52390,12 @@ "additionalProperties": false, "properties": { "AttributeName": { - "markdownDescription": "A name for the attribute\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A name for the attribute\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeName", "type": "string" }, "AttributeType": { - "markdownDescription": "The data type for the attribute, where: \n+ `S` \\- the attribute is of type String\n+ `N` \\- the attribute is of type Number\n+ `B` \\- the attribute is of type Binary\n*Required*: Yes \n*Type*: String \n*Allowed values*: `B | N | S` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The data type for the attribute, where: \n+ `S` \\- the attribute is of type String\n+ `N` \\- the attribute is of type Number\n+ `B` \\- the attribute is of type Binary\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeType", "type": "string" } @@ -51217,7 +52441,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "Indicates whether CloudWatch Contributor Insights are to be enabled \\(true\\) or disabled \\(false\\)\\. \n*Required*: Yes \n*Type*: Boolean \n*Allowed values*: `DISABLE | ENABLE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether CloudWatch Contributor Insights are to be enabled \\(true\\) or disabled \\(false\\)\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -51231,7 +52455,7 @@ "additionalProperties": false, "properties": { "IndexName": { - "markdownDescription": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: Updates are not supported\\.", "title": "IndexName", "type": "string" }, @@ -51239,7 +52463,7 @@ "items": { "$ref": "#/definitions/AWS::DynamoDB::GlobalTable.KeySchema" }, - "markdownDescription": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) \n*Maximum*: `2` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) \n*Update requires*: Updates are not supported\\.", "title": "KeySchema", "type": "array" }, @@ -51270,7 +52494,7 @@ "type": "string" }, "KeyType": { - "markdownDescription": "The role that this key attribute will assume: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `HASH | RANGE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The role that this key attribute will assume: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeyType", "type": "string" } @@ -51285,6 +52509,8 @@ "additionalProperties": false, "properties": { "StreamArn": { + "markdownDescription": "The ARN for a specific Kinesis data stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StreamArn", "type": "string" } }, @@ -51297,7 +52523,7 @@ "additionalProperties": false, "properties": { "IndexName": { - "markdownDescription": "The name of the local secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The name of the local secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: Updates are not supported\\.", "title": "IndexName", "type": "string" }, @@ -51305,7 +52531,7 @@ "items": { "$ref": "#/definitions/AWS::DynamoDB::GlobalTable.KeySchema" }, - "markdownDescription": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) \n*Maximum*: `2` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-keyschema.html) \n*Update requires*: Updates are not supported\\.", "title": "KeySchema", "type": "array" }, @@ -51340,12 +52566,12 @@ "items": { "type": "string" }, - "markdownDescription": "Represents the non\\-key attribute names which will be projected into the index\\. \nFor local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, must not exceed 20\\. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Represents the non\\-key attribute names which will be projected into the index\\. \nFor local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, must not exceed 100\\. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "NonKeyAttributes", "type": "array" }, "ProjectionType": { - "markdownDescription": "The set of attributes that are projected into the index: \n+ `KEYS_ONLY` \\- Only the index and primary keys are projected into the index\\.\n+ `INCLUDE` \\- In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non\\-key attributes that you specify\\.\n+ `ALL` \\- All of the table attributes are projected into the index\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ALL | INCLUDE | KEYS_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The set of attributes that are projected into the index: \n+ `KEYS_ONLY` \\- Only the index and primary keys are projected into the index\\.\n+ `INCLUDE` \\- In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non\\-key attributes that you specify\\.\n+ `ALL` \\- All of the table attributes are projected into the index\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "ProjectionType", "type": "string" } @@ -51377,7 +52603,7 @@ "title": "ContributorInsightsSpecification" }, "IndexName": { - "markdownDescription": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IndexName", "type": "string" }, @@ -51423,7 +52649,9 @@ "type": "array" }, "KinesisStreamSpecification": { - "$ref": "#/definitions/AWS::DynamoDB::GlobalTable.KinesisStreamSpecification" + "$ref": "#/definitions/AWS::DynamoDB::GlobalTable.KinesisStreamSpecification", + "markdownDescription": "Defines the Kinesis Data Streams configuration for the specified replica\\. \n*Required*: No \n*Type*: [KinesisStreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-kinesisstreamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KinesisStreamSpecification" }, "PointInTimeRecoverySpecification": { "$ref": "#/definitions/AWS::DynamoDB::GlobalTable.PointInTimeRecoverySpecification", @@ -51446,7 +52674,7 @@ "title": "SSESpecification" }, "TableClass": { - "markdownDescription": "The table class of the specified table\\. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `STANDARD | STANDARD_INFREQUENT_ACCESS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The table class of the specified table\\. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TableClass", "type": "string" }, @@ -51468,12 +52696,12 @@ "additionalProperties": false, "properties": { "SSEEnabled": { - "markdownDescription": "Indicates whether server\\-side encryption is performed using an AWS managed key or an AWS owned key\\. If disabled \\(false\\) or not specified, server\\-side encryption uses an AWS owned key\\. If enabled \\(true\\), the server\\-side encryption type is set to KMS and an AWS managed key is used \\(AWS KMS charges apply\\)\\. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the `ReplicaSpecification.SSESpecification` object\\. You cannot mix AWS managed and customer managed KMS keys\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether server\\-side encryption is performed using an AWS managed key or an AWS owned key\\. If enabled \\(true\\), server\\-side encryption type is set to KMS and an AWS managed key is used \\(AWS KMS charges apply\\)\\. If disabled \\(false\\) or not specified,server\\-side encryption is set to an AWS owned key\\. If you choose to use KMS encryption, you can also use customer managed KMS keys by specifying them in the `ReplicaSpecification.SSESpecification` object\\. You cannot mix AWS managed and customer managed KMS keys\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SSEEnabled", "type": "boolean" }, "SSEType": { - "markdownDescription": "Server\\-side encryption type\\. The only supported value is: \n+ `KMS` \\- Server\\-side encryption that uses AWS Key Management Service\\. The key is stored in your account and is managed by AWS KMS \\(AWS KMS charges apply\\)\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `AES256 | KMS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Server\\-side encryption type\\. The only supported value is: \n+ `KMS` \\- Server\\-side encryption that uses AWS Key Management Service\\. The key is stored in your account and is managed by AWS KMS \\(AWS KMS charges apply\\)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SSEType", "type": "string" } @@ -51487,7 +52715,7 @@ "additionalProperties": false, "properties": { "StreamViewType": { - "markdownDescription": "When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table\\. Valid values for `StreamViewType` are: \n+ `KEYS_ONLY` \\- Only the key attributes of the modified item are written to the stream\\.\n+ `NEW_IMAGE` \\- The entire item, as it appears after it was modified, is written to the stream\\.\n+ `OLD_IMAGE` \\- The entire item, as it appeared before it was modified, is written to the stream\\.\n+ `NEW_AND_OLD_IMAGES` \\- Both the new and the old item images of the item are written to the stream\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `KEYS_ONLY | NEW_AND_OLD_IMAGES | NEW_IMAGE | OLD_IMAGE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table\\. Valid values for `StreamViewType` are: \n+ `KEYS_ONLY` \\- Only the key attributes of the modified item are written to the stream\\.\n+ `NEW_IMAGE` \\- The entire item, as it appears after it was modified, is written to the stream\\.\n+ `OLD_IMAGE` \\- The entire item, as it appeared before it was modified, is written to the stream\\.\n+ `NEW_AND_OLD_IMAGES` \\- Both the new and the old item images of the item are written to the stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamViewType", "type": "string" } @@ -51530,7 +52758,7 @@ "additionalProperties": false, "properties": { "AttributeName": { - "markdownDescription": "The name of the attribute used to store the expiration time for items in the table\\. \nCurrently, you cannot directly change the attribute name used to evaluate time to live\\. In order to do so, you must first disable time to live, and then re\\-enable it with the new attribute name\\. It can take up to one hour for changes to time to live to take effect\\. If you attempt to modify time to live within that time window, your stack operation might be delayed\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the attribute used to store the expiration time for items in the table\\. \nCurrently, you cannot directly change the attribute name used to evaluate time to live\\. In order to do so, you must first disable time to live, and then re\\-enable it with the new attribute name\\. It can take up to one hour for changes to time to live to take effect\\. If you attempt to modify time to live within that time window, your stack operation might be delayed\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeName", "type": "string" }, @@ -51595,49 +52823,51 @@ "items": { "$ref": "#/definitions/AWS::DynamoDB::Table.AttributeDefinition" }, - "markdownDescription": "A list of attributes that describe the key schema for the table and indexes\\. \nThis property is required to create a DynamoDB table\\. \nUpdate requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\\. Replacement if you edit an existing AttributeDefinition\\. \n*Required*: Conditional \n*Type*: List of [AttributeDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "A list of attributes that describe the key schema for the table and indexes\\. \nThis property is required to create a DynamoDB table\\. \nUpdate requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)\\. Replacement if you edit an existing AttributeDefinition\\. \n*Required*: Conditional \n*Type*: List of [AttributeDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-attributedefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeDefinitions", "type": "array" }, "BillingMode": { - "markdownDescription": "Specify how you are charged for read and write throughput and how you manage capacity\\. \nValid values include: \n+ `PROVISIONED` \\- We recommend using `PROVISIONED` for predictable workloads\\. `PROVISIONED` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual)\\.\n+ `PAY_PER_REQUEST` \\- We recommend using `PAY_PER_REQUEST` for unpredictable workloads\\. `PAY_PER_REQUEST` sets the billing mode to [On\\-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand)\\.\nIf not specified, the default is `PROVISIONED`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `PAY_PER_REQUEST | PROVISIONED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify how you are charged for read and write throughput and how you manage capacity\\. \nValid values include: \n+ `PROVISIONED` \\- We recommend using `PROVISIONED` for predictable workloads\\. `PROVISIONED` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual)\\.\n+ `PAY_PER_REQUEST` \\- We recommend using `PAY_PER_REQUEST` for unpredictable workloads\\. `PAY_PER_REQUEST` sets the billing mode to [On\\-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand)\\.\nIf not specified, the default is `PROVISIONED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BillingMode", "type": "string" }, "ContributorInsightsSpecification": { "$ref": "#/definitions/AWS::DynamoDB::Table.ContributorInsightsSpecification", - "markdownDescription": "The settings used to enable or disable CloudWatch Contributor Insights for the specified table\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The settings used to enable or disable CloudWatch Contributor Insights for the specified table\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContributorInsightsSpecification" }, "GlobalSecondaryIndexes": { "items": { "$ref": "#/definitions/AWS::DynamoDB::Table.GlobalSecondaryIndex" }, - "markdownDescription": "Global secondary indexes to be created on the table\\. You can create up to 20 global secondary indexes\\. \nIf you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update\\. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table\\. You can't use the index or update the table until the index's status is `ACTIVE`\\. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command\\. \nIf you add or delete an index during an update, we recommend that you don't update any other resources\\. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index\\. \nUpdates are not supported\\. The following are exceptions: \n+ If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption\\.\n+ You can delete or add one global secondary index without interruption\\. If you do both in the same update \\(for example, by changing the index's logical ID\\), the update fails\\.\n*Required*: No \n*Type*: List of [GlobalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Global secondary indexes to be created on the table\\. You can create up to 20 global secondary indexes\\. \nIf you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update\\. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table\\. You can't use the index or update the table until the index's status is `ACTIVE`\\. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command\\. \nIf you add or delete an index during an update, we recommend that you don't update any other resources\\. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index\\. \nUpdates are not supported\\. The following are exceptions: \n+ If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption\\.\n+ You can delete or add one global secondary index without interruption\\. If you do both in the same update \\(for example, by changing the index's logical ID\\), the update fails\\.\n*Required*: No \n*Type*: List of [GlobalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "GlobalSecondaryIndexes", "type": "array" }, "ImportSourceSpecification": { - "$ref": "#/definitions/AWS::DynamoDB::Table.ImportSourceSpecification" + "$ref": "#/definitions/AWS::DynamoDB::Table.ImportSourceSpecification", + "markdownDescription": "Specifies the properties of data being imported from the S3 bucket source to the table\\. \nIf you specify the `ImportSourceSpecification` property, and also specify either the `StreamSpecification` or `TableClass` property, the IAM entity creating/updating stack must have `UpdateTable` permission\\.\n*Required*: No \n*Type*: [ImportSourceSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-importsourcespecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ImportSourceSpecification" }, "KeySchema": { "items": { "$ref": "#/definitions/AWS::DynamoDB::Table.KeySchema" }, - "markdownDescription": "Specifies the attributes that make up the primary key for the table\\. The attributes in the `KeySchema` property must also be defined in the `AttributeDefinitions` property\\. \n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the attributes that make up the primary key for the table\\. The attributes in the `KeySchema` property must also be defined in the `AttributeDefinitions` property\\. \n*Required*: Yes \n*Type*: [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeySchema", "type": "array" }, "KinesisStreamSpecification": { "$ref": "#/definitions/AWS::DynamoDB::Table.KinesisStreamSpecification", - "markdownDescription": "The Kinesis Data Streams configuration for the specified table\\. \n*Required*: No \n*Type*: [KinesisStreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-kinesisstreamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Kinesis Data Streams configuration for the specified table\\. \n*Required*: No \n*Type*: [KinesisStreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-kinesisstreamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KinesisStreamSpecification" }, "LocalSecondaryIndexes": { "items": { "$ref": "#/definitions/AWS::DynamoDB::Table.LocalSecondaryIndex" }, - "markdownDescription": "Local secondary indexes to be created on the table\\. You can create up to 5 local secondary indexes\\. Each index is scoped to a given hash key value\\. The size of each hash key can be up to 10 gigabytes\\. \n*Required*: No \n*Type*: List of [LocalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Local secondary indexes to be created on the table\\. You can create up to 5 local secondary indexes\\. Each index is scoped to a given hash key value\\. The size of each hash key can be up to 10 gigabytes\\. \n*Required*: No \n*Type*: List of [LocalSecondaryIndex](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-localsecondaryindex.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LocalSecondaryIndexes", "type": "array" }, @@ -51648,7 +52878,7 @@ }, "ProvisionedThroughput": { "$ref": "#/definitions/AWS::DynamoDB::Table.ProvisionedThroughput", - "markdownDescription": "Throughput for the specified table, which consists of values for `ReadCapacityUnits` and `WriteCapacityUnits`\\. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html)\\. \nIf you set `BillingMode` as `PROVISIONED`, you must specify this property\\. If you set `BillingMode` as `PAY_PER_REQUEST`, you cannot specify this property\\. \n*Required*: Conditional \n*Type*: [ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Throughput for the specified table, which consists of values for `ReadCapacityUnits` and `WriteCapacityUnits`\\. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html)\\. \nIf you set `BillingMode` as `PROVISIONED`, you must specify this property\\. If you set `BillingMode` as `PAY_PER_REQUEST`, you cannot specify this property\\. \n*Required*: Conditional \n*Type*: [ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProvisionedThroughput" }, "SSESpecification": { @@ -51658,11 +52888,11 @@ }, "StreamSpecification": { "$ref": "#/definitions/AWS::DynamoDB::Table.StreamSpecification", - "markdownDescription": "The settings for the DynamoDB table stream, which capture changes to items stored in the table\\. \n*Required*: No \n*Type*: [StreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-streamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The settings for the DynamoDB table stream, which capture changes to items stored in the table\\. \n*Required*: No \n*Type*: [StreamSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-streamspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamSpecification" }, "TableClass": { - "markdownDescription": "The table class of the new table\\. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `STANDARD | STANDARD_INFREQUENT_ACCESS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The table class of the new table\\. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TableClass", "type": "string" }, @@ -51681,7 +52911,7 @@ }, "TimeToLiveSpecification": { "$ref": "#/definitions/AWS::DynamoDB::Table.TimeToLiveSpecification", - "markdownDescription": "Specifies the Time to Live \\(TTL\\) settings for the table\\. \nFor detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide\\. \n*Required*: No \n*Type*: [TimeToLiveSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the Time to Live \\(TTL\\) settings for the table\\. \nFor detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide\\. \n*Required*: No \n*Type*: [TimeToLiveSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-timetolivespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeToLiveSpecification" } }, @@ -51715,12 +52945,12 @@ "additionalProperties": false, "properties": { "AttributeName": { - "markdownDescription": "A name for the attribute\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A name for the attribute\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeName", "type": "string" }, "AttributeType": { - "markdownDescription": "The data type for the attribute, where: \n+ `S` \\- the attribute is of type String\n+ `N` \\- the attribute is of type Number\n+ `B` \\- the attribute is of type Binary\n*Required*: Yes \n*Type*: String \n*Allowed values*: `B | N | S` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The data type for the attribute, where: \n+ `S` \\- the attribute is of type String\n+ `N` \\- the attribute is of type Number\n+ `B` \\- the attribute is of type Binary\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeType", "type": "string" } @@ -51735,7 +52965,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "Indicates whether CloudWatch Contributor Insights are to be enabled \\(true\\) or disabled \\(false\\)\\. \n*Required*: Yes \n*Type*: Boolean \n*Allowed values*: `DISABLE | ENABLE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether CloudWatch Contributor Insights are to be enabled \\(true\\) or disabled \\(false\\)\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -51749,12 +52979,16 @@ "additionalProperties": false, "properties": { "Delimiter": { + "markdownDescription": "The delimiter used for separating items in the CSV file being imported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Delimiter", "type": "string" }, "HeaderList": { "items": { "type": "string" }, + "markdownDescription": "List of the headers used to specify a common header for all source CSV files being imported\\. If this field is specified then the first line of each CSV file is treated as data instead of the header\\. If this field is not specified the the first line of each CSV file is treated as the header\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "HeaderList", "type": "array" } }, @@ -51765,11 +52999,11 @@ "properties": { "ContributorInsightsSpecification": { "$ref": "#/definitions/AWS::DynamoDB::Table.ContributorInsightsSpecification", - "markdownDescription": "The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index\\. \n*Required*: No \n*Type*: [ContributorInsightsSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-contributorinsightsspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContributorInsightsSpecification" }, "IndexName": { - "markdownDescription": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The name of the global secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: Updates are not supported\\.", "title": "IndexName", "type": "string" }, @@ -51777,18 +53011,18 @@ "items": { "$ref": "#/definitions/AWS::DynamoDB::Table.KeySchema" }, - "markdownDescription": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) \n*Maximum*: `2` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) \n*Update requires*: Updates are not supported\\.", "title": "KeySchema", "type": "array" }, "Projection": { "$ref": "#/definitions/AWS::DynamoDB::Table.Projection", - "markdownDescription": "Represents attributes that are copied \\(projected\\) from the table into the global secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html) \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "Represents attributes that are copied \\(projected\\) from the table into the global secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-projection.html) \n*Update requires*: Updates are not supported\\.", "title": "Projection" }, "ProvisionedThroughput": { "$ref": "#/definitions/AWS::DynamoDB::Table.ProvisionedThroughput", - "markdownDescription": "Represents the provisioned throughput settings for the specified global secondary index\\. \nFor current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*\\. \n*Required*: No \n*Type*: [ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Represents the provisioned throughput settings for the specified global secondary index\\. \nFor current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*\\. \n*Required*: No \n*Type*: [ProvisionedThroughput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-provisionedthroughput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProvisionedThroughput" } }, @@ -51803,16 +53037,24 @@ "additionalProperties": false, "properties": { "InputCompressionType": { + "markdownDescription": "Type of compression to be used on the input coming from the imported table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InputCompressionType", "type": "string" }, "InputFormat": { + "markdownDescription": "The format of the source data\\. Valid values for `ImportFormat` are `CSV`, `DYNAMODB_JSON` or `ION`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InputFormat", "type": "string" }, "InputFormatOptions": { - "$ref": "#/definitions/AWS::DynamoDB::Table.InputFormatOptions" + "$ref": "#/definitions/AWS::DynamoDB::Table.InputFormatOptions", + "markdownDescription": "Additional properties that specify how the input is formatted, \n*Required*: No \n*Type*: [InputFormatOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-inputformatoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InputFormatOptions" }, "S3BucketSource": { - "$ref": "#/definitions/AWS::DynamoDB::Table.S3BucketSource" + "$ref": "#/definitions/AWS::DynamoDB::Table.S3BucketSource", + "markdownDescription": "The S3 bucket that provides the source for the import\\. \n*Required*: Yes \n*Type*: [S3BucketSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-s3bucketsource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3BucketSource" } }, "required": [ @@ -51825,7 +53067,9 @@ "additionalProperties": false, "properties": { "Csv": { - "$ref": "#/definitions/AWS::DynamoDB::Table.Csv" + "$ref": "#/definitions/AWS::DynamoDB::Table.Csv", + "markdownDescription": "The options for imported source files in CSV format\\. The values are Delimiter and HeaderList\\. \n*Required*: No \n*Type*: [Csv](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-csv.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Csv" } }, "type": "object" @@ -51839,7 +53083,7 @@ "type": "string" }, "KeyType": { - "markdownDescription": "The role that this key attribute will assume: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `HASH | RANGE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The role that this key attribute will assume: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeyType", "type": "string" } @@ -51854,7 +53098,7 @@ "additionalProperties": false, "properties": { "StreamArn": { - "markdownDescription": "The ARN for a specific Kinesis data stream\\. \nLength Constraints: Minimum length of 37\\. Maximum length of 1024\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `37` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN for a specific Kinesis data stream\\. \nLength Constraints: Minimum length of 37\\. Maximum length of 1024\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamArn", "type": "string" } @@ -51868,7 +53112,7 @@ "additionalProperties": false, "properties": { "IndexName": { - "markdownDescription": "The name of the local secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The name of the local secondary index\\. The name must be unique among all other indexes on this table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: Updates are not supported\\.", "title": "IndexName", "type": "string" }, @@ -51876,13 +53120,13 @@ "items": { "$ref": "#/definitions/AWS::DynamoDB::Table.KeySchema" }, - "markdownDescription": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html) \n*Maximum*: `2` \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: \n+ `HASH` \\- partition key\n+ `RANGE` \\- sort key\nThe partition key of an item is also known as its *hash attribute*\\. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values\\. \nThe sort key of an item is also known as its *range attribute*\\. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value\\.\n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) of [KeySchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-keyschema.html) \n*Update requires*: Updates are not supported\\.", "title": "KeySchema", "type": "array" }, "Projection": { "$ref": "#/definitions/AWS::DynamoDB::Table.Projection", - "markdownDescription": "Represents attributes that are copied \\(projected\\) from the table into the local secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html) \n*Update requires*: Updates are not supported\\.", + "markdownDescription": "Represents attributes that are copied \\(projected\\) from the table into the local secondary index\\. These are in addition to the primary key attributes and index key attributes, which are automatically projected\\. \n*Required*: Yes \n*Type*: [Projection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-projection.html) \n*Update requires*: Updates are not supported\\.", "title": "Projection" } }, @@ -51911,12 +53155,12 @@ "items": { "type": "string" }, - "markdownDescription": "Represents the non\\-key attribute names which will be projected into the index\\. \nFor local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, must not exceed 20\\. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Represents the non\\-key attribute names which will be projected into the index\\. \nFor local secondary indexes, the total count of `NonKeyAttributes` summed across all of the local secondary indexes, must not exceed 100\\. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NonKeyAttributes", "type": "array" }, "ProjectionType": { - "markdownDescription": "The set of attributes that are projected into the index: \n+ `KEYS_ONLY` \\- Only the index and primary keys are projected into the index\\.\n+ `INCLUDE` \\- In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non\\-key attributes that you specify\\.\n+ `ALL` \\- All of the table attributes are projected into the index\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ALL | INCLUDE | KEYS_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The set of attributes that are projected into the index: \n+ `KEYS_ONLY` \\- Only the index and primary keys are projected into the index\\.\n+ `INCLUDE` \\- In addition to the attributes described in `KEYS_ONLY`, the secondary index will include other non\\-key attributes that you specify\\.\n+ `ALL` \\- All of the table attributes are projected into the index\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProjectionType", "type": "string" } @@ -51927,12 +53171,12 @@ "additionalProperties": false, "properties": { "ReadCapacityUnits": { - "markdownDescription": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`\\. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide*\\. \nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0\\. \n*Required*: Yes \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`\\. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide*\\. \nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReadCapacityUnits", "type": "number" }, "WriteCapacityUnits": { - "markdownDescription": "The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`\\. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide*\\. \nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0\\. \n*Required*: Yes \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`\\. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) in the *Amazon DynamoDB Developer Guide*\\. \nIf read/write capacity mode is `PAY_PER_REQUEST` the value is set to 0\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WriteCapacityUnits", "type": "number" } @@ -51947,12 +53191,18 @@ "additionalProperties": false, "properties": { "S3Bucket": { + "markdownDescription": "The S3 bucket that is being imported from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3Bucket", "type": "string" }, "S3BucketOwner": { + "markdownDescription": "The account number of the S3 bucket that is being imported from\\. If the bucket is owned by the requester this is optional\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3BucketOwner", "type": "string" }, "S3KeyPrefix": { + "markdownDescription": "The key prefix shared by all S3 Objects that are being imported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3KeyPrefix", "type": "string" } }, @@ -51989,7 +53239,7 @@ "additionalProperties": false, "properties": { "StreamViewType": { - "markdownDescription": "When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table\\. Valid values for `StreamViewType` are: \n+ `KEYS_ONLY` \\- Only the key attributes of the modified item are written to the stream\\.\n+ `NEW_IMAGE` \\- The entire item, as it appears after it was modified, is written to the stream\\.\n+ `OLD_IMAGE` \\- The entire item, as it appeared before it was modified, is written to the stream\\.\n+ `NEW_AND_OLD_IMAGES` \\- Both the new and the old item images of the item are written to the stream\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `KEYS_ONLY | NEW_AND_OLD_IMAGES | NEW_IMAGE | OLD_IMAGE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table\\. Valid values for `StreamViewType` are: \n+ `KEYS_ONLY` \\- Only the key attributes of the modified item are written to the stream\\.\n+ `NEW_IMAGE` \\- The entire item, as it appears after it was modified, is written to the stream\\.\n+ `OLD_IMAGE` \\- The entire item, as it appeared before it was modified, is written to the stream\\.\n+ `NEW_AND_OLD_IMAGES` \\- Both the new and the old item images of the item are written to the stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamViewType", "type": "string" } @@ -52003,7 +53253,7 @@ "additionalProperties": false, "properties": { "AttributeName": { - "markdownDescription": "The name of the TTL attribute used to store the expiration time for items in the table\\. \nTo update this property, you must first disable TTL then enable TTL with the new attribute name\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the TTL attribute used to store the expiration time for items in the table\\. \nTo update this property, you must first disable TTL then enable TTL with the new attribute name\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AttributeName", "type": "string" }, @@ -52156,7 +53406,7 @@ "additionalProperties": false, "properties": { "ResourceType": { - "markdownDescription": "The type of resource to tag\\. Specify `capacity-reservation`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of resource to tag\\. Specify `capacity-reservation`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceType", "type": "string" }, @@ -52304,7 +53554,7 @@ "type": "string" }, "InstanceType": { - "markdownDescription": "The instance type for which the Capacity Reservation Fleet reserves capacity\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The instance type for which the Capacity Reservation Fleet reserves capacity\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, @@ -52802,7 +54052,7 @@ "additionalProperties": false, "properties": { "ResourceType": { - "markdownDescription": "The type of resource to tag\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of resource to tag\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceType", "type": "string" }, @@ -53407,7 +54657,7 @@ "title": "InstanceRequirements" }, "InstanceType": { - "markdownDescription": "The instance type\\. \nIf you specify `InstanceType`, you can't specify `InstanceRequirements`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The instance type\\. \nIf you specify `InstanceType`, you can't specify `InstanceRequirements`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, @@ -53815,7 +55065,7 @@ "additionalProperties": false, "properties": { "ResourceType": { - "markdownDescription": "The type of resource to tag\\. `ResourceType` must be `fleet`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of resource to tag\\. `ResourceType` must be `fleet`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceType", "type": "string" }, @@ -53960,7 +55210,7 @@ "type": "array" }, "TransferAddress": { - "markdownDescription": "The Elastic IP address you are accepting for transfer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Elastic IP address you are accepting for transfer\\. You can only accept one transferred address\\. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TransferAddress", "type": "string" } @@ -54173,12 +55423,12 @@ "additionalProperties": false, "properties": { "CertificateArn": { - "markdownDescription": "The ARN of the ACM certificate with which to associate the IAM role\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1283` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the ACM certificate with which to associate the IAM role\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CertificateArn", "type": "string" }, "RoleArn": { - "markdownDescription": "The ARN of the IAM role to associate with the ACM certificate\\. You can associate up to 16 IAM roles with an ACM certificate\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1283` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the IAM role to associate with the ACM certificate\\. You can associate up to 16 IAM roles with an ACM certificate\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RoleArn", "type": "string" } @@ -54558,9 +55808,13 @@ "additionalProperties": false, "properties": { "DefaultResourceDiscoveryAssociationId": { + "markdownDescription": "The IPAM's default resource discovery association ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultResourceDiscoveryAssociationId", "type": "string" }, "DefaultResourceDiscoveryId": { + "markdownDescription": "The IPAM's default resource discovery ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultResourceDiscoveryId", "type": "string" }, "Description": { @@ -54577,6 +55831,8 @@ "type": "array" }, "ResourceDiscoveryAssociationCount": { + "markdownDescription": "The IPAM's resource discovery association count\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceDiscoveryAssociationCount", "type": "number" }, "Tags": { @@ -54803,6 +56059,8 @@ "type": "array" }, "PublicIpSource": { + "markdownDescription": "The IP address source for pools in the public scope\\. Only used for provisioning IP address CIDRs to pools in the public scope\\. Default is `BYOIP`\\. For more information, see [Create IPv6 pools](https://docs.aws.amazon.com/vpc/latest/ipam/intro-create-ipv6-pools.html) in the *Amazon VPC IPAM User Guide*\\. By default, you can add only one Amazon\\-provided IPv6 CIDR block to a top\\-level IPv6 pool\\. For information on increasing the default limit, see [ Quotas for your IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) in the *Amazon VPC IPAM User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `amazon | byoip` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PublicIpSource", "type": "string" }, "PubliclyAdvertisable": { @@ -54901,12 +56159,18 @@ "additionalProperties": false, "properties": { "Cidr": { + "markdownDescription": "The CIDR provisioned to the IPAM pool\\. A CIDR is a representation of an IP address and its associated network mask \\(or netmask\\) and refers to a range of IP addresses\\. An IPv4 CIDR example is `10.24.34.0/23`\\. An IPv6 CIDR example is `2001:DB8::/32`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Cidr", "type": "string" }, "IpamPoolId": { + "markdownDescription": "The ID of the IPAM pool\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IpamPoolId", "type": "string" }, "NetmaskLength": { + "markdownDescription": "The netmask length of the CIDR you'd like to provision to a pool\\. Can be used for provisioning Amazon\\-provided IPv6 CIDRs to top\\-level pools and for provisioning CIDRs to pools with source pools\\. Cannot be used to provision BYOIP CIDRs to top\\-level pools\\. \"NetmaskLength\" or \"Cidr\" is required\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NetmaskLength", "type": "number" } }, @@ -54972,18 +56236,24 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The resource discovery description\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "OperatingRegions": { "items": { "$ref": "#/definitions/AWS::EC2::IPAMResourceDiscovery.IpamOperatingRegion" }, + "markdownDescription": "The operating Regions for the resource discovery\\. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs\\. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions\\. \n*Required*: No \n*Type*: List of [IpamOperatingRegion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ipamresourcediscovery-ipamoperatingregion.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OperatingRegions", "type": "array" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A tag is a label that you assign to an AWS resource\\. Each tag consists of a key and an optional value\\. You can use tags to search and filter your resources or track your AWS costs\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -55013,6 +56283,8 @@ "additionalProperties": false, "properties": { "RegionName": { + "markdownDescription": "The name of the operating Region\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RegionName", "type": "string" } }, @@ -55057,15 +56329,21 @@ "additionalProperties": false, "properties": { "IpamId": { + "markdownDescription": "The IPAM ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IpamId", "type": "string" }, "IpamResourceDiscoveryId": { + "markdownDescription": "The resource discovery ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IpamResourceDiscoveryId", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A tag is a label that you assign to an AWS resource\\. Each tag consists of a key and an optional value\\. You can use tags to search and filter your resources or track your AWS costs\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -55309,7 +56587,7 @@ "type": "string" }, "InstanceType": { - "markdownDescription": "The instance type\\. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*\\. \nDefault: `m1.small` \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The instance type\\. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*\\. \nDefault: `m1.small` \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "InstanceType", "type": "string" }, @@ -56619,7 +57897,7 @@ "title": "InstanceRequirements" }, "InstanceType": { - "markdownDescription": "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*\\. \nIf you specify `InstanceType`, you can't specify `InstanceRequirements`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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*\\. \nIf you specify `InstanceType`, you can't specify `InstanceRequirements`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InstanceType", "type": "string" }, @@ -56731,7 +58009,7 @@ "additionalProperties": false, "properties": { "ResourceType": { - "markdownDescription": "The type of resource\\. To tag the launch template, `ResourceType` must be `launch-template`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of resource\\. To tag the launch template, `ResourceType` must be `launch-template`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceType", "type": "string" }, @@ -57113,7 +58391,7 @@ "additionalProperties": false, "properties": { "ResourceType": { - "markdownDescription": "The type of resource to tag\\. \nThe `Valid Values` are all the resource types that can be tagged\\. However, when creating a launch template, you can specify tags for the following resource types only: `instance` \\| `volume` \\| `elastic-gpu` \\| `network-interface` \\| `spot-instances-request` \nTo tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of resource to tag\\. \nThe `Valid Values` are all the resource types that can be tagged\\. However, when creating a launch template, you can specify tags for the following resource types only: `instance` \\| `volume` \\| `elastic-gpu` \\| `network-interface` \\| `spot-instances-request` \nTo tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceType", "type": "string" }, @@ -57243,6 +58521,80 @@ ], "type": "object" }, + "AWS::EC2::LocalGatewayRouteTable": { + "additionalProperties": false, + "properties": { + "Condition": { + "type": "string" + }, + "DeletionPolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + }, + "DependsOn": { + "anyOf": [ + { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + { + "items": { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "type": "array" + } + ] + }, + "Metadata": { + "type": "object" + }, + "Properties": { + "additionalProperties": false, + "properties": { + "LocalGatewayId": { + "type": "string" + }, + "Mode": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "required": [ + "LocalGatewayId" + ], + "type": "object" + }, + "Type": { + "enum": [ + "AWS::EC2::LocalGatewayRouteTable" + ], + "type": "string" + }, + "UpdateReplacePolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Properties" + ], + "type": "object" + }, "AWS::EC2::LocalGatewayRouteTableVPCAssociation": { "additionalProperties": false, "properties": { @@ -57324,6 +58676,81 @@ ], "type": "object" }, + "AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { + "additionalProperties": false, + "properties": { + "Condition": { + "type": "string" + }, + "DeletionPolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + }, + "DependsOn": { + "anyOf": [ + { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + { + "items": { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "type": "array" + } + ] + }, + "Metadata": { + "type": "object" + }, + "Properties": { + "additionalProperties": false, + "properties": { + "LocalGatewayRouteTableId": { + "type": "string" + }, + "LocalGatewayVirtualInterfaceGroupId": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "required": [ + "LocalGatewayRouteTableId", + "LocalGatewayVirtualInterfaceGroupId" + ], + "type": "object" + }, + "Type": { + "enum": [ + "AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation" + ], + "type": "string" + }, + "UpdateReplacePolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Properties" + ], + "type": "object" + }, "AWS::EC2::NatGateway": { "additionalProperties": false, "properties": { @@ -57370,7 +58797,7 @@ "type": "string" }, "MaxDrainDurationSeconds": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum amount of time to wait \\(in seconds\\) before forcibly releasing the IP addresses if connections are still in progress\\. Default value is 350 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `4000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxDrainDurationSeconds", "type": "number" }, @@ -57383,12 +58810,12 @@ "items": { "type": "string" }, - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Secondary EIP allocation IDs\\. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecondaryAllocationIds", "type": "array" }, "SecondaryPrivateIpAddressCount": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "\\[Private NAT gateway only\\] The number of secondary private IPv4 addresses you want to assign to the NAT gateway\\. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*\\. \n`SecondaryPrivateIpAddressCount` and `SecondaryPrivateIpAddresses` cannot be set at the same time\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `7` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecondaryPrivateIpAddressCount", "type": "number" }, @@ -57396,7 +58823,7 @@ "items": { "type": "string" }, - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Secondary private IPv4 addresses\\. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*\\. \n`SecondaryPrivateIpAddressCount` and `SecondaryPrivateIpAddresses` cannot be set at the same time\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecondaryPrivateIpAddresses", "type": "array" }, @@ -58057,9 +59484,13 @@ "items": { "$ref": "#/definitions/AWS::EC2::NetworkInsightsAnalysis.AnalysisComponent" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [AnalysisComponent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkinsightsanalysis-analysiscomponent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LoadBalancers", "type": "array" }, "ServiceName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceName", "type": "string" } }, @@ -58662,6 +60093,8 @@ "type": "number" }, "ServiceName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceName", "type": "string" }, "SourceVpc": { @@ -58785,7 +60218,7 @@ "additionalProperties": false, "properties": { "Destination": { - "markdownDescription": "The AWS resource that is the destination of the path\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The AWS resource that is the destination of the path\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Destination", "type": "string" }, @@ -59728,7 +61161,7 @@ "type": "array" }, "VpcId": { - "markdownDescription": "\\[VPC only\\] The ID of the VPC for the security group\\. Your default VPC ID will be used if you do not define the VpcId here\\. Furthermore\\, VpcId is required if you specify SecurityGroupEgress rules\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\[VPC only\\] The ID of the VPC for the security group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VpcId", "type": "string" } @@ -60619,7 +62052,7 @@ "title": "InstanceRequirements" }, "InstanceType": { - "markdownDescription": "The instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, @@ -60793,7 +62226,7 @@ "title": "InstanceRequirements" }, "InstanceType": { - "markdownDescription": "The instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | mac1.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6ad.12xlarge | r6ad.16xlarge | r6ad.24xlarge | r6ad.2xlarge | r6ad.32xlarge | r6ad.48xlarge | r6ad.4xlarge | r6ad.8xlarge | r6ad.large | r6ad.metal | r6ad.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `a1.2xlarge | a1.4xlarge | a1.large | a1.medium | a1.metal | a1.xlarge | c1.medium | c1.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.metal | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.large | c5ad.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.metal | c5d.xlarge | c5n.18xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.large | c5n.metal | c5n.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.32xlarge | c6a.48xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.metal | c6a.xlarge | c6g.12xlarge | c6g.16xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.large | c6g.medium | c6g.metal | c6g.xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.large | c6gd.medium | c6gd.metal | c6gd.xlarge | c6gn.12xlarge | c6gn.16xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.large | c6gn.medium | c6gn.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.32xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.metal | c6i.xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.2xlarge | c6id.32xlarge | c6id.4xlarge | c6id.8xlarge | c6id.large | c6id.metal | c6id.xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.2xlarge | c6in.32xlarge | c6in.4xlarge | c6in.8xlarge | c6in.large | c6in.xlarge | c7g.12xlarge | c7g.16xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.large | c7g.medium | c7g.xlarge | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d2.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3.xlarge | d3en.12xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.xlarge | dl1.24xlarge | f1.16xlarge | f1.2xlarge | f1.4xlarge | g2.2xlarge | g2.8xlarge | g3.16xlarge | g3.4xlarge | g3.8xlarge | g3s.xlarge | g4ad.16xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.metal | g4dn.xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.2xlarge | g5.48xlarge | g5.4xlarge | g5.8xlarge | g5.xlarge | g5g.16xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.metal | g5g.xlarge | h1.16xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | hi1.4xlarge | hpc6a.48xlarge | hpc6id.32xlarge | hs1.8xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i2.xlarge | i3.16xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.large | i3.metal | i3.xlarge | i3en.12xlarge | i3en.24xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.large | i3en.metal | i3en.xlarge | i4i.16xlarge | i4i.2xlarge | i4i.32xlarge | i4i.4xlarge | i4i.8xlarge | i4i.large | i4i.metal | i4i.xlarge | im4gn.16xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.large | im4gn.xlarge | inf1.24xlarge | inf1.2xlarge | inf1.6xlarge | inf1.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | is4gen.large | is4gen.medium | is4gen.xlarge | m1.large | m1.medium | m1.small | m1.xlarge | m2.2xlarge | m2.4xlarge | m2.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.16xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.metal | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.large | m5ad.xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.large | m5d.metal | m5d.xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.large | m5dn.metal | m5dn.xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.large | m5n.metal | m5n.xlarge | m5zn.12xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.large | m5zn.metal | m5zn.xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.2xlarge | m6a.32xlarge | m6a.48xlarge | m6a.4xlarge | m6a.8xlarge | m6a.large | m6a.metal | m6a.xlarge | m6g.12xlarge | m6g.16xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.large | m6g.medium | m6g.metal | m6g.xlarge | m6gd.12xlarge | m6gd.16xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.large | m6gd.medium | m6gd.metal | m6gd.xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.2xlarge | m6i.32xlarge | m6i.4xlarge | m6i.8xlarge | m6i.large | m6i.metal | m6i.xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.2xlarge | m6id.32xlarge | m6id.4xlarge | m6id.8xlarge | m6id.large | m6id.metal | m6id.xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.2xlarge | m6idn.32xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.large | m6idn.xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.2xlarge | m6in.32xlarge | m6in.4xlarge | m6in.8xlarge | m6in.large | m6in.xlarge | mac1.metal | mac2.metal | p2.16xlarge | p2.8xlarge | p2.xlarge | p3.16xlarge | p3.2xlarge | p3.8xlarge | p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.metal | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.large | r5ad.xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.large | r5b.metal | r5b.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.metal | r5d.xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.large | r5dn.metal | r5dn.xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.large | r5n.metal | r5n.xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.2xlarge | r6a.32xlarge | r6a.48xlarge | r6a.4xlarge | r6a.8xlarge | r6a.large | r6a.metal | r6a.xlarge | r6g.12xlarge | r6g.16xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.large | r6g.medium | r6g.metal | r6g.xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.large | r6gd.medium | r6gd.metal | r6gd.xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.2xlarge | r6i.32xlarge | r6i.4xlarge | r6i.8xlarge | r6i.large | r6i.metal | r6i.xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.2xlarge | r6id.32xlarge | r6id.4xlarge | r6id.8xlarge | r6id.large | r6id.metal | r6id.xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.2xlarge | r6idn.32xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.large | r6idn.xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.2xlarge | r6in.32xlarge | r6in.4xlarge | r6in.8xlarge | r6in.large | r6in.xlarge | t1.micro | t2.2xlarge | t2.large | t2.medium | t2.micro | t2.nano | t2.small | t2.xlarge | t3.2xlarge | t3.large | t3.medium | t3.micro | t3.nano | t3.small | t3.xlarge | t3a.2xlarge | t3a.large | t3a.medium | t3a.micro | t3a.nano | t3a.small | t3a.xlarge | t4g.2xlarge | t4g.large | t4g.medium | t4g.micro | t4g.nano | t4g.small | t4g.xlarge | trn1.2xlarge | trn1.32xlarge | u-12tb1.112xlarge | u-12tb1.metal | u-18tb1.112xlarge | u-18tb1.metal | u-24tb1.112xlarge | u-24tb1.metal | u-3tb1.56xlarge | u-6tb1.112xlarge | u-6tb1.56xlarge | u-6tb1.metal | u-9tb1.112xlarge | u-9tb1.metal | vt1.24xlarge | vt1.3xlarge | vt1.6xlarge | x1.16xlarge | x1.32xlarge | x1e.16xlarge | x1e.2xlarge | x1e.32xlarge | x1e.4xlarge | x1e.8xlarge | x1e.xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.large | x2gd.medium | x2gd.metal | x2gd.xlarge | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2idn.metal | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.2xlarge | x2iedn.32xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.metal | x2iedn.xlarge | x2iezn.12xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.metal | z1d.12xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.large | z1d.metal | z1d.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, @@ -60857,7 +62290,7 @@ "type": "array" }, "UserData": { - "markdownDescription": "The Base64\\-encoded user data that instances use when starting up\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The base64\\-encoded user data that instances use when starting up\\. User data is limited to 16 KB\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "UserData", "type": "string" }, @@ -61021,7 +62454,7 @@ "additionalProperties": false, "properties": { "ResourceType": { - "markdownDescription": "The type of resource\\. Currently, the only resource type that is supported is `instance`\\. To tag the Spot Fleet request on creation, use the `TagSpecifications` parameter in ` [SpotFleetRequestConfigData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html) `\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-server | route-server-endpoint | route-server-peer | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of resource\\. Currently, the only resource type that is supported is `instance`\\. To tag the Spot Fleet request on creation, use the `TagSpecifications` parameter in ` [SpotFleetRequestConfigData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html) `\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `capacity-reservation | capacity-reservation-fleet | carrier-gateway | client-vpn-endpoint | coip-pool | customer-gateway | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-gpu | elastic-ip | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-resource-discovery | ipam-resource-discovery-association | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-route-table-virtual-interface-group-association | local-gateway-route-table-vpc-association | local-gateway-virtual-interface | local-gateway-virtual-interface-group | natgateway | network-acl | network-insights-access-scope | network-insights-access-scope-analysis | network-insights-analysis | network-insights-path | network-interface | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-filter-rule | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-route-table | transit-gateway-route-table-announcement | verified-access-endpoint | verified-access-group | verified-access-instance | verified-access-policy | verified-access-trust-provider | volume | vpc | vpc-block-public-access-exclusion | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-connection-device-type | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-flow-log | vpc-peering-connection | vpn-connection | vpn-connection-device-type | vpn-gateway` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceType", "type": "string" }, @@ -64374,7 +65807,7 @@ "type": "number" }, "VolumeType": { - "markdownDescription": "The volume type\\. This parameter can be one of the following values: \n+ General Purpose SSD: `gp2` \\| `gp3` \n+ Provisioned IOPS SSD: `io1` \\| `io2` \n+ Throughput Optimized HDD: `st1` \n+ Cold HDD: `sc1` \n+ Magnetic: `standard` \nThroughput Optimized HDD \\(`st1`\\) and Cold HDD \\(`sc1`\\) volumes can't be used as boot volumes\\.\nFor more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*\\. \nDefault: `gp2` \n*Required*: No \n*Type*: String \n*Allowed values*: `gp2 | gp3 | io1 | io2 | sc1 | st1 | standard` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The volume type\\. This parameter can be one of the following values: \n+ General Purpose SSD: `gp2` \\| `gp3` \n+ Provisioned IOPS SSD: `io1` \\| `io2` \n+ Throughput Optimized HDD: `st1` \n+ Cold HDD: `sc1` \n+ Magnetic: `standard` \nFor more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*\\. \nDefault: `gp2` \n*Required*: No \n*Type*: String \n*Allowed values*: `gp2 | gp3 | io1 | io2 | sc1 | st1 | standard` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumeType", "type": "string" } @@ -64521,7 +65954,7 @@ "properties": { "RepositoryCatalogData": { "$ref": "#/definitions/AWS::ECR::PublicRepository.RepositoryCatalogData", - "markdownDescription": "The details about the repository that are publicly visible in the Amazon ECR Public Gallery\\. For more information, see [Amazon ECR Public repository catalog data](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html) in the *Amazon ECR Public User Guide*\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The details about the repository that are publicly visible in the Amazon ECR Public Gallery\\. For more information, see [Amazon ECR Public repository catalog data](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html) in the *Amazon ECR Public User Guide*\\. \n*Required*: No \n*Type*: [RepositoryCatalogData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecr-publicrepository-repositorycatalogdata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RepositoryCatalogData" }, "RepositoryName": { @@ -64569,24 +66002,34 @@ "additionalProperties": false, "properties": { "AboutText": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AboutText", "type": "string" }, "Architectures": { "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Architectures", "type": "array" }, "OperatingSystems": { "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OperatingSystems", "type": "array" }, "RepositoryDescription": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RepositoryDescription", "type": "string" }, "UsageText": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UsageText", "type": "string" } }, @@ -65011,7 +66454,7 @@ "type": "string" }, "RegistryId": { - "markdownDescription": "The AWS account ID associated with the registry that contains the repository\\. If you do not specify a registry, the default registry is assumed\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[0-9]{12}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS account ID associated with the registry that contains the repository\\. If you do\u2028 not specify a registry, the default registry is assumed\\. \n*Required*: No \n*Type*: String \n*Pattern*: `[0-9]{12}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RegistryId", "type": "string" } @@ -65102,7 +66545,7 @@ "additionalProperties": false, "properties": { "AutoScalingGroupArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) or short name that identifies the Auto Scaling group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) that identifies the Auto Scaling group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AutoScalingGroupArn", "type": "string" }, @@ -65112,7 +66555,7 @@ "title": "ManagedScaling" }, "ManagedTerminationProtection": { - "markdownDescription": "The managed termination protection setting to use for the Auto Scaling group capacity provider\\. This determines whether the Auto Scaling group has managed termination protection\\. The default is disabled\\. \nWhen using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work\\.\nWhen managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale\\-in action\\. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale\\-in actions enabled as well\\. For more information, see [Instance Protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) in the * AWS Auto Scaling User Guide*\\. \nWhen managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The managed termination protection setting to use for the Auto Scaling group capacity provider\\. This determines whether the Auto Scaling group has managed termination protection\\. The default is off\\. \nWhen using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work\\.\nWhen managed termination protection is on, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale\\-in action\\. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale\\-in actions enabled as well\\. For more information, see [Instance Protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection) in the * AWS Auto Scaling User Guide*\\. \nWhen managed termination protection is off, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ManagedTerminationProtection", "type": "string" } @@ -65131,12 +66574,12 @@ "type": "number" }, "MaximumScalingStepSize": { - "markdownDescription": "The maximum number of container instances that Amazon ECS scales in or scales out at one time\\. If this parameter is omitted, the default value of `10000` is used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time\\. The scale in process is not affected by this parameter\\. If this parameter is omitted, the default value of `1` is used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaximumScalingStepSize", "type": "number" }, "MinimumScalingStepSize": { - "markdownDescription": "The minimum number of container instances that Amazon ECS scales in or scales out at one time\\. If this parameter is omitted, the default value of `1` is used\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time\\. The scale in process is not affected by this parameter If this parameter is omitted, the default value of `1` is used\\. \nWhen additional capacity is required, Amazon ECS will scale up the minimum scaling step size even if the actual demand is less than the minimum scaling step size\\. \nIf you use a capacity provider with an Auto Scaling group configured with more than one Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum scaling step size value and will ignore both the maximum scaling step size as well as the capacity demand\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MinimumScalingStepSize", "type": "number" }, @@ -65192,7 +66635,7 @@ "items": { "type": "string" }, - "markdownDescription": "The short name of one or more capacity providers to associate with the cluster\\. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy\\. \nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster\\. \nTo use an AWS Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers\\. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The short name of one or more capacity providers to associate with the cluster\\. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) actions\\. \nIf specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster\\. New Auto Scaling group capacity providers can be created with the [CreateCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) API operation\\. \nTo use a AWS Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers\\. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used\\. \nThe [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available capacity providers for a cluster after the cluster is created\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CapacityProviders", "type": "array" }, @@ -65205,7 +66648,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::Cluster.ClusterSettings" }, - "markdownDescription": "The setting to use when creating a cluster\\. This parameter is used to enable CloudWatch Container Insights for a cluster\\. If this value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html) of [ClusterSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The setting to use when creating a cluster\\. This parameter is used to use CloudWatch Container Insights for a cluster\\. If this value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html) of [ClusterSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-clustersettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClusterSettings", "type": "array" }, @@ -65223,7 +66666,9 @@ "type": "array" }, "ServiceConnectDefaults": { - "$ref": "#/definitions/AWS::ECS::Cluster.ServiceConnectDefaults" + "$ref": "#/definitions/AWS::ECS::Cluster.ServiceConnectDefaults", + "markdownDescription": "Use this parameter to set a default Service Connect namespace\\. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace\\. This setting only applies to new services that set the `enabled` parameter to `true` in the `ServiceConnectConfiguration`\\. You can set the namespace of each service individually in the `ServiceConnectConfiguration` to override this default parameter\\. \nTasks that run in a namespace can use short names to connect to services in the namespace\\. Tasks can connect to services across all of the clusters in the namespace\\. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility\\. Only the tasks that Amazon ECS services create are supported with Service Connect\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [ServiceConnectDefaults](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-serviceconnectdefaults.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceConnectDefaults" }, "Tags": { "items": { @@ -65297,7 +66742,7 @@ "type": "string" }, "Value": { - "markdownDescription": "The value to set for the cluster setting\\. The supported values are `enabled` and `disabled`\\. If `enabled` is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the `containerInsights` account setting is enabled\\. If a cluster value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value to set for the cluster setting\\. The supported values are `enabled` and `disabled`\\. If `enabled` is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be off unless the `containerInsights` account setting is turned on\\. If a cluster value is specified, it will override the `containerInsights` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -65329,7 +66774,7 @@ "additionalProperties": false, "properties": { "CloudWatchEncryptionEnabled": { - "markdownDescription": "Determines whether to use encryption on the CloudWatch logs\\. If not specified, encryption will be disabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether to use encryption on the CloudWatch logs\\. If not specified, encryption will be off\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchEncryptionEnabled", "type": "boolean" }, @@ -65360,6 +66805,8 @@ "additionalProperties": false, "properties": { "Namespace": { + "markdownDescription": "The namespace name or full Amazon Resource Name \\(ARN\\) of the AWS Cloud Map namespace that's used when you create a service and don't specify a Service Connect configuration\\. The namespace name can include up to 1024 characters\\. The name is case\\-sensitive\\. The name can't include hyphens \\(\\-\\), tilde \\(\\~\\), greater than \\(>\\), less than \\(<\\), or slash \\(/\\)\\. \nIf you enter an existing namespace name or ARN, then that namespace will be used\\. Any namespace type is supported\\. The namespace must be in this account and this AWS Region\\. \nIf you enter a new name, a AWS Cloud Map namespace will be created\\. Amazon ECS creates a AWS Cloud Map namespace with the \"API calls\" method of instance discovery only\\. This instance discovery method is the \"HTTP\" namespace type in the AWS Command Line Interface\\. Other types of instance discovery aren't used by Service Connect\\. \nIf you update the service with an empty string `\"\"` for the namespace name, the cluster configuration for Service Connect is removed\\. Note that the namespace will remain in AWS Cloud Map and must be deleted separately\\. \nFor more information about AWS Cloud Map, see [Working with Services](https://docs.aws.amazon.com/) in the * AWS Cloud Map Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Namespace", "type": "string" } }, @@ -65617,7 +67064,7 @@ "type": "number" }, "EnableECSManagedTags": { - "markdownDescription": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service\\. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service\\. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableECSManagedTags", "type": "boolean" }, @@ -65627,7 +67074,7 @@ "type": "boolean" }, "HealthCheckGracePeriodSeconds": { - "markdownDescription": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started\\. This is only used when your service is configured to use a load balancer\\. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of `0` is used\\. \nIf you do not use an Elastic Load Balancing, we recomend that you use the `startPeriod` in the task definition healtch check parameters\\. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html)\\. \nIf your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds \\(about 69 years\\)\\. During that time, the Amazon ECS service scheduler ignores health check status\\. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started\\. This is only used when your service is configured to use a load balancer\\. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of `0` is used\\. \nIf you do not use an Elastic Load Balancing, we recommend that you use the `startPeriod` in the task definition health check parameters\\. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html)\\. \nIf your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds \\(about 69 years\\)\\. During that time, the Amazon ECS service scheduler ignores health check status\\. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HealthCheckGracePeriodSeconds", "type": "number" }, @@ -65653,7 +67100,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::Service.PlacementConstraint" }, - "markdownDescription": "An array of placement constraint objects to use for tasks in your service\\. You can specify a maximum of 10 constraints for each task\\. This limit includes constraints in the task definition and those specified at runtime\\. \n*Required*: No \n*Type*: List of [PlacementConstraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An array of placement constraint objects to use for tasks in your service\\. You can specify a maximum of 10 constraints for each task\\. This limit includes constraints in the task definition and those specified at runtime\\. \n*Required*: No \n*Type*: List of [PlacementConstraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementconstraint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PlacementConstraints", "type": "array" }, @@ -65661,7 +67108,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::Service.PlacementStrategy" }, - "markdownDescription": "The placement strategy objects to use for tasks in your service\\. You can specify a maximum of five strategy rules per service\\. For more information, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [PlacementStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The placement strategy objects to use for tasks in your service\\. You can specify a maximum of five strategy rules per service\\. For more information, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [PlacementStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-placementstrategy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PlacementStrategies", "type": "array" }, @@ -65686,7 +67133,9 @@ "type": "string" }, "ServiceConnectConfiguration": { - "$ref": "#/definitions/AWS::ECS::Service.ServiceConnectConfiguration" + "$ref": "#/definitions/AWS::ECS::Service.ServiceConnectConfiguration", + "markdownDescription": "The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace\\. \nTasks that run in a namespace can use short names to connect to services in the namespace\\. Tasks can connect to services across all of the clusters in the namespace\\. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility\\. Only the tasks that Amazon ECS services create are supported with Service Connect\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [ServiceConnectConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceConnectConfiguration" }, "ServiceName": { "markdownDescription": "The name of your service\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, underscores, and hyphens are allowed\\. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -65710,7 +67159,7 @@ "type": "array" }, "TaskDefinition": { - "markdownDescription": "The `family` and `revision` \\(`family:revision`\\) or full ARN of the task definition to run in your service\\. The `revision` is required in order for the resource to stabilize\\. \nA task definition must be specified if the service is using either the `ECS` or `CODE_DEPLOY` deployment controllers\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The `family` and `revision` \\(`family:revision`\\) or full ARN of the task definition to run in your service\\. The `revision` is required in order for the resource to stabilize\\. \nA task definition must be specified if the service is using either the `ECS` or `CODE_DEPLOY` deployment controllers\\. \nFor more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TaskDefinition", "type": "string" } @@ -65792,12 +67241,18 @@ "items": { "type": "string" }, + "markdownDescription": "One or more CloudWatch alarm names\\. Use a \",\" to separate the alarms\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmNames", "type": "array" }, "Enable": { + "markdownDescription": "Determines whether to use the CloudWatch alarm option in the service deployment process\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enable", "type": "boolean" }, "Rollback": { + "markdownDescription": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails\\. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Rollback", "type": "boolean" } }, @@ -65817,7 +67272,7 @@ "type": "boolean" }, "Rollback": { - "markdownDescription": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails\\. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails\\. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Rollback", "type": "boolean" } @@ -65832,20 +67287,22 @@ "additionalProperties": false, "properties": { "Alarms": { - "$ref": "#/definitions/AWS::ECS::Service.DeploymentAlarms" + "$ref": "#/definitions/AWS::ECS::Service.DeploymentAlarms", + "markdownDescription": "Information about the CloudWatch alarms\\. \n*Required*: No \n*Type*: [DeploymentAlarms](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentalarms.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Alarms" }, "DeploymentCircuitBreaker": { "$ref": "#/definitions/AWS::ECS::Service.DeploymentCircuitBreaker", - "markdownDescription": "The deployment circuit breaker can only be used for services using the rolling update \\(`ECS`\\) deployment type that are not behind a Classic Load Balancer\\.\nThe **deployment circuit breaker** determines whether a service deployment will fail if the service can't reach a steady state\\. If enabled, a service deployment will transition to a failed state and stop launching new tasks\\. You can also enable Amazon ECS to roll back your service to the last completed deployment after a failure\\. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [DeploymentCircuitBreaker](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The deployment circuit breaker can only be used for services using the rolling update \\(`ECS`\\) deployment type\\.\nThe **deployment circuit breaker** determines whether a service deployment will fail if the service can't reach a steady state\\. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks\\. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully\\. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide* \n*Required*: No \n*Type*: [DeploymentCircuitBreaker](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeploymentCircuitBreaker" }, "MaximumPercent": { - "markdownDescription": "If a service is using the rolling update \\(`ECS`\\) deployment type, the **maximum percent** parameter represents an upper limit on the number of tasks in a service that are allowed in the `RUNNING` or `PENDING` state during a deployment, as a percentage of the desired number of tasks \\(rounded down to the nearest integer\\), and while any container instances are in the `DRAINING` state if the service contains tasks using the EC2 launch type\\. This parameter enables you to define the deployment batch size\\. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks \\(provided that the cluster resources required to do this are available\\)\\. The default value for maximum percent is 200%\\. \nIf a service is using the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and tasks that use the EC2 launch type, the **maximum percent** value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state\\. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If a service is using the rolling update \\(`ECS`\\) deployment type, the `maximumPercent` parameter represents an upper limit on the number of your service's tasks that are allowed in the `RUNNING` or `PENDING` state during a deployment, as a percentage of the `desiredCount` \\(rounded down to the nearest integer\\)\\. This parameter enables you to define the deployment batch size\\. For example, if your service is using the `REPLICA` service scheduler and has a `desiredCount` of four tasks and a `maximumPercent` value of 200%, the scheduler may start four new tasks before stopping the four older tasks \\(provided that the cluster resources required to do this are available\\)\\. The default `maximumPercent` value for a service using the `REPLICA` service scheduler is 200%\\. \nIf a service is using either the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and tasks that use the EC2 launch type, the **maximum percent** value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state\\. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaximumPercent", "type": "number" }, "MinimumHealthyPercent": { - "markdownDescription": "If a service is using the rolling update \\(`ECS`\\) deployment type, the **minimum healthy percent** represents a lower limit on the number of tasks in a service that must remain in the `RUNNING` state during a deployment, as a percentage of the desired number of tasks \\(rounded up to the nearest integer\\), and while any container instances are in the `DRAINING` state if the service contains tasks using the EC2 launch type\\. This parameter enables you to deploy without using additional cluster capacity\\. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks\\. Tasks for services that *do not* use a load balancer are considered healthy if they're in the `RUNNING` state; tasks for services that *do* use a load balancer are considered healthy if they're in the `RUNNING` state and they're reported as healthy by the load balancer\\. The default value for minimum healthy percent is 100%\\. \nIf a service is using the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and tasks that use the EC2 launch type, the **minimum healthy percent** value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state\\. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If a service is using the rolling update \\(`ECS`\\) deployment type, the `minimumHealthyPercent` represents a lower limit on the number of your service's tasks that must remain in the `RUNNING` state during a deployment, as a percentage of the `desiredCount` \\(rounded up to the nearest integer\\)\\. This parameter enables you to deploy without using additional cluster capacity\\. For example, if your service has a `desiredCount` of four tasks and a `minimumHealthyPercent` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks\\. \nFor services that *do not* use a load balancer, the following should be noted: \n+ A service is considered healthy if all essential containers within the tasks in the service pass their health checks\\.\n+ If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a `RUNNING` state before the task is counted towards the minimum healthy percent total\\.\n+ If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total\\. A task is considered healthy when all essential containers within the task have passed their health checks\\. The amount of time the service scheduler can wait for is determined by the container health check settings\\. \nFor services are that *do* use a load balancer, the following should be noted: \n+ If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total\\.\n+ If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total\\.\nIf a service is using either the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and is running tasks that use the EC2 launch type, the **minimum healthy percent** value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the `RUNNING` state while the container instances are in the `DRAINING` state\\. If a service is using either the blue/green \\(`CODE_DEPLOY`\\) or `EXTERNAL` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MinimumHealthyPercent", "type": "number" } @@ -65882,7 +67339,7 @@ "type": "string" }, "TargetGroupArn": { - "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the Elastic Load Balancing target group or groups associated with a service or task set\\. \nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer\\. If you're using a Classic Load Balancer, omit the target group ARN\\. \nFor services using the `ECS` deployment controller, you can specify one or multiple target groups\\. For more information, see [Registering Multiple Target Groups with a Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer\\. For more information, see [Blue/Green Deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance`\\. Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance\\. This network mode is required for the Fargate launch type\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the Elastic Load Balancing target group or groups associated with a service or task set\\. \nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer\\. If you're using a Classic Load Balancer, omit the target group ARN\\. \nFor services using the `ECS` deployment controller, you can specify one or multiple target groups\\. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer\\. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance`\\. Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance\\. This network mode is required for the Fargate launch type\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TargetGroupArn", "type": "string" } @@ -65893,21 +67350,27 @@ "additionalProperties": false, "properties": { "LogDriver": { + "markdownDescription": "The log driver to use for the container\\. \nFor tasks on AWS Fargate, the supported log drivers are `awslogs`, `splunk`, and `awsfirelens`\\. \nFor tasks hosted on Amazon EC2 instances, the supported log drivers are `awslogs`, `fluentd`, `gelf`, `json-file`, `journald`, `logentries`,`syslog`, `splunk`, and `awsfirelens`\\. \nFor more information about using the `awslogs` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor more information about using the `awsfirelens` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver\\. We encourage you to submit pull requests for changes that you would like to have included\\. However, we don't currently provide support for running modified copies of this software\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `awsfirelens | awslogs | fluentd | gelf | journald | json-file | splunk | syslog` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogDriver", "type": "string" }, "Options": { "additionalProperties": true, + "markdownDescription": "The configuration options to send to the log driver\\. This parameter requires version 1\\.19 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Options", "type": "object" }, "SecretOptions": { "items": { "$ref": "#/definitions/AWS::ECS::Service.Secret" }, + "markdownDescription": "The secrets to pass to the log configuration\\. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [Secret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-secret.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecretOptions", "type": "array" } }, @@ -65928,12 +67391,12 @@ "additionalProperties": false, "properties": { "Expression": { - "markdownDescription": "A cluster query language expression to apply to the constraint\\. The expression can have a maximum length of 2000 characters\\. You can't specify an expression if the constraint type is `distinctInstance`\\. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A cluster query language expression to apply to the constraint\\. The expression can have a maximum length of 2000 characters\\. You can't specify an expression if the constraint type is `distinctInstance`\\. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Expression", "type": "string" }, "Type": { - "markdownDescription": "The type of constraint\\. Use `distinctInstance` to ensure that each task in a particular group is running on a different container instance\\. Use `memberOf` to restrict the selection to a group of valid candidates\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `distinctInstance | memberOf` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of constraint\\. Use `distinctInstance` to ensure that each task in a particular group is running on a different container instance\\. Use `memberOf` to restrict the selection to a group of valid candidates\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `distinctInstance | memberOf` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" } @@ -65947,12 +67410,12 @@ "additionalProperties": false, "properties": { "Field": { - "markdownDescription": "The field to apply the placement strategy against\\. For the `spread` placement strategy, valid values are `instanceId` \\(or `host`, which has the same effect\\), or any platform or custom attribute that's applied to a container instance, such as `attribute:ecs.availability-zone`\\. For the `binpack` placement strategy, valid values are `cpu` and `memory`\\. For the `random` placement strategy, this field is not used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The field to apply the placement strategy against\\. For the `spread` placement strategy, valid values are `instanceId` \\(or `host`, which has the same effect\\), or any platform or custom attribute that is applied to a container instance, such as `attribute:ecs.availability-zone`\\. For the `binpack` placement strategy, valid values are `CPU` and `MEMORY`\\. For the `random` placement strategy, this field is not used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Field", "type": "string" }, "Type": { - "markdownDescription": "The type of placement strategy\\. The `random` placement strategy randomly places tasks on available candidates\\. The `spread` placement strategy spreads placement across available candidates evenly based on the `field` parameter\\. The `binpack` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the `field` parameter\\. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `binpack | random | spread` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of placement strategy\\. The `random` placement strategy randomly places tasks on available candidates\\. The `spread` placement strategy spreads placement across available candidates evenly based on the `field` parameter\\. The `binpack` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the `field` parameter\\. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `binpack | random | spread` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" } @@ -65966,9 +67429,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the secret\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ValueFrom": { + "markdownDescription": "The secret to expose to the container\\. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store\\. \nFor information about the require AWS Identity and Access Management permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) \\(for Secrets Manager\\) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) \\(for Systems Manager Parameter store\\) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter\\. If the parameter exists in a different Region, then the full ARN must be specified\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ValueFrom", "type": "string" } }, @@ -65982,9 +67449,13 @@ "additionalProperties": false, "properties": { "DnsName": { + "markdownDescription": "The `dnsName` is the name that you use in the applications of client tasks to connect to this service\\. The name must be a valid DNS name but doesn't need to be fully\\-qualified\\. The name can include up to 127 characters\\. The name can include lowercase letters, numbers, underscores \\(\\_\\), hyphens \\(\\-\\), and periods \\(\\.\\)\\. The name can't start with a hyphen\\. \nIf this parameter isn't specified, the default value of `discoveryName.namespace` is used\\. If the `discoveryName` isn't specified, the port mapping name from the task definition is used in `portName.namespace`\\. \nTo avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default\\. For example, a few common names are `database`, `db`, or the lowercase name of a database, such as `mysql` or `redis`\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DnsName", "type": "string" }, "Port": { + "markdownDescription": "The listening port number for the Service Connect proxy\\. This port is available inside of all of the tasks within the same namespace\\. \nTo avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" } }, @@ -65997,18 +67468,26 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Specifies whether to use Service Connect with this service\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "LogConfiguration": { - "$ref": "#/definitions/AWS::ECS::Service.LogConfiguration" + "$ref": "#/definitions/AWS::ECS::Service.LogConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogConfiguration" }, "Namespace": { + "markdownDescription": "The namespace name or full Amazon Resource Name \\(ARN\\) of the AWS Cloud Map namespace for use with Service Connect\\. The namespace must be in the same AWS Region as the Amazon ECS service and cluster\\. The type of namespace doesn't affect Service Connect\\. For more information about AWS Cloud Map, see [Working with Services](https://docs.aws.amazon.com/) in the * AWS Cloud Map Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Namespace", "type": "string" }, "Services": { "items": { "$ref": "#/definitions/AWS::ECS::Service.ServiceConnectService" }, + "markdownDescription": "The list of Service Connect service objects\\. These are names and aliases \\(also known as endpoints\\) that are used by other Amazon ECS services to connect to this service\\. \nThis field is not required for a \"client\" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace\\. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means\\. \nAn object selects a port from the task definition, assigns a name for the AWS Cloud Map service, and a list of aliases \\(endpoints\\) and ports for client applications to refer to this service\\. \n*Required*: No \n*Type*: List of [ServiceConnectService](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectservice.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Services", "type": "array" } }, @@ -66024,15 +67503,23 @@ "items": { "$ref": "#/definitions/AWS::ECS::Service.ServiceConnectClientAlias" }, + "markdownDescription": "The list of client aliases for this Service Connect service\\. You use these to assign names that can be used by client applications\\. The maximum number of client aliases that you can have in this list is 1\\. \nEach alias \\(\"endpoint\"\\) is a fully\\-qualified name and port number that other Amazon ECS tasks \\(\"clients\"\\) can use to connect to this service\\. \nEach name and port mapping must be unique within the namespace\\. \nFor each `ServiceConnectService`, you must provide at least one `clientAlias` with one `port`\\. \n*Required*: No \n*Type*: List of [ServiceConnectClientAlias](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectclientalias.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientAliases", "type": "array" }, "DiscoveryName": { + "markdownDescription": "The `discoveryName` is the name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service\\. This must be unique within the AWS Cloud Map namespace\\. The name can contain up to 64 characters\\. The name can include lowercase letters, numbers, underscores \\(\\_\\), and hyphens \\(\\-\\)\\. The name can't start with a hyphen\\. \nIf this parameter isn't specified, the default value of `discoveryName.namespace` is used\\. If the `discoveryName` isn't specified, the port mapping name from the task definition is used in `portName.namespace`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DiscoveryName", "type": "string" }, "IngressPortOverride": { + "markdownDescription": "The port number for the Service Connect proxy to listen on\\. \nUse the value of this field to bypass the proxy for traffic on the port number specified in the named `portMapping` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service\\. \nIn `awsvpc` mode and Fargate, the default value is the container port number\\. The container port number is in the `portMapping` in the task definition\\. In bridge mode, the default value is the ephemeral port of the Service Connect proxy\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IngressPortOverride", "type": "number" }, "PortName": { + "markdownDescription": "The `portName` must match the name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PortName", "type": "string" } }, @@ -66106,12 +67593,12 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.ContainerDefinition" }, - "markdownDescription": "A list of container definitions in JSON format that describe the different containers that make up your task\\. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [ContainerDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of container definitions in JSON format that describe the different containers that make up your task\\. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [ContainerDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ContainerDefinitions", "type": "array" }, "Cpu": { - "markdownDescription": "The number of `cpu` units used by the task\\. If you use the EC2 launch type, this field is optional\\. Any value can be used\\. If you use the Fargate launch type, this field is required\\. You must use one of the following values\\. The value that you choose determines your range of valid values for the `memory` parameter\\. \nThe CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate\\. \n+ 256 \\(\\.25 vCPU\\) \\- Available `memory` values: 512 \\(0\\.5 GB\\), 1024 \\(1 GB\\), 2048 \\(2 GB\\)\n+ 512 \\(\\.5 vCPU\\) \\- Available `memory` values: 1024 \\(1 GB\\), 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\)\n+ 1024 \\(1 vCPU\\) \\- Available `memory` values: 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\), 5120 \\(5 GB\\), 6144 \\(6 GB\\), 7168 \\(7 GB\\), 8192 \\(8 GB\\)\n+ 2048 \\(2 vCPU\\) \\- Available `memory` values: Between 4096 \\(4 GB\\) and 16384 \\(16 GB\\) in increments of 1024 \\(1 GB\\)\n+ 4096 \\(4 vCPU\\) \\- Available `memory` values: Between 8192 \\(8 GB\\) and 30720 \\(30 GB\\) in increments of 1024 \\(1 GB\\)\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The number of `cpu` units used by the task\\. If you use the EC2 launch type, this field is optional\\. Any value can be used\\. If you use the Fargate launch type, this field is required\\. You must use one of the following values\\. The value that you choose determines your range of valid values for the `memory` parameter\\. \nThe CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate\\. \n+ 256 \\(\\.25 vCPU\\) \\- Available `memory` values: 512 \\(0\\.5 GB\\), 1024 \\(1 GB\\), 2048 \\(2 GB\\)\n+ 512 \\(\\.5 vCPU\\) \\- Available `memory` values: 1024 \\(1 GB\\), 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\)\n+ 1024 \\(1 vCPU\\) \\- Available `memory` values: 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\), 5120 \\(5 GB\\), 6144 \\(6 GB\\), 7168 \\(7 GB\\), 8192 \\(8 GB\\)\n+ 2048 \\(2 vCPU\\) \\- Available `memory` values: 4096 \\(4 GB\\) and 16384 \\(16 GB\\) in increments of 1024 \\(1 GB\\)\n+ 4096 \\(4 vCPU\\) \\- Available `memory` values: 8192 \\(8 GB\\) and 30720 \\(30 GB\\) in increments of 1024 \\(1 GB\\)\n+ 8192 \\(8 vCPU\\) \\- Available `memory` values: 16 GB and 60 GB in 4 GB increments", "title": "Cpu", "type": "string" }, @@ -66144,12 +67631,12 @@ "type": "string" }, "Memory": { - "markdownDescription": "The amount \\(in MiB\\) of memory used by the task\\. \nIf your tasks runs on Amazon EC2 instances, you must specify either a task\\-level memory value or a container\\-level memory value\\. This field is optional and any value can be used\\. If a task\\-level memory value is specified, the container\\-level memory value is optional\\. For more information regarding container\\-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html)\\. \nIf your tasks runs on AWS Fargate, this field is required\\. You must use one of the following values\\. The value you choose determines your range of valid values for the `cpu` parameter\\. \n+ 512 \\(0\\.5 GB\\), 1024 \\(1 GB\\), 2048 \\(2 GB\\) \\- Available `cpu` values: 256 \\(\\.25 vCPU\\)\n+ 1024 \\(1 GB\\), 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\) \\- Available `cpu` values: 512 \\(\\.5 vCPU\\)\n+ 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\), 5120 \\(5 GB\\), 6144 \\(6 GB\\), 7168 \\(7 GB\\), 8192 \\(8 GB\\) \\- Available `cpu` values: 1024 \\(1 vCPU\\)\n+ Between 4096 \\(4 GB\\) and 16384 \\(16 GB\\) in increments of 1024 \\(1 GB\\) \\- Available `cpu` values: 2048 \\(2 vCPU\\)\n+ Between 8192 \\(8 GB\\) and 30720 \\(30 GB\\) in increments of 1024 \\(1 GB\\) \\- Available `cpu` values: 4096 \\(4 vCPU\\)\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The amount \\(in MiB\\) of memory used by the task\\. \nIf your tasks runs on Amazon EC2 instances, you must specify either a task\\-level memory value or a container\\-level memory value\\. This field is optional and any value can be used\\. If a task\\-level memory value is specified, the container\\-level memory value is optional\\. For more information regarding container\\-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html)\\. \nIf your tasks runs on AWS Fargate, this field is required\\. You must use one of the following values\\. The value you choose determines your range of valid values for the `cpu` parameter\\. \n+ 512 \\(0\\.5 GB\\), 1024 \\(1 GB\\), 2048 \\(2 GB\\) \\- Available `cpu` values: 256 \\(\\.25 vCPU\\)\n+ 1024 \\(1 GB\\), 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\) \\- Available `cpu` values: 512 \\(\\.5 vCPU\\)\n+ 2048 \\(2 GB\\), 3072 \\(3 GB\\), 4096 \\(4 GB\\), 5120 \\(5 GB\\), 6144 \\(6 GB\\), 7168 \\(7 GB\\), 8192 \\(8 GB\\) \\- Available `cpu` values: 1024 \\(1 vCPU\\)\n+ Between 4096 \\(4 GB\\) and 16384 \\(16 GB\\) in increments of 1024 \\(1 GB\\) \\- Available `cpu` values: 2048 \\(2 vCPU\\)\n+ Between 8192 \\(8 GB\\) and 30720 \\(30 GB\\) in increments of 1024 \\(1 GB\\) \\- Available `cpu` values: 4096 \\(4 vCPU\\)\n+ Between 16 GB and 60 GB in 4 GB increments \\- Available `cpu` values: 8192 \\(8 vCPU\\)", "title": "Memory", "type": "string" }, "NetworkMode": { - "markdownDescription": "The Docker networking mode to use for the containers in the task\\. The valid values are `none`, `bridge`, `awsvpc`, and `host`\\. The default Docker network mode is `bridge`\\. If you are using the Fargate launch type, the `awsvpc` network mode is required\\. If you are using the EC2 launch type, any network mode can be used\\. If the network mode is set to `none`, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity\\. The `host` and `awsvpc` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the `bridge` mode\\. \nWith the `host` and `awsvpc` network modes, exposed container ports are mapped directly to the corresponding host port \\(for the `host` network mode\\) or the attached elastic network interface port \\(for the `awsvpc` network mode\\), so you cannot take advantage of dynamic host port mappings\\. \nIf the network mode is `awsvpc`, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html) value when you create a service or run a task with the task definition\\. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nCurrently, only Amazon ECS\\-optimized AMIs, other Amazon Linux variants with the `ecs-init` package, or AWS Fargate infrastructure support the `awsvpc` network mode\\. \nIf the network mode is `host`, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used\\. \nDocker for Windows uses different network modes than Docker for Linux\\. When you register a task definition with Windows containers, you must not specify a network mode\\. If you use the console to register a task definition with Windows containers, you must choose the `` network mode object\\. \nFor more information, see [Network settings](https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `awsvpc | bridge | host | none` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Docker networking mode to use for the containers in the task\\. The valid values are `none`, `bridge`, `awsvpc`, and `host`\\. If no network mode is specified, the default is `bridge`\\. \nFor Amazon ECS tasks on Fargate, the `awsvpc` network mode is required\\. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used\\. For Amazon ECS tasks on Amazon EC2 Windows instances, `` or `awsvpc` can be used\\. If the network mode is set to `none`, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity\\. The `host` and `awsvpc` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the `bridge` mode\\. \nWith the `host` and `awsvpc` network modes, exposed container ports are mapped directly to the corresponding host port \\(for the `host` network mode\\) or the attached elastic network interface port \\(for the `awsvpc` network mode\\), so you cannot take advantage of dynamic host port mappings\\. \nWhen using the `host` network mode, you should not run containers using the root user \\(UID 0\\)\\. It is considered best practice to use a non\\-root user\\.\nIf the network mode is `awsvpc`, the task is allocated an elastic network interface, and you must specify a [NetworkConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-networkconfiguration) value when you create a service or run a task with the task definition\\. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf the network mode is `host`, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used\\. \nFor more information, see [Network settings](https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `awsvpc | bridge | host | none` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "NetworkMode", "type": "string" }, @@ -66168,14 +67655,14 @@ }, "ProxyConfiguration": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.ProxyConfiguration", - "markdownDescription": "The `ProxyConfiguration` property specifies the configuration details for the App Mesh proxy\\. \nYour Amazon ECS container instances require at least version 1\\.26\\.0 of the container agent and at least version 1\\.26\\.0\\-1 of the `ecs-init` package to enable a proxy configuration\\. If your container instances are launched from the Amazon ECS\\-optimized AMI version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [ProxyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The configuration details for the App Mesh proxy\\. \nYour Amazon ECS container instances require at least version 1\\.26\\.0 of the container agent and at least version 1\\.26\\.0\\-1 of the `ecs-init` package to use a proxy configuration\\. If your container instances are launched from the Amazon ECS optimized AMI version `20190301` or later, they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: [ProxyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-proxyconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ProxyConfiguration" }, "RequiresCompatibilities": { "items": { "type": "string" }, - "markdownDescription": "The task launch types the task definition was validated against\\. To determine which task launch types the task definition is validated for, see the `TaskDefinition$compatibilities` parameter\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The task launch types the task definition was validated against\\. To determine which task launch types the task definition is validated for, see the `TaskDefinition$compatibilities` parameter\\. \nThe valid values are: \n+ `EC2` \\- The EC2 launch type\n+ `FARGATE` \\- The Fargate launch type\n+ `EXTERNAL` \\- The external instance \\(ECS Anywhere\\) launch type\n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RequiresCompatibilities", "type": "array" }, @@ -66201,7 +67688,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.Volume" }, - "markdownDescription": "The list of data volume definitions for the task\\. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nThe `host` and `sourcePath` parameters aren't supported for tasks run on AWS Fargate\\.\n*Required*: No \n*Type*: List of [Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The list of data volume definitions for the task\\. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nThe `host` and `sourcePath` parameters aren't supported for tasks run on AWS Fargate\\. \n*Required*: No \n*Type*: List of [Volume](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volume.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Volumes", "type": "array" } @@ -66232,12 +67719,12 @@ "additionalProperties": false, "properties": { "AccessPointId": { - "markdownDescription": "The Amazon EFS access point ID to use\\. If an access point is specified, the root directory value specified in the `EFSVolumeConfiguration` must either be omitted or set to `/` which will enforce the path set on the EFS access point\\. If an access point is used, transit encryption must be enabled in the `EFSVolumeConfiguration`\\. For more information, see [Working with Amazon EFS Access Points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon EFS access point ID to use\\. If an access point is specified, the root directory value specified in the `EFSVolumeConfiguration` must either be omitted or set to `/` which will enforce the path set on the EFS access point\\. If an access point is used, transit encryption must be enabled in the `EFSVolumeConfiguration`\\. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AccessPointId", "type": "string" }, "IAM": { - "markdownDescription": "Determines whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system\\. If enabled, transit encryption must be enabled in the `EFSVolumeConfiguration`\\. If this parameter is omitted, the default value of `DISABLED` is used\\. For more information, see [Using Amazon EFS Access Points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system\\. If enabled, transit encryption must be enabled in the `EFSVolumeConfiguration`\\. If this parameter is omitted, the default value of `DISABLED` is used\\. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IAM", "type": "string" } @@ -66264,12 +67751,12 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.ContainerDependency" }, - "markdownDescription": "The dependencies defined for container startup and shutdown\\. A container can contain multiple dependencies\\. When a dependency is defined for container startup, for container shutdown it is reversed\\. \nFor tasks using the EC2 launch type, the container instances require at least version 1\\.26\\.0 of the container agent to turn on container dependencies\\. However, we recommend using the latest container agent version\\. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*\\. If you're using an Amazon ECS\\-optimized Linux AMI, your instance needs at least version 1\\.26\\.0\\-1 of the `ecs-init` package\\. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor tasks using the Fargate launch type, the task or service requires the following platforms: \n+ Linux platform version `1.3.0` or later\\.\n+ Windows platform version `1.0.0` or later\\.\n*Required*: No \n*Type*: List of [ContainerDependency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The dependencies defined for container startup and shutdown\\. A container can contain multiple dependencies\\. When a dependency is defined for container startup, for container shutdown it is reversed\\. \nFor tasks using the EC2 launch type, the container instances require at least version 1\\.26\\.0 of the container agent to turn on container dependencies\\. However, we recommend using the latest container agent version\\. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*\\. If you're using an Amazon ECS\\-optimized Linux AMI, your instance needs at least version 1\\.26\\.0\\-1 of the `ecs-init` package\\. If your container instances are launched from version `20190301` or later, then they contain the required versions of the container agent and `ecs-init`\\. For more information, see [Amazon ECS\\-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor tasks using the Fargate launch type, the task or service requires the following platforms: \n+ Linux platform version `1.3.0` or later\\.\n+ Windows platform version `1.0.0` or later\\.\nIf the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the `dependsOn` parameter is not supported\\. For more information see [Issue \\#680](https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website\\. \n*Required*: No \n*Type*: List of [ContainerDependency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdependency.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DependsOn", "type": "array" }, "DisableNetworking": { - "markdownDescription": "When this parameter is true, networking is disabled within the container\\. This parameter maps to `NetworkDisabled` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/)\\. \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "When this parameter is true, networking is off within the container\\. This parameter maps to `NetworkDisabled` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/)\\. \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DisableNetworking", "type": "boolean" }, @@ -66320,7 +67807,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.KeyValuePair" }, - "markdownDescription": "The environment variables to pass to a container\\. This parameter maps to `Env` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--env` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWe don't recommend that you use plaintext environment variables for sensitive information, such as credential data\\.\n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The environment variables to pass to a container\\. This parameter maps to `Env` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--env` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWe don't recommend that you use plaintext environment variables for sensitive information, such as credential data\\.\n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-keyvaluepair.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Environment", "type": "array" }, @@ -66341,7 +67828,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.HostEntry" }, - "markdownDescription": "A list of hostnames and IP address mappings to append to the `/etc/hosts` file on the container\\. This parameter maps to `ExtraHosts` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--add-host` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThis parameter isn't supported for Windows containers or tasks that use the `awsvpc` network mode\\.\n*Required*: No \n*Type*: List of [HostEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-hostentry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of hostnames and IP address mappings to append to the `/etc/hosts` file on the container\\. This parameter maps to `ExtraHosts` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--add-host` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nThis parameter isn't supported for Windows containers or tasks that use the `awsvpc` network mode\\.\n*Required*: No \n*Type*: List of [HostEntry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-hostentry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ExtraHosts", "type": "array" }, @@ -66361,7 +67848,7 @@ "type": "string" }, "Image": { - "markdownDescription": "The image used to start a container\\. This string is passed directly to the Docker daemon\\. By default, images in the Docker Hub registry are available\\. Other repositories are specified with either ` repository-url/image:tag ` or ` repository-url/image@digest `\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed\\. This parameter maps to `Image` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `IMAGE` parameter of [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n+ When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use\\. However, subsequent updates to a repository image aren't propagated to already running tasks\\.\n+ Images in Amazon ECR repositories can be specified by either using the full `registry/repository:tag` or `registry/repository@digest`\\. For example, `012345678910.dkr.ecr..amazonaws.com/:latest` or `012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE`\\. \n+ Images in official repositories on Docker Hub use a single name \\(for example, `ubuntu` or `mongo`\\)\\.\n+ Images in other repositories on Docker Hub are qualified with an organization name \\(for example, `amazon/amazon-ecs-agent`\\)\\.\n+ Images in other online repositories are qualified further by a domain name \\(for example, `quay.io/assemblyline/ubuntu`\\)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The image used to start a container\\. This string is passed directly to the Docker daemon\\. By default, images in the Docker Hub registry are available\\. Other repositories are specified with either ` repository-url/image:tag ` or ` repository-url/image@digest `\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed\\. This parameter maps to `Image` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `IMAGE` parameter of [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n+ When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use\\. However, subsequent updates to a repository image aren't propagated to already running tasks\\.\n+ Images in Amazon ECR repositories can be specified by either using the full `registry/repository:tag` or `registry/repository@digest`\\. For example, `012345678910.dkr.ecr..amazonaws.com/:latest` or `012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE`\\. \n+ Images in official repositories on Docker Hub use a single name \\(for example, `ubuntu` or `mongo`\\)\\.\n+ Images in other repositories on Docker Hub are qualified with an organization name \\(for example, `amazon/amazon-ecs-agent`\\)\\.\n+ Images in other online repositories are qualified further by a domain name \\(for example, `quay.io/assemblyline/ubuntu`\\)\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Image", "type": "string" }, @@ -66385,7 +67872,7 @@ }, "LogConfiguration": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.LogConfiguration", - "markdownDescription": "The log configuration specification for the container\\. \nThis parameter maps to `LogConfig` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--log-driver` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. By default, containers use the same logging driver that the Docker daemon uses\\. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition\\. To use a different logging driver for a container, the log system must be configured properly on the container instance \\(or on a different log server for remote logging options\\)\\. For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation\\. \nAmazon ECS currently supports a subset of the logging drivers available to the Docker daemon \\(shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type\\)\\. Additional log drivers may be available in future releases of the Amazon ECS container agent\\.\nThis parameter requires version 1\\.18 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \nThe Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options\\. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*\\.\n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-logconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The log configuration specification for the container\\. \nThis parameter maps to `LogConfig` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--log-driver` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. By default, containers use the same logging driver that the Docker daemon uses\\. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition\\. To use a different logging driver for a container, the log system must be configured properly on the container instance \\(or on a different log server for remote logging options\\)\\. For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation\\. \nAmazon ECS currently supports a subset of the logging drivers available to the Docker daemon \\(shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type\\)\\. Additional log drivers may be available in future releases of the Amazon ECS container agent\\.\nThis parameter requires version 1\\.18 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \nThe Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the `ECS_AVAILABLE_LOGGING_DRIVERS` environment variable before containers placed on that instance can use these log configuration options\\. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*\\.\n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-logconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "LogConfiguration" }, "Memory": { @@ -66394,7 +67881,7 @@ "type": "number" }, "MemoryReservation": { - "markdownDescription": "The soft limit \\(in MiB\\) of memory to reserve for the container\\. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit\\. However, your container can consume more memory when it needs to, up to either the hard limit specified with the `memory` parameter \\(if applicable\\), or all of the available memory on the container instance, whichever comes first\\. This parameter maps to `MemoryReservation` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--memory-reservation` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nIf a task\\-level memory value is not specified, you must specify a non\\-zero integer for one or both of `memory` or `memoryReservation` in a container definition\\. If you specify both, `memory` must be greater than `memoryReservation`\\. If you specify `memoryReservation`, then that value is subtracted from the available memory resources for the container instance where the container is placed\\. Otherwise, the value of `memory` is used\\. \nFor example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a `memoryReservation` of 128 MiB, and a `memory` hard limit of 300 MiB\\. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed\\. \nThe Docker daemon reserves a minimum of 4 MiB of memory for a container\\. Therefore, we recommend that you specify fewer than 4 MiB of memory for your containers\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The soft limit \\(in MiB\\) of memory to reserve for the container\\. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit\\. However, your container can consume more memory when it needs to, up to either the hard limit specified with the `memory` parameter \\(if applicable\\), or all of the available memory on the container instance, whichever comes first\\. This parameter maps to `MemoryReservation` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--memory-reservation` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nIf a task\\-level memory value is not specified, you must specify a non\\-zero integer for one or both of `memory` or `memoryReservation` in a container definition\\. If you specify both, `memory` must be greater than `memoryReservation`\\. If you specify `memoryReservation`, then that value is subtracted from the available memory resources for the container instance where the container is placed\\. Otherwise, the value of `memory` is used\\. \nFor example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a `memoryReservation` of 128 MiB, and a `memory` hard limit of 300 MiB\\. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed\\. \nThe Docker 20\\.10\\.0 or later daemon reserves a minimum of 6 MiB of memory for a container\\. So, don't specify less than 6 MiB of memory for your containers\\. \nThe Docker 19\\.03\\.13\\-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container\\. So, don't specify less than 4 MiB of memory for your containers\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MemoryReservation", "type": "number" }, @@ -66402,12 +67889,12 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.MountPoint" }, - "markdownDescription": "The mount points for data volumes in your container\\. \nThis parameter maps to `Volumes` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--volume` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWindows containers can mount whole directories on the same drive as `$env:ProgramData`\\. Windows containers can't mount directories on a different drive, and mount point can't be across drives\\. \n*Required*: No \n*Type*: List of [MountPoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-mountpoints.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The mount points for data volumes in your container\\. \nThis parameter maps to `Volumes` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--volume` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \nWindows containers can mount whole directories on the same drive as `$env:ProgramData`\\. Windows containers can't mount directories on a different drive, and mount point can't be across drives\\. \n*Required*: No \n*Type*: List of [MountPoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-mountpoint.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MountPoints", "type": "array" }, "Name": { - "markdownDescription": "The name of a container\\. If you're linking multiple containers together in a task definition, the `name` of one container can be entered in the `links` of another container to connect the containers\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, underscores, and hyphens are allowed\\. This parameter maps to `name` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--name` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of a container\\. If you're linking multiple containers together in a task definition, the `name` of one container can be entered in the `links` of another container to connect the containers\\. Up to 255 letters \\(uppercase and lowercase\\), numbers, underscores, and hyphens are allowed\\. This parameter maps to `name` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--name` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -66415,7 +67902,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.PortMapping" }, - "markdownDescription": "The list of port mappings for the container\\. Port mappings allow containers to access ports on the host container instance to send or receive traffic\\. \nFor task definitions that use the `awsvpc` network mode, you should only specify the `containerPort`\\. The `hostPort` can be left blank or it must be the same value as the `containerPort`\\. \nPort mappings on Windows use the `NetNAT` gateway address rather than `localhost`\\. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself\\. \nThis parameter maps to `PortBindings` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--publish` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. If the network mode of a task definition is set to `none`, then you can't specify port mappings\\. If the network mode of a task definition is set to `host`, then host ports must either be undefined or they must match the container port in the port mapping\\. \nAfter a task reaches the `RUNNING` status, manual and automatic host and container port assignments are visible in the **Network Bindings** section of a container description for a selected task in the Amazon ECS console\\. The assignments are also visible in the `networkBindings` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses\\.\n*Required*: No \n*Type*: List of [PortMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-portmappings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The list of port mappings for the container\\. Port mappings allow containers to access ports on the host container instance to send or receive traffic\\. \nFor task definitions that use the `awsvpc` network mode, you should only specify the `containerPort`\\. The `hostPort` can be left blank or it must be the same value as the `containerPort`\\. \nPort mappings on Windows use the `NetNAT` gateway address rather than `localhost`\\. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself\\. \nThis parameter maps to `PortBindings` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--publish` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. If the network mode of a task definition is set to `none`, then you can't specify port mappings\\. If the network mode of a task definition is set to `host`, then host ports must either be undefined or they must match the container port in the port mapping\\. \nAfter a task reaches the `RUNNING` status, manual and automatic host and container port assignments are visible in the **Network Bindings** section of a container description for a selected task in the Amazon ECS console\\. The assignments are also visible in the `networkBindings` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses\\.\n*Required*: No \n*Type*: List of [PortMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-portmapping.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PortMappings", "type": "array" }, @@ -66477,7 +67964,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.Ulimit" }, - "markdownDescription": "A list of `ulimits` to set in the container\\. This parameter maps to `Ulimits` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--ulimit` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type\\. This parameter requires version 1\\.18 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: List of [Ulimit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-ulimit.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of `ulimits` to set in the container\\. This parameter maps to `Ulimits` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--ulimit` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type\\. This parameter requires version 1\\.18 of the Docker Remote API or greater on your container instance\\. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: `sudo docker version --format '{{.Server.APIVersion}}'` \nThis parameter is not supported for Windows containers\\.\n*Required*: No \n*Type*: List of [Ulimit](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-ulimit.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Ulimits", "type": "array" }, @@ -66490,7 +67977,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.VolumeFrom" }, - "markdownDescription": "Data volumes to mount from another container\\. This parameter maps to `VolumesFrom` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--volumes-from` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: No \n*Type*: List of [VolumeFrom](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-volumesfrom.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Data volumes to mount from another container\\. This parameter maps to `VolumesFrom` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/) and the `--volumes-from` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)\\. \n*Required*: No \n*Type*: List of [VolumeFrom](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumefrom.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VolumesFrom", "type": "array" }, @@ -66608,12 +68095,12 @@ "type": "string" }, "TransitEncryption": { - "markdownDescription": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server\\. Transit encryption must be enabled if Amazon EFS IAM authorization is used\\. If this parameter is omitted, the default value of `DISABLED` is used\\. For more information, see [Encrypting Data in Transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server\\. Transit encryption must be enabled if Amazon EFS IAM authorization is used\\. If this parameter is omitted, the default value of `DISABLED` is used\\. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TransitEncryption", "type": "string" }, "TransitEncryptionPort": { - "markdownDescription": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server\\. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses\\. For more information, see [EFS Mount Helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server\\. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses\\. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TransitEncryptionPort", "type": "number" } @@ -66679,7 +68166,7 @@ "items": { "type": "string" }, - "markdownDescription": "A string array representing the command that the container runs to determine if it is healthy\\. The string array must start with `CMD` to execute the command arguments directly, or `CMD-SHELL` to run the command with the container's default shell\\. \n When you use the AWS Management Console JSON panel, the AWS Command Line Interface, or the APIs, enclose the list of commands in brackets\\. \n `[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]` \nYou don't need to include the brackets when you use the AWS Management Console\\. \n ` \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ` \nAn exit code of 0 indicates success, and non\\-zero exit code indicates failure\\. For more information, see `HealthCheck` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A string array representing the command that the container runs to determine if it is healthy\\. The string array must start with `CMD` to run the command arguments directly, or `CMD-SHELL` to run the command with the container's default shell\\. \n When you use the AWS Management Console JSON panel, the AWS Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets\\. \n `[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]` \nYou don't include the double quotes and brackets when you use the AWS Management Console\\. \n ` CMD-SHELL, curl -f http://localhost/ || exit 1` \nAn exit code of 0 indicates success, and non\\-zero exit code indicates failure\\. For more information, see `HealthCheck` in the [Create a container](https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.35/)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Command", "type": "array" }, @@ -66694,7 +68181,7 @@ "type": "number" }, "StartPeriod": { - "markdownDescription": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries\\. You can specify between 0 and 300 seconds\\. By default, the `startPeriod` is disabled\\. \nIf a health check succeeds within the `startPeriod`, then the container is considered healthy and any subsequent failures count toward the maximum number of retries\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries\\. You can specify between 0 and 300 seconds\\. By default, the `startPeriod` is off\\. \nIf a health check succeeds within the `startPeriod`, then the container is considered healthy and any subsequent failures count toward the maximum number of retries\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StartPeriod", "type": "number" }, @@ -66857,7 +68344,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.Secret" }, - "markdownDescription": "The secrets to pass to the log configuration\\. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [Secret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The secrets to pass to the log configuration\\. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: List of [Secret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-secret.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SecretOptions", "type": "array" } @@ -66892,6 +68379,8 @@ "additionalProperties": false, "properties": { "AppProtocol": { + "markdownDescription": "The application protocol that's used for the port mapping\\. This parameter only applies to Service Connect\\. We recommend that you set this parameter to be consistent with the protocol that your application uses\\. If you set this parameter, Amazon ECS adds protocol\\-specific connection handling to the Service Connect proxy\\. If you set this parameter, Amazon ECS adds protocol\\-specific telemetry in the Amazon ECS console and CloudWatch\\. \nIf you don't set a value for this parameter, then TCP is used\\. However, Amazon ECS doesn't add protocol\\-specific telemetry for TCP\\. \nTasks that run in a namespace can use short names to connect to services in the namespace\\. Tasks can connect to services across all of the clusters in the namespace\\. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility\\. Only the tasks that Amazon ECS services create are supported with Service Connect\\. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `grpc | http | http2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AppProtocol", "type": "string" }, "ContainerPort": { @@ -66900,6 +68389,8 @@ "type": "number" }, "ContainerPortRange": { + "markdownDescription": "The port number range on the container that's bound to the dynamically mapped host port range\\. \nThe following rules apply when you specify a `containerPortRange`: \n+ You must use either the `bridge` network mode or the `awsvpc` network mode\\.\n+ This parameter is available for both the EC2 and AWS Fargate launch types\\.\n+ This parameter is available for both the Linux and Windows operating systems\\.\n+ The container instance must have at least version 1\\.67\\.0 of the container agent and at least version 1\\.67\\.0\\-1 of the `ecs-init` package \n+ You can specify a maximum of 100 port ranges per container\\.\n+ You do not specify a `hostPortRange`\\. The value of the `hostPortRange` is set as follows:\n + For containers in a task with the `awsvpc` network mode, the `hostPort` is set to the same value as the `containerPort`\\. This is a static mapping strategy\\.\n + For containers in a task with the `bridge` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports\\.\n+ The `containerPortRange` valid values are between 1 and 65535\\.\n+ A port can only be included in one port mapping per container\\.\n+ You cannot specify overlapping port ranges\\.\n+ The first port in the range must be less than last port in the range\\.\n+ Docker recommends that you turn off the docker\\-proxy in the Docker daemon config file when you have a large number of ports\\.", + "title": "ContainerPortRange", "type": "string" }, "HostPort": { @@ -66908,6 +68399,8 @@ "type": "number" }, "Name": { + "markdownDescription": "The name that's used for the port mapping\\. This parameter only applies to Service Connect\\. This parameter is the name that you use in the `serviceConnectConfiguration` of a service\\. The name can include up to 64 characters\\. The characters can include lowercase letters, numbers, underscores \\(\\_\\), and hyphens \\(\\-\\)\\. The name can't start with a hyphen\\. \nFor more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Protocol": { @@ -66930,7 +68423,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.KeyValuePair" }, - "markdownDescription": "The set of network configuration parameters to provide the Container Network Interface \\(CNI\\) plugin, specified as key\\-value pairs\\. \n+ `IgnoredUID` \\- \\(Required\\) The user ID \\(UID\\) of the proxy container as defined by the `user` parameter in a container definition\\. This is used to ensure the proxy ignores its own traffic\\. If `IgnoredGID` is specified, this field can be empty\\.\n+ `IgnoredGID` \\- \\(Required\\) The group ID \\(GID\\) of the proxy container as defined by the `user` parameter in a container definition\\. This is used to ensure the proxy ignores its own traffic\\. If `IgnoredUID` is specified, this field can be empty\\.\n+ `AppPorts` \\- \\(Required\\) The list of ports that the application uses\\. Network traffic to these ports is forwarded to the `ProxyIngressPort` and `ProxyEgressPort`\\.\n+ `ProxyIngressPort` \\- \\(Required\\) Specifies the port that incoming traffic to the `AppPorts` is directed to\\.\n+ `ProxyEgressPort` \\- \\(Required\\) Specifies the port that outgoing traffic from the `AppPorts` is directed to\\.\n+ `EgressIgnoredPorts` \\- \\(Required\\) The egress traffic going to the specified ports is ignored and not redirected to the `ProxyEgressPort`\\. It can be an empty list\\.\n+ `EgressIgnoredIPs` \\- \\(Required\\) The egress traffic going to the specified IP addresses is ignored and not redirected to the `ProxyEgressPort`\\. It can be an empty list\\.\n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinitions-environment.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The set of network configuration parameters to provide the Container Network Interface \\(CNI\\) plugin, specified as key\\-value pairs\\. \n+ `IgnoredUID` \\- \\(Required\\) The user ID \\(UID\\) of the proxy container as defined by the `user` parameter in a container definition\\. This is used to ensure the proxy ignores its own traffic\\. If `IgnoredGID` is specified, this field can be empty\\.\n+ `IgnoredGID` \\- \\(Required\\) The group ID \\(GID\\) of the proxy container as defined by the `user` parameter in a container definition\\. This is used to ensure the proxy ignores its own traffic\\. If `IgnoredUID` is specified, this field can be empty\\.\n+ `AppPorts` \\- \\(Required\\) The list of ports that the application uses\\. Network traffic to these ports is forwarded to the `ProxyIngressPort` and `ProxyEgressPort`\\.\n+ `ProxyIngressPort` \\- \\(Required\\) Specifies the port that incoming traffic to the `AppPorts` is directed to\\.\n+ `ProxyEgressPort` \\- \\(Required\\) Specifies the port that outgoing traffic from the `AppPorts` is directed to\\.\n+ `EgressIgnoredPorts` \\- \\(Required\\) The egress traffic going to the specified ports is ignored and not redirected to the `ProxyEgressPort`\\. It can be an empty list\\.\n+ `EgressIgnoredIPs` \\- \\(Required\\) The egress traffic going to the specified IP addresses is ignored and not redirected to the `ProxyEgressPort`\\. It can be an empty list\\.\n*Required*: No \n*Type*: List of [KeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-keyvaluepair.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ProxyConfigurationProperties", "type": "array" }, @@ -66980,7 +68473,7 @@ "additionalProperties": false, "properties": { "CpuArchitecture": { - "markdownDescription": "The CPU architecture\\. \nYou can run your Linux tasks on an ARM\\-based platform by setting the value to `ARM64`\\. This option is avaiable for tasks that run on Linuc Amazon EC2 instance or Linux containers on Fargate\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ARM64 | X86_64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The CPU architecture\\. \nYou can run your Linux tasks on an ARM\\-based platform by setting the value to `ARM64`\\. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ARM64 | X86_64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CpuArchitecture", "type": "string" }, @@ -67078,7 +68571,7 @@ "additionalProperties": false, "properties": { "HardLimit": { - "markdownDescription": "The hard limit for the ulimit type\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The hard limit for the `ulimit` type\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "HardLimit", "type": "number" }, @@ -67088,7 +68581,7 @@ "type": "string" }, "SoftLimit": { - "markdownDescription": "The soft limit for the ulimit type\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The soft limit for the `ulimit` type\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SoftLimit", "type": "number" } @@ -67115,7 +68608,7 @@ }, "Host": { "$ref": "#/definitions/AWS::ECS::TaskDefinition.HostVolumeProperties", - "markdownDescription": "This parameter is specified when you use bind mount host volumes\\. The contents of the `host` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored\\. If the `host` parameter is empty, then the Docker daemon assigns a host path for your data volume\\. However, the data isn't guaranteed to persist after the containers that are associated with it stop running\\. \nWindows containers can mount whole directories on the same drive as `$env:ProgramData`\\. Windows containers can't mount directories on a different drive, and mount point can't be across drives\\. For example, you can mount `C:\\my\\path:C:\\my\\path` and `D:\\:D:\\`, but not `D:\\my\\path:C:\\my\\path` or `D:\\:C:\\my\\path`\\. \n*Required*: No \n*Type*: [HostVolumeProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-volumes-host.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "This parameter is specified when you use bind mount host volumes\\. The contents of the `host` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored\\. If the `host` parameter is empty, then the Docker daemon assigns a host path for your data volume\\. However, the data isn't guaranteed to persist after the containers that are associated with it stop running\\. \nWindows containers can mount whole directories on the same drive as `$env:ProgramData`\\. Windows containers can't mount directories on a different drive, and mount point can't be across drives\\. For example, you can mount `C:\\my\\path:C:\\my\\path` and `D:\\:D:\\`, but not `D:\\my\\path:C:\\my\\path` or `D:\\:C:\\my\\path`\\. \n*Required*: No \n*Type*: [HostVolumeProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-hostvolumeproperties.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Host" }, "Name": { @@ -67188,7 +68681,7 @@ "type": "string" }, "LaunchType": { - "markdownDescription": "The launch type that new tasks in the task set uses\\. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf a `launchType` is specified, the `capacityProviderStrategy` parameter must be omitted\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EC2 | EXTERNAL | FARGATE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The launch type that new tasks in the task set uses\\. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf a `launchType` is specified, the `capacityProviderStrategy` parameter must be omitted\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EC2 | EXTERNAL | FARGATE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "LaunchType", "type": "string" }, @@ -67224,7 +68717,7 @@ "items": { "$ref": "#/definitions/AWS::ECS::TaskSet.ServiceRegistry" }, - "markdownDescription": "The details of the service discovery registries to assign to this task set\\. For more information, see [Service Discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html)\\. \n*Required*: No \n*Type*: List of [ServiceRegistry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The details of the service discovery registries to assign to this task set\\. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html)\\. \n*Required*: No \n*Type*: List of [ServiceRegistry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskset-serviceregistry.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ServiceRegistries", "type": "array" }, @@ -67311,7 +68804,7 @@ "type": "string" }, "TargetGroupArn": { - "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the Elastic Load Balancing target group or groups associated with a service or task set\\. \nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer\\. If you're using a Classic Load Balancer, omit the target group ARN\\. \nFor services using the `ECS` deployment controller, you can specify one or multiple target groups\\. For more information, see [Registering Multiple Target Groups with a Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer\\. For more information, see [Blue/Green Deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance`\\. Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance\\. This network mode is required for the Fargate launch type\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The full Amazon Resource Name \\(ARN\\) of the Elastic Load Balancing target group or groups associated with a service or task set\\. \nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer\\. If you're using a Classic Load Balancer, omit the target group ARN\\. \nFor services using the `ECS` deployment controller, you can specify one or multiple target groups\\. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nFor services using the `CODE_DEPLOY` deployment controller, you're required to define two target groups for the load balancer\\. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*\\. \nIf your service's task definition uses the `awsvpc` network mode, you must choose `ip` as the target type, not `instance`\\. Do this when creating your target groups because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance\\. This network mode is required for the Fargate launch type\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TargetGroupArn", "type": "string" } @@ -67593,7 +69086,7 @@ "title": "BackupPolicy" }, "BypassPolicyLockoutSafetyCheck": { - "markdownDescription": "\\(Optional\\) Use this boolean to use or bypass the `FileSystemPolicy` lockout safety check\\. The policy lockout safety check determines if the `FileSystemPolicy` in the request will lock out the IAM principal making the request, preventing them from making future `PutFileSystemPolicy` requests on the file system\\. Set `BypassPolicyLockoutSafetyCheck` to `True` only when you intend to prevent the IAM principal that is making the request from making a subsequent `PutFileSystemPolicy` request on the file system\\. The default value is `False`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "\\(Optional\\) A boolean that specifies whether or not to bypass the `FileSystemPolicy` lockout safety check\\. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future `PutFileSystemPolicy` requests on this file system\\. Set `BypassPolicyLockoutSafetyCheck` to `True` only when you intend to prevent the IAM principal that is making the request from making subsequent `PutFileSystemPolicy` requests on this file system\\. The default value is `False`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BypassPolicyLockoutSafetyCheck", "type": "boolean" }, @@ -67624,7 +69117,7 @@ "items": { "$ref": "#/definitions/AWS::EFS::FileSystem.LifecyclePolicy" }, - "markdownDescription": "A list of one LifecyclePolicy that tells EFS lifecycle management when to transition files to the Infrequent Access \\(IA\\) storage classes\\. \n*Required*: No \n*Type*: List of [LifecyclePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of `LifecyclePolicy` objects that define the file system's `LifecycleConfiguration` object\\. A `LifecycleConfiguration` object informs EFS lifecycle management and intelligent tiering of the following: \n+ When to move files in the file system from primary storage to the IA storage class\\.\n+ When to move files that are in IA storage to primary storage\\.\nAmazon EFS requires that each `LifecyclePolicy` object have only a single transition\\. This means that in a request body, `LifecyclePolicies` needs to be structured as an array of `LifecyclePolicy` objects, one object for each transition, `TransitionToIA`, `TransitionToPrimaryStorageClass`\\. See the example requests in the following section for more information\\.\n*Required*: No \n*Type*: List of [LifecyclePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html) \n*Maximum*: `2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LifecyclePolicies", "type": "array" }, @@ -67639,7 +69132,7 @@ "type": "number" }, "ThroughputMode": { - "markdownDescription": "Specifies the throughput mode for the file system, either `bursting` or `provisioned`\\. If you set `ThroughputMode` to `provisioned`, you must also set a value for `ProvisionedThroughputInMibps`\\. After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, as long as it\u2019s been more than 24 hours since the last decrease or throughput mode change\\. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*\\. \nDefault is `bursting`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `bursting | provisioned` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the throughput mode for the file system\\. The mode can be `bursting`, `provisioned`, or `elastic`\\. If you set `ThroughputMode` to `provisioned`, you must also set a value for `ProvisionedThroughputInMibps`\\. After you create the file system, you can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes, with certain time restrictions\\. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*\\. \nDefault is `bursting`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `bursting | elastic | provisioned` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThroughputMode", "type": "string" } @@ -67704,7 +69197,7 @@ "additionalProperties": false, "properties": { "TransitionToIA": { - "markdownDescription": "Describes the period of time that a file is not accessed, after which it transitions to IA storage\\. Metadata operations such as listing the contents of a directory don't count as file access events\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AFTER_14_DAYS | AFTER_30_DAYS | AFTER_60_DAYS | AFTER_7_DAYS | AFTER_90_DAYS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Describes the period of time that a file is not accessed, after which it transitions to IA storage\\. Metadata operations such as listing the contents of a directory don't count as file access events\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AFTER_14_DAYS | AFTER_1_DAY | AFTER_30_DAYS | AFTER_60_DAYS | AFTER_7_DAYS | AFTER_90_DAYS` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TransitionToIA", "type": "string" }, @@ -67854,13 +69347,17 @@ "type": "string" }, "ConfigurationValues": { + "markdownDescription": "The configuration values that you provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConfigurationValues", "type": "string" }, "PreserveOnDelete": { + "markdownDescription": "Specifying this option preserves the add\\-on software on your cluster but Amazon EKS stops managing any settings for the add\\-on\\. If an IAM account is associated with the add\\-on, it isn't removed\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PreserveOnDelete", "type": "boolean" }, "ResolveConflicts": { - "markdownDescription": "How to resolve parameter value conflicts when migrating an existing add\\-on to an Amazon EKS add\\-on\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | OVERWRITE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "How to resolve field value conflicts for an Amazon EKS add\\-on\\. Conflicts are handled based on the value you choose: \n+ **None** \u2013 If the self\\-managed version of the add\\-on is installed on your cluster, Amazon EKS doesn't change the value\\. Creation of the add\\-on might fail\\.\n+ **Overwrite** \u2013 If the self\\-managed version of the add\\-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value\\.\n+ **Preserve** \u2013 Not supported\\. You can set this value when updating an add\\-on though\\. For more information, see [UpdateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html)\\.\nIf you don't currently have the self\\-managed version of the add\\-on installed on your cluster, the Amazon EKS add\\-on is installed\\. Amazon EKS sets all values to default values, regardless of the option that you specify\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | OVERWRITE | PRESERVE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResolveConflicts", "type": "string" }, @@ -67964,7 +69461,9 @@ "type": "string" }, "OutpostConfig": { - "$ref": "#/definitions/AWS::EKS::Cluster.OutpostConfig" + "$ref": "#/definitions/AWS::EKS::Cluster.OutpostConfig", + "markdownDescription": "An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost\\. This object isn't available for clusters on the AWS cloud\\. \n*Required*: No \n*Type*: [OutpostConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-outpostconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OutpostConfig" }, "ResourcesVpcConfig": { "$ref": "#/definitions/AWS::EKS::Cluster.ResourcesVpcConfig", @@ -67985,7 +69484,7 @@ "type": "array" }, "Version": { - "markdownDescription": "The desired Kubernetes version for your cluster\\. If you don't specify a value here, the latest version available in Amazon EKS is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The desired Kubernetes version for your cluster\\. If you don't specify a value here, the default version available in Amazon EKS is used\\. \nThe default version might not be the latest version available\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -68035,6 +69534,8 @@ "additionalProperties": false, "properties": { "GroupName": { + "markdownDescription": "The name of the placement group for the Kubernetes control plane instances\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "GroupName", "type": "string" } }, @@ -68045,7 +69546,7 @@ "properties": { "Provider": { "$ref": "#/definitions/AWS::EKS::Cluster.Provider", - "markdownDescription": "The encryption provider for the cluster\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The encryption provider for the cluster\\. \n*Required*: No \n*Type*: [Provider](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-provider.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Provider" }, "Resources": { @@ -68063,12 +69564,12 @@ "additionalProperties": false, "properties": { "IpFamily": { - "markdownDescription": "Specify which IP family is used to assign Kubernetes pod and service IP addresses\\. If you don't specify a value, `ipv4` is used by default\\. You can only specify an IP family when you create a cluster and can't change this value once the cluster is created\\. If you specify `ipv6`, the VPC and subnets that you specify for cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them\\. You can't specify `ipv6` for clusters in China Regions\\. \nYou can only specify `ipv6` for 1\\.21 and later clusters that use version 1\\.10\\.1 or later of the Amazon VPC CNI add\\-on\\. If you specify `ipv6`, then ensure that your VPC meets the requirements listed in the considerations listed in [Assigning IPv6 addresses to pods and services](https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html) in the Amazon EKS User Guide\\. Kubernetes assigns services IPv6 addresses from the unique local address range \\(fc00::/7\\)\\. You can't specify a custom IPv6 CIDR block\\. Pod addresses are assigned from the subnet's IPv6 CIDR\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ipv4 | ipv6` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specify which IP family is used to assign Kubernetes pod and service IP addresses\\. If you don't specify a value, `ipv4` is used by default\\. You can only specify an IP family when you create a cluster and can't change this value once the cluster is created\\. If you specify `ipv6`, the VPC and subnets that you specify for cluster creation must have both `IPv4` and `IPv6` CIDR blocks assigned to them\\. You can't specify `ipv6` for clusters in China Regions\\. \nYou can only specify `ipv6` for `1.21` and later clusters that use version `1.10.1` or later of the Amazon VPC CNI add\\-on\\. If you specify `ipv6`, then ensure that your VPC meets the requirements listed in the considerations listed in [Assigning IPv6 addresses to pods and services](https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html) in the Amazon EKS User Guide\\. Kubernetes assigns services `IPv6` addresses from the unique local address range `(fc00::/7)`\\. You can't specify a custom `IPv6` CIDR block\\. Pod addresses are assigned from the subnet's `IPv6` CIDR\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ipv4 | ipv6` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IpFamily", "type": "string" }, "ServiceIpv4Cidr": { - "markdownDescription": "Don't specify a value if you select `ipv6` for **ipFamily**\\. The CIDR block to assign Kubernetes service IP addresses from\\. If you don't specify a block, Kubernetes assigns addresses from either the 10\\.100\\.0\\.0/16 or 172\\.20\\.0\\.0/16 CIDR blocks\\. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC\\. The block must meet the following requirements: \n+ Within one of the following private IP address blocks: 10\\.0\\.0\\.0/8, 172\\.16\\.0\\.0/12, or 192\\.168\\.0\\.0/16\\.\n+ Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC\\.\n+ Between /24 and /12\\.\nYou can only specify a custom CIDR block when you create a cluster and can't change this value once the cluster is created\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Don't specify a value if you select `ipv6` for **ipFamily**\\. The CIDR block to assign Kubernetes service IP addresses from\\. If you don't specify a block, Kubernetes assigns addresses from either the `10.100.0.0/16` or `172.20.0.0/16` CIDR blocks\\. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC\\. The block must meet the following requirements: \n+ Within one of the following private IP address blocks: `10.0.0.0/8`, `172.16.0.0/12`, or `192.168.0.0/16`\\.\n+ Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC\\.\n+ Between /24 and /12\\.\nYou can only specify a custom CIDR block when you create a cluster and can't change this value once the cluster is created\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ServiceIpv4Cidr", "type": "string" }, @@ -68106,15 +69607,21 @@ "additionalProperties": false, "properties": { "ControlPlaneInstanceType": { + "markdownDescription": "The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts\\. Choose an instance type based on the number of nodes that your cluster will have\\. For more information, see [Capacity considerations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the *Amazon EKS User Guide*\\. \nThe instance type that you specify is used for all Kubernetes control plane instances\\. The instance type can't be changed after cluster creation\\. The control plane is not automatically scaled by Amazon EKS\\. \n \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ControlPlaneInstanceType", "type": "string" }, "ControlPlanePlacement": { - "$ref": "#/definitions/AWS::EKS::Cluster.ControlPlanePlacement" + "$ref": "#/definitions/AWS::EKS::Cluster.ControlPlanePlacement", + "markdownDescription": "An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an AWS Outpost\\. For more information, see [Capacity considerations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: [ControlPlanePlacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-controlplaneplacement.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ControlPlanePlacement" }, "OutpostArns": { "items": { "type": "string" }, + "markdownDescription": "The ARN of the Outpost that you want to use for your local Amazon EKS cluster on Outposts\\. Only a single Outpost ARN is supported\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OutpostArns", "type": "array" } }, @@ -68128,6 +69635,8 @@ "additionalProperties": false, "properties": { "KeyArn": { + "markdownDescription": "Amazon Resource Name \\(ARN\\) or alias of the KMS key\\. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key\\. For more information, see [Allowing Users in Other Accounts to Use a KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html) in the * AWS Key Management Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KeyArn", "type": "string" } }, @@ -68158,7 +69667,7 @@ "items": { "type": "string" }, - "markdownDescription": "Specify one or more security groups for the cross\\-account elastic network interfaces that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes control plane\\. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes: \n+ 1\\.14 Amazon EKS platform version `eks.2` and earlier\n+ 1\\.14 Amazon EKS platform version `eks.3` and later \nFor more information, see [Amazon EKS security group considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the * *Amazon EKS User Guide* *\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specify one or more security groups for the cross\\-account elastic network interfaces that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes control plane\\. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes\\. For more information, see [Amazon EKS security group considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the * *Amazon EKS User Guide* *\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SecurityGroupIds", "type": "array" }, @@ -68368,7 +69877,7 @@ }, "Oidc": { "$ref": "#/definitions/AWS::EKS::IdentityProviderConfig.OidcIdentityProviderConfig", - "markdownDescription": "An object that represents an OpenID Connect \\(OIDC\\) identity provider configuration\\. \n*Required*: No \n*Type*: [OidcIdentityProviderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An object representing an OpenID Connect \\(OIDC\\) identity provider configuration\\. \n*Required*: No \n*Type*: [OidcIdentityProviderConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-identityproviderconfig-oidcidentityproviderconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Oidc" }, "Tags": { @@ -68516,7 +70025,7 @@ "additionalProperties": false, "properties": { "AmiType": { - "markdownDescription": "The AMI type for your node group\\. GPU instance types should use the `AL2_x86_64_GPU` AMI type\\. Non\\-GPU instances should use the `AL2_x86_64` AMI type\\. Arm instances should use the `AL2_ARM_64` AMI type\\. All types use the Amazon EKS optimized Amazon Linux 2 AMI\\. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `amiType`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AL2_ARM_64 | AL2_x86_64 | AL2_x86_64_GPU | BOTTLEROCKET_ARM_64 | BOTTLEROCKET_x86_64 | CUSTOM` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The AMI type for your node group\\. If you specify `launchTemplate`, and your launch template uses a custom AMI, then don't specify `amiType`, or the node group deployment will fail\\. If your launch template uses a Windows custom AMI, then add `eks:kube-proxy-windows` to your Windows nodes `rolearn` in the `aws-auth` `ConfigMap`\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AL2_ARM_64 | AL2_x86_64 | AL2_x86_64_GPU | BOTTLEROCKET_ARM_64 | BOTTLEROCKET_ARM_64_NVIDIA | BOTTLEROCKET_x86_64 | BOTTLEROCKET_x86_64_NVIDIA | CUSTOM | WINDOWS_CORE_2019_x86_64 | WINDOWS_CORE_2022_x86_64 | WINDOWS_FULL_2019_x86_64 | WINDOWS_FULL_2022_x86_64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AmiType", "type": "string" }, @@ -68531,7 +70040,7 @@ "type": "string" }, "DiskSize": { - "markdownDescription": "The root device disk size \\(in GiB\\) for your node group instances\\. The default disk size is 20 GiB\\. If you specify `launchTemplate`, then don't specify `diskSize`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The root device disk size \\(in GiB\\) for your node group instances\\. The default disk size is 20 GiB for Linux and Bottlerocket\\. The default disk size is 50 GiB for Windows\\. If you specify `launchTemplate`, then don't specify `diskSize`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DiskSize", "type": "number" }, @@ -68544,13 +70053,13 @@ "items": { "type": "string" }, - "markdownDescription": "Specify the instance types for a node group\\. If you specify a GPU instance type, be sure to specify `AL2_x86_64_GPU` with the `amiType` parameter\\. If you specify `launchTemplate`, then you can specify zero or one instance type in your launch template *or* you can specify 0\\-20 instance types for `instanceTypes`\\. If however, you specify an instance type in your launch template *and* specify any `instanceTypes`, the node group deployment will fail\\. If you don't specify an instance type in a launch template or for `instanceTypes`, then `t3.medium` is used, by default\\. If you specify `Spot` for `capacityType`, then we recommend specifying multiple values for `instanceTypes`\\. For more information, see [Managed node group capacity types](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types) and [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specify the instance types for a node group\\. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the `amiType` parameter\\. If you specify `launchTemplate`, then you can specify zero or one instance type in your launch template *or* you can specify 0\\-20 instance types for `instanceTypes`\\. If however, you specify an instance type in your launch template *and* specify any `instanceTypes`, the node group deployment will fail\\. If you don't specify an instance type in a launch template or for `instanceTypes`, then `t3.medium` is used, by default\\. If you specify `Spot` for `capacityType`, then we recommend specifying multiple values for `instanceTypes`\\. For more information, see [Managed node group capacity types](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types) and [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceTypes", "type": "array" }, "Labels": { "additionalProperties": true, - "markdownDescription": "The Kubernetes labels to be applied to the nodes in the node group when they are created\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Kubernetes labels applied to the nodes in the node group\\. \nOnly labels that are applied with the Amazon EKS API are shown here\\. There may be other Kubernetes labels applied to the nodes in this group\\.\n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -68581,7 +70090,7 @@ }, "RemoteAccess": { "$ref": "#/definitions/AWS::EKS::Nodegroup.RemoteAccess", - "markdownDescription": "The remote access \\(SSH\\) configuration to use with your node group\\. If you specify `launchTemplate`, then don't specify `remoteAccess`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: [RemoteAccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The remote access configuration to use with your node group\\. For Linux, the protocol is SSH\\. For Windows, the protocol is RDP\\. If you specify `launchTemplate`, then don't specify `remoteAccess`, or the node group deployment will fail\\. For more information about using launch templates with Amazon EKS, see [Launch template support](https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html) in the *Amazon EKS User Guide*\\. \n*Required*: No \n*Type*: [RemoteAccess](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-remoteaccess.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RemoteAccess" }, "ScalingConfig": { @@ -68599,7 +70108,7 @@ }, "Tags": { "additionalProperties": true, - "markdownDescription": "The metadata to apply to the node group to assist with categorization and organization\\. Each tag consists of a key and an optional value\\. You define both\\. Node group tags don't propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets\\. \nUpdates to `Tags` can't be combined with updates to `ReleaseVersion`, `Version`, or `LaunchTemplate`\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The metadata applied to the node group to assist with categorization and organization\\. Each tag consists of a key and an optional value\\. You define both\\. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -68659,17 +70168,17 @@ "additionalProperties": false, "properties": { "Id": { - "markdownDescription": "The ID of the launch template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of the launch template\\. \nYou must specify either the launch template ID or the launch template name in the request, but not both\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Id", "type": "string" }, "Name": { - "markdownDescription": "The name of the launch template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the launch template\\. \nYou must specify either the launch template name or the launch template ID in the request, but not both\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Version": { - "markdownDescription": "The version of the launch template to use\\. If no version is specified, then the template's default version is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version number of the launch template to use\\. If no version is specified, then the template's default version is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -68680,7 +70189,7 @@ "additionalProperties": false, "properties": { "Ec2SshKey": { - "markdownDescription": "The Amazon EC2 SSH key that provides access for SSH communication with the nodes in the managed node group\\. For more information, see [Amazon EC2 key pairs and Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group\\. For more information, see [Amazon EC2 key pairs and Linux instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*\\. For Windows, an Amazon EC2 SSH key is used to obtain the RDP password\\. For more information, see [Amazon EC2 key pairs and Windows instances](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-key-pairs.html) in the *Amazon Elastic Compute Cloud User Guide for Windows Instances*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Ec2SshKey", "type": "string" }, @@ -68688,7 +70197,7 @@ "items": { "type": "string" }, - "markdownDescription": "The security groups that are allowed SSH access \\(port 22\\) to the nodes\\. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the nodes is opened to the internet \\(0\\.0\\.0\\.0/0\\)\\. For more information, see [Security Groups for Your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The security group IDs that are allowed SSH access \\(port 22\\) to the nodes\\. For Windows, the port is 3389\\. If you specify an Amazon EC2 SSH key but don't specify a source security group when you create a managed node group, then the port on the nodes is opened to the internet \\(`0.0.0.0/0`\\)\\. For more information, see [Security Groups for Your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon Virtual Private Cloud User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SourceSecurityGroups", "type": "array" } @@ -68810,7 +70319,9 @@ "type": "string" }, "AutoTerminationPolicy": { - "$ref": "#/definitions/AWS::EMR::Cluster.AutoTerminationPolicy" + "$ref": "#/definitions/AWS::EMR::Cluster.AutoTerminationPolicy", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AutoTerminationPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-autoterminationpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoTerminationPolicy" }, "BootstrapActions": { "items": { @@ -68874,6 +70385,8 @@ "type": "string" }, "OSReleaseLabel": { + "markdownDescription": "The Amazon Linux release specified in a cluster launch RunJobFlow request\\. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OSReleaseLabel", "type": "string" }, "ReleaseLabel": { @@ -69014,6 +70527,8 @@ "additionalProperties": false, "properties": { "IdleTimeout": { + "markdownDescription": "Specifies the amount of idle time in seconds after which the cluster automatically terminates\\. You can specify a minimum of 60 seconds and a maximum of 604800 seconds \\(seven days\\)\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IdleTimeout", "type": "number" } }, @@ -69170,11 +70685,11 @@ "properties": { "VolumeSpecification": { "$ref": "#/definitions/AWS::EMR::Cluster.VolumeSpecification", - "markdownDescription": "EBS volume specifications such as volume type, IOPS, and size \\(GiB\\) that will be requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "EBS volume specifications such as volume type, IOPS, size \\(GiB\\) and throughput \\(MiB/s\\) that are requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-volumespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumeSpecification" }, "VolumesPerInstance": { - "markdownDescription": "Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumesPerInstance", "type": "number" } @@ -69282,7 +70797,7 @@ }, "SpotSpecification": { "$ref": "#/definitions/AWS::EMR::Cluster.SpotProvisioningSpecification", - "markdownDescription": "The launch specification for Spot Instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy\\. \n*Required*: No \n*Type*: [SpotProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy\\. \n*Required*: No \n*Type*: [SpotProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-spotprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SpotSpecification" } }, @@ -69484,12 +70999,16 @@ "items": { "$ref": "#/definitions/AWS::EMR::Cluster.InstanceFleetConfig" }, + "markdownDescription": "Describes the EC2 instances and instance configurations for the task instance fleets when using clusters with the instance fleet configuration\\. These task instance fleets are added to the cluster as part of the cluster launch\\. Each task instance fleet must have a unique name specified so that CloudFormation can differentiate between the task instance fleets\\. \nYou can currently specify only one task instance fleet for a cluster\\. After creating the cluster, you can only modify the mutable properties of `InstanceFleetConfig`, which are `TargetOnDemandCapacity` and `TargetSpotCapacity`\\. Modifying any other property results in cluster replacement\\.\nTo allow a maximum of 30 Amazon EC2 instance types per fleet, include `TaskInstanceFleets` when you create your cluster\\. If you create your cluster without `TaskInstanceFleets`, Amazon EMR uses its default allocation strategy, which allows for a maximum of five Amazon EC2 instance types\\.\n*Required*: No \n*Type*: List of [InstanceFleetConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancefleetconfig.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "TaskInstanceFleets", "type": "array" }, "TaskInstanceGroups": { "items": { "$ref": "#/definitions/AWS::EMR::Cluster.InstanceGroupConfig" }, + "markdownDescription": "Describes the EC2 instances and instance configurations for task instance groups when using clusters with the uniform instance group configuration\\. These task instance groups are added to the cluster as part of the cluster launch\\. Each task instance group must have a unique name specified so that CloudFormation can differentiate between the task instance groups\\. \nAfter creating the cluster, you can only modify the mutable properties of `InstanceGroupConfig`, which are `AutoScalingPolicy` and `InstanceCount`\\. Modifying any other property results in cluster replacement\\.\n*Required*: No \n*Type*: List of [InstanceGroupConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-instancegroupconfig.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "TaskInstanceGroups", "type": "array" }, "TerminationProtected": { @@ -69759,7 +71278,7 @@ "type": "string" }, "TimeoutDurationMinutes": { - "markdownDescription": "The spot provisioning timeout period in minutes\\. If Spot Instances are not provisioned within this time period, the `TimeOutAction` is taken\\. Minimum value is 5 and maximum value is 1440\\. The timeout applies only during initial provisioning, when the cluster is first created\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Spot provisioning timeout period in minutes\\. If Spot Instances are not provisioned within this time period, the `TimeOutAction` is taken\\. Minimum value is 5 and maximum value is 1440\\. The timeout applies only during initial provisioning, when the cluster is first created\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutDurationMinutes", "type": "number" } @@ -69809,7 +71328,7 @@ "type": "number" }, "VolumeType": { - "markdownDescription": "The volume type\\. Volume types supported are gp2, io1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The volume type\\. Volume types supported are gp3, gp2, io1, st1, sc1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumeType", "type": "string" } @@ -69956,11 +71475,11 @@ "properties": { "VolumeSpecification": { "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig.VolumeSpecification", - "markdownDescription": "EBS volume specifications such as volume type, IOPS, and size \\(GiB\\) that will be requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "EBS volume specifications such as volume type, IOPS, size \\(GiB\\) and throughput \\(MiB/s\\) that are requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-volumespecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VolumeSpecification" }, "VolumesPerInstance": { - "markdownDescription": "Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VolumesPerInstance", "type": "number" } @@ -69999,7 +71518,7 @@ }, "SpotSpecification": { "$ref": "#/definitions/AWS::EMR::InstanceFleetConfig.SpotProvisioningSpecification", - "markdownDescription": "The launch specification for Spot Instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy\\. \n*Required*: No \n*Type*: [SpotProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy\\. \n*Required*: No \n*Type*: [SpotProvisioningSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-instancefleetconfig-spotprovisioningspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SpotSpecification" } }, @@ -70085,7 +71604,7 @@ "type": "string" }, "TimeoutDurationMinutes": { - "markdownDescription": "The spot provisioning timeout period in minutes\\. If Spot Instances are not provisioned within this time period, the `TimeOutAction` is taken\\. Minimum value is 5 and maximum value is 1440\\. The timeout applies only during initial provisioning, when the cluster is first created\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Spot provisioning timeout period in minutes\\. If Spot Instances are not provisioned within this time period, the `TimeOutAction` is taken\\. Minimum value is 5 and maximum value is 1440\\. The timeout applies only during initial provisioning, when the cluster is first created\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutDurationMinutes", "type": "number" } @@ -70110,7 +71629,7 @@ "type": "number" }, "VolumeType": { - "markdownDescription": "The volume type\\. Volume types supported are gp2, io1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The volume type\\. Volume types supported are gp3, gp2, io1, st1, sc1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VolumeType", "type": "string" } @@ -70362,11 +71881,11 @@ "properties": { "VolumeSpecification": { "$ref": "#/definitions/AWS::EMR::InstanceGroupConfig.VolumeSpecification", - "markdownDescription": "EBS volume specifications such as volume type, IOPS, and size \\(GiB\\) that will be requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "EBS volume specifications such as volume type, IOPS, size \\(GiB\\) and throughput \\(MiB/s\\) that are requested for the EBS volume attached to an EC2 instance in the cluster\\. \n*Required*: Yes \n*Type*: [VolumeSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emr-ebsconfiguration-ebsblockdeviceconfig-volumespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumeSpecification" }, "VolumesPerInstance": { - "markdownDescription": "Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Number of EBS volumes with a specific volume configuration that are associated with every instance in the instance group \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumesPerInstance", "type": "number" } @@ -70537,7 +72056,7 @@ "type": "number" }, "VolumeType": { - "markdownDescription": "The volume type\\. Volume types supported are gp2, io1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The volume type\\. Volume types supported are gp3, gp2, io1, st1, sc1, and standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumeType", "type": "string" } @@ -70792,7 +72311,7 @@ "additionalProperties": false, "properties": { "AuthMode": { - "markdownDescription": "Specifies whether the Studio authenticates users using AWS SSO or IAM\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IAM | SSO` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies whether the Studio authenticates users using IAM Identity Center or IAM\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IAM | SSO` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AuthMode", "type": "string" }, @@ -70932,7 +72451,7 @@ "additionalProperties": false, "properties": { "IdentityName": { - "markdownDescription": "The name of the user or group\\. For more information, see [UserName](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) and [DisplayName](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) in the *AWS SSO Identity Store API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the user or group\\. For more information, see [UserName](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName) and [DisplayName](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName) in the *IAM Identity Center Identity Store API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IdentityName", "type": "string" }, @@ -71067,7 +72586,7 @@ "properties": { "EksInfo": { "$ref": "#/definitions/AWS::EMRContainers::VirtualCluster.EksInfo", - "markdownDescription": "The information about the EKS cluster\\. \n*Required*: Yes \n*Type*: [EksInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-eksinfo.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The information about the Amazon EKS cluster\\. \n*Required*: Yes \n*Type*: [EksInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-eksinfo.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EksInfo" } }, @@ -71090,7 +72609,7 @@ "title": "Info" }, "Type": { - "markdownDescription": "The type of the container provider\\. EKS is the only supported type as of now\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `EKS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of the container provider\\. Amazon EKS is the only supported type as of now\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `EKS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -71152,51 +72671,75 @@ "additionalProperties": false, "properties": { "Architecture": { + "markdownDescription": "The CPU architecture type of the application\\. Allowed values: `X86_64` or `ARM64` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Architecture", "type": "string" }, "AutoStartConfiguration": { - "$ref": "#/definitions/AWS::EMRServerless::Application.AutoStartConfiguration" + "$ref": "#/definitions/AWS::EMRServerless::Application.AutoStartConfiguration", + "markdownDescription": "The configuration for an application to automatically start on job submission\\. \n*Required*: No \n*Type*: [AutoStartConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostartconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoStartConfiguration" }, "AutoStopConfiguration": { - "$ref": "#/definitions/AWS::EMRServerless::Application.AutoStopConfiguration" + "$ref": "#/definitions/AWS::EMRServerless::Application.AutoStopConfiguration", + "markdownDescription": "The configuration for an application to automatically stop after a certain amount of time being idle\\. \n*Required*: No \n*Type*: [AutoStopConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-autostopconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoStopConfiguration" }, "ImageConfiguration": { - "$ref": "#/definitions/AWS::EMRServerless::Application.ImageConfigurationInput" + "$ref": "#/definitions/AWS::EMRServerless::Application.ImageConfigurationInput", + "markdownDescription": "The image configuration applied to all worker types\\. \n*Required*: No \n*Type*: [ImageConfigurationInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-imageconfigurationinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImageConfiguration" }, "InitialCapacity": { "items": { "$ref": "#/definitions/AWS::EMRServerless::Application.InitialCapacityConfigKeyValuePair" }, + "markdownDescription": "The initial capacity of the application\\. \n*Required*: No \n*Type*: List of [InitialCapacityConfigKeyValuePair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfigkeyvaluepair.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InitialCapacity", "type": "array" }, "MaximumCapacity": { - "$ref": "#/definitions/AWS::EMRServerless::Application.MaximumAllowedResources" + "$ref": "#/definitions/AWS::EMRServerless::Application.MaximumAllowedResources", + "markdownDescription": "The maximum capacity of the application\\. This is cumulative across all workers at any given point in time during the lifespan of the application is created\\. No new resources will be created once any one of the defined limits is hit\\. \n*Required*: No \n*Type*: [MaximumAllowedResources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-maximumallowedresources.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumCapacity" }, "Name": { + "markdownDescription": "The name of the application\\. \n*Minimum*: 1 \n*Maximum*: 64 \n*Pattern*: `^[A-Za-z0-9._\\\\/#-]+$` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "NetworkConfiguration": { - "$ref": "#/definitions/AWS::EMRServerless::Application.NetworkConfiguration" + "$ref": "#/definitions/AWS::EMRServerless::Application.NetworkConfiguration", + "markdownDescription": "The network configuration for customer VPC connectivity for the application\\. \n*Required*: No \n*Type*: [NetworkConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-networkconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkConfiguration" }, "ReleaseLabel": { + "markdownDescription": "The EMR release version associated with the application\\. \n*Minimum*: 1 \n*Maximum*: 64 \n*Pattern*: `^[A-Za-z0-9._/-]+$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ReleaseLabel", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags assigned to the application\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "Type": { + "markdownDescription": "The type of application, such as Spark or Hive\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" }, "WorkerTypeSpecifications": { "additionalProperties": false, + "markdownDescription": "The specification applied to each worker type\\. \n*Required*: No \n*Type*: Map of [WorkerTypeSpecificationInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workertypespecificationinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::EMRServerless::Application.WorkerTypeSpecificationInput" } }, + "title": "WorkerTypeSpecifications", "type": "object" } }, @@ -71231,6 +72774,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Enables the application to automatically start on job submission\\. Defaults to true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" } }, @@ -71240,9 +72785,13 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Enables the application to automatically stop after a certain amount of time being idle\\. Defaults to true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "IdleTimeoutMinutes": { + "markdownDescription": "The amount of idle time in minutes after which your application will automatically stop\\. Defaults to 15 minutes\\. \n*Minimum*: 1 \n*Maximum*: 10080 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IdleTimeoutMinutes", "type": "number" } }, @@ -71252,6 +72801,8 @@ "additionalProperties": false, "properties": { "ImageUri": { + "markdownDescription": "The URI of an image in the Amazon ECR registry\\. This field is required when you create a new application\\. If you leave this field blank in an update, Amazon EMR will remove the image configuration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImageUri", "type": "string" } }, @@ -71261,9 +72812,13 @@ "additionalProperties": false, "properties": { "WorkerConfiguration": { - "$ref": "#/definitions/AWS::EMRServerless::Application.WorkerConfiguration" + "$ref": "#/definitions/AWS::EMRServerless::Application.WorkerConfiguration", + "markdownDescription": "The resource configuration of the initial capacity configuration\\. \n*Required*: Yes \n*Type*: [WorkerConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-workerconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WorkerConfiguration" }, "WorkerCount": { + "markdownDescription": "The number of workers in the initial capacity configuration\\. \n*Minimum*: 1 \n*Maximum*: 1000000 \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WorkerCount", "type": "number" } }, @@ -71277,10 +72832,14 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The worker type for an analytics framework\\. For Spark applications, the key can either be set to `Driver` or `Executor`\\. For Hive applications, it can be set to `HiveDriver` or `TezTask`\\. \n*Minimum*: 1 \n*Maximum*: 50 \n*Pattern*: `^[a-zA-Z]+[-_]*[a-zA-Z]+$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { - "$ref": "#/definitions/AWS::EMRServerless::Application.InitialCapacityConfig" + "$ref": "#/definitions/AWS::EMRServerless::Application.InitialCapacityConfig", + "markdownDescription": "The value for the initial capacity configuration per worker\\. \n*Required*: Yes \n*Type*: [InitialCapacityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-initialcapacityconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value" } }, "required": [ @@ -71293,12 +72852,18 @@ "additionalProperties": false, "properties": { "Cpu": { + "markdownDescription": "The maximum allowed CPU for an application\\. \n*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(vCPU|vcpu|VCPU)?$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cpu", "type": "string" }, "Disk": { + "markdownDescription": "The maximum allowed disk for an application\\. \n*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(GB|gb|gB|Gb)$\"` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Disk", "type": "string" }, "Memory": { + "markdownDescription": "The maximum allowed resources for an application\\. \n*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(GB|gb|gB|Gb)?$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Memory", "type": "string" } }, @@ -71315,12 +72880,16 @@ "items": { "type": "string" }, + "markdownDescription": "The array of security group Ids for customer VPC connectivity\\. \n*Minimum*: 1 \n*Maximum*: 32 \n*Pattern*: `^[-0-9a-zA-Z]+` \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroupIds", "type": "array" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "The array of subnet Ids for customer VPC connectivity\\. \n*Minimum*: 1 \n*Maximum*: 32 \n*Pattern*: `^[-0-9a-zA-Z]+` \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetIds", "type": "array" } }, @@ -71330,12 +72899,18 @@ "additionalProperties": false, "properties": { "Cpu": { + "markdownDescription": "*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(vCPU|vcpu|VCPU)?$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cpu", "type": "string" }, "Disk": { + "markdownDescription": "*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(GB|gb|gB|Gb)$\"` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Disk", "type": "string" }, "Memory": { + "markdownDescription": "*Minimum*: 1 \n*Maximum*: 15 \n*Pattern*: `^[1-9][0-9]*(\\\\s)?(GB|gb|gB|Gb)?$` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Memory", "type": "string" } }, @@ -71349,7 +72924,9 @@ "additionalProperties": false, "properties": { "ImageConfiguration": { - "$ref": "#/definitions/AWS::EMRServerless::Application.ImageConfigurationInput" + "$ref": "#/definitions/AWS::EMRServerless::Application.ImageConfigurationInput", + "markdownDescription": "The image configuration for a worker type\\. \n*Required*: No \n*Type*: [ImageConfigurationInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-imageconfigurationinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImageConfiguration" } }, "type": "object" @@ -71438,6 +73015,8 @@ "type": "string" }, "IpDiscovery": { + "markdownDescription": "The network type you choose when modifying a cluster, either `ipv4` \\| `ipv6`\\. IPv6 is supported for workloads using Redis engine version 6\\.2 onward or Memcached engine version 1\\.6\\.6 on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ipv4 | ipv6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IpDiscovery", "type": "string" }, "LogDeliveryConfigurations": { @@ -71449,6 +73028,8 @@ "type": "array" }, "NetworkType": { + "markdownDescription": "Must be either `ipv4` \\| `ipv6` \\| `dual_stack`\\. IPv6 is supported for workloads using Redis engine version 6\\.2 onward or Memcached engine version 1\\.6\\.6 on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `dual_stack | ipv4 | ipv6` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NetworkType", "type": "string" }, "NotificationTopicArn": { @@ -71516,6 +73097,8 @@ "type": "array" }, "TransitEncryptionEnabled": { + "markdownDescription": "A flag that enables in\\-transit encryption when set to true\\. \n Only available when creating a cache cluster in an Amazon VPC using Memcached version 1\\.6\\.12 or later\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TransitEncryptionEnabled", "type": "boolean" }, "VpcSecurityGroupIds": { @@ -71713,7 +73296,7 @@ "items": { "$ref": "#/definitions/AWS::ElastiCache::GlobalReplicationGroup.RegionalConfiguration" }, - "markdownDescription": "The Amazon Regions that comprise the Global Datastore\\. \n*Required*: No \n*Type*: List of [RegionalConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Regions that comprise the Global Datastore\\. \n*Required*: No \n*Type*: List of [RegionalConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-globalreplicationgroup-regionalconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RegionalConfigurations", "type": "array" } @@ -71844,7 +73427,7 @@ "additionalProperties": false, "properties": { "CacheParameterGroupFamily": { - "markdownDescription": "The name of the cache parameter group family that this cache parameter group is compatible with\\. \nValid values are: `memcached1.4` \\| `memcached1.5` \\| `memcached1.6` \\| `redis2.6` \\| `redis2.8` \\| `redis3.2` \\| `redis4.0` \\| `redis5.0` \\| `redis6.x` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the cache parameter group family that this cache parameter group is compatible with\\. \nValid values are: `memcached1.4` \\| `memcached1.5` \\| `memcached1.6` \\| `redis2.6` \\| `redis2.8` \\| `redis3.2` \\| `redis4.0` \\| `redis5.0` \\| `redis6.x` \\| `redis7` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CacheParameterGroupFamily", "type": "string" }, @@ -71941,7 +73524,7 @@ "type": "boolean" }, "AuthToken": { - "markdownDescription": "**Reserved parameter\\.** The password used to access a password protected server\\. \n `AuthToken` can be specified only on replication groups where `TransitEncryptionEnabled` is `true`\\. For more information, see [Authenticating Users with the Redis AUTH Command](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html)\\. \nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`\\.\nPassword constraints: \n+ Must be only printable ASCII characters\\.\n+ Must be at least 16 characters and no more than 128 characters in length\\.\n+ Nonalphanumeric characters are restricted to \\(\\!, &, \\#, $, ^, <, >, \\-, \\)\\. \nFor more information, see [AUTH password](http://redis.io/commands/AUTH) at http://redis\\.io/commands/AUTH\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "**Reserved parameter\\.** The password used to access a password protected server\\. \n `AuthToken` can be specified only on replication groups where `TransitEncryptionEnabled` is `true`\\. For more information, see [Authenticating Users with the Redis AUTH Command](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/auth.html)\\. \nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`\\.\nPassword constraints: \n+ Must be only printable ASCII characters\\.\n+ Must be at least 16 characters and no more than 128 characters in length\\.\n+ Nonalphanumeric characters are restricted to \\(\\!, &, \\#, $, ^, <, >, \\-, \\)\\. \nFor more information, see [AUTH password](http://redis.io/commands/AUTH) at http://redis\\.io/commands/AUTH\\. \nIf ADDING the AuthToken, update requires [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "AuthToken", "type": "string" }, @@ -71984,7 +73567,7 @@ "type": "boolean" }, "Engine": { - "markdownDescription": "The name of the cache engine to be used for the clusters in this replication group\\. Must be Redis\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the cache engine to be used for the clusters in this replication group\\. The value must be set to `Redis`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Engine", "type": "string" }, @@ -71999,6 +73582,8 @@ "type": "string" }, "IpDiscovery": { + "markdownDescription": "The network type you choose when creating a replication group, either `ipv4` \\| `ipv6`\\. IPv6 is supported for workloads using Redis engine version 6\\.2 onward or Memcached engine version 1\\.6\\.6 on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ipv4 | ipv6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IpDiscovery", "type": "string" }, "KmsKeyId": { @@ -72020,6 +73605,8 @@ "type": "boolean" }, "NetworkType": { + "markdownDescription": "Must be either `ipv4` \\| `ipv6` \\| `dual_stack`\\. IPv6 is supported for workloads using Redis engine version 6\\.2 onward or Memcached engine version 1\\.6\\.6 on all instances built on the [Nitro system](http://aws.amazon.com/ec2/nitro/)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `dual_stack | ipv4 | ipv6` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NetworkType", "type": "string" }, "NodeGroupConfiguration": { @@ -72128,18 +73715,20 @@ "type": "array" }, "TransitEncryptionEnabled": { - "markdownDescription": "A flag that enables in\\-transit encryption when set to `true`\\. \nYou cannot modify the value of `TransitEncryptionEnabled` after the cluster is created\\. To enable in\\-transit encryption on a cluster you must set `TransitEncryptionEnabled` to `true` when you create a cluster\\. \nThis parameter is valid only if the `Engine` parameter is `redis`, the `EngineVersion` parameter is `3.2.6` or `4.x` onward, and the cluster is being created in an Amazon VPC\\. \nIf you enable in\\-transit encryption, you must also specify a value for `CacheSubnetGroup`\\. \n **Required:** Only available when creating a replication group in an Amazon VPC using redis version `3.2.6` or `4.x` onward\\. \nDefault: `false` \nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A flag that enables in\\-transit encryption when set to `true`\\. \nYou cannot modify the value of `TransitEncryptionEnabled` after the cluster is created\\. To enable in\\-transit encryption on a cluster you must set `TransitEncryptionEnabled` to `true` when you create a cluster\\. \nThis parameter is valid only if the `Engine` parameter is `redis`, the `EngineVersion` parameter is `3.2.6` or `4.x` onward, and the cluster is being created in an Amazon VPC\\. \nIf you enable in\\-transit encryption, you must also specify a value for `CacheSubnetGroup`\\. \n **Required:** Only available when creating a replication group in an Amazon VPC using redis version `3.2.6` or `4.x` onward\\. \nDefault: `false` \nFor HIPAA compliance, you must specify `TransitEncryptionEnabled` as `true`, an `AuthToken`, and a `CacheSubnetGroup`\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TransitEncryptionEnabled", "type": "boolean" }, "TransitEncryptionMode": { + "markdownDescription": "A setting that allows you to migrate your clients to use in\\-transit encryption, with no downtime\\. \nWhen setting `TransitEncryptionEnabled` to `true`, you can set your `TransitEncryptionMode` to `preferred` in the same request, to allow both encrypted and unencrypted connections at the same time\\. Once you migrate all your Redis clients to use encrypted connections you can modify the value to `required` to allow encrypted connections only\\. \nSetting `TransitEncryptionMode` to `required` is a two\\-step process that requires you to first set the `TransitEncryptionMode` to `preferred`, after that you can set `TransitEncryptionMode` to `required`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `preferred | required` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TransitEncryptionMode", "type": "string" }, "UserGroupIds": { "items": { "type": "string" }, - "markdownDescription": "The list of user groups to associate with the replication group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of user group to associate with the replication group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UserGroupIds", "type": "array" } @@ -72563,7 +74152,9 @@ "type": "string" }, "AuthenticationMode": { - "$ref": "#/definitions/AWS::ElastiCache::User.AuthenticationMode" + "$ref": "#/definitions/AWS::ElastiCache::User.AuthenticationMode", + "markdownDescription": "Specifies the authentication mode to use\\. Below is an example of the possible JSON values:", + "title": "AuthenticationMode" }, "Engine": { "markdownDescription": "The current supported value is redis\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[a-zA-Z]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -72629,9 +74220,13 @@ "items": { "type": "string" }, + "markdownDescription": "Specifies the passwords to use for authentication if `Type` is set to `password`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Passwords", "type": "array" }, "Type": { + "markdownDescription": "Specifies the authentication type\\. Possible options are IAM authentication, password and no password\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `iam | no-password-required | password` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -72915,7 +74510,7 @@ }, "SourceBundle": { "$ref": "#/definitions/AWS::ElasticBeanstalk::ApplicationVersion.SourceBundle", - "markdownDescription": "The Amazon S3 bucket and key that identify the location of the source bundle for this version\\. \nThe Amazon S3 bucket must be in the same region as the environment\\.\n*Required*: Yes \n*Type*: [SourceBundle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-sourcebundle.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon S3 bucket and key that identify the location of the source bundle for this version\\. \nThe Amazon S3 bucket must be in the same region as the environment\\.\n*Required*: Yes \n*Type*: [SourceBundle](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticbeanstalk-applicationversion-sourcebundle.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SourceBundle" } }, @@ -73928,7 +75523,7 @@ "type": "string" }, "ClientSecret": { - "markdownDescription": "The OAuth 2\\.0 client secret\\. This parameter is required if you are creating a rule\\. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The OAuth 2\\.0 client secret\\. This parameter is required if you are creating a rule\\. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientSecret", "type": "string" }, @@ -73963,6 +75558,8 @@ "type": "string" }, "UseExistingClientSecret": { + "markdownDescription": "Indicates whether to use the existing client secret when modifying a rule\\. If you are creating a rule, you can omit this parameter or set it to false\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseExistingClientSecret", "type": "boolean" }, "UserInfoEndpoint": { @@ -74144,7 +75741,7 @@ "items": { "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerCertificate.Certificate" }, - "markdownDescription": "The certificate\\. You can specify one certificate per resource\\. \n*Required*: Yes \n*Type*: List of [Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The certificate\\. You can specify one certificate per resource\\. \n*Required*: Yes \n*Type*: List of [Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-certificates.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Certificates", "type": "array" }, @@ -74414,7 +76011,7 @@ "type": "string" }, "ClientSecret": { - "markdownDescription": "The OAuth 2\\.0 client secret\\. This parameter is required if you are creating a rule\\. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The OAuth 2\\.0 client secret\\. This parameter is required if you are creating a rule\\. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClientSecret", "type": "string" }, @@ -74518,7 +76115,7 @@ "items": { "type": "string" }, - "markdownDescription": "One or more host names\\. The maximum size of each name is 128 characters\\. The comparison is case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf you specify multiple strings, the condition is satisfied if one of the strings matches the host name\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The host names\\. The maximum size of each name is 128 characters\\. The comparison is case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf you specify multiple strings, the condition is satisfied if one of the strings matches the host name\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -74537,7 +76134,7 @@ "items": { "type": "string" }, - "markdownDescription": "One or more strings to compare against the value of the HTTP header\\. The maximum size of each string is 128 characters\\. The comparison strings are case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf the same header appears multiple times in the request, we search them in order until a match is found\\. \nIf you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header\\. To require that all of the strings are a match, create one condition per string\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The strings to compare against the value of the HTTP header\\. The maximum size of each string is 128 characters\\. The comparison strings are case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf the same header appears multiple times in the request, we search them in order until a match is found\\. \nIf you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header\\. To require that all of the strings are a match, create one condition per string\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -74565,7 +76162,7 @@ "items": { "type": "string" }, - "markdownDescription": "One or more path patterns to compare against the request URL\\. The maximum size of each string is 128 characters\\. The comparison is case sensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf you specify multiple strings, the condition is satisfied if one of them matches the request URL\\. The path pattern is compared only to the path of the URL, not to its query string\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The path patterns to compare against the request URL\\. The maximum size of each string is 128 characters\\. The comparison is case sensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. \nIf you specify multiple strings, the condition is satisfied if one of them matches the request URL\\. The path pattern is compared only to the path of the URL, not to its query string\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -74579,7 +76176,7 @@ "items": { "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::ListenerRule.QueryStringKeyValue" }, - "markdownDescription": "One or more key/value pairs or values to find in the query string\\. The maximum size of each string is 128 characters\\. The comparison is case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. To search for a literal '\\*' or '?' character in a query string, you must escape these characters in `Values` using a '\\\\' character\\. \nIf you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string\\. \n*Required*: No \n*Type*: List of [QueryStringKeyValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key/value pairs or values to find in the query string\\. The maximum size of each string is 128 characters\\. The comparison is case insensitive\\. The following wildcard characters are supported: \\* \\(matches 0 or more characters\\) and ? \\(matches exactly 1 character\\)\\. To search for a literal '\\*' or '?' character in a query string, you must escape these characters in `Values` using a '\\\\' character\\. \nIf you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string\\. \n*Required*: No \n*Type*: List of [QueryStringKeyValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-querystringkeyvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -74697,7 +76294,7 @@ "items": { "type": "string" }, - "markdownDescription": "One or more source IP addresses, in CIDR format\\. You can use both IPv4 and IPv6 addresses\\. Wildcards are not supported\\. \nIf you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks\\. This condition is not satisfied by the addresses in the X\\-Forwarded\\-For header\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The source IP addresses, in CIDR format\\. You can use both IPv4 and IPv6 addresses\\. Wildcards are not supported\\. \nIf you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks\\. This condition is not satisfied by the addresses in the X\\-Forwarded\\-For header\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -74858,7 +76455,7 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The name of the attribute\\. \nThe following attribute is supported by all load balancers: \n+ `deletion_protection.enabled` \\- Indicates whether deletion protection is enabled\\. The value is `true` or `false`\\. The default is `false`\\.\nThe following attributes are supported by both Application Load Balancers and Network Load Balancers: \n+ `access_logs.s3.enabled` \\- Indicates whether access logs are enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `access_logs.s3.bucket` \\- The name of the S3 bucket for the access logs\\. This attribute is required if access logs are enabled\\. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket\\.\n+ `access_logs.s3.prefix` \\- The prefix for the location in the S3 bucket for the access logs\\.\n+ `ipv6.deny_all_igw_traffic` \\- Blocks internet gateway \\(IGW\\) access to the load balancer\\. It is set to `false` for internet\\-facing load balancers and `true` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway\\.\nThe following attributes are supported by only Application Load Balancers: \n+ `idle_timeout.timeout_seconds` \\- The idle timeout value, in seconds\\. The valid range is 1\\-4000 seconds\\. The default is 60 seconds\\.\n+ `routing.http.desync_mitigation_mode` \\- Determines how the load balancer handles requests that might pose a security risk to your application\\. The possible values are `monitor`, `defensive`, and `strictest`\\. The default is `defensive`\\.\n+ `routing.http.drop_invalid_header_fields.enabled` \\- Indicates whether HTTP headers with invalid header fields are removed by the load balancer \\(`true`\\) or routed to targets \\(`false`\\)\\. The default is `false`\\.\n+ `routing.http.x_amzn_tls_version_and_cipher_suite.enabled` \\- Indicates whether the two headers \\(`x-amzn-tls-version` and `x-amzn-tls-cipher-suite`\\), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target\\. The `x-amzn-tls-version` header has information about the TLS protocol version negotiated with the client, and the `x-amzn-tls-cipher-suite` header has information about the cipher suite negotiated with the client\\. Both headers are in OpenSSL format\\. The possible values for the attribute are `true` and `false`\\. The default is `false`\\.\n+ `routing.http.xff_client_port.enabled` \\- Indicates whether the `X-Forwarded-For` header should preserve the source port that the client used to connect to the load balancer\\. The possible values are `true` and `false`\\. The default is `false`\\.\n+ `routing.http2.enabled` \\- Indicates whether HTTP/2 is enabled\\. The possible values are `true` and `false`\\. The default is `true`\\. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens\\.\n+ `waf.fail_open.enabled` \\- Indicates whether to allow a WAF\\-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF\\. The possible values are `true` and `false`\\. The default is `false`\\.\nThe following attribute is supported by Network Load Balancers and Gateway Load Balancers: \n+ `load_balancing.cross_zone.enabled` \\- Indicates whether cross\\-zone load balancing is enabled\\. The possible values are `true` and `false`\\. The default is `false`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the attribute\\. \nThe following attributes are supported by all load balancers: \n+ `deletion_protection.enabled` \\- Indicates whether deletion protection is enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `load_balancing.cross_zone.enabled` \\- Indicates whether cross\\-zone load balancing is enabled\\. The possible values are `true` and `false`\\. The default for Network Load Balancers and Gateway Load Balancers is `false`\\. The default for Application Load Balancers is `true`, and cannot be changed\\.\nThe following attributes are supported by both Application Load Balancers and Network Load Balancers: \n+ `access_logs.s3.enabled` \\- Indicates whether access logs are enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `access_logs.s3.bucket` \\- The name of the S3 bucket for the access logs\\. This attribute is required if access logs are enabled\\. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket\\.\n+ `access_logs.s3.prefix` \\- The prefix for the location in the S3 bucket for the access logs\\.\n+ `ipv6.deny_all_igw_traffic` \\- Blocks internet gateway \\(IGW\\) access to the load balancer\\. It is set to `false` for internet\\-facing load balancers and `true` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway\\.\nThe following attributes are supported by only Application Load Balancers: \n+ `idle_timeout.timeout_seconds` \\- The idle timeout value, in seconds\\. The valid range is 1\\-4000 seconds\\. The default is 60 seconds\\.\n+ `routing.http.desync_mitigation_mode` \\- Determines how the load balancer handles requests that might pose a security risk to your application\\. The possible values are `monitor`, `defensive`, and `strictest`\\. The default is `defensive`\\.\n+ `routing.http.drop_invalid_header_fields.enabled` \\- Indicates whether HTTP headers with invalid header fields are removed by the load balancer \\(`true`\\) or routed to targets \\(`false`\\)\\. The default is `false`\\.\n+ `routing.http.preserve_host_header.enabled` \\- Indicates whether the Application Load Balancer should preserve the `Host` header in the HTTP request and send it to the target without any change\\. The possible values are `true` and `false`\\. The default is `false`\\.\n+ `routing.http.x_amzn_tls_version_and_cipher_suite.enabled` \\- Indicates whether the two headers \\(`x-amzn-tls-version` and `x-amzn-tls-cipher-suite`\\), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target\\. The `x-amzn-tls-version` header has information about the TLS protocol version negotiated with the client, and the `x-amzn-tls-cipher-suite` header has information about the cipher suite negotiated with the client\\. Both headers are in OpenSSL format\\. The possible values for the attribute are `true` and `false`\\. The default is `false`\\.\n+ `routing.http.xff_client_port.enabled` \\- Indicates whether the `X-Forwarded-For` header should preserve the source port that the client used to connect to the load balancer\\. The possible values are `true` and `false`\\. The default is `false`\\.\n+ `routing.http.xff_header_processing.mode` \\- Enables you to modify, preserve, or remove the `X-Forwarded-For` header in the HTTP request before the Application Load Balancer sends the request to the target\\. The possible values are `append`, `preserve`, and `remove`\\. The default is `append`\\.\n + If the value is `append`, the Application Load Balancer adds the client IP address \\(of the last hop\\) to the `X-Forwarded-For` header in the HTTP request before it sends it to targets\\.\n + If the value is `preserve` the Application Load Balancer preserves the `X-Forwarded-For` header in the HTTP request, and sends it to targets without any change\\.\n + If the value is `remove`, the Application Load Balancer removes the `X-Forwarded-For` header in the HTTP request before it sends it to targets\\.\n+ `routing.http2.enabled` \\- Indicates whether HTTP/2 is enabled\\. The possible values are `true` and `false`\\. The default is `true`\\. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens\\.\n+ `waf.fail_open.enabled` \\- Indicates whether to allow a WAF\\-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF\\. The possible values are `true` and `false`\\. The default is `false`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, @@ -74940,7 +76537,7 @@ "type": "boolean" }, "HealthCheckIntervalSeconds": { - "markdownDescription": "The approximate amount of time, in seconds, between health checks of an individual target\\. If the target group protocol is HTTP or HTTPS, the default is 30 seconds\\. If the target group protocol is TCP, TLS, UDP, or TCP\\_UDP, the supported values are 10 and 30 seconds and the default is 30 seconds\\. If the target group protocol is GENEVE, the default is 10 seconds\\. If the target type is `lambda`, the default is 35 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `5` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The approximate amount of time, in seconds, between health checks of an individual target\\. The range is 5\\-300\\. If the target group protocol is TCP, TLS, UDP, TCP\\_UDP, HTTP or HTTPS, the default is 30 seconds\\. If the target group protocol is GENEVE, the default is 10 seconds\\. If the target type is `lambda`, the default is 35 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `5` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HealthCheckIntervalSeconds", "type": "number" }, @@ -74960,12 +76557,12 @@ "type": "string" }, "HealthCheckTimeoutSeconds": { - "markdownDescription": "The amount of time, in seconds, during which no response from a target means a failed health check\\. For target groups with a protocol of HTTP, HTTPS, or GENEVE, the default is 5 seconds\\. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks\\. If the target type is `lambda`, the default is 30 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `120` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of time, in seconds, during which no response from a target means a failed health check\\. The range is 2\u2013120 seconds\\. For target groups with a protocol of HTTP, the default is 6 seconds\\. For target groups with a protocol of TCP, TLS or HTTPS, the default is 10 seconds\\. For target groups with a protocol of GENEVE, the default is 5 seconds\\. If the target type is `lambda`, the default is 30 seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `120` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HealthCheckTimeoutSeconds", "type": "number" }, "HealthyThresholdCount": { - "markdownDescription": "The number of consecutive health checks successes required before considering an unhealthy target healthy\\. For target groups with a protocol of HTTP or HTTPS, the default is 5\\. For target groups with a protocol of TCP, TLS, or GENEVE, the default is 3\\. If the target type is `lambda`, the default is 5\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of consecutive health check successes required before considering a target healthy\\. The range is 2\\-10\\. If the target group protocol is TCP, TCP\\_UDP, UDP, TLS, HTTP or HTTPS, the default is 5\\. For target groups with a protocol of GENEVE, the default is 5\\. If the target type is `lambda`, the default is 5\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HealthyThresholdCount", "type": "number" }, @@ -74976,7 +76573,7 @@ }, "Matcher": { "$ref": "#/definitions/AWS::ElasticLoadBalancingV2::TargetGroup.Matcher", - "markdownDescription": "\\[HTTP/HTTPS health checks\\] The HTTP or gRPC codes to use when checking for a successful response from a target\\. \n*Required*: No \n*Type*: [Matcher](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "\\[HTTP/HTTPS health checks\\] The HTTP or gRPC codes to use when checking for a successful response from a target\\. For target groups with a protocol of TCP, TCP\\_UDP, UDP or TLS the range is 200\\-599\\. For target groups with a protocol of HTTP or HTTPS, the range is 200\\-499\\. For target groups with a protocol of GENEVE, the range is 200\\-399\\. \n*Required*: No \n*Type*: [Matcher](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-targetgroup-matcher.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Matcher" }, "Name": { @@ -75029,7 +76626,7 @@ "type": "array" }, "UnhealthyThresholdCount": { - "markdownDescription": "The number of consecutive health check failures required before considering a target unhealthy\\. If the target group protocol is HTTP or HTTPS, the default is 2\\. If the target group protocol is TCP or TLS, this value must be the same as the healthy threshold count\\. If the target group protocol is GENEVE, the default is 3\\. If the target type is `lambda`, the default is 2\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of consecutive health check failures required before considering a target unhealthy\\. The range is 2\\-10\\. If the target group protocol is TCP, TCP\\_UDP, UDP, TLS, HTTP or HTTPS, the default is 2\\. For target groups with a protocol of GENEVE, the default is 2\\. If the target type is `lambda`, the default is 5\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UnhealthyThresholdCount", "type": "number" }, @@ -75070,7 +76667,7 @@ "type": "string" }, "HttpCode": { - "markdownDescription": "For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200\\. You can specify multiple values \\(for example, \"200,202\"\\) or a range of values \\(for example, \"200\\-299\"\\)\\. \nFor Network Load Balancers and Gateway Load Balancers, this must be \"200\u2013399\"\\. \nNote that when using shorthand syntax, some values such as commas need to be escaped\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "For Application Load Balancers, you can specify values between 200 and 499, with the default value being 200\\. You can specify multiple values \\(for example, \"200,202\"\\) or a range of values \\(for example, \"200\\-299\"\\)\\. \nFor Network Load Balancers, you can specify values between 200 and 599, with the default value being 200\\-399\\. You can specify multiple values \\(for example, \"200,202\"\\) or a range of values \\(for example, \"200\\-299\"\\)\\. \nFor Gateway Load Balancers, this must be \"200\u2013399\"\\. \nNote that when using shorthand syntax, some values such as commas need to be escaped\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HttpCode", "type": "string" } @@ -75081,7 +76678,7 @@ "additionalProperties": false, "properties": { "AvailabilityZone": { - "markdownDescription": "An Availability Zone or `all`\\. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer\\. \nThis parameter is not supported if the target type of the target group is `instance` or `alb`\\. \nIf the target type is `ip` and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional\\. If the IP address is outside the VPC, this parameter is required\\. \nWith an Application Load Balancer, if the target type is `ip` and the IP address is outside the VPC for the target group, the only supported value is `all`\\. \nIf the target type is `lambda`, this parameter is optional and the only supported value is `all`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An Availability Zone or `all`\\. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer\\. \nFor Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross\\-zone load balancing is off\\. Otherwise the parameter is ignored and treated as `all`\\. \nThis parameter is not supported if the target type of the target group is `instance` or `alb`\\. \nIf the target type is `ip` and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional\\. If the IP address is outside the VPC, this parameter is required\\. \nFor Application Load Balancer target groups with cross\\-zone load balancing off, if the target type is `ip` and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group\\. \nIf the target type is `lambda`, this parameter is optional and the only supported value is `all`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AvailabilityZone", "type": "string" }, @@ -75105,7 +76702,7 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The name of the attribute\\. \nThe following attribute is supported by all load balancers: \n+ `deregistration_delay.timeout_seconds` \\- The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from `draining` to `unused`\\. The range is 0\\-3600 seconds\\. The default value is 300 seconds\\. If the target is a Lambda function, this attribute is not supported\\.\nThe following attributes are supported by both Application Load Balancers and Network Load Balancers: \n+ `stickiness.enabled` \\- Indicates whether sticky sessions are enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `stickiness.type` \\- The type of sticky sessions\\. The possible values are `lb_cookie` and `app_cookie` for Application Load Balancers or `source_ip` for Network Load Balancers\\.\nThe following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address: \n+ `load_balancing.algorithm.type` \\- The load balancing algorithm determines how the load balancer selects targets when routing requests\\. The value is `round_robin` or `least_outstanding_requests`\\. The default is `round_robin`\\.\n+ `slow_start.duration_seconds` \\- The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group\\. After this time period ends, the target receives its full share of traffic\\. The range is 30\\-900 seconds \\(15 minutes\\)\\. The default is 0 seconds \\(disabled\\)\\.\n+ `stickiness.app_cookie.cookie_name` \\- Indicates the name of the application\\-based cookie\\. Names that start with the following prefixes are not allowed: `AWSALB`, `AWSALBAPP`, and `AWSALBTG`; they're reserved for use by the load balancer\\.\n+ `stickiness.app_cookie.duration_seconds` \\- The time period, in seconds, during which requests from a client should be routed to the same target\\. After this time period expires, the application\\-based cookie is considered stale\\. The range is 1 second to 1 week \\(604800 seconds\\)\\. The default value is 1 day \\(86400 seconds\\)\\.\n+ `stickiness.lb_cookie.duration_seconds` \\- The time period, in seconds, during which requests from a client should be routed to the same target\\. After this time period expires, the load balancer\\-generated cookie is considered stale\\. The range is 1 second to 1 week \\(604800 seconds\\)\\. The default value is 1 day \\(86400 seconds\\)\\.\nThe following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function: \n+ `lambda.multi_value_headers.enabled` \\- Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings\\. The value is `true` or `false`\\. The default is `false`\\. If the value is `false` and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client\\.\nThe following attributes are supported only by Network Load Balancers: \n+ `deregistration_delay.connection_termination.enabled` \\- Indicates whether the load balancer terminates connections at the end of the deregistration timeout\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `preserve_client_ip.enabled` \\- Indicates whether client IP preservation is enabled\\. The value is `true` or `false`\\. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS\\. Otherwise, the default is enabled\\. Client IP preservation cannot be disabled for UDP and TCP\\_UDP target groups\\.\n+ `proxy_protocol_v2.enabled` \\- Indicates whether Proxy Protocol version 2 is enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the attribute\\. \nThe following attributes are supported by all load balancers: \n+ `deregistration_delay.timeout_seconds` \\- The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from `draining` to `unused`\\. The range is 0\\-3600 seconds\\. The default value is 300 seconds\\. If the target is a Lambda function, this attribute is not supported\\.\n+ `stickiness.enabled` \\- Indicates whether target stickiness is enabled\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `stickiness.type` \\- Indicates the type of stickiness\\. The possible values are:\n + `lb_cookie` and `app_cookie` for Application Load Balancers\\.\n + `source_ip` for Network Load Balancers\\.\n + `source_ip_dest_ip` and `source_ip_dest_ip_proto` for Gateway Load Balancers\\.\nThe following attributes are supported by Application Load Balancers and Network Load Balancers: \n+ `load_balancing.cross_zone.enabled` \\- Indicates whether cross zone load balancing is enabled\\. The value is `true`, `false` or `use_load_balancer_configuration`\\. The default is `use_load_balancer_configuration`\\.\n+ `target_group_health.dns_failover.minimum_healthy_targets.count` \\- The minimum number of targets that must be healthy\\. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones\\. The possible values are `off` or an integer from 1 to the maximum number of targets\\. The default is `off`\\.\n+ `target_group_health.dns_failover.minimum_healthy_targets.percentage` \\- The minimum percentage of targets that must be healthy\\. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones\\. The possible values are `off` or an integer from 1 to 100\\. The default is `off`\\.\n+ `target_group_health.unhealthy_state_routing.minimum_healthy_targets.count` \\- The minimum number of targets that must be healthy\\. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets\\. The possible values are 1 to the maximum number of targets\\. The default is 1\\.\n+ `target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage` \\- The minimum percentage of targets that must be healthy\\. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets\\. The possible values are `off` or an integer from 1 to 100\\. The default is `off`\\.\nThe following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address: \n+ `load_balancing.algorithm.type` \\- The load balancing algorithm determines how the load balancer selects targets when routing requests\\. The value is `round_robin` or `least_outstanding_requests`\\. The default is `round_robin`\\.\n+ `slow_start.duration_seconds` \\- The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group\\. After this time period ends, the target receives its full share of traffic\\. The range is 30\\-900 seconds \\(15 minutes\\)\\. The default is 0 seconds \\(disabled\\)\\.\n+ `stickiness.app_cookie.cookie_name` \\- Indicates the name of the application\\-based cookie\\. Names that start with the following prefixes are not allowed: `AWSALB`, `AWSALBAPP`, and `AWSALBTG`; they're reserved for use by the load balancer\\.\n+ `stickiness.app_cookie.duration_seconds` \\- The time period, in seconds, during which requests from a client should be routed to the same target\\. After this time period expires, the application\\-based cookie is considered stale\\. The range is 1 second to 1 week \\(604800 seconds\\)\\. The default value is 1 day \\(86400 seconds\\)\\.\n+ `stickiness.lb_cookie.duration_seconds` \\- The time period, in seconds, during which requests from a client should be routed to the same target\\. After this time period expires, the load balancer\\-generated cookie is considered stale\\. The range is 1 second to 1 week \\(604800 seconds\\)\\. The default value is 1 day \\(86400 seconds\\)\\. \nThe following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function: \n+ `lambda.multi_value_headers.enabled` \\- Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings\\. The value is `true` or `false`\\. The default is `false`\\. If the value is `false` and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client\\.\nThe following attributes are supported only by Network Load Balancers: \n+ `deregistration_delay.connection_termination.enabled` \\- Indicates whether the load balancer terminates connections at the end of the deregistration timeout\\. The value is `true` or `false`\\. The default is `false`\\.\n+ `preserve_client_ip.enabled` \\- Indicates whether client IP preservation is enabled\\. The value is `true` or `false`\\. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS\\. Otherwise, the default is enabled\\. Client IP preservation cannot be disabled for UDP and TCP\\_UDP target groups\\.\n+ `proxy_protocol_v2.enabled` \\- Indicates whether Proxy Protocol version 2 is enabled\\. The value is `true` or `false`\\. The default is `false`\\. \nThe following attributes are supported only by Gateway Load Balancers: \n+ `target_failover.on_deregistration` \\- Indicates how the Gateway Load Balancer handles existing flows when a target is deregistered\\. The possible values are `rebalance` and `no_rebalance`\\. The default is `no_rebalance`\\. The two attributes \\(`target_failover.on_deregistration` and `target_failover.on_unhealthy`\\) can't be set independently\\. The value you set for both attributes must be the same\\. \n+ `target_failover.on_unhealthy` \\- Indicates how the Gateway Load Balancer handles existing flows when a target is unhealthy\\. The possible values are `rebalance` and `no_rebalance`\\. The default is `no_rebalance`\\. The two attributes \\(`target_failover.on_deregistration` and `target_failover.on_unhealthy`\\) cannot be set independently\\. The value you set for both attributes must be the same\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9._]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, @@ -75170,7 +76767,7 @@ }, "AdvancedSecurityOptions": { "$ref": "#/definitions/AWS::Elasticsearch::Domain.AdvancedSecurityOptionsInput", - "markdownDescription": "Specifies options for fine\\-grained access control\\. \n*Required*: No \n*Type*: [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies options for fine\\-grained access control\\. \n*Required*: No \n*Type*: [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-advancedsecurityoptionsinput.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "AdvancedSecurityOptions" }, "CognitoOptions": { @@ -75184,7 +76781,7 @@ "title": "DomainEndpointOptions" }, "DomainName": { - "markdownDescription": "A name for the OpenSearch Service domain\\. For valid values, see the [DomainName](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname) data type in the *Amazon OpenSearch Service Developer Guide*\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A name for the OpenSearch Service domain\\. For valid values, see the [DomainName](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname) data type in the *Amazon OpenSearch Service Developer Guide*\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nIf you specify a name, you cannot perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DomainName", "type": "string" }, @@ -75269,6 +76866,8 @@ "additionalProperties": false, "properties": { "AnonymousAuthEnabled": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AnonymousAuthEnabled", "type": "boolean" }, "Enabled": { @@ -75298,17 +76897,17 @@ "type": "boolean" }, "IdentityPoolId": { - "markdownDescription": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. Required if you enable Cognito authentication\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdentityPoolId", "type": "string" }, "RoleArn": { - "markdownDescription": "The `AmazonESCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The `AmazonESCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool\\. Required if you enable Cognito authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RoleArn", "type": "string" }, "UserPoolId": { - "markdownDescription": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. Required if you enable Cognito authentication\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UserPoolId", "type": "string" } @@ -75330,12 +76929,12 @@ "additionalProperties": false, "properties": { "CustomEndpoint": { - "markdownDescription": "The fully qualified URL for your custom endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The fully qualified URL for your custom endpoint\\. Required if you enabled a custom endpoint for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomEndpoint", "type": "string" }, "CustomEndpointCertificateArn": { - "markdownDescription": "The AWS Certificate Manager ARN for your domain's SSL/TLS certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS Certificate Manager ARN for your domain's SSL/TLS certificate\\. Required if you enabled a custom endpoint for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomEndpointCertificateArn", "type": "string" }, @@ -75366,7 +76965,7 @@ "type": "boolean" }, "Iops": { - "markdownDescription": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. This property applies only to the Provisioned IOPS \\(SSD\\) EBS volume type\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. This property applies only to provisioned IOPS EBS volume types\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Iops", "type": "number" }, @@ -75417,7 +77016,7 @@ "type": "string" }, "WarmCount": { - "markdownDescription": "The number of warm nodes in the cluster\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of warm nodes in the cluster\\. Required if you enable warm storage\\. \n*Required*: Conditional \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WarmCount", "type": "number" }, @@ -75427,13 +77026,13 @@ "type": "boolean" }, "WarmType": { - "markdownDescription": "The instance type for the cluster's warm nodes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The instance type for the cluster's warm nodes\\. Required if you enable warm storage\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WarmType", "type": "string" }, "ZoneAwarenessConfig": { "$ref": "#/definitions/AWS::Elasticsearch::Domain.ZoneAwarenessConfig", - "markdownDescription": "Specifies zone awareness configuration options\\. Only use if `ZoneAwarenessEnabled` is `true`\\. \n*Required*: No \n*Type*: [ZoneAwarenessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies zone awareness configuration options\\. Only use if `ZoneAwarenessEnabled` is `true`\\. \n*Required*: Conditional \n*Type*: [ZoneAwarenessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-zoneawarenessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ZoneAwarenessConfig" }, "ZoneAwarenessEnabled": { @@ -75453,7 +77052,7 @@ "type": "boolean" }, "KmsKeyId": { - "markdownDescription": "The KMS key ID\\. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The KMS key ID\\. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`\\. Required if you enable encryption at rest\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" } @@ -75464,7 +77063,7 @@ "additionalProperties": false, "properties": { "CloudWatchLogsLogGroupArn": { - "markdownDescription": "Specifies the CloudWatch log group to publish to\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the CloudWatch log group to publish to\\. Required if you enable log publishing for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchLogsLogGroupArn", "type": "string" }, @@ -75480,17 +77079,17 @@ "additionalProperties": false, "properties": { "MasterUserARN": { - "markdownDescription": "ARN for the master user\\. Only specify if `InternalUserDatabaseEnabled` is false in `AdvancedSecurityOptions`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "ARN for the master user\\. Only specify if `InternalUserDatabaseEnabled` is false in `AdvancedSecurityOptions`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserARN", "type": "string" }, "MasterUserName": { - "markdownDescription": "Username for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Username for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserName", "type": "string" }, "MasterUserPassword": { - "markdownDescription": "Password for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Password for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserPassword", "type": "string" } @@ -75534,7 +77133,7 @@ "items": { "type": "string" }, - "markdownDescription": "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*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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*\\. \nRequired if you're creating your domain inside a VPC\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SubnetIds", "type": "array" } @@ -76858,7 +78457,7 @@ "items": { "$ref": "#/definitions/AWS::Events::Rule.Target" }, - "markdownDescription": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule\\. \nTargets are the resources that are invoked when a rule is triggered\\. \nEach rule can have up to five \\(5\\) targets associated with it at one time\\.\nYou can configure the following as targets for Events: \n+ [API destination](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) \n+ [API Gateway](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html) \n+ Batch job queue\n+ CloudWatch group\n+ CodeBuild project\n+ CodePipeline\n+ EC2 `CreateSnapshot` API call\n+ EC2 Image Builder\n+ EC2 `RebootInstances` API call\n+ EC2 `StopInstances` API call\n+ EC2 `TerminateInstances` API call\n+ ECS task\n+ [Event bus in a different account or Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cross-account.html) \n+ [Event bus in the same account and Region](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-bus-to-bus.html) \n+ Firehose delivery stream\n+ Glue workflow\n+ [Incident Manager response plan](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html#incident-tracking-auto-eventbridge) \n+ Inspector assessment template\n+ Kinesis stream\n+ Lambda function\n+ Redshift cluster\n+ SageMaker Pipeline\n+ SNS topic\n+ SQS queue\n+ Step Functions state machine\n+ Systems Manager Automation\n+ Systems Manager OpsItem\n+ Systems Manager Run Command\nCreating rules with built\\-in targets is supported only in the AWS Management Console\\. The built\\-in targets are `EC2 CreateSnapshot API call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`, and `EC2 TerminateInstances API call`\\. \nFor some target types, `PutTargets` provides target\\-specific parameters\\. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument\\. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field\\. \nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions\\. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource\\-based policies\\. For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets`\\. For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide*\\. \nIf another AWS account is in the same region and has granted you permission \\(using `PutPermission`\\), you can send events to that account\\. Set that account's event bus as a target of the rules in your account\\. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets`\\. If your account sends events to another account, your account is charged for each sent event\\. Each event sent to another account is charged as a custom event\\. The account receiving the event is not charged\\. For more information, see [Amazon EventBridge Pricing](http://aws.amazon.com/eventbridge/pricing/)\\. \n `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account\\.\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure\\. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*\\. \nFor more information about enabling cross\\-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html)\\. \n **Input**, **InputPath**, and **InputTransformer** are mutually exclusive and optional parameters of a target\\. When a rule is triggered due to a matched event: \n+ If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format \\(unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target\\)\\.\n+ If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant\\.\n+ If **InputPath** is specified in the form of JSONPath \\(for example, `$.detail`\\), then only the part of the event specified in the path is passed to the target \\(for example, only the detail part of the event is passed\\)\\.\n+ If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target\\.\nWhen you specify `InputPath` or `InputTransformer`, you must use JSON dot notation, not bracket notation\\. \nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked\\. Allow a short period of time for changes to take effect\\. \nThis action can partially fail if too many requests are made at the same time\\. If that happens, `FailedEntryCount` is non\\-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code\\. \n*Required*: No \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule\\. \nTargets are the resources that are invoked when a rule is triggered\\. \nThe maximum number of entries per request is 10\\. \nEach rule can have up to five \\(5\\) targets associated with it at one time\\.\nFor a list of services you can configure as targets for events, see [EventBridge targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html) in the *Amazon EventBridge User Guide*\\. \nCreating rules with built\\-in targets is supported only in the AWS Management Console\\. The built\\-in targets are: \n+ `Amazon EBS CreateSnapshot API call` \n+ `Amazon EC2 RebootInstances API call` \n+ `Amazon EC2 StopInstances API call` \n+ `Amazon EC2 TerminateInstances API call` \nFor some target types, `PutTargets` provides target\\-specific parameters\\. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the `KinesisParameters` argument\\. To invoke a command on multiple EC2 instances with one rule, you can use the `RunCommandParameters` field\\. \nTo be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions: \n+ For AWS Lambda and Amazon SNS resources, EventBridge relies on resource\\-based policies\\.\n+ For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets`\\.\nFor more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the *Amazon EventBridge User Guide*\\. \nIf another AWS account is in the same region and has granted you permission \\(using `PutPermission`\\), you can send events to that account\\. Set that account's event bus as a target of the rules in your account\\. To send the matched events to the other account, specify that account's event bus as the `Arn` value when you run `PutTargets`\\. If your account sends events to another account, your account is charged for each sent event\\. Each event sent to another account is charged as a custom event\\. The account receiving the event is not charged\\. For more information, see [Amazon EventBridge Pricing](http://aws.amazon.com/eventbridge/pricing/)\\. \n `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account\\.\nIf you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure\\. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*\\. \nFor more information about enabling cross\\-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html)\\. \n **Input**, **InputPath**, and **InputTransformer** are mutually exclusive and optional parameters of a target\\. When a rule is triggered due to a matched event: \n+ If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format \\(unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target\\)\\.\n+ If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant\\.\n+ If **InputPath** is specified in the form of JSONPath \\(for example, `$.detail`\\), then only the part of the event specified in the path is passed to the target \\(for example, only the detail part of the event is passed\\)\\.\n+ If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target\\.\nWhen you specify `InputPath` or `InputTransformer`, you must use JSON dot notation, not bracket notation\\. \nWhen you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked\\. Allow a short period of time for changes to take effect\\. \nThis action can partially fail if too many requests are made at the same time\\. If that happens, `FailedEntryCount` is non\\-zero in the response and each entry in `FailedEntries` provides the ID of the failed target and the error code\\. \n*Required*: No \n*Type*: List of [Target](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Targets", "type": "array" } @@ -77530,10 +79129,14 @@ "type": "string" }, "RemoveSegment": { + "markdownDescription": "Set this to `true` to remove the segment that is associated with this experiment\\. You can't use this parameter if the experiment is currently running\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RemoveSegment", "type": "boolean" }, "RunningStatus": { - "$ref": "#/definitions/AWS::Evidently::Experiment.RunningStatusObject" + "$ref": "#/definitions/AWS::Evidently::Experiment.RunningStatusObject", + "markdownDescription": "A structure that you can use to start and stop the experiment\\. \n*Required*: No \n*Type*: [RunningStatusObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RunningStatus" }, "SamplingRate": { "markdownDescription": "The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent\\. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature\\. \nThis is represented in thousandths of a percent\\. For example, specify 10,000 to allocate 10% of the available audience\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -77541,6 +79144,8 @@ "type": "number" }, "Segment": { + "markdownDescription": "Specifies an audience *segment* to use in the experiment\\. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment\\. \nFor more information, see [ Segment rule pattern syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments-syntax.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Segment", "type": "string" }, "Tags": { @@ -77604,7 +79209,7 @@ "type": "string" }, "EventPattern": { - "markdownDescription": "The EventBridge event pattern that defines how the metric is recorded\\. \nFor more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The EventBridge event pattern that defines how the metric is recorded\\. \nFor more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventPattern", "type": "string" }, @@ -77655,15 +79260,23 @@ "additionalProperties": false, "properties": { "AnalysisCompleteTime": { + "markdownDescription": "If you are using AWS CloudFormation to start the experiment, use this field to specify when the experiment is to end\\. The format is as a UNIX timestamp\\. For more information about this format, see [The Current Epoch Unix Timestamp](https://www.unixtimestamp.com/index.php)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AnalysisCompleteTime", "type": "string" }, "DesiredState": { + "markdownDescription": "If you are using AWS CloudFormation to stop this experiment, specify either `COMPLETED` or `CANCELLED` here to indicate how to classify this experiment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DesiredState", "type": "string" }, "Reason": { + "markdownDescription": "If you are using AWS CloudFormation to stop this experiment, this is an optional field that you can use to record why the experiment is being stopped or cancelled\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Reason", "type": "string" }, "Status": { + "markdownDescription": "To start the experiment now, specify `START` for this parameter\\. If this experiment is currently running and you want to stop it now, specify `STOP`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" } }, @@ -77876,7 +79489,7 @@ "type": "string" }, "VariationName": { - "markdownDescription": "A name for the variation\\. It can include up to 127 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A name for the variation\\. It can include up to 127 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VariationName", "type": "string" } @@ -77927,7 +79540,9 @@ "type": "string" }, "ExecutionStatus": { - "$ref": "#/definitions/AWS::Evidently::Launch.ExecutionStatusObject" + "$ref": "#/definitions/AWS::Evidently::Launch.ExecutionStatusObject", + "markdownDescription": "A structure that you can use to start and stop the launch\\. \n*Required*: No \n*Type*: [ExecutionStatusObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-executionstatusobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExecutionStatus" }, "Groups": { "items": { @@ -78010,12 +79625,18 @@ "additionalProperties": false, "properties": { "DesiredState": { + "markdownDescription": "If you are using AWS CloudFormation to stop this launch, specify either `COMPLETED` or `CANCELLED` here to indicate how to classify this experiment\\. If you omit this parameter, the default of `COMPLETED` is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DesiredState", "type": "string" }, "Reason": { + "markdownDescription": "If you are using AWS CloudFormation to stop this launch, this is an optional field that you can use to record why the launch is being stopped or cancelled\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Reason", "type": "string" }, "Status": { + "markdownDescription": "To start the launch now, specify `START` for this parameter\\. If this launch is currently running and you want to stop it now, specify `STOP`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" } }, @@ -78084,7 +79705,7 @@ "type": "string" }, "EventPattern": { - "markdownDescription": "The EventBridge event pattern that defines how the metric is recorded\\. \nFor more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The EventBridge event pattern that defines how the metric is recorded\\. \nFor more information about EventBridge event patterns, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventPattern", "type": "string" }, @@ -78115,15 +79736,21 @@ "additionalProperties": false, "properties": { "EvaluationOrder": { + "markdownDescription": "A number indicating the order to use to evaluate segment overrides, if there are more than one\\. Segment overrides with lower numbers are evaluated first\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EvaluationOrder", "type": "number" }, "Segment": { + "markdownDescription": "The ARN of the segment to use for this override\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Segment", "type": "string" }, "Weights": { "items": { "$ref": "#/definitions/AWS::Evidently::Launch.GroupToWeight" }, + "markdownDescription": "The traffic allocation percentages among the feature variations to assign to this segment\\. This is a set of key\\-value pairs\\. The keys are variation names\\. The values represent the amount of traffic to allocate to that variation for this segment\\. This is expressed in thousandths of a percent, so a weight of 50000 represents 50% of traffic\\. \n*Required*: Yes \n*Type*: List of [GroupToWeight](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-grouptoweight.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Weights", "type": "array" } }, @@ -78149,6 +79776,8 @@ "items": { "$ref": "#/definitions/AWS::Evidently::Launch.SegmentOverride" }, + "markdownDescription": "An array of structures that you can use to specify different traffic splits for one or more audience *segments*\\. A segment is a portion of your audience that share one or more characteristics\\. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age\\. \nFor more information, see [ Use segments to focus your audience](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html)\\. \n*Required*: No \n*Type*: List of [SegmentOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-segmentoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SegmentOverrides", "type": "array" }, "StartTime": { @@ -78199,7 +79828,9 @@ "additionalProperties": false, "properties": { "AppConfigResource": { - "$ref": "#/definitions/AWS::Evidently::Project.AppConfigResourceObject" + "$ref": "#/definitions/AWS::Evidently::Project.AppConfigResourceObject", + "markdownDescription": "Use this parameter if the project will use *client\\-side evaluation powered by AWS AppConfig*\\. Client\\-side evaluation allows your application to assign variations to user sessions locally instead of by calling the [EvaluateFeature](https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html) operation\\. This mitigates the latency and availability risks that come with an API call\\. For more information, see [ Use client\\-side evaluation \\- powered by AWS AppConfig\\.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-client-side-evaluation.html) \nThis parameter is a structure that contains information about the AWS AppConfig application that will be used as for client\\-side evaluation\\. \nTo create a project that uses client\\-side evaluation, you must have the `evidently:ExportProjectAsConfiguration` permission\\. \n*Required*: No \n*Type*: [AppConfigResourceObject](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-appconfigresourceobject.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppConfigResource" }, "DataDelivery": { "$ref": "#/definitions/AWS::Evidently::Project.DataDeliveryObject", @@ -78255,9 +79886,13 @@ "additionalProperties": false, "properties": { "ApplicationId": { + "markdownDescription": "The ID of the AWS AppConfig application to use for client\\-side evaluation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApplicationId", "type": "string" }, "EnvironmentId": { + "markdownDescription": "The ID of the AWS AppConfig environment to use for client\\-side evaluation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnvironmentId", "type": "string" } }, @@ -78338,18 +79973,26 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "An optional description for this segment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A name for the segment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Pattern": { + "markdownDescription": "The pattern to use for the segment\\. For more information about pattern syntax, see [ Segment rule pattern syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments-syntax.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pattern", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Assigns one or more tags \\(key\\-value pairs\\) to the feature\\. \nTags can help you organize and categorize your resources\\. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values\\. \nTags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters\\. \nYou can associate as many as 50 tags with a feature\\. \nFor more information, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -78505,6 +80148,8 @@ "additionalProperties": false, "properties": { "LogGroupArn": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogGroupArn", "type": "string" } }, @@ -78567,7 +80212,7 @@ "properties": { "CloudWatchLogsConfiguration": { "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.CloudWatchLogsConfiguration", - "markdownDescription": "The configuration for experiment logging to Amazon CloudWatch Logs\\. The supported field is `logGroupArn`\\. For example: \n`{\"logGroupArn\": \"aws:arn:logs:region_name:account_id:log-group:log_group_name\"}` \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The configuration for experiment logging to Amazon CloudWatch Logs\\. The supported field is `LogGroupArn`\\. For example: \n`{\"LogGroupArn\": \"aws:arn:logs:region_name:account_id:log-group:log_group_name\"}` \n*Required*: No \n*Type*: [CloudWatchLogsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-cloudwatchlogsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchLogsConfiguration" }, "LogSchemaVersion": { @@ -78577,7 +80222,7 @@ }, "S3Configuration": { "$ref": "#/definitions/AWS::FIS::ExperimentTemplate.S3Configuration", - "markdownDescription": "The configuration for experiment logging to Amazon S3\\. The following fields are supported: \n+ `bucketName` \\- The name of the destination bucket\\.\n+ `prefix` \\- An optional bucket prefix\\.\nFor example: \n`{\"bucketName\": \"my-s3-bucket\", \"prefix\": \"log-folder\"}` \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The configuration for experiment logging to Amazon S3\\. The following fields are supported: \n+ `bucketName` \\- The name of the destination bucket\\.\n+ `prefix` \\- An optional bucket prefix\\.\nFor example: \n`{\"BucketName\": \"my-s3-bucket\", \"Prefix\": \"log-folder\"}` \n*Required*: No \n*Type*: [S3Configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fis-experimenttemplate-s3configuration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3Configuration" } }, @@ -78690,9 +80335,13 @@ "additionalProperties": false, "properties": { "BucketName": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketName", "type": "string" }, "Prefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Prefix", "type": "string" } }, @@ -78830,6 +80479,8 @@ "title": "IncludeMap" }, "PolicyDescription": { + "markdownDescription": "The definition of the AWS Network Firewall firewall policy\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyDescription", "type": "string" }, "PolicyName": { @@ -78846,6 +80497,8 @@ "items": { "type": "string" }, + "markdownDescription": "The unique identifiers of the resource sets used by the policy\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceSetIds", "type": "array" }, "ResourceTags": { @@ -78857,7 +80510,7 @@ "type": "array" }, "ResourceType": { - "markdownDescription": "The type of resource protected by or in scope of the policy\\. This is in the format shown in the [AWS Resource Types Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)\\. To apply this policy to multiple resource types, specify a resource type of `ResourceTypeList` and then specify the resource types in a `ResourceTypeList`\\. \nFor AWS WAF and Shield Advanced, example resource types include `AWS::ElasticLoadBalancingV2::LoadBalancer` and `AWS::CloudFront::Distribution`\\. For a security group common policy, valid values are `AWS::EC2::NetworkInterface` and `AWS::EC2::Instance`\\. For a security group content audit policy, valid values are `AWS::EC2::SecurityGroup`, `AWS::EC2::NetworkInterface`, and `AWS::EC2::Instance`\\. For a security group usage audit policy, the value is `AWS::EC2::SecurityGroup`\\. For an AWS Network Firewall policy or DNS Firewall policy, the value is `AWS::EC2::VPC`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of resource protected by or in scope of the policy\\. This is in the format shown in the [AWS Resource Types Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)\\. To apply this policy to multiple resource types, specify a resource type of `ResourceTypeList` and then specify the resource types in a `ResourceTypeList`\\. \nFor AWS WAF and Shield Advanced, example resource types include `AWS::ElasticLoadBalancingV2::LoadBalancer` and `AWS::CloudFront::Distribution`\\. For a security group common policy, valid values are `AWS::EC2::NetworkInterface` and `AWS::EC2::Instance`\\. For a security group content audit policy, valid values are `AWS::EC2::SecurityGroup`, `AWS::EC2::NetworkInterface`, and `AWS::EC2::Instance`\\. For a security group usage audit policy, the value is `AWS::EC2::SecurityGroup`\\. For an AWS Network Firewall policy or DNS Firewall policy, the value is `AWS::EC2::VPC`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceType", "type": "string" }, @@ -78943,6 +80596,8 @@ "additionalProperties": false, "properties": { "FirewallDeploymentModel": { + "markdownDescription": "Defines the deployment model to use for the firewall policy\\. To use a distributed model, set [PolicyOption](https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_PolicyOption.html) to `NULL`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CENTRALIZED | DISTRIBUTED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FirewallDeploymentModel", "type": "string" } }, @@ -78955,10 +80610,14 @@ "additionalProperties": false, "properties": { "NetworkFirewallPolicy": { - "$ref": "#/definitions/AWS::FMS::Policy.NetworkFirewallPolicy" + "$ref": "#/definitions/AWS::FMS::Policy.NetworkFirewallPolicy", + "markdownDescription": "Defines the deployment model to use for the firewall policy\\. \n*Required*: No \n*Type*: [NetworkFirewallPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-networkfirewallpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkFirewallPolicy" }, "ThirdPartyFirewallPolicy": { - "$ref": "#/definitions/AWS::FMS::Policy.ThirdPartyFirewallPolicy" + "$ref": "#/definitions/AWS::FMS::Policy.ThirdPartyFirewallPolicy", + "markdownDescription": "Defines the policy options for a third\\-party firewall policy\\. \n*Required*: No \n*Type*: [ThirdPartyFirewallPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-thirdpartyfirewallpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ThirdPartyFirewallPolicy" } }, "type": "object" @@ -79006,12 +80665,18 @@ "additionalProperties": false, "properties": { "ManagedServiceData": { + "markdownDescription": "Details about the service that are specific to the service type, in JSON format\\. \n+ Example: `DNS_FIREWALL`", + "title": "ManagedServiceData", "type": "string" }, "PolicyOption": { - "$ref": "#/definitions/AWS::FMS::Policy.PolicyOption" + "$ref": "#/definitions/AWS::FMS::Policy.PolicyOption", + "markdownDescription": "Contains the Network Firewall firewall policy options to configure a centralized deployment model\\. \n*Required*: No \n*Type*: [PolicyOption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fms-policy-policyoption.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyOption" }, "Type": { + "markdownDescription": "The service that the policy is using to protect the resources\\. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy\\. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy\\. This is an adjustable limit that you can increase by contacting AWS Support\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DNS_FIREWALL | IMPORT_NETWORK_FIREWALL | NETWORK_FIREWALL | SECURITY_GROUPS_COMMON | SECURITY_GROUPS_CONTENT_AUDIT | SECURITY_GROUPS_USAGE_AUDIT | SHIELD_ADVANCED | THIRD_PARTY_FIREWALL | WAF | WAFV2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -79024,6 +80689,8 @@ "additionalProperties": false, "properties": { "FirewallDeploymentModel": { + "markdownDescription": "Defines the deployment model to use for the third\\-party firewall policy\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CENTRALIZED | DISTRIBUTED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FirewallDeploymentModel", "type": "string" } }, @@ -79032,6 +80699,93 @@ ], "type": "object" }, + "AWS::FMS::ResourceSet": { + "additionalProperties": false, + "properties": { + "Condition": { + "type": "string" + }, + "DeletionPolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + }, + "DependsOn": { + "anyOf": [ + { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + { + "items": { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "type": "array" + } + ] + }, + "Metadata": { + "type": "object" + }, + "Properties": { + "additionalProperties": false, + "properties": { + "Description": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "ResourceTypeList": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Resources": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "required": [ + "Name", + "ResourceTypeList" + ], + "type": "object" + }, + "Type": { + "enum": [ + "AWS::FMS::ResourceSet" + ], + "type": "string" + }, + "UpdateReplacePolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Properties" + ], + "type": "object" + }, "AWS::FSx::DataRepositoryAssociation": { "additionalProperties": false, "properties": { @@ -79068,27 +80822,41 @@ "additionalProperties": false, "properties": { "BatchImportMetaDataOnCreate": { + "markdownDescription": "A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created\\. The task runs if this flag is set to `true`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BatchImportMetaDataOnCreate", "type": "boolean" }, "DataRepositoryPath": { + "markdownDescription": "The path to the Amazon S3 data repository that will be linked to the file system\\. The path can be an S3 bucket or prefix in the format `s3://myBucket/myPrefix/`\\. This path specifies where in the S3 data repository files will be imported from or exported to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataRepositoryPath", "type": "string" }, "FileSystemId": { + "markdownDescription": "The ID of the file system on which the data repository association is configured\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemId", "type": "string" }, "FileSystemPath": { + "markdownDescription": "A path on the Amazon FSx for Lustre file system that points to a high\\-level directory \\(such as `/ns1/`\\) or subdirectory \\(such as `/ns1/subdir/`\\) that will be mapped 1\\-1 with `DataRepositoryPath`\\. The leading forward slash in the name is required\\. Two data repository associations cannot have overlapping file system paths\\. For example, if a data repository is associated with file system path `/ns1/`, then you cannot link another data repository with file system path `/ns1/ns2`\\. \nThis path specifies where in your file system files will be exported from or imported to\\. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory\\. \nIf you specify only a forward slash \\(`/`\\) as the file system path, you can link only one data repository to the file system\\. You can only specify \"/\" as the file system path for the first data repository associated with a file system\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4096` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,4096}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemPath", "type": "string" }, "ImportedFileChunkSize": { + "markdownDescription": "For files imported from a data repository, this value determines the stripe count and maximum amount of data per file \\(in MiB\\) stored on a single physical disk\\. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache\\. \nThe default chunk size is 1,024 MiB \\(1 GiB\\) and can go as high as 512,000 MiB \\(500 GiB\\)\\. Amazon S3 objects have a maximum size of 5 TB\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `512000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImportedFileChunkSize", "type": "number" }, "S3": { - "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation.S3" + "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation.S3", + "markdownDescription": "The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association\\. The configuration defines which file events \\(new, changed, or deleted files or directories\\) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository\\. \n*Required*: No \n*Type*: [S3](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-s3.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -79127,6 +80895,8 @@ "items": { "type": "string" }, + "markdownDescription": "The `AutoExportPolicy` can have the following event values: \n+ `NEW` \\- New files and directories are automatically exported to the data repository as they are added to the file system\\.\n+ `CHANGED` \\- Changes to files and directories on the file system are automatically exported to the data repository\\.\n+ `DELETED` \\- Files and directories are automatically deleted on the data repository when they are deleted on the file system\\.\nYou can define any combination of event types for your `AutoExportPolicy`\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Events", "type": "array" } }, @@ -79142,6 +80912,8 @@ "items": { "type": "string" }, + "markdownDescription": "The `AutoImportPolicy` can have the following event values: \n+ `NEW` \\- Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system\\.\n+ `CHANGED` \\- Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository\\.\n+ `DELETED` \\- Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository\\.\nYou can define any combination of event types for your `AutoImportPolicy`\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Events", "type": "array" } }, @@ -79154,10 +80926,14 @@ "additionalProperties": false, "properties": { "AutoExportPolicy": { - "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation.AutoExportPolicy" + "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation.AutoExportPolicy", + "markdownDescription": "Describes a data repository association's automatic export policy\\. The `AutoExportPolicy` defines the types of updated objects on the file system that will be automatically exported to the data repository\\. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file\\. \nThis `AutoExportPolicy` is supported only for Amazon FSx for Lustre file systems with the `Persistent_2` deployment type\\. \n*Required*: No \n*Type*: [AutoExportPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoexportpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoExportPolicy" }, "AutoImportPolicy": { - "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation.AutoImportPolicy" + "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation.AutoImportPolicy", + "markdownDescription": "Describes the data repository association's automatic import policy\\. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket\\. \nThe `AutoImportPolicy` is supported only for Amazon FSx for Lustre file systems with the `Persistent_2` deployment type\\. \n*Required*: No \n*Type*: [AutoImportPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoimportpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoImportPolicy" } }, "type": "object" @@ -79198,7 +80974,7 @@ "additionalProperties": false, "properties": { "BackupId": { - "markdownDescription": "The ID of the source backup\\. Specifies the backup that you are copying\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the file system backup that you are using to create a file system\\. For more information, see [CreateFileSystemFromBackup](https://docs.aws.amazon.com/fsx/latest/APIReference/API_CreateFileSystemFromBackup.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "BackupId", "type": "string" }, @@ -79213,13 +80989,13 @@ "type": "string" }, "KmsKeyId": { - "markdownDescription": "The ID of the AWS Key Management Service \\(AWS KMS\\) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and `PERSISTENT` Amazon FSx for Lustre file systems at rest\\. If this ID isn't specified, the Amazon FSx\\-managed key for your account is used\\. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using the Amazon FSx\\-managed key for your account\\. For more information, see [Encrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html) in the * AWS Key Management Service API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the AWS Key Management Service \\(AWS KMS\\) key used to encrypt Amazon FSx file system data\\. Used as follows with Amazon FSx file system types: \n+ Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment types only\\.", "title": "KmsKeyId", "type": "string" }, "LustreConfiguration": { "$ref": "#/definitions/AWS::FSx::FileSystem.LustreConfiguration", - "markdownDescription": "The Lustre configuration for the file system being created\\. \nThe following parameters are not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation` to create a data repository association to link your Lustre file system to a data repository\\. \n+ `AutoImportPolicy` \n+ `ExportPath` \n+ `ImportedChunkSize` \n+ `ImportPath` \n*Required*: No \n*Type*: [LustreConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Lustre configuration for the file system being created\\. \nThe following parameters are not supported for file systems with the Lustre `Persistent_2` deployment type\\. \n+ `AutoImportPolicy` \n+ `ExportPath` \n+ `ImportedChunkSize` \n+ `ImportPath` \n*Required*: Conditional \n*Type*: [LustreConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LustreConfiguration" }, "OntapConfiguration": { @@ -79241,12 +81017,12 @@ "type": "array" }, "StorageCapacity": { - "markdownDescription": "Sets the storage capacity of the file system that you're creating\\. `StorageCapacity` is required if you are creating a new file system\\. Do not include `StorageCapacity` if you are creating a file system from a backup\\. \nFor Lustre file systems: \n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Sets the storage capacity of the file system that you're creating\\. `StorageCapacity` is required if you are creating a new file system\\. \n**FSx for Lustre file systems** \\- The amount of storage capacity that you can configure depends on the value that you set for `StorageType` and the Lustre `DeploymentType`, as follows: \n+ For `SCRATCH_2`, `PERSISTENT_2` and `PERSISTENT_1` deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB\\.\n+ For `PERSISTENT_1` HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems\\.\n+ For `SCRATCH_1` deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB\\.\n**FSx for ONTAP file systems** \\- The amount of storage capacity that you can configure is from 1024 GiB up to 196,608 GiB \\(192 TiB\\)\\. \n**FSx for OpenZFS file systems** \\- The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB \\(512 TiB\\)\\. If you are creating a file system from a backup, you can specify a storage capacity equal to or greater than the original file system's storage capacity\\. \n**FSx for Windows File Server file systems** \\- The amount of storage capacity that you can configure depends on the value that you set for `StorageType` as follows: \n+ For SSD storage, valid values are 32 GiB\\-65,536 GiB \\(64 TiB\\)\\.\n+ For HDD storage, valid values are 2000 GiB\\-65,536 GiB \\(64 TiB\\)\\.\n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StorageCapacity", "type": "number" }, "StorageType": { - "markdownDescription": "Sets the storage type for the file system that you're creating\\. Valid values are `SSD` and `HDD`\\. \n+ Set to `SSD` to use solid state drive storage\\. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types\\.\n+ Set to `HDD` to use hard disk drive storage\\. HDD is supported on `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types, and on `PERSISTENT` Lustre file system deployment types\\. \nDefault value is `SSD`\\. For more information, see [ Storage type options](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options) in the *FSx for Windows File Server User Guide* and [Multiple storage options](https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options) in the *FSx for Lustre User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HDD | SSD` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Sets the storage type for the file system that you're creating\\. Valid values are `SSD` and `HDD`\\. \n+ Set to `SSD` to use solid state drive storage\\. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types\\.\n+ Set to `HDD` to use hard disk drive storage\\. HDD is supported on `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types, and on `PERSISTENT_1` Lustre file system deployment types\\. \nDefault value is `SSD`\\. For more information, see [ Storage type options](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options) in the *FSx for Windows File Server User Guide* and [Multiple storage options](https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options) in the *FSx for Lustre User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HDD | SSD` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StorageType", "type": "string" }, @@ -79262,7 +81038,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "The tags to associate with the file system\\. For more information, see [Tagging your Amazon EC2 resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the *Amazon EC2 User Guide*\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -79363,12 +81139,12 @@ "additionalProperties": false, "properties": { "AutoImportPolicy": { - "markdownDescription": "\\(Optional\\) Available with `Scratch` and `Persistent_1` deployment types\\. When you create your file system, your existing S3 objects appear as file and directory listings\\. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket\\. `AutoImportPolicy` can have the following values: \n+ `NONE` \\- \\(Default\\) AutoImport is off\\. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created\\. FSx does not update file and directory listings for any new or changed objects after choosing this option\\.\n+ `NEW` \\- AutoImport is on\\. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system\\. \n+ `NEW_CHANGED` \\- AutoImport is on\\. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option\\.\n+ `NEW_CHANGED_DELETED` \\- AutoImport is on\\. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket\\.\nFor more information, see [ Automatically import updates from your S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html)\\. \nThis parameter is not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation` to create a data repository association to link your Lustre file system to a data repository\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `NEW | NEW_CHANGED | NEW_CHANGED_DELETED | NONE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "\\(Optional\\) Available with `Scratch` and `Persistent_1` deployment types\\. When you create your file system, your existing S3 objects appear as file and directory listings\\. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket\\. `AutoImportPolicy` can have the following values: \n+ `NONE` \\- \\(Default\\) AutoImport is off\\. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created\\. FSx does not update file and directory listings for any new or changed objects after choosing this option\\.\n+ `NEW` \\- AutoImport is on\\. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system\\. \n+ `NEW_CHANGED` \\- AutoImport is on\\. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option\\.\n+ `NEW_CHANGED_DELETED` \\- AutoImport is on\\. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket\\.\nFor more information, see [ Automatically import updates from your S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html)\\. \nThis parameter is not supported for Lustre file systems using the `Persistent_2` deployment type\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `NEW | NEW_CHANGED | NEW_CHANGED_DELETED | NONE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutoImportPolicy", "type": "string" }, "AutomaticBackupRetentionDays": { - "markdownDescription": "The number of days to retain automatic backups\\. Setting this to 0 disables automatic backups\\. You can retain automatic backups for a maximum of 90 days\\. The default is 0\\. Only valid for use with `PERSISTENT_1` deployment types\\. For more information, see [Working with backups](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html) in the *Amazon FSx for Lustre User Guide*\\. \\(Default = 0\\) \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `90` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of days to retain automatic backups\\. Setting this property to `0` disables automatic backups\\. You can retain automatic backups for a maximum of 90 days\\. The default is `0`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutomaticBackupRetentionDays", "type": "number" }, @@ -79378,7 +81154,7 @@ "type": "boolean" }, "DailyAutomaticBackupStartTime": { - "markdownDescription": "A recurring daily time, in the format` HH:MM`\\. `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. For example, `05:00` specifies 5 AM daily\\. Only valid for use with `PERSISTENT_1` deployment types\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A recurring daily time, in the format `HH:MM`\\. `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. For example, `05:00` specifies 5 AM daily\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DailyAutomaticBackupStartTime", "type": "string" }, @@ -79388,27 +81164,27 @@ "type": "string" }, "DeploymentType": { - "markdownDescription": "\\(Optional\\) Choose `SCRATCH_1` and `SCRATCH_2` deployment types when you need temporary storage and shorter\\-term processing of data\\. The `SCRATCH_2` deployment type provides in\\-transit encryption of data and higher burst throughput capacity than `SCRATCH_1`\\. \nChoose `PERSISTENT_1` for longer\\-term storage and for throughput\\-focused workloads that aren\u2019t latency\\-sensitive\\. `PERSISTENT_1` supports encryption of data in transit, and is available in all AWS Regions in which FSx for Lustre is available\\. \nChoose `PERSISTENT_2` for longer\\-term storage and for latency\\-sensitive workloads that require the highest levels of IOPS/throughput\\. `PERSISTENT_2` supports SSD storage, and offers higher `PerUnitStorageThroughput` \\(up to 1000 MB/s/TiB\\)\\. `PERSISTENT_2` is available in a limited number of AWS Regions\\. For more information, and an up\\-to\\-date list of AWS Regions in which `PERSISTENT_2` is available, see [File system deployment options for FSx for Lustre](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types) in the *Amazon FSx for Lustre User Guide*\\. \nIf you choose `PERSISTENT_2`, and you set `FileSystemTypeVersion` to `2.10`, the `CreateFileSystem` operation fails\\.\nEncryption of data in transit is automatically turned on when you access `SCRATCH_2`, `PERSISTENT_1` and `PERSISTENT_2` file systems from Amazon EC2 instances that [support automatic encryption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data- protection.html) in the AWS Regions where they are available\\. For more information about encryption in transit for FSx for Lustre file systems, see [Encrypting data in transit](https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html) in the *Amazon FSx for Lustre User Guide*\\. \n\\(Default = `SCRATCH_1`\\) \n*Required*: No \n*Type*: String \n*Allowed values*: `PERSISTENT_1 | PERSISTENT_2 | SCRATCH_1 | SCRATCH_2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\(Optional\\) Choose `SCRATCH_1` and `SCRATCH_2` deployment types when you need temporary storage and shorter\\-term processing of data\\. The `SCRATCH_2` deployment type provides in\\-transit encryption of data and higher burst throughput capacity than `SCRATCH_1`\\. \nChoose `PERSISTENT_1` for longer\\-term storage and for throughput\\-focused workloads that aren\u2019t latency\\-sensitive\\. `PERSISTENT_1` supports encryption of data in transit, and is available in all AWS Regions in which FSx for Lustre is available\\. \nChoose `PERSISTENT_2` for longer\\-term storage and for latency\\-sensitive workloads that require the highest levels of IOPS/throughput\\. `PERSISTENT_2` supports SSD storage, and offers higher `PerUnitStorageThroughput` \\(up to 1000 MB/s/TiB\\)\\. `PERSISTENT_2` is available in a limited number of AWS Regions\\. For more information, and an up\\-to\\-date list of AWS Regions in which `PERSISTENT_2` is available, see [File system deployment options for FSx for Lustre](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types) in the *Amazon FSx for Lustre User Guide*\\. \nIf you choose `PERSISTENT_2`, and you set `FileSystemTypeVersion` to `2.10`, the `CreateFileSystem` operation fails\\.\nEncryption of data in transit is automatically turned on when you access `SCRATCH_2`, `PERSISTENT_1` and `PERSISTENT_2` file systems from Amazon EC2 instances that support automatic encryption in the AWS Regions where they are available\\. For more information about encryption in transit for FSx for Lustre file systems, see [Encrypting data in transit](https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html) in the *Amazon FSx for Lustre User Guide*\\. \n\\(Default = `SCRATCH_1`\\) \n*Required*: No \n*Type*: String \n*Allowed values*: `PERSISTENT_1 | PERSISTENT_2 | SCRATCH_1 | SCRATCH_2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DeploymentType", "type": "string" }, "DriveCacheType": { - "markdownDescription": "The type of drive cache used by `PERSISTENT_1` file systems that are provisioned with HDD storage devices\\. This parameter is required when storage type is HDD\\. Set this property to `READ` to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system\\. \nThis parameter is required when `StorageType` is set to `HDD`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NONE | READ` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of drive cache used by `PERSISTENT_1` file systems that are provisioned with HDD storage devices\\. This parameter is required when storage type is HDD\\. Set this property to `READ` to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system\\. \nThis parameter is required when `StorageType` is set to `HDD` and `DeploymentType` is `PERSISTENT_1`\\. \n*Required*: Conditional \n*Type*: String \n*Allowed values*: `NONE | READ` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DriveCacheType", "type": "string" }, "ExportPath": { - "markdownDescription": "\\(Optional\\) Available with `Scratch` and `Persistent_1` deployment types\\. Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported\\. The path must use the same Amazon S3 bucket as specified in ImportPath\\. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system\\. If an `ExportPath` value is not provided, Amazon FSx sets a default export path, `s3://import-bucket/FSxLustre[creation-timestamp]`\\. The timestamp is in UTC format, for example `s3://import-bucket/FSxLustre20181105T222312Z`\\. \nThe Amazon S3 export bucket must be the same as the import bucket specified by `ImportPath`\\. If you specify only a bucket name, such as `s3://import-bucket`, you get a 1:1 mapping of file system objects to S3 bucket objects\\. This mapping means that the input data in S3 is overwritten on export\\. If you provide a custom prefix in the export path, such as `s3://import-bucket/[custom-optional-prefix]`, Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket\\. \nThis parameter is not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation` to create a data repository association to link your Lustre file system to a data repository\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\(Optional\\) Available with `Scratch` and `Persistent_1` deployment types\\. Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported\\. The path must use the same Amazon S3 bucket as specified in ImportPath\\. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system\\. If an `ExportPath` value is not provided, Amazon FSx sets a default export path, `s3://import-bucket/FSxLustre[creation-timestamp]`\\. The timestamp is in UTC format, for example `s3://import-bucket/FSxLustre20181105T222312Z`\\. \nThe Amazon S3 export bucket must be the same as the import bucket specified by `ImportPath`\\. If you specify only a bucket name, such as `s3://import-bucket`, you get a 1:1 mapping of file system objects to S3 bucket objects\\. This mapping means that the input data in S3 is overwritten on export\\. If you provide a custom prefix in the export path, such as `s3://import-bucket/[custom-optional-prefix]`, Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket\\. \nThis parameter is not supported for file systems using the `Persistent_2` deployment type\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ExportPath", "type": "string" }, "ImportPath": { - "markdownDescription": "\\(Optional\\) The path to the Amazon S3 bucket \\(including the optional prefix\\) that you're using as the data repository for your Amazon FSx for Lustre file system\\. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select\\. An example is `s3://import-bucket/optional-prefix`\\. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system\\. \nThis parameter is not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation`to create a data repository association to link your Lustre file system to a data repository\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\(Optional\\) The path to the Amazon S3 bucket \\(including the optional prefix\\) that you're using as the data repository for your Amazon FSx for Lustre file system\\. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select\\. An example is `s3://import-bucket/optional-prefix`\\. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system\\. \nThis parameter is not supported for Lustre file systems using the `Persistent_2` deployment type\\.\n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `4357` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ImportPath", "type": "string" }, "ImportedFileChunkSize": { - "markdownDescription": "\\(Optional\\) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file \\(in MiB\\) stored on a single physical disk\\. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system\\. \nThe default chunk size is 1,024 MiB \\(1 GiB\\) and can go as high as 512,000 MiB \\(500 GiB\\)\\. Amazon S3 objects have a maximum size of 5 TB\\. \nThis parameter is not supported for file systems with the `Persistent_2` deployment type\\. Instead, use `CreateDataRepositoryAssociation` to create a data repository association to link your Lustre file system to a data repository\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `512000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\(Optional\\) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file \\(in MiB\\) stored on a single physical disk\\. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system\\. \nThe default chunk size is 1,024 MiB \\(1 GiB\\) and can go as high as 512,000 MiB \\(500 GiB\\)\\. Amazon S3 objects have a maximum size of 5 TB\\. \nThis parameter is not supported for Lustre file systems using the `Persistent_2` deployment type\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `512000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ImportedFileChunkSize", "type": "number" }, @@ -79418,7 +81194,7 @@ "type": "number" }, "WeeklyMaintenanceStartTime": { - "markdownDescription": "\\(Optional\\) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A recurring weekly time, in the format `D:HH:MM`\\. \n `D` is the day of the week, for which 1 represents Monday and 7 represents Sunday\\. For further details, see [the ISO\\-8601 spec as described on Wikipedia](https://en.wikipedia.org/wiki/ISO_week_date)\\. \n `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. \nFor example, `1:05:00` specifies maintenance at 5 AM Monday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WeeklyMaintenanceStartTime", "type": "string" } @@ -79453,7 +81229,7 @@ "type": "string" }, "DeploymentType": { - "markdownDescription": "Specifies the FSx for ONTAP file system deployment type to use in creating the file system\\. `MULTI_AZ_1` is the supported ONTAP deployment type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `MULTI_AZ_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the FSx for ONTAP file system deployment type to use in creating the file system\\. \n+ `MULTI_AZ_1` \\- \\(Default\\) A high availability file system configured for Multi\\-AZ redundancy to tolerate temporary Availability Zone \\(AZ\\) unavailability\\. \n+ `SINGLE_AZ_1` \\- A file system configured for Single\\-AZ redundancy\\.\nFor information about the use cases for Multi\\-AZ and Single\\-AZ deployments, refer to [Choosing a file system deployment type](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-AZ.html)\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `MULTI_AZ_1 | SINGLE_AZ_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DeploymentType", "type": "string" }, @@ -79463,7 +81239,7 @@ "title": "DiskIopsConfiguration" }, "EndpointIpAddressRange": { - "markdownDescription": "Specifies the IP address range in which the endpoints to access your file system will be created\\. By default, Amazon FSx selects an unused IP address range for you from the 198\\.19\\.\\* range\\. \nThe Endpoint IP address range you select for your file system must exist outside the VPC's CIDR range and must be at least /30 or larger\\.\n*Required*: No \n*Type*: String \n*Minimum*: `9` \n*Maximum*: `17` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{9,17}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\(Multi\\-AZ only\\) Specifies the IP address range in which the endpoints to access your file system will be created\\. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198\\.19\\.\\* range\\. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC\u2019s primary CIDR range to use as the endpoint IP address range for the file system\\. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables\\. \n*Required*: No \n*Type*: String \n*Minimum*: `9` \n*Maximum*: `17` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{9,17}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EndpointIpAddressRange", "type": "string" }, @@ -79481,12 +81257,12 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies the virtual private cloud \\(VPC\\) route tables in which your file system's endpoints will be created\\. You should specify all VPC route tables associated with the subnets in which your clients are located\\. By default, Amazon FSx selects your VPC's default route table\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "\\(Multi\\-AZ only\\) Specifies the virtual private cloud \\(VPC\\) route tables in which your file system's endpoints will be created\\. You should specify all VPC route tables associated with the subnets in which your clients are located\\. By default, Amazon FSx selects your VPC's default route table\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RouteTableIds", "type": "array" }, "ThroughputCapacity": { - "markdownDescription": "Sets the throughput capacity for the file system that you're creating\\. Valid values are 128, 256, 512, 1024, and 2048 MBps\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `4096` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Sets the throughput capacity for the file system that you're creating\\. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThroughputCapacity", "type": "number" }, @@ -79515,7 +81291,7 @@ "type": "boolean" }, "CopyTagsToVolumes": { - "markdownDescription": "A Boolean value indicating whether tags for the volume should be copied to snapshots\\. This value defaults to `false`\\. If it's set to `true`, all tags for the volume are copied to snapshots where the user doesn't specify tags\\. If this value is `true`, and you specify one or more tags, only the specified tags are copied to snapshots\\. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A Boolean value indicating whether tags for the file system should be copied to volumes\\. This value defaults to `false`\\. If it's set to `true`, all tags for the file system are copied to volumes where the user doesn't specify tags\\. If this value is `true`, and you specify one or more tags, only the specified tags are copied to volumes\\. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CopyTagsToVolumes", "type": "boolean" }, @@ -79525,7 +81301,7 @@ "type": "string" }, "DeploymentType": { - "markdownDescription": "Specifies the file system deployment type\\. Amazon FSx for OpenZFS supports `SINGLE_AZ_1`\\. `SINGLE_AZ_1` deployment type is configured for redundancy within a single Availability Zone\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SINGLE_AZ_1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the file system deployment type\\. Single AZ deployment types are configured for redundancy within a single Availability Zone in an AWS Region \\. Valid values are the following: \n+ `SINGLE_AZ_1`\\- \\(Default\\) Creates file systems with throughput capacities of 64 \\- 4,096 MB/s\\. `Single_AZ_1` is available in all AWS Regions where Amazon FSx for OpenZFS is available, except US West \\(Oregon\\)\\.\n+ `SINGLE_AZ_2`\\- Creates file systems with throughput capacities of 160 \\- 10,240 MB/s using an NVMe L2ARC cache\\. `Single_AZ_2` is available only in the US East \\(N\\. Virginia\\), US East \\(Ohio\\), US West \\(Oregon\\), and Europe \\(Ireland\\) AWS Regions\\.\nFor more information, see: [Deployment type availability](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions) and [File system performance](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SINGLE_AZ_1 | SINGLE_AZ_2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DeploymentType", "type": "string" }, @@ -79538,6 +81314,8 @@ "items": { "type": "string" }, + "markdownDescription": "To delete a file system if there are child volumes present below the root volume, use the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`\\. If your file system has child volumes and you don't use this option, the delete request will fail\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Options", "type": "array" }, "RootVolumeConfiguration": { @@ -79546,7 +81324,7 @@ "title": "RootVolumeConfiguration" }, "ThroughputCapacity": { - "markdownDescription": "Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second \\(MB/s\\)\\. Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s\\. You pay for additional throughput capacity that you provision\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second \\(MB/s\\)\\. Valid values depend on the DeploymentType you choose, as follows: \n+ For `SINGLE_AZ_1`, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s\\.\n+ For `SINGLE_AZ_2`, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s\\.\nYou pay for additional throughput capacity that you provision\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThroughputCapacity", "type": "number" }, @@ -79588,13 +81366,15 @@ "type": "boolean" }, "RecordSizeKiB": { + "markdownDescription": "Specifies the record size of an OpenZFS root volume, in kibibytes \\(KiB\\)\\. Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB\\. The default is 128 KiB\\. Most workloads should use the default record size\\. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size\\. For additional guidance on setting a custom record size, see [ Tips for maximizing performance](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `4` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RecordSizeKiB", "type": "number" }, "UserAndGroupQuotas": { "items": { "$ref": "#/definitions/AWS::FSx::FileSystem.UserAndGroupQuotas" }, - "markdownDescription": "An object specifying how much storage users or groups can use on the volume\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html) of [UserAndGroupQuotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html) \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An object specifying how much storage users or groups can use on the volume\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html) of [UserAndGroupQuotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-userandgroupquotas.html) \n*Maximum*: `500` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "UserAndGroupQuotas", "type": "array" } @@ -79628,7 +81408,7 @@ "type": "string" }, "Password": { - "markdownDescription": "The password for the service account on your self\\-managed AD domain that Amazon FSx will use to join to your AD domain\\. We strongly suggest that you follow best practices and *do not* embed passwords in your CFN templates\\. \nThe recommended approach is to use AWS Secrets Manager to store your passwords\\. You can retrieve them for use in your templates using the `secretsmanager` dynamic reference\\. There are additional costs associated with using AWS Secrets Manager\\. To learn more, see [Secrets Manager secrets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) in the *AWS CloudFormation User Guide*\\. \nAlternatively, you can use the `NoEcho` property to obfuscate the password parameter value\\. For more information, see [Do Not Embed Credentials in Your Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html#creds) in the *AWS CloudFormation User Guide*\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^.{1,256}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The password for the service account on your self\\-managed AD domain that Amazon FSx will use to join to your AD domain\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^.{1,256}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Password", "type": "string" }, @@ -79665,7 +81445,7 @@ "additionalProperties": false, "properties": { "ActiveDirectoryId": { - "markdownDescription": "The ID for an existing AWS Managed Microsoft Active Directory \\(AD\\) instance that the file system should join when it's created\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `12` \n*Maximum*: `12` \n*Pattern*: `^d-[0-9a-f]{10}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID for an existing AWS Managed Microsoft Active Directory \\(AD\\) instance that the file system should join when it's created\\. Required if you are joining the file system to an existing AWS Managed Microsoft AD\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `12` \n*Maximum*: `12` \n*Pattern*: `^d-[0-9a-f]{10}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ActiveDirectoryId", "type": "string" }, @@ -79683,17 +81463,17 @@ "title": "AuditLogConfiguration" }, "AutomaticBackupRetentionDays": { - "markdownDescription": "The number of days to retain automatic backups\\. The default is to retain backups for 7 days\\. Setting this value to 0 disables the creation of automatic backups\\. The maximum retention period for backups is 90 days\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `90` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of days to retain automatic backups\\. Setting this property to `0` disables automatic backups\\. You can retain automatic backups for a maximum of 90 days\\. The default is `0`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutomaticBackupRetentionDays", "type": "number" }, "CopyTagsToBackups": { - "markdownDescription": "A Boolean flag indicating whether tags for the file system should be copied to backups\\. This value defaults to false\\. If it's set to true, all tags for the file system are copied to all automatic and user\\-initiated backups where the user doesn't specify tags\\. If this value is true, and you specify one or more tags, only the specified tags are copied to backups\\. If you specify one or more tags when creating a user\\-initiated backup, no tags are copied from the file system, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A boolean flag indicating whether tags for the file system should be copied to backups\\. This value defaults to false\\. If it's set to true, all tags for the file system are copied to all automatic and user\\-initiated backups where the user doesn't specify tags\\. If this value is true, and you specify one or more tags, only the specified tags are copied to backups\\. If you specify one or more tags when creating a user\\-initiated backup, no tags are copied from the file system, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CopyTagsToBackups", "type": "boolean" }, "DailyAutomaticBackupStartTime": { - "markdownDescription": "The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A recurring daily time, in the format `HH:MM`\\. `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. For example, `05:00` specifies 5 AM daily\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DailyAutomaticBackupStartTime", "type": "string" }, @@ -79703,7 +81483,7 @@ "type": "string" }, "PreferredSubnetId": { - "markdownDescription": "Required when `DeploymentType` is set to `MULTI_AZ_1`\\. This specifies the subnet in which you want the preferred file server to be located\\. For in\\-AWS applications, we recommend that you launch your clients in the same Availability Zone \\(AZ\\) as your preferred file server to reduce cross\\-AZ data transfer costs and minimize latency\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Required when `DeploymentType` is set to `MULTI_AZ_1`\\. This specifies the subnet in which you want the preferred file server to be located\\. For in\\-AWS applications, we recommend that you launch your clients in the same availability zone as your preferred file server to reduce cross\\-availability zone data transfer costs and minimize latency\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PreferredSubnetId", "type": "string" }, @@ -79713,12 +81493,12 @@ "title": "SelfManagedActiveDirectoryConfiguration" }, "ThroughputCapacity": { - "markdownDescription": "Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second \\(MB/s\\), in 2 to the *n*th increments, between 2^3 \\(8\\) and 2^11 \\(2048\\)\\. \n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second \\(MB/s\\), in 2 to the *n*th increments, between 2^3 \\(8\\) and 2^11 \\(2048\\)\\. \n*Required*: Conditional \n*Type*: Integer \n*Minimum*: `8` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ThroughputCapacity", "type": "number" }, "WeeklyMaintenanceStartTime": { - "markdownDescription": "The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A recurring weekly time, in the format `D:HH:MM`\\. \n `D` is the day of the week, for which 1 represents Monday and 7 represents Sunday\\. For further details, see [the ISO\\-8601 spec as described on Wikipedia](https://en.wikipedia.org/wiki/ISO_week_date)\\. \n `HH` is the zero\\-padded hour of the day \\(0\\-23\\), and `MM` is the zero\\-padded minute of the hour\\. \nFor example, `1:05:00` specifies maintenance at 5 AM Monday\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WeeklyMaintenanceStartTime", "type": "string" } @@ -79764,15 +81544,21 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the snapshot\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `203` \n*Pattern*: `^[a-zA-Z0-9_:.-]{1,203}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "VolumeId": { + "markdownDescription": "The ID of the volume that the snapshot is of\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `23` \n*Maximum*: `23` \n*Pattern*: `^(fsvol-[0-9a-f]{17,})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VolumeId", "type": "string" } }, @@ -79839,24 +81625,36 @@ "additionalProperties": false, "properties": { "ActiveDirectoryConfiguration": { - "$ref": "#/definitions/AWS::FSx::StorageVirtualMachine.ActiveDirectoryConfiguration" + "$ref": "#/definitions/AWS::FSx::StorageVirtualMachine.ActiveDirectoryConfiguration", + "markdownDescription": "Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable\\. \n*Required*: No \n*Type*: [ActiveDirectoryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActiveDirectoryConfiguration" }, "FileSystemId": { + "markdownDescription": "Specifies the FSx for ONTAP file system on which to create the SVM\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemId", "type": "string" }, "Name": { + "markdownDescription": "The name of the SVM\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `47` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,47}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "RootVolumeSecurityStyle": { + "markdownDescription": "The security style of the root volume of the SVM\\. Specify one of the following values: \n+ `UNIX` if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account\\.\n+ `NTFS` if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account\\.\n+ `MIXED` if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `MIXED | NTFS | UNIX` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RootVolumeSecurityStyle", "type": "string" }, "SvmAdminPassword": { + "markdownDescription": "Specifies the password to use when logging on to the SVM using a secure shell \\(SSH\\) connection to the SVM's management endpoint\\. Doing so enables you to manage the SVM using the NetApp ONTAP CLI or REST API\\. If you do not specify a password, you can still use the file system's `fsxadmin` user to manage the SVM\\. For more information, see [ Managing SVMs using the NetApp ONTAP CLI](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html#vsadmin-ontap-cli) in the *FSx for ONTAP User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SvmAdminPassword", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -79891,10 +81689,14 @@ "additionalProperties": false, "properties": { "NetBiosName": { + "markdownDescription": "The NetBIOS name of the Active Directory computer object that will be created for your SVM\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `15` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NetBiosName", "type": "string" }, "SelfManagedActiveDirectoryConfiguration": { - "$ref": "#/definitions/AWS::FSx::StorageVirtualMachine.SelfManagedActiveDirectoryConfiguration" + "$ref": "#/definitions/AWS::FSx::StorageVirtualMachine.SelfManagedActiveDirectoryConfiguration", + "markdownDescription": "The configuration that Amazon FSx uses to join the ONTAP storage virtual machine \\(SVM\\) to your self\\-managed \\(including on\\-premises\\) Microsoft Active Directory \\(AD\\) directory\\. \n*Required*: No \n*Type*: [SelfManagedActiveDirectoryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SelfManagedActiveDirectoryConfiguration" } }, "type": "object" @@ -79906,21 +81708,33 @@ "items": { "type": "string" }, + "markdownDescription": "A list of up to three IP addresses of DNS servers or domain controllers in the self\\-managed AD directory\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DnsIps", "type": "array" }, "DomainName": { + "markdownDescription": "The fully qualified domain name of the self\\-managed AD directory, such as `corp.example.com`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DomainName", "type": "string" }, "FileSystemAdministratorsGroup": { + "markdownDescription": "\\(Optional\\) The name of the domain group whose members are granted administrative privileges for the file system\\. Administrative privileges include taking ownership of files and folders, setting audit controls \\(audit ACLs\\) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell\\. The group that you specify must already exist in your domain\\. If you don't provide one, your AD domain's Domain Admins group is used\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemAdministratorsGroup", "type": "string" }, "OrganizationalUnitDistinguishedName": { + "markdownDescription": "\\(Optional\\) The fully qualified distinguished name of the organizational unit within your self\\-managed AD directory\\. Amazon FSx only accepts OU as the direct parent of the file system\\. An example is `OU=FSx,DC=yourdomain,DC=corp,DC=com`\\. To learn more, see [RFC 2253](https://tools.ietf.org/html/rfc2253)\\. If none is provided, the FSx file system is created in the default location of your self\\-managed AD directory\\. \nOnly Organizational Unit \\(OU\\) objects can be the direct parent of the file system that you're creating\\.\n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2000` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,2000}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OrganizationalUnitDistinguishedName", "type": "string" }, "Password": { + "markdownDescription": "The password for the service account on your self\\-managed AD domain that Amazon FSx will use to join to your AD domain\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^.{1,256}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Password", "type": "string" }, "UserName": { + "markdownDescription": "The user name for the service account on your self\\-managed AD domain that Amazon FSx will use to join to your AD domain\\. This account must have the permission to join computers to the domain in the organizational unit provided in `OrganizationalUnitDistinguishedName`, or in the default location of your AD domain\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserName", "type": "string" } }, @@ -79962,24 +81776,36 @@ "additionalProperties": false, "properties": { "BackupId": { + "markdownDescription": "Specifies the ID of the volume backup to use to create a new volume\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BackupId", "type": "string" }, "Name": { + "markdownDescription": "The name of the volume\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `203` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,203}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "OntapConfiguration": { - "$ref": "#/definitions/AWS::FSx::Volume.OntapConfiguration" + "$ref": "#/definitions/AWS::FSx::Volume.OntapConfiguration", + "markdownDescription": "The configuration of an Amazon FSx for NetApp ONTAP volume\\. \n*Required*: No \n*Type*: [OntapConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OntapConfiguration" }, "OpenZFSConfiguration": { - "$ref": "#/definitions/AWS::FSx::Volume.OpenZFSConfiguration" + "$ref": "#/definitions/AWS::FSx::Volume.OpenZFSConfiguration", + "markdownDescription": "The configuration of an Amazon FSx for OpenZFS volume\\. \n*Required*: No \n*Type*: [OpenZFSConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OpenZFSConfiguration" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "VolumeType": { + "markdownDescription": "The type of the volume\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ONTAP | OPENZFS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VolumeType", "type": "string" } }, @@ -80013,12 +81839,16 @@ "additionalProperties": false, "properties": { "Clients": { + "markdownDescription": "A value that specifies who can mount the file system\\. You can provide a wildcard character \\(`*`\\), an IP address \\(`0.0.0.0`\\), or a CIDR address \\(`192.0.2.0/24`\\)\\. By default, Amazon FSx uses the wildcard character when specifying the client\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[ -~]{1,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Clients", "type": "string" }, "Options": { "items": { "type": "string" }, + "markdownDescription": "The options to use when mounting the file system\\. For a list of options that you can use with Network File System \\(NFS\\), see the [exports\\(5\\) \\- Linux man page](https://linux.die.net/man/5/exports)\\. When choosing your options, consider the following: \n+ `crossmnt` is used by default\\. If you don't specify `crossmnt` when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory\\.\n+ `sync` is used by default\\. If you instead specify `async`, the system acknowledges writes before writing to disk\\. If the system crashes before the writes are finished, you lose the unwritten data\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Options", "type": "array" } }, @@ -80035,6 +81865,8 @@ "items": { "$ref": "#/definitions/AWS::FSx::Volume.ClientConfigurations" }, + "markdownDescription": "A list of configuration objects that contain the client and options for mounting the OpenZFS file system\\. \n*Required*: Yes \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports-clientconfigurations.html) of [ClientConfigurations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports-clientconfigurations.html) \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientConfigurations", "type": "array" } }, @@ -80047,31 +81879,49 @@ "additionalProperties": false, "properties": { "CopyTagsToBackups": { + "markdownDescription": "A boolean flag indicating whether tags for the volume should be copied to backups\\. This value defaults to false\\. If it's set to true, all tags for the volume are copied to all automatic and user\\-initiated backups where the user doesn't specify tags\\. If this value is true, and you specify one or more tags, only the specified tags are copied to backups\\. If you specify one or more tags when creating a user\\-initiated backup, no tags are copied from the volume, regardless of this value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CopyTagsToBackups", "type": "string" }, "JunctionPath": { + "markdownDescription": "Specifies the location in the SVM's namespace where the volume is mounted\\. The `JunctionPath` must have a leading forward slash, such as `/vol3`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "JunctionPath", "type": "string" }, "OntapVolumeType": { + "markdownDescription": "Specifies the type of volume you are creating\\. Valid values are the following: \n+ `RW` specifies a read/write volume\\. `RW` is the default\\.\n+ `DP` specifies a data\\-protection volume\\. A `DP` volume is read\\-only and can be used as the destination of a NetApp SnapMirror relationship\\.\nFor more information, see [Volume types](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types) in the *Amazon FSx for NetApp ONTAP User Guide*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DP | RW` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OntapVolumeType", "type": "string" }, "SecurityStyle": { + "markdownDescription": "Specifies the security style for the volume\\. If a volume's security style is not specified, it is automatically set to the root volume's security style\\. The security style determines the type of permissions that FSx for ONTAP uses to control data access\\. For more information, see [Volume security style](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style) in the *Amazon FSx for NetApp ONTAP User Guide*\\. Specify one of the following values: \n+ `UNIX` if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account\\. \n+ `NTFS` if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account\\.\n+ `MIXED` if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `MIXED | NTFS | UNIX` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityStyle", "type": "string" }, "SizeInMegabytes": { + "markdownDescription": "Specifies the size of the volume, in megabytes \\(MB\\), that you are creating\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SizeInMegabytes", "type": "string" }, "SnapshotPolicy": { + "markdownDescription": "Specifies the snapshot policy for the volume\\. There are three built\\-in snapshot policies: \n+ `default`: This is the default policy\\. A maximum of six hourly snapshots taken five minutes past the hour\\. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight\\. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight\\.\n+ `default-1weekly`: This policy is the same as the `default` policy except that it only retains one snapshot from the weekly schedule\\.\n+ `none`: This policy does not take any snapshots\\. This policy can be assigned to volumes to prevent automatic snapshots from being taken\\.\nYou can also provide the name of a custom policy that you created with the ONTAP CLI or REST API\\. \nFor more information, see [Snapshot policies](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies) in the *Amazon FSx for NetApp ONTAP User Guide*\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SnapshotPolicy", "type": "string" }, "StorageEfficiencyEnabled": { + "markdownDescription": "Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageEfficiencyEnabled", "type": "string" }, "StorageVirtualMachineId": { + "markdownDescription": "Specifies the ONTAP SVM in which to create the volume\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `21` \n*Maximum*: `21` \n*Pattern*: `^(svm-[0-9a-f]{17,})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StorageVirtualMachineId", "type": "string" }, "TieringPolicy": { - "$ref": "#/definitions/AWS::FSx::Volume.TieringPolicy" + "$ref": "#/definitions/AWS::FSx::Volume.TieringPolicy", + "markdownDescription": "Describes the data tiering policy for an ONTAP volume\\. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns\\. \nValid tiering policies are the following: \n+ `SNAPSHOT_ONLY` \\- \\(Default value\\) moves cold snapshots to the capacity pool storage tier\\.\n+ `AUTO` \\- moves cold user data and snapshots to the capacity pool storage tier based on your access patterns\\.\n+ `ALL` \\- moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier\\.\n+ `NONE` \\- keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier\\.\n*Required*: No \n*Type*: [TieringPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-ontapconfiguration-tieringpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TieringPolicy" } }, "required": [ @@ -80084,45 +81934,67 @@ "additionalProperties": false, "properties": { "CopyTagsToSnapshots": { + "markdownDescription": "A Boolean value indicating whether tags for the volume should be copied to snapshots\\. This value defaults to `false`\\. If it's set to `true`, all tags for the volume are copied to snapshots where the user doesn't specify tags\\. If this value is `true`, and you specify one or more tags, only the specified tags are copied to snapshots\\. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CopyTagsToSnapshots", "type": "boolean" }, "DataCompressionType": { + "markdownDescription": "Specifies the method used to compress the data on the volume\\. The compression type is `NONE` by default\\. \n+ `NONE` \\- Doesn't compress the data on the volume\\. `NONE` is the default\\.\n+ `ZSTD` \\- Compresses the data in the volume using the Zstandard \\(ZSTD\\) compression algorithm\\. Compared to LZ4, Z\\-Standard provides a better compression ratio to minimize on\\-disk storage utilization\\.\n+ `LZ4` \\- Compresses the data in the volume using the LZ4 compression algorithm\\. Compared to Z\\-Standard, LZ4 is less compute\\-intensive and delivers higher write throughput speeds\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `LZ4 | NONE | ZSTD` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataCompressionType", "type": "string" }, "NfsExports": { "items": { "$ref": "#/definitions/AWS::FSx::Volume.NfsExports" }, + "markdownDescription": "The configuration object for mounting a Network File System \\(NFS\\) file system\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports.html) of [NfsExports](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-nfsexports.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NfsExports", "type": "array" }, "Options": { "items": { "type": "string" }, + "markdownDescription": "To delete the volume's child volumes, snapshots, and clones, use the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Options", "type": "array" }, "OriginSnapshot": { - "$ref": "#/definitions/AWS::FSx::Volume.OriginSnapshot" + "$ref": "#/definitions/AWS::FSx::Volume.OriginSnapshot", + "markdownDescription": "The configuration object that specifies the snapshot to use as the origin of the data for the volume\\. \n*Required*: No \n*Type*: [OriginSnapshot](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-originsnapshot.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OriginSnapshot" }, "ParentVolumeId": { + "markdownDescription": "The ID of the volume to use as the parent volume of the volume that you are creating\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `23` \n*Maximum*: `23` \n*Pattern*: `^(fsvol-[0-9a-f]{17,})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ParentVolumeId", "type": "string" }, "ReadOnly": { + "markdownDescription": "A Boolean value indicating whether the volume is read\\-only\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReadOnly", "type": "boolean" }, "RecordSizeKiB": { + "markdownDescription": "Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes \\(KiB\\)\\. Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB\\. The default is 128 KiB\\. We recommend using the default setting for the majority of use cases\\. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads \\(small record size\\) or media streaming workloads \\(large record size\\)\\. For additional guidance on when to set a custom record size, see [ ZFS Record size](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `4` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RecordSizeKiB", "type": "number" }, "StorageCapacityQuotaGiB": { + "markdownDescription": "Sets the maximum storage size in gibibytes \\(GiB\\) for the volume\\. You can specify a quota that is larger than the storage on the parent volume\\. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume\\. To guarantee quota space, you must also set `StorageCapacityReservationGiB`\\. To *not* specify a storage capacity quota, set this to `-1`\\. \nFor more information, see [Volume properties](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `-1` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageCapacityQuotaGiB", "type": "number" }, "StorageCapacityReservationGiB": { + "markdownDescription": "Specifies the amount of storage in gibibytes \\(GiB\\) to reserve from the parent volume\\. Setting `StorageCapacityReservationGiB` guarantees that the specified amount of storage space on the parent volume will always be available for the volume\\. You can't reserve more storage than the parent volume has\\. To *not* specify a storage capacity reservation, set this to `0` or `-1`\\. For more information, see [Volume properties](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties) in the *Amazon FSx for OpenZFS User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `-1` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageCapacityReservationGiB", "type": "number" }, "UserAndGroupQuotas": { "items": { "$ref": "#/definitions/AWS::FSx::Volume.UserAndGroupQuotas" }, + "markdownDescription": "An object specifying how much storage users or groups can use on the volume\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-userandgroupquotas.html) of [UserAndGroupQuotas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration-userandgroupquotas.html) \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserAndGroupQuotas", "type": "array" } }, @@ -80135,9 +82007,13 @@ "additionalProperties": false, "properties": { "CopyStrategy": { + "markdownDescription": "The strategy used when copying data from the snapshot to the new volume\\. \n+ `CLONE` \\- The new volume references the data in the origin snapshot\\. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput\\. However, the origin snapshot can't be deleted if there is a volume using its copied data\\. \n+ `FULL_COPY` \\- Copies all data from the snapshot to the new volume\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CLONE | FULL_COPY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CopyStrategy", "type": "string" }, "SnapshotARN": { + "markdownDescription": "Specifies the snapshot to use when creating an OpenZFS volume from a snapshot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SnapshotARN", "type": "string" } }, @@ -80151,9 +82027,13 @@ "additionalProperties": false, "properties": { "CoolingPeriod": { + "markdownDescription": "Specifies the number of days that user data in a volume must remain inactive before it is considered \"cold\" and moved to the capacity pool\\. Used with the `AUTO` and `SNAPSHOT_ONLY` tiering policies\\. Enter a whole number between 2 and 183\\. Default values are 31 days for `AUTO` and 2 days for `SNAPSHOT_ONLY`\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `2` \n*Maximum*: `183` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CoolingPeriod", "type": "number" }, "Name": { + "markdownDescription": "Specifies the tiering policy used to transition data\\. Default value is `SNAPSHOT_ONLY`\\. \n+ `SNAPSHOT_ONLY` \\- moves cold snapshots to the capacity pool storage tier\\.\n+ `AUTO` \\- moves cold user data and snapshots to the capacity pool storage tier based on your access patterns\\.\n+ `ALL` \\- moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier\\.\n+ `NONE` \\- keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ALL | AUTO | NONE | SNAPSHOT_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -80163,12 +82043,18 @@ "additionalProperties": false, "properties": { "Id": { + "markdownDescription": "The ID of the user or group\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id", "type": "number" }, "StorageCapacityQuotaGiB": { + "markdownDescription": "The amount of storage that the user or group can use in gibibytes \\(GiB\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageCapacityQuotaGiB", "type": "number" }, "Type": { + "markdownDescription": "A value that specifies whether the quota applies to a user or group\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `GROUP | USER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -80372,7 +82258,7 @@ "additionalProperties": false, "properties": { "DataFrequency": { - "markdownDescription": "The frequency of data collection\\. This parameter is required for RELATED\\_TIME\\_SERIES datasets\\. \nValid intervals are Y \\(Year\\), M \\(Month\\), W \\(Week\\), D \\(Day\\), H \\(Hour\\), 30min \\(30 minutes\\), 15min \\(15 minutes\\), 10min \\(10 minutes\\), 5min \\(5 minutes\\), and 1min \\(1 minute\\)\\. For example, \"D\" indicates every day and \"15min\" indicates every 15 minutes\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `5` \n*Pattern*: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The frequency of data collection\\. This parameter is required for RELATED\\_TIME\\_SERIES datasets\\. \nValid intervals are an integer followed by Y \\(Year\\), M \\(Month\\), W \\(Week\\), D \\(Day\\), H \\(Hour\\), and min \\(Minute\\)\\. For example, \"1D\" indicates every day and \"15min\" indicates every 15 minutes\\. You cannot specify a value that would overlap with the next larger frequency\\. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour\\. The valid values for each frequency are the following: \n+ Minute \\- 1\\-59\n+ Hour \\- 1\\-23\n+ Day \\- 1\\-6\n+ Week \\- 1\\-4\n+ Month \\- 1\\-11\n+ Year \\- 1\nThus, if you want every other week forecasts, specify \"2W\"\\. Or, if you want quarterly forecasts, you specify \"3M\"\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `5` \n*Pattern*: `^Y|M|W|D|H|30min|15min|10min|5min|1min$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataFrequency", "type": "string" }, @@ -80393,19 +82279,19 @@ }, "EncryptionConfig": { "$ref": "#/definitions/AWS::Forecast::Dataset.EncryptionConfig", - "markdownDescription": "A Key Management Service \\(KMS\\) key and the Identity and Access Management \\(IAM\\) role that Amazon Forecast can assume to access the key\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A Key Management Service \\(KMS\\) key and the Identity and Access Management \\(IAM\\) role that Amazon Forecast can assume to access the key\\. \n*Required*: No \n*Type*: [EncryptionConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-encryptionconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EncryptionConfig" }, "Schema": { "$ref": "#/definitions/AWS::Forecast::Dataset.Schema", - "markdownDescription": "The schema for the dataset\\. The schema attributes and their order must match the fields in your data\\. The dataset `Domain` and `DatasetType` that you choose determine the minimum required fields in your training data\\. For information about the required fields for a specific dataset domain and type, see [Dataset Domains and Dataset Types](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html)\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The schema for the dataset\\. The schema attributes and their order must match the fields in your data\\. The dataset `Domain` and `DatasetType` that you choose determine the minimum required fields in your training data\\. For information about the required fields for a specific dataset domain and type, see [Dataset Domains and Dataset Types](https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html)\\. \n*Required*: Yes \n*Type*: [Schema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-schema.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Schema" }, "Tags": { "items": { "$ref": "#/definitions/AWS::Forecast::Dataset.TagsItems" }, - "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [TagsItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-tagsitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -80443,9 +82329,13 @@ "additionalProperties": false, "properties": { "AttributeName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AttributeName", "type": "string" }, "AttributeType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AttributeType", "type": "string" } }, @@ -80455,9 +82345,13 @@ "additionalProperties": false, "properties": { "KmsKeyArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the KMS key\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:aws:kms:.*:key/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyArn", "type": "string" }, "RoleArn": { + "markdownDescription": "The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key\\. \nPassing a role across AWS accounts is not allowed\\. If you pass a role that isn't in your account, you get an `InvalidInputException` error\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:([a-z\\d-]+):forecast:.*:.*:.+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" } }, @@ -80470,6 +82364,8 @@ "items": { "$ref": "#/definitions/AWS::Forecast::Dataset.AttributesItems" }, + "markdownDescription": "An array of attributes specifying the name and type of each field in a dataset\\. \n*Required*: No \n*Type*: List of [AttributesItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-forecast-dataset-attributesitems.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Attributes", "type": "array" } }, @@ -80479,9 +82375,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -81780,13 +83680,13 @@ "type": "string" }, "OperatingSystem": { - "markdownDescription": "The operating system that the game server binaries are built to run on\\. This value determines the type of fleet resources that you can use for this build\\. If your game build contains multiple executables, they all must run on the same operating system\\. If an operating system is not specified when creating a build, Amazon GameLift uses the default value \\(WINDOWS\\_2012\\)\\. This value cannot be changed later\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AMAZON_LINUX | AMAZON_LINUX_2 | WINDOWS_2012` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The operating system that you built the game server binaries to run on\\. This value determines the type of fleet resources that you can use for this build\\. If your game build contains multiple executables, they all must run on the same operating system\\. If an operating system is not specified when creating a build, GameLift uses the default value \\(WINDOWS\\_2012\\)\\. This value cannot be changed later\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AMAZON_LINUX | AMAZON_LINUX_2 | WINDOWS_2012` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "OperatingSystem", "type": "string" }, "StorageLocation": { "$ref": "#/definitions/AWS::GameLift::Build.StorageLocation", - "markdownDescription": "Information indicating where your game build files are stored\\. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own\\. The storage location must specify an Amazon S3 bucket name and key\\. The location must also specify a role ARN that you set up to allow Amazon Web Services to access your Amazon S3 bucket\\. The S3 bucket and your new build must be in the same Region\\. \nIf a `StorageLocation` is specified, the size of your file can be found in your Amazon S3 bucket\\. Amazon Web Services will report a `SizeOnDisk` of 0\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Information indicating where your game build files are stored\\. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own\\. The storage location must specify an Amazon S3 bucket name and key\\. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket\\. The S3 bucket and your new build must be in the same Region\\. \nIf a `StorageLocation` is specified, the size of your file can be found in your Amazon S3 bucket\\. Amazon GameLift will report a `SizeOnDisk` of 0\\. \n*Required*: No \n*Type*: [StorageLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-build-storagelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StorageLocation" }, "Version": { @@ -81821,15 +83721,23 @@ "additionalProperties": false, "properties": { "Bucket": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Bucket", "type": "string" }, "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" }, "ObjectVersion": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ObjectVersion", "type": "string" }, "RoleArn": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RoleArn", "type": "string" } }, @@ -81876,7 +83784,9 @@ "additionalProperties": false, "properties": { "AnywhereConfiguration": { - "$ref": "#/definitions/AWS::GameLift::Fleet.AnywhereConfiguration" + "$ref": "#/definitions/AWS::GameLift::Fleet.AnywhereConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AnywhereConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-anywhereconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AnywhereConfiguration" }, "BuildId": { "markdownDescription": "A unique identifier for a build to be deployed on the new fleet\\. If you are deploying the fleet with a custom game build, you must specify this property\\. The build must have been successfully uploaded to Amazon GameLift and be in a `READY` status\\. This fleet setting cannot be changed once the fleet is created\\. \n*Required*: Conditional \n*Type*: String \n*Pattern*: `^build-\\S+|^arn:.*:build\\/build-\\S+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -81885,14 +83795,16 @@ }, "CertificateConfiguration": { "$ref": "#/definitions/AWS::GameLift::Fleet.CertificateConfiguration", - "markdownDescription": "Prompts GameLift to generate a TLS/SSL certificate for the fleet\\. TLS certificates are used for encrypting traffic between game clients and the game servers that are running on GameLift\\. By default, the `CertificateConfiguration` is set to `DISABLED`\\. This property cannot be changed after the fleet is created\\. \nNote: This feature requires the AWS Certificate Manager \\(ACM\\) service, which is not available in all AWS regions\\. When working in a region that does not support this feature, a fleet creation request with certificate generation fails with a 4xx error\\. \n*Required*: No \n*Type*: [CertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Prompts GameLift to generate a TLS/SSL certificate for the fleet\\. GameLift uses the certificates to encrypt traffic between game clients and the game servers running on GameLift\\. By default, the `CertificateConfiguration` is `DISABLED`\\. You can't change this property after you create the fleet\\. \n AWS Certificate Manager \\(ACM\\) certificates expire after 13 months\\. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet\\. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition\\. \nACM isn't available in all AWS regions\\. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error\\. For more information about the supported Regions, see [Supported Regions](https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html) in the * AWS Certificate Manager User Guide*\\.\n*Required*: No \n*Type*: [CertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-certificateconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CertificateConfiguration" }, "ComputeType": { + "markdownDescription": "The type of compute resource used to host your game servers\\. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ANYWHERE | EC2` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ComputeType", "type": "string" }, "Description": { - "markdownDescription": "A human\\-readable description of the fleet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description for the fleet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -81910,7 +83822,7 @@ "type": "array" }, "EC2InstanceType": { - "markdownDescription": "The GameLift\\-supported Amazon EC2 instance type to use for all fleet instances\\. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity\\. See [Amazon Elastic Compute Cloud Instance Types](http://aws.amazon.com/ec2/instance-types/) for detailed descriptions of Amazon EC2 instance types\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | t2.large | t2.medium | t2.micro | t2.small` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The GameLift\\-supported Amazon EC2 instance type to use for all fleet instances\\. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity\\. See [Amazon Elastic Compute Cloud Instance Types](http://aws.amazon.com/ec2/instance-types/) for detailed descriptions of Amazon EC2 instance types\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `c3.2xlarge | c3.4xlarge | c3.8xlarge | c3.large | c3.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c4.large | c4.xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.large | c5.xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.large | c5a.xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.large | c5d.xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.2xlarge | c6a.4xlarge | c6a.8xlarge | c6a.large | c6a.xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.2xlarge | c6i.4xlarge | c6i.8xlarge | c6i.large | c6i.xlarge | m3.2xlarge | m3.large | m3.medium | m3.xlarge | m4.10xlarge | m4.2xlarge | m4.4xlarge | m4.large | m4.xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.large | m5.xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.large | m5a.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r3.large | r3.xlarge | r4.16xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.large | r4.xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.large | r5.xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.large | r5a.xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.large | r5d.xlarge | t2.large | t2.medium | t2.micro | t2.small` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EC2InstanceType", "type": "string" }, @@ -81951,7 +83863,7 @@ "type": "number" }, "Name": { - "markdownDescription": "A descriptive label that is associated with a fleet\\. Fleet names do not need to be unique\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A descriptive label that is associated with a fleet\\. Fleet names do not need to be unique\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -81966,7 +83878,7 @@ "type": "string" }, "PeerVpcId": { - "markdownDescription": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet\\. The VPC must be in the same Region as your fleet\\. To look up a VPC ID, use the [VPC Dashboard](https://console.aws.amazon.com/vpc/) in the AWS Management Console\\. Learn more about VPC peering in [VPC Peering with GameLift Fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A unique identifier for a VPC with resources to be accessed by your GameLift fleet\\. The VPC must be in the same Region as your fleet\\. To look up a VPC ID, use the [VPC Dashboard](https://console.aws.amazon.com/vpc/) in the AWS Management Console\\. Learn more about VPC peering in [VPC Peering with GameLift Fleets](https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PeerVpcId", "type": "string" }, @@ -82016,6 +83928,8 @@ "additionalProperties": false, "properties": { "Cost": { + "markdownDescription": "The cost to run your fleet per hour\\. GameLift uses the provided cost of your fleet to balance usage in queues\\. For more information about queues, see [Setting up queues](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html) in the *Amazon GameLift Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `11` \n*Pattern*: `^\\d{1,5}(?:\\.\\d{1,5})?$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cost", "type": "string" } }, @@ -82100,7 +84014,7 @@ "additionalProperties": false, "properties": { "Location": { - "markdownDescription": "An AWS Region code, such as `us-west-2`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-z]+(-([a-z]+|\\d))*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An AWS Region code, such as `us-west-2`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[A-Za-z0-9\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Location", "type": "string" }, @@ -82119,7 +84033,7 @@ "additionalProperties": false, "properties": { "NewGameSessionsPerCreator": { - "markdownDescription": "The maximum number of game sessions that an individual can create during the policy period\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A policy that puts limits on the number of game sessions that a player can create within a specified span of time\\. With this policy, you can control players' ability to consume available resources\\. \nThe policy is evaluated when a player tries to create a new game session\\. On receiving a `CreateGameSession` request, GameLift checks that the player \\(identified by `CreatorId`\\) has created fewer than game session limit in the specified time period\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NewGameSessionsPerCreator", "type": "number" }, @@ -82264,7 +84178,7 @@ "type": "number" }, "RoleArn": { - "markdownDescription": "The Amazon Resource Name \\([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)\\) for an IAM role that allows Amazon Web Services to access your Amazon EC2 Auto Scaling groups\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^arn:.*:role\\/[\\w+=,.@-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)\\) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^arn:.*:role\\/[\\w+=,.@-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RoleArn", "type": "string" }, @@ -82423,7 +84337,7 @@ "additionalProperties": false, "properties": { "CustomEventData": { - "markdownDescription": "Information to be added to all events that are related to this game session queue\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Information to be added to all events that are related to this game session queue\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomEventData", "type": "string" }, @@ -82507,7 +84421,7 @@ "additionalProperties": false, "properties": { "DestinationArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) that is assigned to fleet or fleet alias\\. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9:/-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) that is assigned to fleet or fleet alias\\. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9:/-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DestinationArn", "type": "string" } @@ -82602,12 +84516,16 @@ "additionalProperties": false, "properties": { "LocationName": { + "markdownDescription": "The location's name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[A-Za-z0-9\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LocationName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -82698,7 +84616,7 @@ "type": "string" }, "Description": { - "markdownDescription": "A descriptive label that is associated with matchmaking configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description for the matchmaking configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -82929,7 +84847,7 @@ }, "StorageLocation": { "$ref": "#/definitions/AWS::GameLift::Script.S3Location", - "markdownDescription": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored\\. The storage location must specify the Amazon S3 bucket name, the zip file name \\(the \"key\"\\), and a role ARN that allows Amazon Web Services to access the Amazon S3 storage location\\. The S3 bucket must be in the same Region where you want to create a new script\\. By default, Amazon Web Services uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the `ObjectVersion` parameter to specify an earlier version\\. \n*Required*: Yes \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored\\. The storage location must specify the Amazon S3 bucket name, the zip file name \\(the \"key\"\\), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location\\. The S3 bucket must be in the same Region where you want to create a new script\\. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the `ObjectVersion` parameter to specify an earlier version\\. \n*Required*: Yes \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-script-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StorageLocation" }, "Tags": { @@ -82976,7 +84894,7 @@ "additionalProperties": false, "properties": { "Bucket": { - "markdownDescription": "An Amazon S3 bucket identifier\\. This is the name of the S3 bucket\\. \nGameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot \\(\\.\\)\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An Amazon S3 bucket identifier\\. Thename of the S3 bucket\\. \nGameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot \\(\\.\\)\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Bucket", "type": "string" }, @@ -82986,12 +84904,12 @@ "type": "string" }, "ObjectVersion": { - "markdownDescription": "The version of the file, if object versioning is turned on for the bucket\\. Amazon Web Services uses this information when retrieving files from an S3 bucket that you own\\. Use this parameter to specify a specific version of the file\\. If not set, the latest version of the file is retrieved\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the file, if object versioning is turned on for the bucket\\. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own\\. Use this parameter to specify a specific version of the file\\. If not set, the latest version of the file is retrieved\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ObjectVersion", "type": "string" }, "RoleArn": { - "markdownDescription": "The Amazon Resource Name \\([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)\\) for an IAM role that allows Amazon Web Services to access the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)\\) for an IAM role that allows Amazon GameLift to access the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RoleArn", "type": "string" } @@ -83044,7 +84962,7 @@ "type": "boolean" }, "IpAddressType": { - "markdownDescription": "The value for the address type must be IPv4\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `IPV4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The IP address type that an accelerator supports\\. For a standard accelerator, the value can be IPV4 or DUAL\\_STACK\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DUAL_STACK | IPV4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IpAddressType", "type": "string" }, @@ -83057,7 +84975,7 @@ "type": "array" }, "Name": { - "markdownDescription": "The name of the accelerator\\. The name must contain only alphanumeric characters or hyphens \\(\\-\\), and must not begin or end with a hyphen\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the accelerator\\. The name must contain only alphanumeric characters or hyphens \\(\\-\\), and must not begin or end with a hyphen\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -83173,7 +85091,7 @@ "items": { "$ref": "#/definitions/AWS::GlobalAccelerator::EndpointGroup.PortOverride" }, - "markdownDescription": "Allows you to override the destination ports used to route traffic to an endpoint\\. Using a port override lets you to map a list of external destination ports \\(that your users send traffic to\\) to a list of internal destination ports that you want an application endpoint to receive traffic on\\. \n*Required*: No \n*Type*: List of [PortOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-portoverride.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Allows you to override the destination ports used to route traffic to an endpoint\\. Using a port override lets you map a list of external destination ports \\(that your users send traffic to\\) to a list of internal destination ports that you want an application endpoint to receive traffic on\\. \n*Required*: No \n*Type*: List of [PortOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-globalaccelerator-endpointgroup-portoverride.html) \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PortOverrides", "type": "array" }, @@ -83453,7 +85371,7 @@ "type": "boolean" }, "ContainsHeader": { - "markdownDescription": "Indicates whether the CSV file contains a header\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether the CSV file contains a header\\. \nA value of `UNKNOWN` specifies that the classifier will detect whether the CSV file contains headings\\. \nA value of `PRESENT` specifies that the CSV file contains headings\\. \nA value of `ABSENT` specifies that the CSV file does not contain headings\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContainsHeader", "type": "string" }, @@ -83644,7 +85562,7 @@ "type": "object" }, "ConnectionType": { - "markdownDescription": "The type of the connection\\. Currently, these types are supported: \n+ `JDBC` \\- Designates a connection to a database through Java Database Connectivity \\(JDBC\\)\\.\n+ `KAFKA` \\- Designates a connection to an Apache Kafka streaming platform\\.\n+ `MONGODB` \\- Designates a connection to a MongoDB document database\\.\n+ `NETWORK` \\- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment \\(Amazon VPC\\)\\.\nSFTP is not supported\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of the connection\\. Currently, these types are supported: \n+ `JDBC` \\- Designates a connection to a database through Java Database Connectivity \\(JDBC\\)\\.", "title": "ConnectionType", "type": "string" }, @@ -83662,7 +85580,7 @@ "type": "array" }, "Name": { - "markdownDescription": "The name of the connection\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the connection\\. Connection will not function as expected without a name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -83740,7 +85658,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of UTF\\-8 strings that specify the custom classifiers that are associated with the crawler\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of UTF\\-8 strings that specify the names of custom classifiers that are associated with the crawler\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Classifiers", "type": "array" }, @@ -83786,7 +85704,7 @@ }, "SchemaChangePolicy": { "$ref": "#/definitions/AWS::Glue::Crawler.SchemaChangePolicy", - "markdownDescription": "The policy that specifies update and delete behaviors for the crawler\\. \n*Required*: No \n*Type*: [SchemaChangePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The policy that specifies update and delete behaviors for the crawler\\. The policy tells the crawler what to do in the event that it detects a change in a table that already exists in the customer's database at the time of the crawl\\. The `SchemaChangePolicy` does not affect whether or how new tables and partitions are added\\. New tables and partitions are always created regardless of the `SchemaChangePolicy` on a crawler\\. \nThe SchemaChangePolicy consists of two components, `UpdateBehavior` and `DeleteBehavior`\\. \n*Required*: No \n*Type*: [SchemaChangePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SchemaChangePolicy" }, "TablePrefix": { @@ -83922,12 +85840,12 @@ "type": "string" }, "DlqEventQueueArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A valid Amazon dead\\-letter SQS ARN\\. For example, `arn:aws:sqs:region:account:deadLetterQueue`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DlqEventQueueArn", "type": "string" }, "EventQueueArn": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A valid Amazon SQS ARN\\. For example, `arn:aws:sqs:region:account:sqs`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventQueueArn", "type": "string" }, @@ -83967,12 +85885,12 @@ "additionalProperties": false, "properties": { "DeleteBehavior": { - "markdownDescription": "The deletion behavior when the crawler finds a deleted object\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The deletion behavior when the crawler finds a deleted object\\. \nA value of `LOG` specifies that if a table or partition is found to no longer exist, do not delete it, only log that it was found to no longer exist\\. \nA value of `DELETE_FROM_DATABASE` specifies that if a table or partition is found to have been removed, delete it from the database\\. \nA value of `DEPRECATE_IN_DATABASE` specifies that if a table has been found to no longer exist, to add a property to the table that says \"DEPRECATED\" and includes a timestamp with the time of deprecation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeleteBehavior", "type": "string" }, "UpdateBehavior": { - "markdownDescription": "The update behavior when the crawler finds a changed schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The update behavior when the crawler finds a changed schema\\. \nA value of `LOG` specifies that if a table or a partition already exists, and a change is detected, do not update it, only log that a change was detected\\. Add new tables and new partitions \\(including on existing tables\\)\\. \nA value of `UPDATE_IN_DATABASE` specifies that if a table or partition already exists, and a change is detected, update it\\. Add new tables and partitions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UpdateBehavior", "type": "string" } @@ -84253,7 +86171,7 @@ "items": { "$ref": "#/definitions/AWS::Glue::Database.PrincipalPrivileges" }, - "markdownDescription": "Creates a set of default permissions on the table for principals\\. \n*Required*: No \n*Type*: List of [PrincipalPrivileges](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-principalprivileges.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Creates a set of default permissions on the table for principals\\. Used by AWS Lake Formation\\. Not used in the normal course of AWS Glue operations\\. \n*Required*: No \n*Type*: List of [PrincipalPrivileges](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-principalprivileges.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CreateTableDefaultPermissions", "type": "array" }, @@ -84483,7 +86401,7 @@ "additionalProperties": false, "properties": { "AllocatedCapacity": { - "markdownDescription": "The number of capacity units that are allocated to this job\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This parameter is no longer supported\\. Use `MaxCapacity` instead\\. \nThe number of capacity units that are allocated to this job\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllocatedCapacity", "type": "number" }, @@ -84508,6 +86426,8 @@ "type": "string" }, "ExecutionClass": { + "markdownDescription": "Indicates whether the job is run with a standard or flexible execution class\\. The standard execution class is ideal for time\\-sensitive workloads that require fast job startup and dedicated resources\\. \nThe flexible execution class is appropriate for time\\-insensitive jobs whose start and completion times may vary\\. \nOnly jobs with AWS Glue version 3\\.0 and above and command type `glueetl` will be allowed to set `ExecutionClass` to `FLEX`\\. The flexible execution class is available for Spark jobs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExecutionClass", "type": "string" }, "ExecutionProperty": { @@ -84541,6 +86461,8 @@ "type": "string" }, "NonOverridableArguments": { + "markdownDescription": "Non\\-overridable arguments for this job, specified as name\\-value pairs\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NonOverridableArguments", "type": "object" }, "NotificationProperty": { @@ -84640,7 +86562,7 @@ "type": "string" }, "PythonVersion": { - "markdownDescription": "The Python version being used to execute a Python shell job\\. Allowed values are 2 or 3\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Python version being used to execute a Python shell job\\. Allowed values are 3 or 3\\.9\\. Version 2 is deprecated\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PythonVersion", "type": "string" }, @@ -85714,7 +87636,7 @@ "additionalProperties": false, "properties": { "CloudWatchEncryptionMode": { - "markdownDescription": "The encryption mode to use for CloudWatch data\\. \n*Required*: No \n*Type*: String \n*Allowed Values*: `DISABLED | SSE-KMS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The encryption mode to use for CloudWatch data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchEncryptionMode", "type": "string" }, @@ -85751,7 +87673,7 @@ "additionalProperties": false, "properties": { "JobBookmarksEncryptionMode": { - "markdownDescription": "The encryption mode to use for job bookmarks data\\. \n*Required*: No \n*Type*: String \n*Allowed Values*: `DISABLED | CSE-KMS`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The encryption mode to use for job bookmarks data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "JobBookmarksEncryptionMode", "type": "string" }, @@ -85772,7 +87694,7 @@ "type": "string" }, "S3EncryptionMode": { - "markdownDescription": "The encryption mode to use for Amazon S3 data\\. \n*Required*: No \n*Type*: String \n*Allowed Values*: `DISABLED | SSE-KMS | SSE-S3`\n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The encryption mode to use for Amazon S3 data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3EncryptionMode", "type": "string" } @@ -85820,7 +87742,7 @@ "additionalProperties": false, "properties": { "CatalogId": { - "markdownDescription": "The ID of the Data Catalog in which to create the `Table`\\. If none is supplied, the AWS account ID is used by default\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the Data Catalog in which to create the `Table`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CatalogId", "type": "string" }, @@ -86112,7 +88034,7 @@ "type": "string" }, "Owner": { - "markdownDescription": "The table owner\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The table owner\\. Included for Apache Hive compatibility\\. Not used in the normal course of AWS Glue operations\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Owner", "type": "string" }, @@ -86140,7 +88062,7 @@ "title": "StorageDescriptor" }, "TableType": { - "markdownDescription": "The type of this table \\(`EXTERNAL_TABLE`, `VIRTUAL_VIEW`, etc\\.\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of this table\\. AWS Glue will create tables with the `EXTERNAL_TABLE` type\\. Other services, such as Athena, may create tables with additional table types\\. \n AWS Glue related table types: \nEXTERNAL\\_TABLE \nHive compatible attribute \\- indicates a non\\-Hive managed table\\. \nGOVERNED \nUsed by AWS Lake Formation\\. The AWS Glue Data Catalog understands `GOVERNED`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TableType", "type": "string" }, @@ -86150,12 +88072,12 @@ "title": "TargetTable" }, "ViewExpandedText": { - "markdownDescription": "If the table is a view, the expanded text of the view; otherwise `null`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Included for Apache Hive compatibility\\. Not used in the normal course of AWS Glue operations\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ViewExpandedText", "type": "string" }, "ViewOriginalText": { - "markdownDescription": "If the table is a view, the original text of the view; otherwise `null`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Included for Apache Hive compatibility\\. Not used in the normal course of AWS Glue operations\\. If the table is a `VIRTUAL_VIEW`, certain Athena configuration encoded in base64\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ViewOriginalText", "type": "string" } @@ -86211,7 +88133,9 @@ "type": "string" }, "EventBatchingCondition": { - "$ref": "#/definitions/AWS::Glue::Trigger.EventBatchingCondition" + "$ref": "#/definitions/AWS::Glue::Trigger.EventBatchingCondition", + "markdownDescription": "Batch condition that must be met \\(specified number of events received or batch time window expired\\) before EventBridge event trigger fires\\. \n*Required*: No \n*Type*: [EventBatchingCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-eventbatchingcondition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventBatchingCondition" }, "Name": { "markdownDescription": "The name of the trigger\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -86239,7 +88163,7 @@ "type": "object" }, "Type": { - "markdownDescription": "The type of trigger that this is\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of trigger that this is\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" }, @@ -86347,9 +88271,13 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "BatchWindow": { + "markdownDescription": "Window of time in seconds after which EventBridge event trigger fires\\. Window starts when first event is received\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchWindow", "type": "number" } }, @@ -86434,6 +88362,8 @@ "type": "string" }, "MaxConcurrentRuns": { + "markdownDescription": "You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs\\. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxConcurrentRuns", "type": "number" }, "Name": { @@ -86505,58 +88435,86 @@ "additionalProperties": false, "properties": { "AccountAccessType": { + "markdownDescription": "Specifies whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization\\. If this is `ORGANIZATION`, the `workspaceOrganizationalUnits` parameter specifies which organizational units the workspace can access\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CURRENT_ACCOUNT | ORGANIZATION` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccountAccessType", "type": "string" }, "AuthenticationProviders": { "items": { "type": "string" }, + "markdownDescription": "Specifies whether this workspace uses SAML 2\\.0, AWS IAM Identity Center \\(successor to AWS Single Sign\\-On\\), or both to authenticate users for using the Grafana console within a workspace\\. For more information, see [User authentication in Amazon Managed Grafana](https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AuthenticationProviders", "type": "array" }, "ClientToken": { + "markdownDescription": "A unique, case\\-sensitive, user\\-provided identifier to ensure the idempotency of the request\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[!-~]{1,64}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ClientToken", "type": "string" }, "DataSources": { "items": { "type": "string" }, + "markdownDescription": "Specifies the AWS data sources that have been configured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources\\. \nThis list is only used when the workspace was created through the AWS console, and the `permissionType` is `SERVICE_MANAGED`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSources", "type": "array" }, "Description": { + "markdownDescription": "The user\\-defined description of the workspace\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the workspace\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9-._~]{1,255}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "NotificationDestinations": { "items": { "type": "string" }, + "markdownDescription": "The AWS notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotificationDestinations", "type": "array" }, "OrganizationRoleName": { + "markdownDescription": "The name of the IAM role that is used to access resources through Organizations\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationRoleName", "type": "string" }, "OrganizationalUnits": { "items": { "type": "string" }, + "markdownDescription": "Specifies the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationalUnits", "type": "array" }, "PermissionType": { + "markdownDescription": "If this is `SERVICE_MANAGED`, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use AWS data sources and notification channels\\. \nIf this is `CUSTOMER_MANAGED`, you must manage those roles and permissions yourself\\. \nIf you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other AWS accounts in the organization, this parameter must be set to `CUSTOMER_MANAGED`\\. \nFor more information about converting between customer and service managed, see [Managing permissions for data sources and notification channels](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html)\\. For more information about the roles and permissions that must be managed for customer managed workspaces, see [Amazon Managed Grafana permissions and policies for AWS data sources and notification channels](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html) \n*Required*: No \n*Type*: String \n*Allowed values*: `CUSTOMER_MANAGED | SERVICE_MANAGED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PermissionType", "type": "string" }, "RoleArn": { + "markdownDescription": "The IAM role that grants permissions to the AWS resources that the workspace will view data from\\. This role must already exist\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "SamlConfiguration": { - "$ref": "#/definitions/AWS::Grafana::Workspace.SamlConfiguration" + "$ref": "#/definitions/AWS::Grafana::Workspace.SamlConfiguration", + "markdownDescription": "If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the `Admin` and `Editor` roles in the workspace\\. \n*Required*: No \n*Type*: [SamlConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-samlconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SamlConfiguration" }, "StackSetName": { + "markdownDescription": "The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StackSetName", "type": "string" }, "VpcConfiguration": { - "$ref": "#/definitions/AWS::Grafana::Workspace.VpcConfiguration" + "$ref": "#/definitions/AWS::Grafana::Workspace.VpcConfiguration", + "markdownDescription": "The configuration for connecting to data sources in a private VPC \\(Amazon Virtual Private Cloud\\)\\. \n*Required*: No \n*Type*: [VpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-vpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcConfiguration" } }, "type": "object" @@ -86585,21 +88543,33 @@ "additionalProperties": false, "properties": { "Email": { + "markdownDescription": "The name of the attribute within the SAML assertion to use as the email names for SAML users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Email", "type": "string" }, "Groups": { + "markdownDescription": "The name of the attribute within the SAML assertion to use as the user full \"friendly\" names for user groups\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Groups", "type": "string" }, "Login": { + "markdownDescription": "The name of the attribute within the SAML assertion to use as the login names for SAML users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Login", "type": "string" }, "Name": { + "markdownDescription": "The name of the attribute within the SAML assertion to use as the user full \"friendly\" names for SAML users\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Org": { + "markdownDescription": "The name of the attribute within the SAML assertion to use as the user full \"friendly\" names for the users' organizations\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Org", "type": "string" }, "Role": { + "markdownDescription": "The name of the attribute within the SAML assertion to use as the user roles\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Role", "type": "string" } }, @@ -86609,9 +88579,13 @@ "additionalProperties": false, "properties": { "Url": { + "markdownDescription": "The URL of the location containing the IdP metadata\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Url", "type": "string" }, "Xml": { + "markdownDescription": "The full IdP metadata, in XML format\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Xml", "type": "string" } }, @@ -86624,12 +88598,16 @@ "items": { "type": "string" }, + "markdownDescription": "A list of groups from the SAML assertion attribute to grant the Grafana `Admin` role to\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Admin", "type": "array" }, "Editor": { "items": { "type": "string" }, + "markdownDescription": "A list of groups from the SAML assertion attribute to grant the Grafana `Editor` role to\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Editor", "type": "array" } }, @@ -86642,19 +88620,29 @@ "items": { "type": "string" }, + "markdownDescription": "Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace\\. If this is empty, all organizations in the assertion attribute have access\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowedOrganizations", "type": "array" }, "AssertionAttributes": { - "$ref": "#/definitions/AWS::Grafana::Workspace.AssertionAttributes" + "$ref": "#/definitions/AWS::Grafana::Workspace.AssertionAttributes", + "markdownDescription": "A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace\\. \n*Required*: No \n*Type*: [AssertionAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-assertionattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssertionAttributes" }, "IdpMetadata": { - "$ref": "#/definitions/AWS::Grafana::Workspace.IdpMetadata" + "$ref": "#/definitions/AWS::Grafana::Workspace.IdpMetadata", + "markdownDescription": "A structure containing the identity provider \\(IdP\\) metadata used to integrate the identity provider with this workspace\\. \n*Required*: Yes \n*Type*: [IdpMetadata](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-idpmetadata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IdpMetadata" }, "LoginValidityDuration": { + "markdownDescription": "How long a sign\\-on session by a SAML user is valid, before the user has to sign on again\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LoginValidityDuration", "type": "number" }, "RoleValues": { - "$ref": "#/definitions/AWS::Grafana::Workspace.RoleValues" + "$ref": "#/definitions/AWS::Grafana::Workspace.RoleValues", + "markdownDescription": "A structure containing arrays that map group names in the SAML assertion to the Grafana `Admin` and `Editor` roles in the workspace\\. \n*Required*: No \n*Type*: [RoleValues](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-grafana-workspace-rolevalues.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleValues" } }, "required": [ @@ -86669,12 +88657,16 @@ "items": { "type": "string" }, + "markdownDescription": "The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect\\. Duplicates not allowed\\. \n*Array Members*: Minimum number of 1 items\\. Maximum number of 5 items\\. \n*Length*: Minimum length of 0\\. Maximum length of 255\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroupIds", "type": "array" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect\\. Duplicates not allowed\\. \n*Array Members*: Minimum number of 2 items\\. Maximum number of 6 items\\. \n*Length*: Minimum length of 0\\. Maximum length of 255\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetIds", "type": "array" } }, @@ -89250,12 +91242,12 @@ "additionalProperties": false, "properties": { "DependencyType": { - "markdownDescription": "The type of this dependency\\. Choose from the following options: \n+ `SOFT` \u2013 The component doesn't restart if the dependency changes state\\.\n+ `HARD` \u2013 The component restarts if the dependency changes state\\.\nDefault: `HARD` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of this dependency\\. Choose from the following options: \n+ `SOFT` \u2013 The component doesn't restart if the dependency changes state\\.\n+ `HARD` \u2013 The component restarts if the dependency changes state\\.\nDefault: `HARD` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DependencyType", "type": "string" }, "VersionRequirement": { - "markdownDescription": "The component version requirement for the component dependency\\. \nAWS IoT Greengrass uses semantic version constraints\\. For more information, see [Semantic Versioning](https://semver.org/)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The component version requirement for the component dependency\\. \nAWS IoT Greengrass uses semantic version constraints\\. For more information, see [Semantic Versioning](https://semver.org/)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VersionRequirement", "type": "string" } @@ -89267,7 +91259,7 @@ "properties": { "Attributes": { "additionalProperties": true, - "markdownDescription": "A dictionary of attributes for the platform\\. The software defines the `os` and `platform` by default\\. You can specify additional platform attributes for a core device when you deploy the Greengrass nucleus component\\. For more information, see the [Greengrass nucleus component](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A dictionary of attributes for the platform\\. The AWS IoT Greengrass Core software defines the `os` and `platform` by default\\. You can specify additional platform attributes for a core device when you deploy the AWS IoT Greengrass nucleus component\\. For more information, see the [AWS IoT Greengrass nucleus component](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -89394,7 +91386,7 @@ "title": "LinuxProcessParams" }, "MaxIdleTimeInSeconds": { - "markdownDescription": "The maximum amount of time in seconds that a non\\-pinned Lambda function can idle before the software stops its process\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum amount of time in seconds that a non\\-pinned Lambda function can idle before the AWS IoT Greengrass Core software stops its process\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaxIdleTimeInSeconds", "type": "number" }, @@ -89404,12 +91396,12 @@ "type": "number" }, "MaxQueueSize": { - "markdownDescription": "The maximum size of the message queue for the Lambda function component\\. The Greengrass core device stores messages in a FIFO \\(first\\-in\\-first\\-out\\) queue until it can run the Lambda function to consume each message\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum size of the message queue for the Lambda function component\\. The AWS IoT Greengrass core device stores messages in a FIFO \\(first\\-in\\-first\\-out\\) queue until it can run the Lambda function to consume each message\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaxQueueSize", "type": "number" }, "Pinned": { - "markdownDescription": "Whether or not the Lambda function is pinned, or long\\-lived\\. \n+ A pinned Lambda function starts when the starts and keeps running in its own container\\.\n+ A non\\-pinned Lambda function starts only when it receives a work item and exists after it idles for `maxIdleTimeInSeconds`\\. If the function has multiple work items, the software creates multiple instances of the function\\.\nDefault: `true` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Whether or not the Lambda function is pinned, or long\\-lived\\. \n+ A pinned Lambda function starts when the AWS IoT Greengrass Core starts and keeps running in its own container\\.\n+ A non\\-pinned Lambda function starts only when it receives a work item and exists after it idles for `maxIdleTimeInSeconds`\\. If the function has multiple work items, the AWS IoT Greengrass Core software creates multiple instances of the function\\.\nDefault: `true` \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Pinned", "type": "boolean" }, @@ -89442,7 +91434,7 @@ }, "ComponentLambdaParameters": { "$ref": "#/definitions/AWS::GreengrassV2::ComponentVersion.LambdaExecutionParameters", - "markdownDescription": "The system and runtime parameters for the Lambda function as it runs on the Greengrass core device\\. \n*Required*: No \n*Type*: [LambdaExecutionParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The system and runtime parameters for the Lambda function as it runs on the AWS IoT Greengrass core device\\. \n*Required*: No \n*Type*: [LambdaExecutionParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-componentversion-lambdaexecutionparameters.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ComponentLambdaParameters" }, "ComponentName": { @@ -89550,32 +91542,44 @@ "properties": { "Components": { "additionalProperties": false, + "markdownDescription": "The components to deploy\\. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component\\. \n*Required*: No \n*Type*: Map of [ComponentDeploymentSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentdeploymentspecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::GreengrassV2::Deployment.ComponentDeploymentSpecification" } }, + "title": "Components", "type": "object" }, "DeploymentName": { + "markdownDescription": "The name of the deployment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DeploymentName", "type": "string" }, "DeploymentPolicies": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentPolicies" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentPolicies", + "markdownDescription": "The deployment policies for the deployment\\. These policies define how the deployment updates components and handles failure\\. \n*Required*: No \n*Type*: [DeploymentPolicies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentpolicies.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DeploymentPolicies" }, "IotJobConfiguration": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentIoTJobConfiguration" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentIoTJobConfiguration", + "markdownDescription": "The job configuration for the deployment configuration\\. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration\\. \n*Required*: No \n*Type*: [DeploymentIoTJobConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentiotjobconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IotJobConfiguration" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Application\\-specific metadata to attach to the deployment\\. You can use tags in IAM policies to control access to AWS IoT Greengrass resources\\. You can also use tags to categorize your resources\\. For more information, see [Tag your AWS IoT Greengrass Version 2 resources](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html) in the *AWS IoT Greengrass V2 Developer Guide*\\. \nThis `Json` property type is processed as a map of key\\-value pairs\\. It uses the following format, which is different from most `Tags` implementations in AWS CloudFormation templates\\.", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "TargetArn": { + "markdownDescription": "The ARN of the target AWS IoT thing or thing group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TargetArn", "type": "string" } }, @@ -89609,12 +91613,16 @@ "additionalProperties": false, "properties": { "Merge": { + "markdownDescription": "A serialized JSON string that contains the configuration object to merge to target devices\\. The core device merges this configuration with the component's existing configuration\\. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration\\. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object\\. For more information, see [Merge configuration updates](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#merge-configuration-update) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Merge", "type": "string" }, "Reset": { "items": { "type": "string" }, + "markdownDescription": "The list of configuration nodes to reset to default values on target devices\\. Use JSON pointers to specify each node to reset\\. JSON pointers start with a forward slash \\(`/`\\) and use forward slashes to separate the key for each level in the object\\. For more information, see the [JSON pointer specification](https://tools.ietf.org/html/rfc6901) and [Reset configuration updates](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#reset-configuration-update) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Reset", "type": "array" } }, @@ -89624,13 +91632,19 @@ "additionalProperties": false, "properties": { "ComponentVersion": { + "markdownDescription": "The version of the component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ComponentVersion", "type": "string" }, "ConfigurationUpdate": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.ComponentConfigurationUpdate" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.ComponentConfigurationUpdate", + "markdownDescription": "The configuration updates to deploy for the component\\. You can define reset updates and merge updates\\. A reset updates the keys that you specify to the default configuration for the component\\. A merge updates the core device's component configuration with the keys and values that you specify\\. The AWS IoT Greengrass Core software applies reset updates before it applies merge updates\\. For more information, see [Update component configuration](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html)\\. \n*Required*: No \n*Type*: [ComponentConfigurationUpdate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentconfigurationupdate.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConfigurationUpdate" }, "RunWith": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.ComponentRunWith" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.ComponentRunWith", + "markdownDescription": "The system user and group that the software uses to run component processes on the core device\\. If you omit this parameter, the software uses the system user and group that you configure for the core device\\. For more information, see [Configure the user and group that run components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user) in the *AWS IoT Greengrass V2 Developer Guide*\\. \n*Required*: No \n*Type*: [ComponentRunWith](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-componentrunwith.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RunWith" } }, "type": "object" @@ -89639,12 +91653,18 @@ "additionalProperties": false, "properties": { "PosixUser": { + "markdownDescription": "The POSIX system user and \\(optional\\) group to use to run this component\\. Specify the user and group separated by a colon \\(`:`\\) in the following format: `user:group`\\. The group is optional\\. If you don't specify a group, the AWS IoT Greengrass Core software uses the primary user for the group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PosixUser", "type": "string" }, "SystemResourceLimits": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.SystemResourceLimits" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.SystemResourceLimits", + "markdownDescription": "The system resource limits to apply to this component's process on the core device\\. AWS IoT Greengrass supports this feature only on Linux core devices\\. \nIf you omit this parameter, the AWS IoT Greengrass Core software uses the default system resource limits that you configure on the AWS IoT Greengrass nucleus component\\. For more information, see [ Configure system resource limits for components ](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits)\\. \n*Required*: No \n*Type*: [SystemResourceLimits](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-systemresourcelimits.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SystemResourceLimits" }, "WindowsUser": { + "markdownDescription": "The Windows user to use to run this component on Windows core devices\\. The user must exist on each Windows core device, and its name and password must be in the LocalSystem account's Credentials Manager instance\\. \nIf you omit this parameter, the AWS IoT Greengrass Core software uses the default Windows user that you configure on the AWS IoT Greengrass nucleus component\\. For more information, see [Configure the user and group that run components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "WindowsUser", "type": "string" } }, @@ -89654,9 +91674,13 @@ "additionalProperties": false, "properties": { "Action": { + "markdownDescription": "Whether or not to notify components and wait for components to become safe to update\\. Choose from the following options: \n+ `NOTIFY_COMPONENTS` \u2013 The deployment notifies each component before it stops and updates that component\\. Components can use the [SubscribeToComponentUpdates](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates) IPC operation to receive these notifications\\. Then, components can respond with the [DeferComponentUpdate](https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate) IPC operation\\. For more information, see the [Create deployments](https://docs.aws.amazon.com/greengrass/v2/latest/developerguide/create-deployments.html) in the *AWS IoT Greengrass V2 Developer Guide*\\.\n+ `SKIP_NOTIFY_COMPONENTS` \u2013 The deployment doesn't notify components or wait for them to be safe to update\\.\nDefault: `NOTIFY_COMPONENTS` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Action", "type": "string" }, "TimeoutInSeconds": { + "markdownDescription": "The amount of time in seconds that each component on a device has to report that it's safe to update\\. If the component waits for longer than this timeout, then the deployment proceeds on the device\\. \nDefault: `60` \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TimeoutInSeconds", "type": "number" } }, @@ -89666,6 +91690,8 @@ "additionalProperties": false, "properties": { "TimeoutInSeconds": { + "markdownDescription": "The amount of time in seconds that a component can validate its configuration updates\\. If the validation time exceeds this timeout, then the deployment proceeds for the device\\. \nDefault: `30` \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TimeoutInSeconds", "type": "number" } }, @@ -89675,13 +91701,19 @@ "additionalProperties": false, "properties": { "AbortConfig": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobAbortConfig" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobAbortConfig", + "markdownDescription": "The stop configuration for the job\\. This configuration defines when and how to stop a job rollout\\. \n*Required*: No \n*Type*: [IoTJobAbortConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AbortConfig" }, "JobExecutionsRolloutConfig": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobExecutionsRolloutConfig" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobExecutionsRolloutConfig", + "markdownDescription": "The rollout configuration for the job\\. This configuration defines the rate at which the job rolls out to the fleet of target devices\\. \n*Required*: No \n*Type*: [IoTJobExecutionsRolloutConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexecutionsrolloutconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "JobExecutionsRolloutConfig" }, "TimeoutConfig": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobTimeoutConfig" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobTimeoutConfig", + "markdownDescription": "The timeout configuration for the job\\. This configuration defines the amount of time each device has to complete the job\\. \n*Required*: No \n*Type*: [IoTJobTimeoutConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobtimeoutconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TimeoutConfig" } }, "type": "object" @@ -89690,12 +91722,18 @@ "additionalProperties": false, "properties": { "ComponentUpdatePolicy": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentComponentUpdatePolicy" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentComponentUpdatePolicy", + "markdownDescription": "The component update policy for the configuration deployment\\. This policy defines when it's safe to deploy the configuration to devices\\. \n*Required*: No \n*Type*: [DeploymentComponentUpdatePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentcomponentupdatepolicy.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ComponentUpdatePolicy" }, "ConfigurationValidationPolicy": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentConfigurationValidationPolicy" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.DeploymentConfigurationValidationPolicy", + "markdownDescription": "The configuration validation policy for the configuration deployment\\. This policy defines how long each component has to validate its configure updates\\. \n*Required*: No \n*Type*: [DeploymentConfigurationValidationPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-deploymentconfigurationvalidationpolicy.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConfigurationValidationPolicy" }, "FailureHandlingPolicy": { + "markdownDescription": "The failure handling policy for the configuration deployment\\. This policy defines what to do if the deployment fails\\. \nDefault: `ROLLBACK` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FailureHandlingPolicy", "type": "string" } }, @@ -89708,6 +91746,8 @@ "items": { "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobAbortCriteria" }, + "markdownDescription": "The list of criteria that define when and how to cancel the configuration deployment\\. \n*Required*: Yes \n*Type*: List of [IoTJobAbortCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobabortcriteria.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CriteriaList", "type": "array" } }, @@ -89720,15 +91760,23 @@ "additionalProperties": false, "properties": { "Action": { + "markdownDescription": "The action to perform when the criteria are met\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Action", "type": "string" }, "FailureType": { + "markdownDescription": "The type of job deployment failure that can cancel a job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FailureType", "type": "string" }, "MinNumberOfExecutedThings": { + "markdownDescription": "The minimum number of things that receive the configuration before the job can cancel\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MinNumberOfExecutedThings", "type": "number" }, "ThresholdPercentage": { + "markdownDescription": "The minimum percentage of `failureType` failures that occur before the job can cancel\\. \nThis parameter supports up to two digits after the decimal \\(for example, you can specify `10.9` or `10.99`, but not `10.999`\\)\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ThresholdPercentage", "type": "number" } }, @@ -89744,9 +91792,13 @@ "additionalProperties": false, "properties": { "ExponentialRate": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobExponentialRolloutRate" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobExponentialRolloutRate", + "markdownDescription": "The exponential rate to increase the job rollout rate\\. \n*Required*: No \n*Type*: [IoTJobExponentialRolloutRate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobexponentialrolloutrate.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExponentialRate" }, "MaximumPerMinute": { + "markdownDescription": "The maximum number of devices that receive a pending job notification, per minute\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaximumPerMinute", "type": "number" } }, @@ -89756,13 +91808,19 @@ "additionalProperties": false, "properties": { "BaseRatePerMinute": { + "markdownDescription": "The minimum number of devices that receive a pending job notification, per minute, when the job starts\\. This parameter defines the initial rollout rate of the job\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BaseRatePerMinute", "type": "number" }, "IncrementFactor": { + "markdownDescription": "The exponential factor to increase the rollout rate for the job\\. \nThis parameter supports up to one digit after the decimal \\(for example, you can specify `1.5`, but not `1.55`\\)\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IncrementFactor", "type": "number" }, "RateIncreaseCriteria": { - "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobRateIncreaseCriteria" + "$ref": "#/definitions/AWS::GreengrassV2::Deployment.IoTJobRateIncreaseCriteria", + "markdownDescription": "The criteria to increase the rollout rate for the job\\. \n*Required*: Yes \n*Type*: [IoTJobRateIncreaseCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrassv2-deployment-iotjobrateincreasecriteria.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RateIncreaseCriteria" } }, "required": [ @@ -89776,9 +91834,13 @@ "additionalProperties": false, "properties": { "NumberOfNotifiedThings": { + "markdownDescription": "The number of devices to receive the job notification before the rollout rate increases\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NumberOfNotifiedThings", "type": "number" }, "NumberOfSucceededThings": { + "markdownDescription": "The number of devices to successfully run the configuration job before the rollout rate increases\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NumberOfSucceededThings", "type": "number" } }, @@ -89788,6 +91850,8 @@ "additionalProperties": false, "properties": { "InProgressTimeoutInMinutes": { + "markdownDescription": "The amount of time, in minutes, that devices have to complete the job\\. The timer starts when the job status is set to `IN_PROGRESS`\\. If the job status doesn't change to a terminal state before the time expires, then the job status is set to `TIMED_OUT`\\. \nThe timeout interval must be between 1 minute and 7 days \\(10080 minutes\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InProgressTimeoutInMinutes", "type": "number" } }, @@ -89797,9 +91861,13 @@ "additionalProperties": false, "properties": { "Cpus": { + "markdownDescription": "The maximum amount of CPU time that a component's processes can use on the core device\\. A core device's total CPU time is equivalent to the device's number of CPU cores\\. For example, on a core device with 4 CPU cores, you can set this value to 2 to limit the component's processes to 50 percent usage of each CPU core\\. On a device with 1 CPU core, you can set this value to 0\\.25 to limit the component's processes to 25 percent usage of the CPU\\. If you set this value to a number greater than the number of CPU cores, the AWS IoT Greengrass Core software doesn't limit the component's CPU usage\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Cpus", "type": "number" }, "Memory": { + "markdownDescription": "The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on the core device\\. For more information, see [Configure system resource limits for components](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-system-resource-limits)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Memory", "type": "number" } }, @@ -90187,9 +92255,13 @@ "additionalProperties": false, "properties": { "ContactPostPassDurationSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContactPostPassDurationSeconds", "type": "number" }, "ContactPrePassDurationSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContactPrePassDurationSeconds", "type": "number" }, "EndpointDetails": { @@ -90491,6 +92563,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags to be added to a new detector resource\\. Each tag consists of a key and an optional value, both of which you define\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -90529,7 +92603,9 @@ "title": "Kubernetes" }, "MalwareProtection": { - "$ref": "#/definitions/AWS::GuardDuty::Detector.CFNMalwareProtectionConfiguration" + "$ref": "#/definitions/AWS::GuardDuty::Detector.CFNMalwareProtectionConfiguration", + "markdownDescription": "Describes whether Malware Protection will be enabled as a data source\\. \n*Required*: No \n*Type*: [CFNMalwareProtectionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnmalwareprotectionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MalwareProtection" }, "S3Logs": { "$ref": "#/definitions/AWS::GuardDuty::Detector.CFNS3LogsConfiguration", @@ -90565,7 +92641,9 @@ "additionalProperties": false, "properties": { "ScanEc2InstanceWithFindings": { - "$ref": "#/definitions/AWS::GuardDuty::Detector.CFNScanEc2InstanceWithFindingsConfiguration" + "$ref": "#/definitions/AWS::GuardDuty::Detector.CFNScanEc2InstanceWithFindingsConfiguration", + "markdownDescription": "Describes the configuration of Malware Protection for EC2 instances with findings\\. \n*Required*: No \n*Type*: [CFNScanEc2InstanceWithFindingsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-guardduty-detector-cfnscanec2instancewithfindingsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ScanEc2InstanceWithFindings" } }, "type": "object" @@ -90585,6 +92663,8 @@ "additionalProperties": false, "properties": { "EbsVolumes": { + "markdownDescription": "Describes the configuration for scanning EBS volumes as data source\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EbsVolumes", "type": "boolean" } }, @@ -90631,7 +92711,7 @@ "type": "string" }, "Description": { - "markdownDescription": "The description of the filter\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the filter\\. Valid special characters include period \\(\\.\\), underscore \\(\\_\\), dash \\(\\-\\), and whitespace\\. The new line character is considered to be an invalid input for description\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -90646,12 +92726,12 @@ "title": "FindingCriteria" }, "Name": { - "markdownDescription": "The name of the filter\\. Minimum length of 3\\. Maximum length of 64\\. Valid characters include alphanumeric characters, dot \\(\\.\\), underscore \\(\\_\\), and dash \\(\\-\\)\\. Spaces are not allowed\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the filter\\. Valid characters include period \\(\\.\\), underscore \\(\\_\\), dash \\(\\-\\), and alphanumeric characters\\. A whitespace is considered to be an invalid character\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `64` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, "Rank": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the position of the filter in the list of current filters\\. Also specifies the order in which this filter is applied to the findings\\. The minimum value for this property is 1 and the maximum is 100\\. \nBy default, filters may not be created in the same order as they are ranked\\. To ensure that the filters are created in the expected order, you can use an optional attribute, [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html), with the following syntax: `\"DependsOn\":[ \"ObjectName\" ]`\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Rank", "type": "number" }, @@ -90659,6 +92739,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags to be added to a new filter resource\\. Each tag consists of a key and an optional value, both of which you define\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -90708,15 +92790,23 @@ "items": { "type": "string" }, + "markdownDescription": "Represents an *equal* **** condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Equals", "type": "array" }, "GreaterThan": { + "markdownDescription": "Represents a *greater than* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GreaterThan", "type": "number" }, "GreaterThanOrEqual": { + "markdownDescription": "Represents a *greater than or equal* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GreaterThanOrEqual", "type": "number" }, "Gt": { + "markdownDescription": "Represents a *greater than* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Gt", "type": "number" }, "Gte": { @@ -90725,9 +92815,13 @@ "type": "number" }, "LessThan": { + "markdownDescription": "Represents a *less than* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LessThan", "type": "number" }, "LessThanOrEqual": { + "markdownDescription": "Represents a *less than or equal* condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LessThanOrEqual", "type": "number" }, "Lt": { @@ -90752,6 +92846,8 @@ "items": { "type": "string" }, + "markdownDescription": "Represents a *not equal* **** condition to be applied to a single field when querying for findings\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotEquals", "type": "array" } }, @@ -90829,7 +92925,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The user\\-friendly name to identify the IPSet\\. \n Allowed characters are alphanumerics, spaces, hyphens \\(\\-\\), and underscores \\(\\_\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user\\-friendly name to identify the IPSet\\. \n Allowed characters are alphanumeric, whitespace, dash \\(\\-\\), and underscores \\(\\_\\)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `300` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -90837,6 +92933,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags to be added to a new IP set resource\\. Each tag consists of a key and an optional value, both of which you define\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -91105,6 +93203,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags to be added to a new threat list resource\\. Each tag consists of a key and an optional value, both of which you define\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -91231,9 +93331,13 @@ "additionalProperties": false, "properties": { "Nanos": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Nanos", "type": "number" }, "Seconds": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Seconds", "type": "string" } }, @@ -91886,7 +93990,7 @@ "type": "object" }, "Description": { - "markdownDescription": "A description of the role that you provide\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Pattern*: `[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description of the role that you provide\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -91899,7 +94003,7 @@ "type": "array" }, "MaxSessionDuration": { - "markdownDescription": "The maximum session duration \\(in seconds\\) that you want to set for the specified role\\. If you do not specify a value for this setting, the default maximum of one hour is applied\\. This setting can have a value from 1 hour to 12 hours\\. \nAnyone who assumes the role from the or API can use the `DurationSeconds` API parameter or the `duration-seconds` CLI parameter to request a longer session\\. The `MaxSessionDuration` setting determines the maximum duration that can be requested using the `DurationSeconds` parameter\\. If users don't specify a value for the `DurationSeconds` parameter, their security credentials are valid for one hour by default\\. This applies when you use the `AssumeRole*` API operations or the `assume-role*` CLI operations but does not apply when you use those operations to create a console URL\\. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `3600` \n*Maximum*: `43200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum session duration \\(in seconds\\) that you want to set for the specified role\\. If you do not specify a value for this setting, the default value of one hour is applied\\. This setting can have a value from 1 hour to 12 hours\\. \nAnyone who assumes the role from the AWS CLI or API can use the `DurationSeconds` API parameter or the `duration-seconds` AWS CLI parameter to request a longer session\\. The `MaxSessionDuration` setting determines the maximum duration that can be requested using the `DurationSeconds` parameter\\. If users don't specify a value for the `DurationSeconds` parameter, their security credentials are valid for one hour by default\\. This applies when you use the `AssumeRole*` API operations or the `assume-role*` AWS CLI operations but does not apply when you use those operations to create a console URL\\. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `3600` \n*Maximum*: `43200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxSessionDuration", "type": "number" }, @@ -91917,7 +94021,7 @@ "items": { "$ref": "#/definitions/AWS::IAM::Role.Policy" }, - "markdownDescription": "Adds or updates an inline policy document that is embedded in the specified IAM role\\. \nWhen you embed an inline policy in a role, the inline policy is used as part of the role's access \\(permissions\\) policy\\. The role's trust policy is created at the same time as the role\\. You can update a role's trust policy later\\. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html)\\. \nA role can also have an attached managed policy\\. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*\\. \nFor information about limits on the number of inline policies that you can embed with a role, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*\\. \nIf an external policy \\(such as `AWS::IAM::Policy` or `AWS::IAM::ManagedPolicy`\\) has a `Ref` to a role and if a resource \\(such as `AWS::ECS::Service`\\) also has a `Ref` to the same role, add a `DependsOn` attribute to the resource to make the resource depend on the external policy\\. This dependency ensures that the role's policy is available throughout the resource's lifecycle\\. For example, when you delete a stack with an `AWS::ECS::Service` resource, the `DependsOn` attribute ensures that AWS CloudFormation deletes the `AWS::ECS::Service` resource before deleting its role's policy\\.\n*Required*: No \n*Type*: List of [Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Adds or updates an inline policy document that is embedded in the specified IAM role\\. \nWhen you embed an inline policy in a role, the inline policy is used as part of the role's access \\(permissions\\) policy\\. The role's trust policy is created at the same time as the role\\. You can update a role's trust policy later\\. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html)\\. \nA role can also have an attached managed policy\\. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*\\. \nFor information about limits on the number of inline policies that you can embed with a role, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*\\. \nIf an external policy \\(such as `AWS::IAM::Policy` or `AWS::IAM::ManagedPolicy`\\) has a `Ref` to a role and if a resource \\(such as `AWS::ECS::Service`\\) also has a `Ref` to the same role, add a `DependsOn` attribute to the resource to make the resource depend on the external policy\\. This dependency ensures that the role's policy is available throughout the resource's lifecycle\\. For example, when you delete a stack with an `AWS::ECS::Service` resource, the `DependsOn` attribute ensures that AWS CloudFormation deletes the `AWS::ECS::Service` resource before deleting its role's policy\\.\n*Required*: No \n*Type*: List of [Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Policies", "type": "array" }, @@ -91965,7 +94069,7 @@ "additionalProperties": false, "properties": { "PolicyDocument": { - "markdownDescription": "The policy document\\. \n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `131072` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The entire contents of the policy that defines permissions\\. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json)\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PolicyDocument", "type": "object" }, @@ -92198,7 +94302,7 @@ "type": "string" }, "Description": { - "markdownDescription": "The description of the role\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Pattern*: `[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the role\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" } @@ -92291,7 +94395,7 @@ "type": "string" }, "PermissionsBoundary": { - "markdownDescription": "The ARN of the policy that is used to set the permissions boundary for the user\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN of the managed policy that is used to set the permissions boundary for the user\\. \nA permissions boundary policy defines the maximum permissions that identity\\-based policies can grant to an entity, but does not grant permissions\\. Permissions boundaries do not define the maximum permissions that a resource\\-based policy can grant to an entity\\. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*\\. \nFor more information about policy types, see [Policy types ](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PermissionsBoundary", "type": "string" }, @@ -92299,7 +94403,7 @@ "items": { "$ref": "#/definitions/AWS::IAM::User.Policy" }, - "markdownDescription": "Adds or updates an inline policy document that is embedded in the specified IAM user\\. To view AWS::IAM::User snippets, see [Declaring an IAM User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user)\\. \nThe name of each policy for a role, user, or group must be unique\\. If you don't choose unique names, updates to the IAM identity will fail\\. \nFor information about limits on the number of inline policies that you can embed in a user, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: List of [Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Adds or updates an inline policy document that is embedded in the specified IAM user\\. To view AWS::IAM::User snippets, see [Declaring an IAM User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user)\\. \nThe name of each policy for a role, user, or group must be unique\\. If you don't choose unique names, updates to the IAM identity will fail\\. \nFor information about limits on the number of inline policies that you can embed in a user, see [Limitations on IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *IAM User Guide*\\. \n*Required*: No \n*Type*: List of [Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Policies", "type": "array" }, @@ -92362,7 +94466,7 @@ "additionalProperties": false, "properties": { "PolicyDocument": { - "markdownDescription": "The policy document\\. \n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `131072` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The entire contents of the policy that defines permissions\\. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json)\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PolicyDocument", "type": "object" }, @@ -92606,7 +94710,7 @@ "type": "array" }, "Type": { - "markdownDescription": "The channel type, which determines the allowable resolution and bitrate\\. *If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately\\.* Valid values: \n+ `STANDARD`: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions\\. Resolution can be up to 1080p and bitrate can be up to 8\\.5 Mbps\\. Audio is transcoded only for renditions 360p and below; above that, audio is passed through\\.\n+ `BASIC`: delivers the original input to viewers\\. The viewer\u2019s video\\-quality choice is limited to the original input\\. Resolution can be up to 480p and bitrate can be up to 1\\.5 Mbps\\.\n*Default*: `STANDARD` \n*Required*: No \n*Type*: String \n*Allowed values*: `BASIC | STANDARD` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The channel type, which determines the allowable resolution and bitrate\\. *If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately\\.* Valid values: \n+ `STANDARD`: Video is transcoded: multiple qualities are generated from the original input to automatically give viewers the best experience for their devices and network conditions\\. Transcoding allows higher playback quality across a range of download speeds\\. Resolution can be up to 1080p and bitrate can be up to 8\\.5 Mbps\\. Audio is transcoded only for renditions 360p and below; above that, audio is passed through\\.\n+ `BASIC`: Video is transmuxed: Amazon IVS delivers the original input to viewers\\. The viewer\u2019s video\\-quality choice is limited to the original input\\. Resolution can be up to 1080p and bitrate can be up to 1\\.5 Mbps for 480p and up to 3\\.5 Mbps for resolutions between 480p and 1080p\\.\n*Default*: `STANDARD` \n*Required*: No \n*Type*: String \n*Allowed values*: `ADVANCED_HD | ADVANCED_SD | BASIC | STANDARD` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" } @@ -92674,7 +94778,7 @@ "type": "string" }, "PublicKeyMaterial": { - "markdownDescription": "The public portion of a customer\\-generated key pair\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The public portion of a customer\\-generated key pair\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PublicKeyMaterial", "type": "string" }, @@ -92755,6 +94859,8 @@ "type": "string" }, "RecordingReconnectWindowSeconds": { + "markdownDescription": "If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together\\. \n*Default*: `0` \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `300` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RecordingReconnectWindowSeconds", "type": "number" }, "Tags": { @@ -92955,12 +95061,18 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A string containing the description of the group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "DisplayName": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DisplayName", "type": "string" }, "IdentityStoreId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IdentityStoreId", "type": "string" } }, @@ -93027,13 +95139,19 @@ "additionalProperties": false, "properties": { "GroupId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GroupId", "type": "string" }, "IdentityStoreId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IdentityStoreId", "type": "string" }, "MemberId": { - "$ref": "#/definitions/AWS::IdentityStore::GroupMembership.MemberId" + "$ref": "#/definitions/AWS::IdentityStore::GroupMembership.MemberId", + "markdownDescription": "An object containing the identifier of a group member\\. Setting `MemberId`'s `UserId` field to a specific User's ID indicates we should consider that User as a group member\\. \n*Required*: Yes \n*Type*: [MemberId](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-identitystore-groupmembership-memberid.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MemberId" } }, "required": [ @@ -93068,6 +95186,8 @@ "additionalProperties": false, "properties": { "UserId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserId", "type": "string" } }, @@ -93112,22 +95232,22 @@ "additionalProperties": false, "properties": { "ChangeDescription": { - "markdownDescription": "A change description of the component\\. For example `initial version`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The change description of the component\\. Describes what change has been made in this version, or what makes this version different from other versions of this component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ChangeDescription", "type": "string" }, "Data": { - "markdownDescription": "The data of the component\\. For example, `name: HelloWorldTestingDocument\\ndescription: This is hello world testing document.\\nschemaVersion: 1.0\\n\\nphases:\\n - name: test\\n steps:\\n - name: HelloWorldStep\\n action: ExecuteBash\\n inputs:\\n commands:\\n - echo \\\"Hello World! Test.\\\"\\n`\\. See Examples below for the schema for creating a component using Data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Component `data` contains inline YAML document content for the component\\. Alternatively, you can specify the `uri` of a YAML document file stored in Amazon S3\\. However, you cannot specify both properties\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16000` \n*Pattern*: `[^\\x00]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Data", "type": "string" }, "Description": { - "markdownDescription": "The description of the component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Describes the contents of the component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Description", "type": "string" }, "KmsKeyId": { - "markdownDescription": "The KMS key identifier used to encrypt the component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the KMS key that is used to encrypt this component\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" }, @@ -93137,7 +95257,7 @@ "type": "string" }, "Platform": { - "markdownDescription": "The platform of the component\\. For example, `Windows`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Linux | Windows` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The operating system platform of the component\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Linux | Windows` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Platform", "type": "string" }, @@ -93151,7 +95271,7 @@ }, "Tags": { "additionalProperties": true, - "markdownDescription": "The tags associated with the component\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The tags that apply to the component\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -93166,7 +95286,7 @@ "type": "string" }, "Version": { - "markdownDescription": "The component version\\. For example, `1.0.0`\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[0-9]+\\.[0-9]+\\.[0-9]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The component version\\. For example, `1.0.0`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Version", "type": "string" } @@ -93238,7 +95358,7 @@ "items": { "$ref": "#/definitions/AWS::ImageBuilder::ContainerRecipe.ComponentConfiguration" }, - "markdownDescription": "Components for build and test that are included in the container recipe\\. \n*Required*: Yes \n*Type*: List of [ComponentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Build and test components that are included in the container recipe\\. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination\\. \n*Required*: Yes \n*Type*: List of [ComponentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Components", "type": "array" }, @@ -93263,7 +95383,7 @@ "type": "string" }, "ImageOsVersionOverride": { - "markdownDescription": "Specifies the operating system version for the source image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the operating system version for the base image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ImageOsVersionOverride", "type": "string" }, @@ -93288,7 +95408,7 @@ "type": "string" }, "PlatformOverride": { - "markdownDescription": "Specifies the operating system platform when you use a custom source image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the operating system platform when you use a custom base image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PlatformOverride", "type": "string" }, @@ -93362,6 +95482,8 @@ "items": { "$ref": "#/definitions/AWS::ImageBuilder::ContainerRecipe.ComponentParameter" }, + "markdownDescription": "A group of parameter settings that Image Builder uses to configure the component for a specific recipe\\. \n*Required*: No \n*Type*: List of [ComponentParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-containerrecipe-componentparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Parameters", "type": "array" } }, @@ -93371,12 +95493,16 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the component parameter to set\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[^\\x00]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Value": { "items": { "type": "string" }, + "markdownDescription": "Sets the value for the named component parameter\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "array" } }, @@ -93590,29 +95716,41 @@ "properties": { "AmiTags": { "additionalProperties": true, + "markdownDescription": "The tags to apply to AMIs distributed to this Region\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "AmiTags", "type": "object" }, "Description": { + "markdownDescription": "The description of the AMI distribution configuration\\. Minimum and maximum length are in characters\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "KmsKeyId": { + "markdownDescription": "The KMS key identifier used to encrypt the distributed image\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "LaunchPermissionConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.LaunchPermissionConfiguration" + "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.LaunchPermissionConfiguration", + "markdownDescription": "Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances\\. \n*Required*: No \n*Type*: [LaunchPermissionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LaunchPermissionConfiguration" }, "Name": { + "markdownDescription": "The name of the output AMI\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `127` \n*Pattern*: `^[-_A-Za-z0-9{][-_A-Za-z0-9\\s:{}\\.]+[-_A-Za-z0-9}]$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "TargetAccountIds": { "items": { "type": "string" }, + "markdownDescription": "The ID of an account to which you want to distribute an image\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1536` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetAccountIds", "type": "array" } }, @@ -93625,13 +95763,19 @@ "items": { "type": "string" }, + "markdownDescription": "Tags that are attached to the container distribution configuration\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContainerTags", "type": "array" }, "Description": { + "markdownDescription": "The description of the container distribution configuration\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "TargetRepository": { - "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.TargetContainerRepository" + "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.TargetContainerRepository", + "markdownDescription": "The destination repository for the container distribution configuration\\. \n*Required*: No \n*Type*: [TargetContainerRepository](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-targetcontainerrepository.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetRepository" } }, "type": "object" @@ -93641,18 +95785,20 @@ "properties": { "AmiDistributionConfiguration": { "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.AmiDistributionConfiguration", - "markdownDescription": "The specific AMI settings, such as launch permissions and AMI tags\\. For details, see example schema below\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The specific AMI settings, such as launch permissions and AMI tags\\. For details, see example schema below\\. \n*Required*: No \n*Type*: [AmiDistributionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-amidistributionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AmiDistributionConfiguration" }, "ContainerDistributionConfiguration": { "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.ContainerDistributionConfiguration", - "markdownDescription": "Container distribution settings for encryption, licensing, and sharing in a specific Region\\. For details, see example schema below\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Container distribution settings for encryption, licensing, and sharing in a specific Region\\. For details, see example schema below\\. \n*Required*: No \n*Type*: [ContainerDistributionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-containerdistributionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContainerDistributionConfiguration" }, "FastLaunchConfigurations": { "items": { "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.FastLaunchConfiguration" }, + "markdownDescription": "The Windows faster\\-launching configurations to use for AMI distribution\\. \n*Required*: No \n*Type*: List of [FastLaunchConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html) \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FastLaunchConfigurations", "type": "array" }, "LaunchTemplateConfigurations": { @@ -93686,19 +95832,29 @@ "additionalProperties": false, "properties": { "AccountId": { + "markdownDescription": "The owner account ID for the fast\\-launch enabled Windows AMI\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[0-9]{12}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccountId", "type": "string" }, "Enabled": { + "markdownDescription": "A Boolean that represents the current state of faster launching for the Windows AMI\\. Set to `true` to start using Windows faster launching, or `false` to stop using it\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "LaunchTemplate": { - "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.FastLaunchLaunchTemplateSpecification" + "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.FastLaunchLaunchTemplateSpecification", + "markdownDescription": "The launch template that the fast\\-launch enabled Windows AMI uses when it launches Windows instances to create pre\\-provisioned snapshots\\. \n*Required*: No \n*Type*: [FastLaunchLaunchTemplateSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LaunchTemplate" }, "MaxParallelLaunches": { + "markdownDescription": "The maximum number of parallel instances that are launched for creating resources\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxParallelLaunches", "type": "number" }, "SnapshotConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.FastLaunchSnapshotConfiguration" + "$ref": "#/definitions/AWS::ImageBuilder::DistributionConfiguration.FastLaunchSnapshotConfiguration", + "markdownDescription": "Configuration settings for managing the number of snapshots that are created from pre\\-provisioned instances for the Windows AMI when faster launching is enabled\\. \n*Required*: No \n*Type*: [FastLaunchSnapshotConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchsnapshotconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SnapshotConfiguration" } }, "type": "object" @@ -93707,12 +95863,18 @@ "additionalProperties": false, "properties": { "LaunchTemplateId": { + "markdownDescription": "The ID of the launch template to use for faster launching for a Windows AMI\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^lt-[a-z0-9-_]{17}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LaunchTemplateId", "type": "string" }, "LaunchTemplateName": { + "markdownDescription": "The name of the launch template to use for faster launching for a Windows AMI\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LaunchTemplateName", "type": "string" }, "LaunchTemplateVersion": { + "markdownDescription": "The version of the launch template to use for faster launching for a Windows AMI\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LaunchTemplateVersion", "type": "string" } }, @@ -93722,6 +95884,8 @@ "additionalProperties": false, "properties": { "TargetResourceCount": { + "markdownDescription": "The number of pre\\-provisioned snapshots to keep on hand for a fast\\-launch enabled Windows AMI\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetResourceCount", "type": "number" } }, @@ -93734,24 +95898,32 @@ "items": { "type": "string" }, + "markdownDescription": "The ARN for an AWS Organization that you want to share your AMI with\\. For more information, see [What is AWS Organizations?](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationArns", "type": "array" }, "OrganizationalUnitArns": { "items": { "type": "string" }, + "markdownDescription": "The ARN for an AWS Organizations organizational unit \\(OU\\) that you want to share your AMI with\\. For more information about key concepts for AWS Organizations, see [AWS Organizations terminology and concepts](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `25` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OrganizationalUnitArns", "type": "array" }, "UserGroups": { "items": { "type": "string" }, + "markdownDescription": "The name of the group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserGroups", "type": "array" }, "UserIds": { "items": { "type": "string" }, + "markdownDescription": "The AWS account ID\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1536` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserIds", "type": "array" } }, @@ -93782,9 +95954,13 @@ "additionalProperties": false, "properties": { "RepositoryName": { + "markdownDescription": "The name of the container repository where the output container image is stored\\. This name is prefixed by the repository location\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RepositoryName", "type": "string" }, "Service": { + "markdownDescription": "Specifies the service in which this image was registered\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ECR` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Service", "type": "string" } }, @@ -93836,7 +96012,7 @@ "type": "string" }, "EnhancedImageMetadataEnabled": { - "markdownDescription": "Collects additional information about the image being created, including the operating system \\(OS\\) version and package list\\. This information is used to enhance the overall experience of using EC2 Image Builder\\. Enabled by default\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Indicates whether Image Builder collects additional information about the image, such as the operating system \\(OS\\) version and package list\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EnhancedImageMetadataEnabled", "type": "boolean" }, @@ -93846,7 +96022,9 @@ "type": "string" }, "ImageScanningConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::Image.ImageScanningConfiguration" + "$ref": "#/definitions/AWS::ImageBuilder::Image.ImageScanningConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ImageScanningConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagescanningconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ImageScanningConfiguration" }, "ImageTestsConfiguration": { "$ref": "#/definitions/AWS::ImageBuilder::Image.ImageTestsConfiguration", @@ -93903,9 +96081,13 @@ "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContainerTags", "type": "array" }, "RepositoryName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RepositoryName", "type": "string" } }, @@ -93915,9 +96097,13 @@ "additionalProperties": false, "properties": { "EcrConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::Image.EcrConfiguration" + "$ref": "#/definitions/AWS::ImageBuilder::Image.EcrConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [EcrConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-ecrconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EcrConfiguration" }, "ImageScanningEnabled": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ImageScanningEnabled", "type": "boolean" } }, @@ -93932,7 +96118,7 @@ "type": "boolean" }, "TimeoutMinutes": { - "markdownDescription": "The maximum time in minutes that tests are permitted to run\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `1440` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum time in minutes that tests are permitted to run\\. \nThe timeoutMinutes attribute is not currently active\\. This value is ignored\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `1440` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TimeoutMinutes", "type": "number" } @@ -94000,7 +96186,9 @@ "type": "string" }, "ImageScanningConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration" + "$ref": "#/definitions/AWS::ImageBuilder::ImagePipeline.ImageScanningConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ImageScanningConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-imagescanningconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImageScanningConfiguration" }, "ImageTestsConfiguration": { "$ref": "#/definitions/AWS::ImageBuilder::ImagePipeline.ImageTestsConfiguration", @@ -94073,9 +96261,13 @@ "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContainerTags", "type": "array" }, "RepositoryName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RepositoryName", "type": "string" } }, @@ -94085,9 +96277,13 @@ "additionalProperties": false, "properties": { "EcrConfiguration": { - "$ref": "#/definitions/AWS::ImageBuilder::ImagePipeline.EcrConfiguration" + "$ref": "#/definitions/AWS::ImageBuilder::ImagePipeline.EcrConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [EcrConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagepipeline-ecrconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EcrConfiguration" }, "ImageScanningEnabled": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImageScanningEnabled", "type": "boolean" } }, @@ -94102,7 +96298,7 @@ "type": "boolean" }, "TimeoutMinutes": { - "markdownDescription": "The maximum time in minutes that tests are permitted to run\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `1440` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum time in minutes that tests are permitted to run\\. \nThe timeoutMinutes attribute is not currently active\\. This value is ignored\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `1440` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutMinutes", "type": "number" } @@ -94113,7 +96309,7 @@ "additionalProperties": false, "properties": { "PipelineExecutionStartCondition": { - "markdownDescription": "The condition configures when the pipeline should trigger a new image build\\. When the `pipelineExecutionStartCondition` is set to `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE`, and you use semantic version filters on the source image or components in your image recipe, Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter\\. When it is set to `EXPRESSION_MATCH_ONLY`, it will build a new image every time the CRON expression matches the current time\\. For semantic version syntax, see [CreateComponent](https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html) in the * Image Builder API Reference*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE | EXPRESSION_MATCH_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The condition configures when the pipeline should trigger a new image build\\. When the `pipelineExecutionStartCondition` is set to `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE`, and you use semantic version filters on the base image or components in your image recipe, Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter\\. When it is set to `EXPRESSION_MATCH_ONLY`, it will build a new image every time the CRON expression matches the current time\\. For semantic version syntax, see [CreateComponent](https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html) in the * Image Builder API Reference*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE | EXPRESSION_MATCH_ONLY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PipelineExecutionStartCondition", "type": "string" }, @@ -94192,7 +96388,7 @@ "type": "string" }, "ParentImage": { - "markdownDescription": "The parent image of the image recipe\\. The string must be either an Image ARN \\(SemVers is ok\\) or an AMI ID\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The parent image of the image recipe\\. The string must be either an Image ARN or an AMI ID\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ParentImage", "type": "string" }, @@ -94275,7 +96471,7 @@ "items": { "$ref": "#/definitions/AWS::ImageBuilder::ImageRecipe.ComponentParameter" }, - "markdownDescription": "A group of parameter settings that are used to configure the component for a specific recipe\\. \n*Required*: No \n*Type*: List of [ComponentParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-componentparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A group of parameter settings that Image Builder uses to configure the component for a specific recipe\\. \n*Required*: No \n*Type*: List of [ComponentParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-componentparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Parameters", "type": "array" } @@ -94538,7 +96734,7 @@ "additionalProperties": false, "properties": { "HttpPutResponseHopLimit": { - "markdownDescription": "Limit the number of hops that an instance metadata request can traverse to reach its destination\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Limit the number of hops that an instance metadata request can traverse to reach its destination\\. The default is one hop\\. However, if HTTP tokens are required, container image builds need a minimum of two hops\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HttpPutResponseHopLimit", "type": "number" }, @@ -95260,7 +97456,7 @@ "additionalProperties": false, "properties": { "Comparison": { - "markdownDescription": "The operator to use when comparing values in the filter \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The operator to use when comparing values in the filter\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Comparison", "type": "string" }, @@ -95674,10 +97870,14 @@ "title": "DeviceCertificateSharedCheck" }, "IntermediateCaRevokedForActiveDeviceCertificatesCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" + "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration", + "markdownDescription": "*Required*: No \n*Type*: [AuditCheckConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntermediateCaRevokedForActiveDeviceCertificatesCheck" }, "IoTPolicyPotentialMisConfigurationCheck": { - "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration" + "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration", + "markdownDescription": "*Required*: No \n*Type*: [AuditCheckConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-accountauditconfiguration-auditcheckconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IoTPolicyPotentialMisConfigurationCheck" }, "IotPolicyOverlyPermissiveCheck": { "$ref": "#/definitions/AWS::IoT::AccountAuditConfiguration.AuditCheckConfiguration", @@ -95795,7 +97995,7 @@ "type": "string" }, "EnableCachingForHttp": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableCachingForHttp", "type": "boolean" }, @@ -95896,30 +98096,46 @@ "additionalProperties": false, "properties": { "AutoRegistrationStatus": { + "markdownDescription": "Whether the CA certificate is configured for auto registration of device certificates\\. Valid values are \"ENABLE\" and \"DISABLE\"\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoRegistrationStatus", "type": "string" }, "CACertificatePem": { + "markdownDescription": "The certificate data in PEM format\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CACertificatePem", "type": "string" }, "CertificateMode": { + "markdownDescription": "The mode of the CA\\. \nAll the device certificates that are registered using this CA will be registered in the same mode as the CA\\. For more information about certificate mode for device certificates, see [certificate mode](https://docs.aws.amazon.com/iot/latest/apireference/API_CertificateDescription.html#iot-Type-CertificateDescription-certificateMode)\\. \nValid values are \"DEFAULT\" and \"SNI\\_ONLY\"\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CertificateMode", "type": "string" }, "RegistrationConfig": { - "$ref": "#/definitions/AWS::IoT::CACertificate.RegistrationConfig" + "$ref": "#/definitions/AWS::IoT::CACertificate.RegistrationConfig", + "markdownDescription": "Information about the registration configuration\\. \n*Required*: No \n*Type*: [RegistrationConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-cacertificate-registrationconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RegistrationConfig" }, "RemoveAutoRegistration": { + "markdownDescription": "If true, removes auto registration\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RemoveAutoRegistration", "type": "boolean" }, "Status": { + "markdownDescription": "The status of the CA certificate\\. \nValid values are \"ACTIVE\" and \"INACTIVE\"\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "VerificationCertificatePem": { + "markdownDescription": "The private key verification certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VerificationCertificatePem", "type": "string" } }, @@ -95954,12 +98170,18 @@ "additionalProperties": false, "properties": { "RoleArn": { + "markdownDescription": "The ARN of the role\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "TemplateBody": { + "markdownDescription": "The template body\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TemplateBody", "type": "string" }, "TemplateName": { + "markdownDescription": "The name of the provisioning template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TemplateName", "type": "string" } }, @@ -96006,7 +98228,7 @@ "type": "string" }, "CertificateMode": { - "markdownDescription": "Specifies which mode of certificate registration to use with this resource\\. Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI\\_ONLY with CertificatePem, and Default with CertificateSigningRequest\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies which mode of certificate registration to use with this resource\\. Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI\\_ONLY with CertificatePem, and Default with CertificateSigningRequest\\. \n`DEFAULT`: A certificate in `DEFAULT` mode is either generated by AWS IoT Core or registered with an issuer certificate authority \\(CA\\)\\. Devices with certificates in `DEFAULT` mode aren't required to send the Server Name Indication \\(SNI\\) extension when connecting to AWS IoT Core\\. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to AWS IoT Core\\. \n`SNI_ONLY`: A certificate in `SNI_ONLY` mode is registered without an issuer CA\\. Devices with certificates in `SNI_ONLY` mode must send the SNI extension when connecting to AWS IoT Core\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CertificateMode", "type": "string" }, @@ -96542,7 +98764,7 @@ "properties": { "AbortConfig": { "$ref": "#/definitions/AWS::IoT::JobTemplate.AbortConfig", - "markdownDescription": "The criteria that determine when and how a job abort takes place\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The criteria that determine when and how a job abort takes place\\. \n*Required*: No \n*Type*: [AbortConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AbortConfig" }, "Description": { @@ -96567,12 +98789,12 @@ }, "JobExecutionsRetryConfig": { "$ref": "#/definitions/AWS::IoT::JobTemplate.JobExecutionsRetryConfig", - "markdownDescription": "Allows you to create the criteria to retry a job\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Allows you to create the criteria to retry a job\\. \n*Required*: No \n*Type*: [JobExecutionsRetryConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsretryconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "JobExecutionsRetryConfig" }, "JobExecutionsRolloutConfig": { "$ref": "#/definitions/AWS::IoT::JobTemplate.JobExecutionsRolloutConfig", - "markdownDescription": "Allows you to create a staged rollout of a job\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Allows you to create a staged rollout of a job\\. \n*Required*: No \n*Type*: [JobExecutionsRolloutConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-jobexecutionsrolloutconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "JobExecutionsRolloutConfig" }, "JobTemplateId": { @@ -96582,7 +98804,7 @@ }, "PresignedUrlConfig": { "$ref": "#/definitions/AWS::IoT::JobTemplate.PresignedUrlConfig", - "markdownDescription": "Configuration for pre\\-signed S3 URLs\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Configuration for pre\\-signed S3 URLs\\. \n*Required*: No \n*Type*: [PresignedUrlConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-presignedurlconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PresignedUrlConfig" }, "Tags": { @@ -96595,7 +98817,7 @@ }, "TimeoutConfig": { "$ref": "#/definitions/AWS::IoT::JobTemplate.TimeoutConfig", - "markdownDescription": "Specifies the amount of time each device has to finish its execution of the job\\. A timer is started when the job execution status is set to `IN_PROGRESS`\\. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to `TIMED_OUT`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the amount of time each device has to finish its execution of the job\\. A timer is started when the job execution status is set to `IN_PROGRESS`\\. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to `TIMED_OUT`\\. \n*Required*: No \n*Type*: [TimeoutConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-timeoutconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TimeoutConfig" } }, @@ -96633,6 +98855,8 @@ "items": { "$ref": "#/definitions/AWS::IoT::JobTemplate.AbortCriteria" }, + "markdownDescription": "The list of criteria that determine when and how to abort the job\\. \n*Required*: Yes \n*Type*: List of [AbortCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-abortcriteria.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CriteriaList", "type": "array" } }, @@ -96645,15 +98869,23 @@ "additionalProperties": false, "properties": { "Action": { + "markdownDescription": "The type of job action to take to initiate the job abort\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Action", "type": "string" }, "FailureType": { + "markdownDescription": "The type of job execution failures that can initiate a job abort\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FailureType", "type": "string" }, "MinNumberOfExecutedThings": { + "markdownDescription": "The minimum number of things which must receive job execution notifications before the job can be aborted\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MinNumberOfExecutedThings", "type": "number" }, "ThresholdPercentage": { + "markdownDescription": "The minimum percentage of job execution failures that must occur to initiate the job abort\\. \n AWS IoT Core supports up to two digits after the decimal \\(for example, 10\\.9 and 10\\.99, but not 10\\.999\\)\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ThresholdPercentage", "type": "number" } }, @@ -96669,13 +98901,19 @@ "additionalProperties": false, "properties": { "BaseRatePerMinute": { + "markdownDescription": "The minimum number of things that will be notified of a pending job, per minute at the start of job rollout\\. This parameter allows you to define the initial rate of rollout\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BaseRatePerMinute", "type": "number" }, "IncrementFactor": { + "markdownDescription": "The exponential factor to increase the rate of rollout for a job\\. \n AWS IoT Core supports up to one digit after the decimal \\(for example, 1\\.5, but not 1\\.55\\)\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IncrementFactor", "type": "number" }, "RateIncreaseCriteria": { - "$ref": "#/definitions/AWS::IoT::JobTemplate.RateIncreaseCriteria" + "$ref": "#/definitions/AWS::IoT::JobTemplate.RateIncreaseCriteria", + "markdownDescription": "The criteria to initiate the increase in rate of rollout for a job\\. \n*Required*: Yes \n*Type*: [RateIncreaseCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-rateincreasecriteria.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RateIncreaseCriteria" } }, "required": [ @@ -96692,6 +98930,8 @@ "items": { "$ref": "#/definitions/AWS::IoT::JobTemplate.RetryCriteria" }, + "markdownDescription": "The list of criteria that determines how many retries are allowed for each failure type for a job\\. \n*Required*: No \n*Type*: List of [RetryCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-retrycriteria.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetryCriteriaList", "type": "array" } }, @@ -96701,9 +98941,13 @@ "additionalProperties": false, "properties": { "ExponentialRolloutRate": { - "$ref": "#/definitions/AWS::IoT::JobTemplate.ExponentialRolloutRate" + "$ref": "#/definitions/AWS::IoT::JobTemplate.ExponentialRolloutRate", + "markdownDescription": "Allows you to create an exponential rate of rollout for a job\\. \n*Required*: No \n*Type*: [ExponentialRolloutRate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-jobtemplate-exponentialrolloutrate.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExponentialRolloutRate" }, "MaximumPerMinute": { + "markdownDescription": "The maximum number of things that will be notified of a pending job, per minute\\. This parameter allows you to create a staged rollout\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaximumPerMinute", "type": "number" } }, @@ -96713,9 +98957,13 @@ "additionalProperties": false, "properties": { "ExpiresInSec": { + "markdownDescription": "How long \\(in seconds\\) pre\\-signed URLs are valid\\. Valid values are 60 \\- 3600, the default value is 3600 seconds\\. Pre\\-signed URLs are generated when Jobs receives an MQTT request for the job document\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExpiresInSec", "type": "number" }, "RoleArn": { + "markdownDescription": "The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored\\. The role must also grant permission for IoT to download the files\\. \nFor information about addressing the confused deputy problem, see [cross\\-service confused deputy prevention](https://docs.aws.amazon.com/iot/latest/developerguide/cross-service-confused-deputy-prevention.html) in the * AWS IoT Core developer guide*\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RoleArn", "type": "string" } }, @@ -96728,9 +98976,13 @@ "additionalProperties": false, "properties": { "NumberOfNotifiedThings": { + "markdownDescription": "The threshold for number of notified things that will initiate the increase in rate of rollout\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NumberOfNotifiedThings", "type": "number" }, "NumberOfSucceededThings": { + "markdownDescription": "The threshold for number of succeeded things that will initiate the increase in rate of rollout\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NumberOfSucceededThings", "type": "number" } }, @@ -96740,9 +98992,13 @@ "additionalProperties": false, "properties": { "FailureType": { + "markdownDescription": "The type of job execution failures that can initiate a job retry\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailureType", "type": "string" }, "NumberOfRetries": { + "markdownDescription": "The number of retries allowed for a failure type for the job\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NumberOfRetries", "type": "number" } }, @@ -96752,6 +99008,8 @@ "additionalProperties": false, "properties": { "InProgressTimeoutInMinutes": { + "markdownDescription": "Specifies the amount of time, in minutes, this device has to finish execution of this job\\. The timeout interval can be anywhere between 1 minute and 7 days \\(1 to 10080 minutes\\)\\. The in progress timer can't be updated and will apply to all job executions for the job\\. Whenever a job execution remains in the IN\\_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal `TIMED_OUT` status\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InProgressTimeoutInMinutes", "type": "number" } }, @@ -96801,7 +99059,7 @@ "type": "string" }, "DefaultLogLevel": { - "markdownDescription": "The default log level\\.Valid Values: `DEBUG | INFO | ERROR | WARN | DISABLED` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The default log level\\. Valid Values: `DEBUG | INFO | ERROR | WARN | DISABLED` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DefaultLogLevel", "type": "string" }, @@ -97095,7 +99353,7 @@ "additionalProperties": false, "properties": { "PolicyDocument": { - "markdownDescription": "The JSON document that describes the policy\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The JSON document that describes the policy\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PolicyDocument", "type": "object" }, @@ -97278,6 +99536,8 @@ "type": "string" }, "TemplateType": { + "markdownDescription": "The type of the provisioning template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TemplateType", "type": "string" } }, @@ -97439,18 +99699,26 @@ "additionalProperties": false, "properties": { "CredentialDurationSeconds": { + "markdownDescription": "The number of seconds for which the credential is valid\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CredentialDurationSeconds", "type": "number" }, "RoleAlias": { + "markdownDescription": "The role alias\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RoleAlias", "type": "string" }, "RoleArn": { + "markdownDescription": "The role ARN\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -98205,7 +100473,9 @@ "title": "Lambda" }, "Location": { - "$ref": "#/definitions/AWS::IoT::TopicRule.LocationAction" + "$ref": "#/definitions/AWS::IoT::TopicRule.LocationAction", + "markdownDescription": "Sends device location data to [Amazon Location Service](https://docs.aws.amazon.com/location/latest/developerguide/welcome.html)\\. \n*Required*: No \n*Type*: [LocationAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Location" }, "OpenSearch": { "$ref": "#/definitions/AWS::IoT::TopicRule.OpenSearchAction", @@ -98351,6 +100621,8 @@ "additionalProperties": false, "properties": { "BatchMode": { + "markdownDescription": "Indicates whether batches of log records will be extracted and uploaded into CloudWatch\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchMode", "type": "boolean" }, "LogGroupName": { @@ -98777,21 +101049,33 @@ "additionalProperties": false, "properties": { "DeviceId": { + "markdownDescription": "The unique ID of the device providing the location data\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeviceId", "type": "string" }, "Latitude": { + "markdownDescription": "A string that evaluates to a double value that represents the latitude of the device's location\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Latitude", "type": "string" }, "Longitude": { + "markdownDescription": "A string that evaluates to a double value that represents the longitude of the device's location\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Longitude", "type": "string" }, "RoleArn": { + "markdownDescription": "The IAM role that grants permission to write to the Amazon Location resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "Timestamp": { - "$ref": "#/definitions/AWS::IoT::TopicRule.Timestamp" + "$ref": "#/definitions/AWS::IoT::TopicRule.Timestamp", + "markdownDescription": "The time that the location data was sampled\\. The default value is the time the MQTT message was processed\\. \n*Required*: No \n*Type*: [Timestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-timestamp.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Timestamp" }, "TrackerName": { + "markdownDescription": "The name of the tracker resource in Amazon Location in which the location is updated\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrackerName", "type": "string" } }, @@ -98897,7 +101181,9 @@ "additionalProperties": false, "properties": { "Headers": { - "$ref": "#/definitions/AWS::IoT::TopicRule.RepublishActionHeaders" + "$ref": "#/definitions/AWS::IoT::TopicRule.RepublishActionHeaders", + "markdownDescription": "MQTT Version 5\\.0 headers information\\. For more information, see [MQTT](https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html) in the IoT Core Developer Guide\\. \n*Required*: No \n*Type*: [RepublishActionHeaders](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-republishactionheaders.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Headers" }, "Qos": { "markdownDescription": "The Quality of Service \\(QoS\\) level to use when republishing messages\\. The default value is 0\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -98925,24 +101211,36 @@ "additionalProperties": false, "properties": { "ContentType": { + "markdownDescription": "A UTF\\-8 encoded string that describes the content of the publishing message\\. \nFor more information, see [ Content Type](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901118) in the MQTT Version 5\\.0 specification\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContentType", "type": "string" }, "CorrelationData": { + "markdownDescription": "The base64\\-encoded binary data used by the sender of the request message to identify which request the response message is for\\. \nFor more information, see [ Correlation Data](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901115) in the MQTT Version 5\\.0 specification\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n This binary data must be base64\\-encoded\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CorrelationData", "type": "string" }, "MessageExpiry": { + "markdownDescription": "A user\\-defined integer value that represents the message expiry interval at the broker\\. If the messages haven't been sent to the subscribers within that interval, the message expires and is removed\\. The value of `messageExpiry` represents the number of seconds before it expires\\. For more information about the limits of `messageExpiry`, see [Message broker and protocol limits and quotas](https://docs.aws.amazon.com/general/latest/gr/iot-core.html#limits_iot) in the IoT Core Reference Guide\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageExpiry", "type": "string" }, "PayloadFormatIndicator": { + "markdownDescription": "An `Enum` string value that indicates whether the payload is formatted as UTF\\-8\\. \nValid values are `UNSPECIFIED_BYTES` and `UTF8_DATA`\\. \nFor more information, see [ Payload Format Indicator](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111) from the MQTT Version 5\\.0 specification\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PayloadFormatIndicator", "type": "string" }, "ResponseTopic": { + "markdownDescription": "A UTF\\-8 encoded string that's used as the topic name for a response message\\. The response topic is used to describe the topic to which the receiver should publish as part of the request\\-response flow\\. The topic must not contain wildcard characters\\. \nFor more information, see [ Response Topic](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901114) in the MQTT Version 5\\.0 specification\\. \nSupports [substitution templates](https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResponseTopic", "type": "string" }, "UserProperties": { "items": { "$ref": "#/definitions/AWS::IoT::TopicRule.UserProperty" }, + "markdownDescription": "An array of key\\-value pairs that you define in the MQTT5 header\\. \n*Required*: No \n*Type*: List of [UserProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-userproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserProperties", "type": "array" } }, @@ -99084,9 +101382,13 @@ "additionalProperties": false, "properties": { "Unit": { + "markdownDescription": "The precision of the timestamp value that results from the expression described in `value`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Unit", "type": "string" }, "Value": { + "markdownDescription": "An expression that returns a long epoch time value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -99222,9 +101524,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "A key to be specified in `UserProperty`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "A value to be specified in `UserProperty`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -99440,7 +101746,7 @@ "title": "CustomerManagedS3" }, "ServiceManagedS3": { - "markdownDescription": "Used to store channel data in an S3 bucket managed by AWS IoT Analytics\\. You can't change the choice of S3 storage after the data store is created\\. \n*Required*: No \n*Type*: [ServiceManagedS3](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-servicemanageds3.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Used to store channel data in an S3 bucket managed by AWS IoT Analytics\\. You can't change the choice of S3 storage after the data store is created\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceManagedS3", "type": "object" } @@ -100223,7 +102529,7 @@ "title": "IotSiteWiseMultiLayerStorage" }, "ServiceManagedS3": { - "markdownDescription": "Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service\\. The choice of service\\-managed or customer\\-managed S3 storage cannot be changed after creation of the data store\\. \n*Required*: No \n*Type*: [ServiceManagedS3](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-servicemanageds3.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service\\. The choice of service\\-managed or customer\\-managed S3 storage cannot be changed after creation of the data store\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServiceManagedS3", "type": "object" } @@ -100234,7 +102540,7 @@ "additionalProperties": false, "properties": { "JsonConfiguration": { - "markdownDescription": "Contains the configuration information of the JSON format\\. \n*Required*: No \n*Type*: [JsonConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-jsonconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains the configuration information of the JSON format\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "JsonConfiguration", "type": "object" }, @@ -100800,7 +103106,7 @@ "properties": { "SuiteDefinitionConfiguration": { "$ref": "#/definitions/AWS::IoTCoreDeviceAdvisor::SuiteDefinition.SuiteDefinitionConfiguration", - "markdownDescription": "The configuration of the Suite Definition\\. Listed below are the required elements of the `SuiteDefinitionConfiguration`\\. \n**devicePermissionRoleArn** \nThe device permission arn\\. \nThis is a required element\\. \n**Type:** String \n**devices** \nThe list of configured devices under test\\. For more information on devices under test, see [DeviceUnderTest](http://amazonaws.com/iot/latest/apireference/API_iotdeviceadvisor_DeviceUnderTest.html) \nNot a required element\\. \n**Type:** List of devices under test \n**intendedForQualification** \nThe tests intended for qualification in a suite\\. \nNot a required element\\. \n**Type:** Boolean \n**rootGroup** \nThe test suite root group\\. For more information on creating and using root groups see the [Device Advisor workflow](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html)\\. \nThis is a required element\\. \n**Type:** String \n**suiteDefinitionName** \nThe Suite Definition Configuration name\\. \nThis is a required element\\. \n**Type:** String\n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The configuration of the Suite Definition\\. Listed below are the required elements of the `SuiteDefinitionConfiguration`\\. \n**devicePermissionRoleArn** \nThe device permission arn\\. \nThis is a required element\\. \n**Type:** String \n**devices** \nThe list of configured devices under test\\. For more information on devices under test, see [DeviceUnderTest](http://amazonaws.com/iot/latest/apireference/API_iotdeviceadvisor_DeviceUnderTest.html) \nNot a required element\\. \n**Type:** List of devices under test \n**intendedForQualification** \nThe tests intended for qualification in a suite\\. \nNot a required element\\. \n**Type:** Boolean \n**rootGroup** \nThe test suite root group\\. For more information on creating and using root groups see the [Device Advisor workflow](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html)\\. \nThis is a required element\\. \n**Type:** String \n**suiteDefinitionName** \nThe Suite Definition Configuration name\\. \nThis is a required element\\. \n**Type:** String\n*Required*: Yes \n*Type*: [SuiteDefinitionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuiteDefinitionConfiguration" }, "Tags": { @@ -100842,9 +103148,13 @@ "additionalProperties": false, "properties": { "CertificateArn": { + "markdownDescription": "Lists devices certificate ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertificateArn", "type": "string" }, "ThingArn": { + "markdownDescription": "Lists devices thing ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ThingArn", "type": "string" } }, @@ -100854,21 +103164,31 @@ "additionalProperties": false, "properties": { "DevicePermissionRoleArn": { + "markdownDescription": "Gets the device permission ARN\\. This is a required parameter\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DevicePermissionRoleArn", "type": "string" }, "Devices": { "items": { "$ref": "#/definitions/AWS::IoTCoreDeviceAdvisor::SuiteDefinition.DeviceUnderTest" }, + "markdownDescription": "Gets the devices configured\\. \n*Required*: No \n*Type*: List of [DeviceUnderTest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-deviceundertest.html) \n*Maximum*: `2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Devices", "type": "array" }, "IntendedForQualification": { + "markdownDescription": "Gets the tests intended for qualification in a suite\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntendedForQualification", "type": "boolean" }, "RootGroup": { + "markdownDescription": "Gets the test suite root group\\. This is a required parameter\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RootGroup", "type": "string" }, "SuiteDefinitionName": { + "markdownDescription": "Gets the suite definition name\\. This is a required parameter\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SuiteDefinitionName", "type": "string" } }, @@ -100914,33 +103234,51 @@ "additionalProperties": false, "properties": { "AlarmCapabilities": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmCapabilities" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmCapabilities", + "markdownDescription": "Contains the configuration information of alarm state changes\\. \n*Required*: No \n*Type*: [AlarmCapabilities](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmCapabilities" }, "AlarmEventActions": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmEventActions" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmEventActions", + "markdownDescription": "Contains information about one or more alarm actions\\. \n*Required*: No \n*Type*: [AlarmEventActions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmeventactions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmEventActions" }, "AlarmModelDescription": { + "markdownDescription": "The description of the alarm model\\. \n*Required*: No \n*Type*: String \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmModelDescription", "type": "string" }, "AlarmModelName": { + "markdownDescription": "The name of the alarm model\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z0-9_-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AlarmModelName", "type": "string" }, "AlarmRule": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmRule" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmRule", + "markdownDescription": "Defines when your alarm is invoked\\. \n*Required*: Yes \n*Type*: [AlarmRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmRule" }, "Key": { + "markdownDescription": "An input attribute used as a key to create an alarm\\. AWS IoT Events routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^((`[\\w\\- ]+`)|([\\w\\-]+))(\\.((`[\\w- ]+`)|([\\w\\-]+)))*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" }, "RoleArn": { + "markdownDescription": "The ARN of the IAM role that allows the alarm to perform actions and access AWS resources\\. For more information, see [Amazon Resource Names \\(ARNs\\)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "Severity": { + "markdownDescription": "A non\\-negative integer that reflects the severity level of the alarm\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Severity", "type": "number" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of key\\-value pairs that contain metadata for the alarm model\\. The tags help you manage the alarm model\\. For more information, see [Tagging your AWS IoT Events resources](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the * AWS IoT Events Developer Guide*\\. \nYou can create up to 50 tags for one alarm model\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -100975,6 +103313,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "The value must be `TRUE` or `FALSE`\\. If `TRUE`, you receive a notification when the alarm state changes\\. You must choose to acknowledge the notification before the alarm state can return to `NORMAL`\\. If `FALSE`, you won't receive notifications\\. The alarm automatically changes to the `NORMAL` state when the input property value returns to the specified range\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" } }, @@ -100984,31 +103324,49 @@ "additionalProperties": false, "properties": { "DynamoDB": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.DynamoDB" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.DynamoDB", + "markdownDescription": "Defines an action to write to the Amazon DynamoDB table that you created\\. The standard action payload contains all the information about the detector model instance and the event that triggered the action\\. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html)\\. One column of the DynamoDB table receives all attribute\\-value pairs in the payload that you specify\\. \nYou must use expressions for all parameters in `DynamoDBAction`\\. The expressions accept literals, operators, functions, references, and substitution templates\\.", + "title": "DynamoDB" }, "DynamoDBv2": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.DynamoDBv2" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.DynamoDBv2", + "markdownDescription": "Defines an action to write to the Amazon DynamoDB table that you created\\. The default action payload contains all the information about the detector model instance and the event that triggered the action\\. You can customize the [payload](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html)\\. A separate column of the DynamoDB table receives one attribute\\-value pair in the payload that you specify\\. \nYou must use expressions for all parameters in `DynamoDBv2Action`\\. The expressions accept literals, operators, functions, references, and substitution templates\\.", + "title": "DynamoDBv2" }, "Firehose": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Firehose" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Firehose", + "markdownDescription": "Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream\\. \n*Required*: No \n*Type*: [Firehose](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Firehose" }, "IotEvents": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.IotEvents" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.IotEvents", + "markdownDescription": "Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action\\. \n*Required*: No \n*Type*: [IotEvents](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IotEvents" }, "IotSiteWise": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.IotSiteWise" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.IotSiteWise", + "markdownDescription": "Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise\\. \nYou must use expressions for all parameters in `IotSiteWiseAction`\\. The expressions accept literals, operators, functions, references, and substitutions templates\\.", + "title": "IotSiteWise" }, "IotTopicPublish": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.IotTopicPublish" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.IotTopicPublish", + "markdownDescription": "Information required to publish the MQTT message through the AWS IoT message broker\\. \n*Required*: No \n*Type*: [IotTopicPublish](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IotTopicPublish" }, "Lambda": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Lambda" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Lambda", + "markdownDescription": "Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action\\. \n*Required*: No \n*Type*: [Lambda](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Lambda" }, "Sns": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Sns" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Sns", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Sns](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sns" }, "Sqs": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Sqs" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Sqs", + "markdownDescription": "Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue\\. \n*Required*: No \n*Type*: [Sqs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sqs" } }, "type": "object" @@ -101017,10 +103375,14 @@ "additionalProperties": false, "properties": { "AcknowledgeFlow": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AcknowledgeFlow" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AcknowledgeFlow", + "markdownDescription": "Specifies whether to get notified for alarm state changes\\. \n*Required*: No \n*Type*: [AcknowledgeFlow](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-acknowledgeflow.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AcknowledgeFlow" }, "InitializationConfiguration": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.InitializationConfiguration" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.InitializationConfiguration", + "markdownDescription": "Specifies the default alarm state\\. The configuration applies to all alarms that were created based on this alarm model\\. \n*Required*: No \n*Type*: [InitializationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-initializationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InitializationConfiguration" } }, "type": "object" @@ -101032,6 +103394,8 @@ "items": { "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AlarmAction" }, + "markdownDescription": "Specifies one or more supported actions to receive notifications when the alarm state changes\\. \n*Required*: No \n*Type*: List of [AlarmAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmActions", "type": "array" } }, @@ -101041,7 +103405,9 @@ "additionalProperties": false, "properties": { "SimpleRule": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.SimpleRule" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.SimpleRule", + "markdownDescription": "A rule that compares an input property value to a threshold value with a comparison operator\\. \n*Required*: No \n*Type*: [SimpleRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SimpleRule" } }, "type": "object" @@ -101050,9 +103416,13 @@ "additionalProperties": false, "properties": { "OffsetInNanos": { + "markdownDescription": "The nanosecond offset converted from `timeInSeconds`\\. The valid range is between 0\\-999999999\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OffsetInNanos", "type": "string" }, "TimeInSeconds": { + "markdownDescription": "The timestamp, in seconds, in the Unix epoch format\\. The valid range is between 1\\-31556889864403199\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TimeInSeconds", "type": "string" } }, @@ -101065,13 +103435,19 @@ "additionalProperties": false, "properties": { "Quality": { + "markdownDescription": "The quality of the asset property value\\. The value must be `'GOOD'`, `'BAD'`, or `'UNCERTAIN'`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Quality", "type": "string" }, "Timestamp": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AssetPropertyTimestamp" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AssetPropertyTimestamp", + "markdownDescription": "The timestamp associated with the asset property value\\. The default is the current event time\\. \n*Required*: No \n*Type*: [AssetPropertyTimestamp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Timestamp" }, "Value": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AssetPropertyVariant" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AssetPropertyVariant", + "markdownDescription": "The value to send to an asset property\\. \n*Required*: Yes \n*Type*: [AssetPropertyVariant](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value" } }, "required": [ @@ -101083,15 +103459,23 @@ "additionalProperties": false, "properties": { "BooleanValue": { + "markdownDescription": "The asset property value is a Boolean value that must be `'TRUE'` or `'FALSE'`\\. You must use an expression, and the evaluated result should be a Boolean value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BooleanValue", "type": "string" }, "DoubleValue": { + "markdownDescription": "The asset property value is a double\\. You must use an expression, and the evaluated result should be a double\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DoubleValue", "type": "string" }, "IntegerValue": { + "markdownDescription": "The asset property value is an integer\\. You must use an expression, and the evaluated result should be an integer\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntegerValue", "type": "string" }, "StringValue": { + "markdownDescription": "The asset property value is a string\\. You must use an expression, and the evaluated result should be a string\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StringValue", "type": "string" } }, @@ -101101,33 +103485,53 @@ "additionalProperties": false, "properties": { "HashKeyField": { + "markdownDescription": "The name of the hash key \\(also called the partition key\\)\\. The `hashKeyField` value must match the partition key of the target DynamoDB table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HashKeyField", "type": "string" }, "HashKeyType": { + "markdownDescription": "The data type for the hash key \\(also called the partition key\\)\\. You can specify the following values: \n+ `'STRING'` \\- The hash key is a string\\.\n+ `'NUMBER'` \\- The hash key is a number\\.\nIf you don't specify `hashKeyType`, the default value is `'STRING'`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HashKeyType", "type": "string" }, "HashKeyValue": { + "markdownDescription": "The value of the hash key \\(also called the partition key\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HashKeyValue", "type": "string" }, "Operation": { + "markdownDescription": "The type of operation to perform\\. You can specify the following values: \n+ `'INSERT'` \\- Insert data as a new item into the DynamoDB table\\. This item uses the specified hash key as a partition key\\. If you specified a range key, the item uses the range key as a sort key\\.\n+ `'UPDATE'` \\- Update an existing item of the DynamoDB table with new data\\. This item's partition key must match the specified hash key\\. If you specified a range key, the range key must match the item's sort key\\.\n+ `'DELETE'` \\- Delete an existing item of the DynamoDB table\\. This item's partition key must match the specified hash key\\. If you specified a range key, the range key must match the item's sort key\\.\nIf you don't specify this parameter, AWS IoT Events triggers the `'INSERT'` operation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Operation", "type": "string" }, "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "Information needed to configure the payload\\. \nBy default, AWS IoT Events generates a standard payload in JSON for any action\\. This action payload contains all attribute\\-value pairs that have the information about the detector model instance and the event triggered the action\\. To configure the action payload, you can use `contentExpression`\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" }, "PayloadField": { + "markdownDescription": "The name of the DynamoDB column that receives the action payload\\. \nIf you don't specify this parameter, the name of the DynamoDB column is `payload`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PayloadField", "type": "string" }, "RangeKeyField": { + "markdownDescription": "The name of the range key \\(also called the sort key\\)\\. The `rangeKeyField` value must match the sort key of the target DynamoDB table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RangeKeyField", "type": "string" }, "RangeKeyType": { + "markdownDescription": "The data type for the range key \\(also called the sort key\\), You can specify the following values: \n+ `'STRING'` \\- The range key is a string\\.\n+ `'NUMBER'` \\- The range key is number\\.\nIf you don't specify `rangeKeyField`, the default value is `'STRING'`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RangeKeyType", "type": "string" }, "RangeKeyValue": { + "markdownDescription": "The value of the range key \\(also called the sort key\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RangeKeyValue", "type": "string" }, "TableName": { + "markdownDescription": "The name of the DynamoDB table\\. The `tableName` value must match the table name of the target DynamoDB table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TableName", "type": "string" } }, @@ -101142,9 +103546,13 @@ "additionalProperties": false, "properties": { "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" }, "TableName": { + "markdownDescription": "The name of the DynamoDB table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TableName", "type": "string" } }, @@ -101157,12 +103565,18 @@ "additionalProperties": false, "properties": { "DeliveryStreamName": { + "markdownDescription": "The name of the Kinesis Data Firehose delivery stream where the data is written\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeliveryStreamName", "type": "string" }, "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" }, "Separator": { + "markdownDescription": "A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream\\. Valid values are: '\\\\n' \\(newline\\), '\\\\t' \\(tab\\), '\\\\r\\\\n' \\(Windows newline\\), ',' \\(comma\\)\\. \n*Required*: No \n*Type*: String \n*Pattern*: `([\\n\\t])|(\\r\\n)|(,)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Separator", "type": "string" } }, @@ -101175,6 +103589,8 @@ "additionalProperties": false, "properties": { "DisabledOnInitialization": { + "markdownDescription": "The value must be `TRUE` or `FALSE`\\. If `FALSE`, all alarm instances created based on the alarm model are activated\\. The default value is `TRUE`\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DisabledOnInitialization", "type": "boolean" } }, @@ -101187,10 +103603,14 @@ "additionalProperties": false, "properties": { "InputName": { + "markdownDescription": "The name of the AWS IoT Events input where the data is sent\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputName", "type": "string" }, "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "You can configure the action payload when you send a message to an AWS IoT Events input\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" } }, "required": [ @@ -101202,19 +103622,29 @@ "additionalProperties": false, "properties": { "AssetId": { + "markdownDescription": "The ID of the asset that has the specified property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssetId", "type": "string" }, "EntryId": { + "markdownDescription": "A unique identifier for this entry\\. You can use the entry ID to track which data entry causes an error in case of failure\\. The default is a new unique identifier\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EntryId", "type": "string" }, "PropertyAlias": { + "markdownDescription": "The alias of the asset property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PropertyAlias", "type": "string" }, "PropertyId": { + "markdownDescription": "The ID of the asset property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PropertyId", "type": "string" }, "PropertyValue": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AssetPropertyValue" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.AssetPropertyValue", + "markdownDescription": "The value to send to the asset property\\. This value contains timestamp, quality, and value \\(TQV\\) information\\. \n*Required*: No \n*Type*: [AssetPropertyValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PropertyValue" } }, "type": "object" @@ -101223,10 +103653,14 @@ "additionalProperties": false, "properties": { "MqttTopic": { + "markdownDescription": "The MQTT topic of the message\\. You can use a string expression that includes variables \\(`$variable.`\\) and input values \\(`$input..`\\) as the topic string\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MqttTopic", "type": "string" }, "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "You can configure the action payload when you publish a message to an AWS IoT Core topic\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" } }, "required": [ @@ -101238,10 +103672,14 @@ "additionalProperties": false, "properties": { "FunctionArn": { + "markdownDescription": "The ARN of the Lambda function that is executed\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FunctionArn", "type": "string" }, "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "You can configure the action payload when you send a message to a Lambda function\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" } }, "required": [ @@ -101253,9 +103691,13 @@ "additionalProperties": false, "properties": { "ContentExpression": { + "markdownDescription": "The content of the payload\\. You can use a string expression that includes quoted strings \\(`''`\\), variables \\(`$variable.`\\), input values \\(`$input..`\\), string concatenations, and quoted strings that contain `${}` as the content\\. The recommended maximum size of a content expression is 1 KB\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContentExpression", "type": "string" }, "Type": { + "markdownDescription": "The value of the payload type can be either `STRING` or `JSON`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `JSON | STRING` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -101269,12 +103711,18 @@ "additionalProperties": false, "properties": { "ComparisonOperator": { + "markdownDescription": "The comparison operator\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `EQUAL | GREATER | GREATER_OR_EQUAL | LESS | LESS_OR_EQUAL | NOT_EQUAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ComparisonOperator", "type": "string" }, "InputProperty": { + "markdownDescription": "The value on the left side of the comparison operator\\. You can specify an AWS IoT Events input attribute as an input property\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputProperty", "type": "string" }, "Threshold": { + "markdownDescription": "The value on the right side of the comparison operator\\. You can enter a number or specify an AWS IoT Events input attribute\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Threshold", "type": "string" } }, @@ -101289,9 +103737,13 @@ "additionalProperties": false, "properties": { "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "You can configure the action payload when you send a message as an Amazon SNS push notification\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" }, "TargetArn": { + "markdownDescription": "The ARN of the Amazon SNS target where the message is sent\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetArn", "type": "string" } }, @@ -101304,12 +103756,18 @@ "additionalProperties": false, "properties": { "Payload": { - "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload" + "$ref": "#/definitions/AWS::IoTEvents::AlarmModel.Payload", + "markdownDescription": "You can configure the action payload when you send a message to an Amazon SQS queue\\. \n*Required*: No \n*Type*: [Payload](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Payload" }, "QueueUrl": { + "markdownDescription": "The URL of the SQS queue where the data is written\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "QueueUrl", "type": "string" }, "UseBase64": { + "markdownDescription": "Set this to TRUE if you want the data to be base\\-64 encoded before it is written to the queue\\. Otherwise, set this to FALSE\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseBase64", "type": "boolean" } }, @@ -102290,60 +104748,92 @@ "additionalProperties": false, "properties": { "Action": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Action", "type": "string" }, "CollectionScheme": { - "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.CollectionScheme" + "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.CollectionScheme", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [CollectionScheme](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CollectionScheme" }, "Compression": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Compression", "type": "string" }, "DataExtraDimensions": { "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataExtraDimensions", "type": "array" }, "Description": { + "markdownDescription": "The description of the campaign\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "DiagnosticsMode": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DiagnosticsMode", "type": "string" }, "ExpiryTime": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExpiryTime", "type": "string" }, "Name": { + "markdownDescription": "The name of a campaign\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z\\d\\-_:]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "PostTriggerCollectionDuration": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PostTriggerCollectionDuration", "type": "number" }, "Priority": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Priority", "type": "number" }, "SignalCatalogArn": { + "markdownDescription": "The ARN of the signal catalog associated with the campaign\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SignalCatalogArn", "type": "string" }, "SignalsToCollect": { "items": { "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.SignalInformation" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [SignalInformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-signalinformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SignalsToCollect", "type": "array" }, "SpoolingMode": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SpoolingMode", "type": "string" }, "StartTime": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StartTime", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TargetArn": { + "markdownDescription": "The ARN of a vehicle or fleet to which the campaign is deployed\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TargetArn", "type": "string" } }, @@ -102381,10 +104871,14 @@ "additionalProperties": false, "properties": { "ConditionBasedCollectionScheme": { - "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.ConditionBasedCollectionScheme" + "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.ConditionBasedCollectionScheme", + "markdownDescription": "Information about a collection scheme that uses a simple logical expression to recognize what data to collect\\. \n*Required*: No \n*Type*: [ConditionBasedCollectionScheme](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConditionBasedCollectionScheme" }, "TimeBasedCollectionScheme": { - "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.TimeBasedCollectionScheme" + "$ref": "#/definitions/AWS::IoTFleetWise::Campaign.TimeBasedCollectionScheme", + "markdownDescription": "Information about a collection scheme that uses a time period to decide how often to collect data\\. \n*Required*: No \n*Type*: [TimeBasedCollectionScheme](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedcollectionscheme.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TimeBasedCollectionScheme" } }, "type": "object" @@ -102393,15 +104887,23 @@ "additionalProperties": false, "properties": { "ConditionLanguageVersion": { + "markdownDescription": "Specifies the version of the conditional expression language\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConditionLanguageVersion", "type": "number" }, "Expression": { + "markdownDescription": "The logical expression used to recognize what data to collect\\. For example, `$variable.Vehicle.OutsideAirTemperature >= 105.0`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Expression", "type": "string" }, "MinimumTriggerIntervalMs": { + "markdownDescription": "The minimum duration of time between two triggering events to collect data, in milliseconds\\. \nIf a signal changes often, you might want to collect data at a slower rate\\.\n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MinimumTriggerIntervalMs", "type": "number" }, "TriggerMode": { + "markdownDescription": "Whether to collect data for all triggering events \\(`ALWAYS`\\)\\. Specify \\(`RISING_EDGE`\\), or specify only when the condition first evaluates to false\\. For example, triggering on \"AirbagDeployed\"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS | RISING_EDGE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TriggerMode", "type": "string" } }, @@ -102414,12 +104916,18 @@ "additionalProperties": false, "properties": { "MaxSampleCount": { + "markdownDescription": "The maximum number of samples to collect\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxSampleCount", "type": "number" }, "MinimumSamplingIntervalMs": { + "markdownDescription": "The minimum duration of time \\(in milliseconds\\) between two triggering events to collect data\\. \nIf a signal changes often, you might want to collect data at a slower rate\\.\n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MinimumSamplingIntervalMs", "type": "number" }, "Name": { + "markdownDescription": "The name of the signal\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `150` \n*Pattern*: `[\\w|*|-]+(\\.[\\w|*|-]+)*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -102432,6 +104940,8 @@ "additionalProperties": false, "properties": { "PeriodMs": { + "markdownDescription": "The time period \\(in milliseconds\\) to decide how often to collect data\\. For example, if the time period is `60000`, the Edge Agent software collects data once every minute\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PeriodMs", "type": "number" } }, @@ -102476,33 +104986,47 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A brief description of the decoder manifest\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "ModelManifestArn": { + "markdownDescription": "The ARN of a vehicle model \\(model manifest\\) associated with the decoder manifest\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelManifestArn", "type": "string" }, "Name": { + "markdownDescription": "The name of the decoder manifest\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "NetworkInterfaces": { "items": { "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.NetworkInterfacesItems" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [NetworkInterfacesItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkInterfaces", "type": "array" }, "SignalDecoders": { "items": { "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.SignalDecodersItems" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [SignalDecodersItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-signaldecodersitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SignalDecoders", "type": "array" }, "Status": { + "markdownDescription": "The state of the decoder manifest\\. If the status is `ACTIVE`, the decoder manifest can't be edited\\. If the status is marked `DRAFT`, you can edit the decoder manifest\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | DRAFT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -102537,12 +105061,18 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The unique name of the interface\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ProtocolName": { + "markdownDescription": "The name of the communication protocol for the interface\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ProtocolName", "type": "string" }, "ProtocolVersion": { + "markdownDescription": "The version of the communication protocol for the interface\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ProtocolVersion", "type": "string" } }, @@ -102555,27 +105085,43 @@ "additionalProperties": false, "properties": { "Factor": { + "markdownDescription": "A multiplier used to decode the CAN message\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Factor", "type": "string" }, "IsBigEndian": { + "markdownDescription": "Whether the byte ordering of a CAN message is big\\-endian\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsBigEndian", "type": "string" }, "IsSigned": { + "markdownDescription": "Whether the message data is specified as a signed value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsSigned", "type": "string" }, "Length": { + "markdownDescription": "How many bytes of data are in the message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Length", "type": "string" }, "MessageId": { + "markdownDescription": "The ID of the message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageId", "type": "string" }, "Name": { + "markdownDescription": "The name of the signal\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Offset": { + "markdownDescription": "Indicates where data appears in the CAN message\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Offset", "type": "string" }, "StartBit": { + "markdownDescription": "Indicates the beginning of the CAN message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StartBit", "type": "string" } }, @@ -102594,15 +105140,23 @@ "additionalProperties": false, "properties": { "CanInterface": { - "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.CanInterface" + "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.CanInterface", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [CanInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-caninterface.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CanInterface" }, "InterfaceId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InterfaceId", "type": "string" }, "ObdInterface": { - "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.ObdInterface" + "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.ObdInterface", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ObdInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdinterface.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObdInterface" }, "Type": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -102616,24 +105170,38 @@ "additionalProperties": false, "properties": { "DtcRequestIntervalSeconds": { + "markdownDescription": "The maximum number message requests per diagnostic trouble code per second\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DtcRequestIntervalSeconds", "type": "string" }, "HasTransmissionEcu": { + "markdownDescription": "Whether the vehicle has a transmission control module \\(TCM\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HasTransmissionEcu", "type": "string" }, "Name": { + "markdownDescription": "The name of the interface\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ObdStandard": { + "markdownDescription": "The standard OBD II PID\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObdStandard", "type": "string" }, "PidRequestIntervalSeconds": { + "markdownDescription": "The maximum number message requests per second\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PidRequestIntervalSeconds", "type": "string" }, "RequestMessageId": { + "markdownDescription": "The ID of the message requesting vehicle data\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RequestMessageId", "type": "string" }, "UseExtendedIds": { + "markdownDescription": "Whether to use extended IDs in the message\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UseExtendedIds", "type": "string" } }, @@ -102647,30 +105215,48 @@ "additionalProperties": false, "properties": { "BitMaskLength": { + "markdownDescription": "The number of bits to mask in a message\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BitMaskLength", "type": "string" }, "BitRightShift": { + "markdownDescription": "The number of positions to shift bits in the message\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BitRightShift", "type": "string" }, "ByteLength": { + "markdownDescription": "The length of a message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ByteLength", "type": "string" }, "Offset": { + "markdownDescription": "Indicates where data appears in the message\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Offset", "type": "string" }, "Pid": { + "markdownDescription": "The diagnostic code used to request data from a vehicle for this signal\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pid", "type": "string" }, "PidResponseLength": { + "markdownDescription": "The length of the requested data\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PidResponseLength", "type": "string" }, "Scaling": { + "markdownDescription": "A multiplier used to decode the message\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Scaling", "type": "string" }, "ServiceMode": { + "markdownDescription": "The mode of operation \\(diagnostic service\\) in a message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceMode", "type": "string" }, "StartByte": { + "markdownDescription": "Indicates the beginning of the message\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StartByte", "type": "string" } }, @@ -102689,18 +105275,28 @@ "additionalProperties": false, "properties": { "CanSignal": { - "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.CanSignal" + "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.CanSignal", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [CanSignal](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CanSignal" }, "FullyQualifiedName": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FullyQualifiedName", "type": "string" }, "InterfaceId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InterfaceId", "type": "string" }, "ObdSignal": { - "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.ObdSignal" + "$ref": "#/definitions/AWS::IoTFleetWise::DecoderManifest.ObdSignal", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ObdSignal](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObdSignal" }, "Type": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -102747,18 +105343,26 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A brief description of the fleet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Id": { + "markdownDescription": "The unique ID of the fleet\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `[a-zA-Z0-9:_-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Id", "type": "string" }, "SignalCatalogArn": { + "markdownDescription": "The ARN of the signal catalog associated with the fleet\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SignalCatalogArn", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -102825,27 +105429,39 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A brief description of the vehicle model\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the vehicle model\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Nodes": { "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Nodes", "type": "array" }, "SignalCatalogArn": { + "markdownDescription": "The ARN of the signal catalog associated with the vehicle model\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SignalCatalogArn", "type": "string" }, "Status": { + "markdownDescription": "The state of the vehicle model\\. If the status is `ACTIVE`, the vehicle model can't be edited\\. If the status is `DRAFT`, you can edit the vehicle model\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | DRAFT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -102912,24 +105528,34 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the signal catalog\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "NodeCounts": { - "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.NodeCounts" + "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.NodeCounts", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [NodeCounts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NodeCounts" }, "Nodes": { "items": { "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Node" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Node](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Nodes", "type": "array" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -102962,27 +105588,43 @@ "items": { "type": "string" }, + "markdownDescription": "A list of possible values an actuator can take\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowedValues", "type": "array" }, "AssignedValue": { + "markdownDescription": "A specified value for the actuator\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssignedValue", "type": "string" }, "DataType": { + "markdownDescription": "The specified data type of the actuator\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BOOLEAN | BOOLEAN_ARRAY | DOUBLE | DOUBLE_ARRAY | FLOAT | FLOAT_ARRAY | INT16 | INT16_ARRAY | INT32 | INT32_ARRAY | INT64 | INT64_ARRAY | INT8 | INT8_ARRAY | STRING | STRING_ARRAY | UINT16 | UINT16_ARRAY | UINT32 | UINT32_ARRAY | UINT64 | UINT64_ARRAY | UINT8 | UINT8_ARRAY | UNIX_TIMESTAMP | UNIX_TIMESTAMP_ARRAY | UNKNOWN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType", "type": "string" }, "Description": { + "markdownDescription": "A brief description of the actuator\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "FullyQualifiedName": { + "markdownDescription": "The fully qualified name of the actuator\\. For example, the fully qualified name of an actuator might be `Vehicle.Front.Left.Door.Lock`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FullyQualifiedName", "type": "string" }, "Max": { + "markdownDescription": "The specified possible maximum value of an actuator\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Max", "type": "number" }, "Min": { + "markdownDescription": "The specified possible minimum value of an actuator\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Min", "type": "number" }, "Unit": { + "markdownDescription": "The scientific unit for the actuator\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Unit", "type": "string" } }, @@ -102999,30 +105641,48 @@ "items": { "type": "string" }, + "markdownDescription": "A list of possible values an attribute can be assigned\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowedValues", "type": "array" }, "AssignedValue": { + "markdownDescription": "A specified value for the attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssignedValue", "type": "string" }, "DataType": { + "markdownDescription": "The specified data type of the attribute\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BOOLEAN | BOOLEAN_ARRAY | DOUBLE | DOUBLE_ARRAY | FLOAT | FLOAT_ARRAY | INT16 | INT16_ARRAY | INT32 | INT32_ARRAY | INT64 | INT64_ARRAY | INT8 | INT8_ARRAY | STRING | STRING_ARRAY | UINT16 | UINT16_ARRAY | UINT32 | UINT32_ARRAY | UINT64 | UINT64_ARRAY | UINT8 | UINT8_ARRAY | UNIX_TIMESTAMP | UNIX_TIMESTAMP_ARRAY | UNKNOWN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType", "type": "string" }, "DefaultValue": { + "markdownDescription": "The default value of the attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultValue", "type": "string" }, "Description": { + "markdownDescription": "A brief description of the attribute\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "FullyQualifiedName": { + "markdownDescription": "The fully qualified name of the attribute\\. For example, the fully qualified name of an attribute might be `Vehicle.Body.Engine.Type`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FullyQualifiedName", "type": "string" }, "Max": { + "markdownDescription": "The specified possible maximum value of the attribute\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Max", "type": "number" }, "Min": { + "markdownDescription": "The specified possible minimum value of the attribute\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Min", "type": "number" }, "Unit": { + "markdownDescription": "The scientific unit for the attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Unit", "type": "string" } }, @@ -103036,9 +105696,13 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A brief description of the branch\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "FullyQualifiedName": { + "markdownDescription": "The fully qualified name of the branch\\. For example, the fully qualified name of a branch might be `Vehicle.Body.Engine`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FullyQualifiedName", "type": "string" } }, @@ -103051,16 +105715,24 @@ "additionalProperties": false, "properties": { "Actuator": { - "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Actuator" + "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Actuator", + "markdownDescription": "Information about a node specified as an actuator\\. \nAn actuator is a digital representation of a vehicle device\\.\n*Required*: No \n*Type*: [Actuator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Actuator" }, "Attribute": { - "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Attribute" + "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Attribute", + "markdownDescription": "Information about a node specified as an attribute\\. \nAn attribute represents static information about a vehicle\\.\n*Required*: No \n*Type*: [Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Attribute" }, "Branch": { - "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Branch" + "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Branch", + "markdownDescription": "Information about a node specified as a branch\\. \nA group of signals that are defined in a hierarchical structure\\.\n*Required*: No \n*Type*: [Branch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Branch" }, "Sensor": { - "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Sensor" + "$ref": "#/definitions/AWS::IoTFleetWise::SignalCatalog.Sensor", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Sensor](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sensor" } }, "type": "object" @@ -103069,18 +105741,28 @@ "additionalProperties": false, "properties": { "TotalActuators": { + "markdownDescription": "The total number of nodes in a vehicle network that represent actuators\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TotalActuators", "type": "number" }, "TotalAttributes": { + "markdownDescription": "The total number of nodes in a vehicle network that represent attributes\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TotalAttributes", "type": "number" }, "TotalBranches": { + "markdownDescription": "The total number of nodes in a vehicle network that represent branches\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TotalBranches", "type": "number" }, "TotalNodes": { + "markdownDescription": "The total number of nodes in a vehicle network\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TotalNodes", "type": "number" }, "TotalSensors": { + "markdownDescription": "The total number of nodes in a vehicle network that represent sensors\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TotalSensors", "type": "number" } }, @@ -103093,24 +105775,38 @@ "items": { "type": "string" }, + "markdownDescription": "A list of possible values a sensor can take\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowedValues", "type": "array" }, "DataType": { + "markdownDescription": "The specified data type of the sensor\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BOOLEAN | BOOLEAN_ARRAY | DOUBLE | DOUBLE_ARRAY | FLOAT | FLOAT_ARRAY | INT16 | INT16_ARRAY | INT32 | INT32_ARRAY | INT64 | INT64_ARRAY | INT8 | INT8_ARRAY | STRING | STRING_ARRAY | UINT16 | UINT16_ARRAY | UINT32 | UINT32_ARRAY | UINT64 | UINT64_ARRAY | UINT8 | UINT8_ARRAY | UNIX_TIMESTAMP | UNIX_TIMESTAMP_ARRAY | UNKNOWN` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType", "type": "string" }, "Description": { + "markdownDescription": "A brief description of a sensor\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[^\\u0000-\\u001F\\u007F]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "FullyQualifiedName": { + "markdownDescription": "The fully qualified name of the sensor\\. For example, the fully qualified name of a sensor might be `Vehicle.Body.Engine.Battery`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FullyQualifiedName", "type": "string" }, "Max": { + "markdownDescription": "The specified possible maximum value of the sensor\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Max", "type": "number" }, "Min": { + "markdownDescription": "The specified possible minimum value of the sensor\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Min", "type": "number" }, "Unit": { + "markdownDescription": "The scientific unit of measurement for data collected by the sensor\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Unit", "type": "string" } }, @@ -103156,30 +105852,42 @@ "additionalProperties": false, "properties": { "AssociationBehavior": { + "markdownDescription": "An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CreateIotThing | ValidateIotThingExists` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssociationBehavior", "type": "string" }, "Attributes": { "additionalProperties": true, + "markdownDescription": "Static information about a vehicle in a key\\-value pair\\. For example: `\"engine Type\"` : `\"v6\"` \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Attributes", "type": "object" }, "DecoderManifestArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of a decoder manifest associated with the vehicle to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DecoderManifestArn", "type": "string" }, "ModelManifestArn": { + "markdownDescription": "The ARN of the vehicle model \\(model manifest\\) to create the vehicle from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelManifestArn", "type": "string" }, "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Metadata which can be used to manage the vehicle\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -103248,7 +105956,7 @@ "properties": { "AccessPolicyIdentity": { "$ref": "#/definitions/AWS::IoTSiteWise::AccessPolicy.AccessPolicyIdentity", - "markdownDescription": "The identity for this access policy\\. Choose an AWS SSO user, an AWS SSO group, or an IAM user\\. \n*Required*: Yes \n*Type*: [AccessPolicyIdentity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identity for this access policy\\. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user\\. \n*Required*: Yes \n*Type*: [AccessPolicyIdentity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessPolicyIdentity" }, "AccessPolicyPermission": { @@ -103305,7 +106013,7 @@ }, "User": { "$ref": "#/definitions/AWS::IoTSiteWise::AccessPolicy.User", - "markdownDescription": "The AWS SSO user to which this access policy maps\\. \n*Required*: No \n*Type*: [User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The IAM Identity Center user to which this access policy maps\\. \n*Required*: No \n*Type*: [User](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "User" } }, @@ -103418,6 +106126,8 @@ "additionalProperties": false, "properties": { "AssetDescription": { + "markdownDescription": "A description for the asset\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssetDescription", "type": "string" }, "AssetHierarchies": { @@ -103516,11 +106226,13 @@ "type": "string" }, "NotificationState": { - "markdownDescription": "The MQTT notification state \\(enabled or disabled\\) for this asset property\\. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic\\. For more information, see [Interacting with other services](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) in the *AWS IoT SiteWise User Guide*\\. \nIf you omit this parameter, the notification state is set to `DISABLED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The MQTT notification state \\(`ENABLED` or `DISABLED`\\) for this asset property\\. When the notification state is `ENABLED`, AWS IoT SiteWise publishes property value updates to a unique MQTT topic\\. For more information, see [Interacting with other services](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) in the *AWS IoT SiteWise User Guide*\\. \nIf you omit this parameter, the notification state is set to `DISABLED`\\. \nYou must use all caps for the NotificationState parameter\\. If you use lower case letters, you will receive a schema validation error\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NotificationState", "type": "string" }, "Unit": { + "markdownDescription": "The unit \\(such as `Newtons` or `RPM`\\) of the asset property\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Unit", "type": "string" } }, @@ -103717,7 +106429,7 @@ }, "Type": { "$ref": "#/definitions/AWS::IoTSiteWise::AssetModel.PropertyType", - "markdownDescription": "Contains a property type, which can be one of `attribute`, `measurement`, `metric`, or `transform`\\. \n*Required*: Yes \n*Type*: [PropertyType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains a property type, which can be one of `Attribute`, `Measurement`, `Metric`, or `Transform`\\. \n*Required*: Yes \n*Type*: [PropertyType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-propertytype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type" }, "Unit": { @@ -104176,7 +106888,7 @@ "properties": { "Alarms": { "$ref": "#/definitions/AWS::IoTSiteWise::Portal.Alarms", - "markdownDescription": "Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal\\. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range\\. For more information, see [Monitoring with alarms](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the * AWS IoT SiteWise Application Guide*\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal\\. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range\\. For more information, see [Monitoring with alarms](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the * AWS IoT SiteWise Application Guide*\\. \n*Required*: No \n*Type*: [Alarms](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Alarms" }, "NotificationSenderEmail": { @@ -104185,7 +106897,7 @@ "type": "string" }, "PortalAuthMode": { - "markdownDescription": "The service to use to authenticate users to the portal\\. Choose from the following options: \n+ `SSO` \u2013 The portal uses AWS Single Sign\\-On to authenticate users and manage user permissions\\. Before you can create a portal that uses AWS SSO, you must enable AWS SSO\\. For more information, see [Enabling AWS SSO](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) in the *AWS IoT SiteWise User Guide*\\. This option is only available in AWS Regions other than the China Regions\\.\n+ `IAM` \u2013 The portal uses AWS Identity and Access Management \\(IAM\\) to authenticate users and manage user permissions\\.\nYou can't change this value after you create a portal\\. \nDefault: `SSO` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The service to use to authenticate users to the portal\\. Choose from the following options: \n+ `SSO` \u2013 The portal uses AWS IAM Identity Center \\(successor to AWS Single Sign\\-On\\) to authenticate users and manage user permissions\\. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center\\. For more information, see [Enabling IAM Identity Center](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) in the *AWS IoT SiteWise User Guide*\\. This option is only available in AWS Regions other than the China Regions\\.\n+ `IAM` \u2013 The portal uses AWS Identity and Access Management \\(IAM\\) to authenticate users and manage user permissions\\.\nYou can't change this value after you create a portal\\. \nDefault: `SSO` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PortalAuthMode", "type": "string" }, @@ -104250,9 +106962,13 @@ "additionalProperties": false, "properties": { "AlarmRoleArn": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmRoleArn", "type": "string" }, "NotificationLambdaArn": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotificationLambdaArn", "type": "string" } }, @@ -104388,14 +107104,10 @@ "additionalProperties": false, "properties": { "CompatibleNamespaceVersion": { - "markdownDescription": "The version of the user's namespace against which the workflow was validated\\. Use this value in your system instance\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "title": "CompatibleNamespaceVersion", "type": "number" }, "Definition": { - "$ref": "#/definitions/AWS::IoTThingsGraph::FlowTemplate.DefinitionDocument", - "markdownDescription": "A workflow's definition document\\. \n*Required*: Yes \n*Type*: [DefinitionDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotthingsgraph-flowtemplate-definitiondocument.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "title": "Definition" + "$ref": "#/definitions/AWS::IoTThingsGraph::FlowTemplate.DefinitionDocument" } }, "required": [ @@ -104428,13 +107140,9 @@ "additionalProperties": false, "properties": { "Language": { - "markdownDescription": "The language used to define the entity\\. `GRAPHQL` is the only valid value\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "title": "Language", "type": "string" }, "Text": { - "markdownDescription": "The GraphQL text that defines the entity\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", - "title": "Text", "type": "string" } }, @@ -104480,57 +107188,75 @@ "additionalProperties": false, "properties": { "ComponentTypeId": { + "markdownDescription": "The ID of the component type\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ComponentTypeId", "type": "string" }, "Description": { + "markdownDescription": "The description of the component type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "ExtendsFrom": { "items": { "type": "string" }, + "markdownDescription": "The name of the parent component type that this component type extends\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExtendsFrom", "type": "array" }, "Functions": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to the functions in the component type\\. Each string in the mapping must be unique to this object\\. \nFor information on the FunctionResponse object see the [FunctionResponse](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_FunctionResponse.html) API reference\\. \n*Required*: No \n*Type*: Map of [Function](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-function.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.Function" } }, + "title": "Functions", "type": "object" }, "IsSingleton": { + "markdownDescription": "A boolean value that specifies whether an entity can have more than one component of this type\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsSingleton", "type": "boolean" }, "PropertyDefinitions": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to the property definitions in the component type\\. Each string in the mapping must be unique to this object\\. \nFor information about the PropertyDefinitionResponse object, see the [PropertyDefinitionResponse](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyDefinitionResponse.html) API reference\\. \n*Required*: No \n*Type*: Map of [PropertyDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.PropertyDefinition" } }, + "title": "PropertyDefinitions", "type": "object" }, "PropertyGroups": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to the property groups in the component type\\. Each string in the mapping must be unique to this object\\. \n*Required*: No \n*Type*: Map of [PropertyGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertygroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.PropertyGroup" } }, + "title": "PropertyGroups", "type": "object" }, "Tags": { "additionalProperties": true, + "markdownDescription": "The ComponentType tags\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "WorkspaceId": { + "markdownDescription": "The ID of the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "WorkspaceId", "type": "string" } }, @@ -104565,10 +107291,14 @@ "additionalProperties": false, "properties": { "IsNative": { + "markdownDescription": "A boolean value that specifies whether the data connector is native to IoT TwinMaker\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsNative", "type": "boolean" }, "Lambda": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.LambdaFunction" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.LambdaFunction", + "markdownDescription": "The Lambda function associated with the data connector\\. \n*Required*: No \n*Type*: [LambdaFunction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-lambdafunction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Lambda" } }, "type": "object" @@ -104580,18 +107310,28 @@ "items": { "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataValue" }, + "markdownDescription": "The allowed values for this data type\\. \n*Required*: No \n*Type*: List of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowedValues", "type": "array" }, "NestedType": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataType" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataType", + "markdownDescription": "The nested type in the data type\\. \n*Required*: No \n*Type*: [DataType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-componenttype-datatype.html#aws-properties-iottwinmaker-componenttype-datatype) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NestedType" }, "Relationship": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.Relationship" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.Relationship", + "markdownDescription": "A relationship that associates a component with another component\\. \n*Required*: No \n*Type*: [Relationship](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-relationship.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Relationship" }, "Type": { + "markdownDescription": "The underlying type of the data type\\. \nValid Values: `RELATIONSHIP | STRING | LONG | BOOLEAN | INTEGER | DOUBLE | LIST | MAP` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "UnitOfMeasure": { + "markdownDescription": "The unit of measure used in this data type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UnitOfMeasure", "type": "string" } }, @@ -104604,39 +107344,57 @@ "additionalProperties": false, "properties": { "BooleanValue": { + "markdownDescription": "A boolean value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BooleanValue", "type": "boolean" }, "DoubleValue": { + "markdownDescription": "A double value\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DoubleValue", "type": "number" }, "Expression": { + "markdownDescription": "An expression that produces the value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Expression", "type": "string" }, "IntegerValue": { + "markdownDescription": "An integer value\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntegerValue", "type": "number" }, "ListValue": { "items": { "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataValue" }, + "markdownDescription": "A list of multiple values\\. \n*Required*: No \n*Type*: List of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-componenttype-datavalue.html#aws-properties-iottwinmaker-componenttype-datavalue) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ListValue", "type": "array" }, "LongValue": { + "markdownDescription": "A long value\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LongValue", "type": "number" }, "MapValue": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to multiple `DataValue` objects\\. \n*Required*: No \n*Type*: Map of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-componenttype-datavalue.html#aws-properties-iottwinmaker-componenttype-datavalue) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataValue" } }, + "title": "MapValue", "type": "object" }, "RelationshipValue": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.RelationshipValue" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.RelationshipValue", + "markdownDescription": "A value that relates a component to another component\\. \n*Required*: No \n*Type*: [RelationshipValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-relationshipvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RelationshipValue" }, "StringValue": { + "markdownDescription": "A string value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StringValue", "type": "string" } }, @@ -104646,9 +107404,13 @@ "additionalProperties": false, "properties": { "Code": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Code", "type": "string" }, "Message": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Message", "type": "string" } }, @@ -104658,15 +107420,21 @@ "additionalProperties": false, "properties": { "ImplementedBy": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataConnector" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataConnector", + "markdownDescription": "The data connector\\. \n*Required*: No \n*Type*: [DataConnector](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-dataconnector.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImplementedBy" }, "RequiredProperties": { "items": { "type": "string" }, + "markdownDescription": "The required properties of the function\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RequiredProperties", "type": "array" }, "Scope": { + "markdownDescription": "The scope of the function\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Scope", "type": "string" } }, @@ -104676,6 +107444,8 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "The Lambda function ARN\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Arn", "type": "string" } }, @@ -104689,29 +107459,43 @@ "properties": { "Configurations": { "additionalProperties": true, + "markdownDescription": "A mapping that specifies configuration information about the property\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Configurations", "type": "object" }, "DataType": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataType" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataType", + "markdownDescription": "*Required*: No \n*Type*: [DataType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datatype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType" }, "DefaultValue": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataValue" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.DataValue", + "markdownDescription": "A boolean value that specifies whether the property ID comes from an external data store\\. \n*Required*: No \n*Type*: [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultValue" }, "IsExternalId": { + "markdownDescription": "A boolean value that specifies whether the property ID comes from an external data store\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsExternalId", "type": "boolean" }, "IsRequiredInEntity": { + "markdownDescription": "A boolean value that specifies whether the property is required in an entity\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsRequiredInEntity", "type": "boolean" }, "IsStoredExternally": { + "markdownDescription": "A boolean value that specifies whether the property is stored externally\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsStoredExternally", "type": "boolean" }, "IsTimeSeries": { + "markdownDescription": "A boolean value that specifies whether the property consists of time series data\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsTimeSeries", "type": "boolean" } }, @@ -104721,12 +107505,16 @@ "additionalProperties": false, "properties": { "GroupType": { + "markdownDescription": "The group type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GroupType", "type": "string" }, "PropertyNames": { "items": { "type": "string" }, + "markdownDescription": "The property names\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PropertyNames", "type": "array" } }, @@ -104736,9 +107524,13 @@ "additionalProperties": false, "properties": { "RelationshipType": { + "markdownDescription": "The type of the relationship\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RelationshipType", "type": "string" }, "TargetComponentTypeId": { + "markdownDescription": "The ID of the target component type associated with this relationship\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetComponentTypeId", "type": "string" } }, @@ -104748,9 +107540,13 @@ "additionalProperties": false, "properties": { "TargetComponentName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetComponentName", "type": "string" }, "TargetEntityId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetEntityId", "type": "string" } }, @@ -104760,9 +107556,13 @@ "additionalProperties": false, "properties": { "Error": { - "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.Error" + "$ref": "#/definitions/AWS::IoTTwinMaker::ComponentType.Error", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Error](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-error.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Error" }, "State": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "State", "type": "string" } }, @@ -104805,35 +107605,49 @@ "properties": { "Components": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to the components in the entity\\. Each string in the mapping must be unique to this object\\. \nFor information on the component object see the [component](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ComponentResponse.html) API reference\\. \n*Required*: No \n*Type*: Map of [Component](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-component.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Component" } }, + "title": "Components", "type": "object" }, "Description": { + "markdownDescription": "The description of the entity\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "EntityId": { + "markdownDescription": "The entity ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EntityId", "type": "string" }, "EntityName": { + "markdownDescription": "The entity name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EntityName", "type": "string" }, "ParentEntityId": { + "markdownDescription": "The ID of the parent entity\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ParentEntityId", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Metadata that you can use to manage the entity\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "WorkspaceId": { + "markdownDescription": "The ID of the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "WorkspaceId", "type": "string" } }, @@ -104868,37 +107682,51 @@ "additionalProperties": false, "properties": { "ComponentName": { + "markdownDescription": "The name of the component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ComponentName", "type": "string" }, "ComponentTypeId": { + "markdownDescription": "The ID of the ComponentType\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ComponentTypeId", "type": "string" }, "DefinedIn": { + "markdownDescription": "The name of the property definition set in the request\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefinedIn", "type": "string" }, "Description": { + "markdownDescription": "The description of the component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Properties": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to the properties to set in the component type\\. Each string in the mapping must be unique to this object\\. \n*Required*: No \n*Type*: Map of [Property](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-property.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Property" } }, + "title": "Properties", "type": "object" }, "PropertyGroups": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to the property groups in the component type\\. Each string in the mapping must be unique to this object\\. \n*Required*: No \n*Type*: Map of [PropertyGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-propertygroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.PropertyGroup" } }, + "title": "PropertyGroups", "type": "object" }, "Status": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Status" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Status", + "markdownDescription": "The status of the component\\. \n*Required*: No \n*Type*: [Status](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-status.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status" } }, "type": "object" @@ -104910,18 +107738,28 @@ "items": { "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowedValues", "type": "array" }, "NestedType": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataType" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataType", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DataType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-entity-datatype.html#aws-properties-iottwinmaker-entity-datatype) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NestedType" }, "Relationship": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Relationship" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Relationship", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Relationship](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-relationship.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Relationship" }, "Type": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "UnitOfMeasure": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UnitOfMeasure", "type": "string" } }, @@ -104931,39 +107769,57 @@ "additionalProperties": false, "properties": { "BooleanValue": { + "markdownDescription": "A boolean value\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BooleanValue", "type": "boolean" }, "DoubleValue": { + "markdownDescription": "A double value\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DoubleValue", "type": "number" }, "Expression": { + "markdownDescription": "An expression that produces the value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Expression", "type": "string" }, "IntegerValue": { + "markdownDescription": "An integer value\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntegerValue", "type": "number" }, "ListValue": { "items": { "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue" }, + "markdownDescription": "A list of multiple values\\. \n*Required*: No \n*Type*: List of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-entity-datavalue.html#aws-properties-iottwinmaker-entity-datavalue) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ListValue", "type": "array" }, "LongValue": { + "markdownDescription": "A long value\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LongValue", "type": "number" }, "MapValue": { "additionalProperties": false, + "markdownDescription": "An object that maps strings to multiple DataValue objects\\. \n*Required*: No \n*Type*: Map of [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-iottwinmaker-entity-datavalue.html#aws-properties-iottwinmaker-entity-datavalue) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue" } }, + "title": "MapValue", "type": "object" }, "RelationshipValue": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.RelationshipValue" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.RelationshipValue", + "markdownDescription": "A value that relates a component to another component\\. \n*Required*: No \n*Type*: [RelationshipValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-relationshipvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RelationshipValue" }, "StringValue": { + "markdownDescription": "A string value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StringValue", "type": "string" } }, @@ -104974,38 +107830,58 @@ "properties": { "Configuration": { "additionalProperties": true, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Configuration", "type": "object" }, "DataType": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataType" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataType", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DataType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datatype.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType" }, "DefaultValue": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultValue" }, "IsExternalId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsExternalId", "type": "boolean" }, "IsFinal": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsFinal", "type": "boolean" }, "IsImported": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsImported", "type": "boolean" }, "IsInherited": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsInherited", "type": "boolean" }, "IsRequiredInEntity": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsRequiredInEntity", "type": "boolean" }, "IsStoredExternally": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsStoredExternally", "type": "boolean" }, "IsTimeSeries": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsTimeSeries", "type": "boolean" } }, @@ -105015,9 +107891,13 @@ "additionalProperties": false, "properties": { "Code": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Code", "type": "string" }, "Message": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Message", "type": "string" } }, @@ -105027,10 +107907,14 @@ "additionalProperties": false, "properties": { "Definition": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Definition" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Definition", + "markdownDescription": "An object that specifies information about a property\\. \n*Required*: No \n*Type*: [Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-definition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Definition" }, "Value": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.DataValue", + "markdownDescription": "An object that contains information about a value for a time series property\\. \n*Required*: No \n*Type*: [DataValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-datavalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value" } }, "type": "object" @@ -105039,12 +107923,16 @@ "additionalProperties": false, "properties": { "GroupType": { + "markdownDescription": "The group type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GroupType", "type": "string" }, "PropertyNames": { "items": { "type": "string" }, + "markdownDescription": "The property names\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PropertyNames", "type": "array" } }, @@ -105054,9 +107942,13 @@ "additionalProperties": false, "properties": { "RelationshipType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RelationshipType", "type": "string" }, "TargetComponentTypeId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetComponentTypeId", "type": "string" } }, @@ -105066,9 +107958,13 @@ "additionalProperties": false, "properties": { "TargetComponentName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetComponentName", "type": "string" }, "TargetEntityId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetEntityId", "type": "string" } }, @@ -105078,9 +107974,13 @@ "additionalProperties": false, "properties": { "Error": { - "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Error" + "$ref": "#/definitions/AWS::IoTTwinMaker::Entity.Error", + "markdownDescription": "The error message\\. \n*Required*: No \n*Type*: [Error](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-entity-error.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Error" }, "State": { + "markdownDescription": "The current state of the entity, component, component type, or workspace\\. \nValid Values: `CREATING | UPDATING | DELETING | ACTIVE | ERROR` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "State", "type": "string" } }, @@ -105125,27 +108025,39 @@ "items": { "type": "string" }, + "markdownDescription": "A list of capabilities that the scene uses to render\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Capabilities", "type": "array" }, "ContentLocation": { + "markdownDescription": "The relative path that specifies the location of the content definition file\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContentLocation", "type": "string" }, "Description": { + "markdownDescription": "The description of this scene\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "SceneId": { + "markdownDescription": "The scene ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SceneId", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "The ComponentType tags\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "WorkspaceId": { + "markdownDescription": "The ID of the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "WorkspaceId", "type": "string" } }, @@ -105213,21 +108125,29 @@ "additionalProperties": false, "properties": { "SyncRole": { + "markdownDescription": "The SyncJob IAM role\\. This IAM role is used by the sync job to read from the syncSource, and create, update or delete the corresponding resources\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SyncRole", "type": "string" }, "SyncSource": { + "markdownDescription": "The sync source\\. \nCurrently the only supported syncSoucre is `SITEWISE`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SyncSource", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Metadata you can use to manage the SyncJob\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "WorkspaceId": { + "markdownDescription": "The ID of the workspace that contains the sync job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "WorkspaceId", "type": "string" } }, @@ -105295,24 +108215,34 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the workspace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Role": { + "markdownDescription": "The ARN of the execution role associated with the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Role", "type": "string" }, "S3Location": { + "markdownDescription": "The ARN of the S3 bucket where resources associated with the workspace are stored\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3Location", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Metadata that you can use to manage the workspace\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "WorkspaceId": { + "markdownDescription": "The ID of the workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "WorkspaceId", "type": "string" } }, @@ -105535,6 +108465,8 @@ "items": { "type": "number" }, + "markdownDescription": "The list of values that make up the FactoryPresetFreqs value\\. \n*Required*: No \n*Type*: List of Integer \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FactoryPresetFreqsList", "type": "array" }, "MacVersion": { @@ -105578,15 +108510,23 @@ "type": "string" }, "RxDataRate2": { + "markdownDescription": "The RXDataRate2 value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RxDataRate2", "type": "number" }, "RxDelay1": { + "markdownDescription": "The RXDelay1 value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RxDelay1", "type": "number" }, "RxDrOffset1": { + "markdownDescription": "The RXDROffset1 value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `7` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RxDrOffset1", "type": "number" }, "RxFreq2": { + "markdownDescription": "The RXFreq2 value\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1000000` \n*Maximum*: `16700000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RxFreq2", "type": "number" }, "Supports32BitFCnt": { @@ -105909,30 +108849,42 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "Name of the network analyzer configuration\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags to attach to the specified resource\\. Tags are metadata that you can use to manage a resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Tags", "type": "array" }, "TraceContent": { - "$ref": "#/definitions/AWS::IoTWireless::NetworkAnalyzerConfiguration.TraceContent" + "$ref": "#/definitions/AWS::IoTWireless::NetworkAnalyzerConfiguration.TraceContent", + "markdownDescription": "Trace content for your wireless gateway and wireless device resources\\. \n*Required*: No \n*Type*: [TraceContent](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-networkanalyzerconfiguration-tracecontent.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TraceContent" }, "WirelessDevices": { "items": { "type": "string" }, + "markdownDescription": "Wireless device resources to add to the network analyzer configuration\\. Provide the `WirelessDeviceId` of the resource to add in the input array\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `250` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WirelessDevices", "type": "array" }, "WirelessGateways": { "items": { "type": "string" }, + "markdownDescription": "Wireless gateway resources to add to the network analyzer configuration\\. Provide the `WirelessGatewayId` of the resource to add in the input array\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WirelessGateways", "type": "array" } }, @@ -105966,9 +108918,13 @@ "additionalProperties": false, "properties": { "LogLevel": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogLevel", "type": "string" }, "WirelessDeviceFrameInfo": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WirelessDeviceFrameInfo", "type": "string" } }, @@ -106080,12 +109036,18 @@ "additionalProperties": false, "properties": { "AmazonId": { + "markdownDescription": "The Sidewalk Amazon ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AmazonId", "type": "string" }, "Arn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Arn", "type": "string" }, "Fingerprint": { + "markdownDescription": "The fingerprint of the Sidewalk application server private key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `64` \n*Maximum*: `64` \n*Pattern*: `[a-fA-F0-9]{64}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Fingerprint", "type": "string" } }, @@ -106315,7 +109277,7 @@ "additionalProperties": false, "properties": { "AutoCreateTasks": { - "markdownDescription": "Whether to automatically create tasks using this task definition for all gateways with the specified current version\\. If `false`, the task must me created by calling `CreateWirelessGatewayTask`\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Whether to automatically create tasks using this task definition for all gateways with the specified current version\\. If `false`, the task must be created by calling `CreateWirelessGatewayTask`\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutoCreateTasks", "type": "boolean" }, @@ -106808,6 +109770,8 @@ "type": "string" }, "ThingName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ThingName", "type": "string" } }, @@ -106893,7 +109857,7 @@ "additionalProperties": false, "properties": { "AliasName": { - "markdownDescription": "Specifies the alias name\\. This value must begin with `alias/` followed by a name, such as `alias/ExampleAlias`\\. \nIf you change the value of a `Replacement` property, such as `AliasName`, the existing alias is deleted and a new alias is created for the specified KMS key\\. This change can disrupt applications that use the alias\\. It can also allow or deny access to a KMS key affected by attribute\\-based access control \\(ABAC\\)\\.\nThe alias must be string of 1\\-256 characters\\. It can contain only alphanumeric characters, forward slashes \\(/\\), underscores \\(\\_\\), and dashes \\(\\-\\)\\. The alias name cannot begin with `alias/aws/`\\. The `alias/aws/` prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)\\. \n*Pattern*: `alias/^[a-zA-Z0-9/_-]+$` \n*Minimum*: `1` \n*Maximum*: `256` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the alias name\\. This value must begin with `alias/` followed by a name, such as `alias/ExampleAlias`\\. \nIf you change the value of the `AliasName` property, the existing alias is deleted and a new alias is created for the specified KMS key\\. This change can disrupt applications that use the alias\\. It can also allow or deny access to a KMS key affected by attribute\\-based access control \\(ABAC\\)\\.\nThe alias must be string of 1\\-256 characters\\. It can contain only alphanumeric characters, forward slashes \\(/\\), underscores \\(\\_\\), and dashes \\(\\-\\)\\. The alias name cannot begin with `alias/aws/`\\. The `alias/aws/` prefix is reserved for [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)\\. \n*Pattern*: `^alias/[a-zA-Z0-9/_-]+$` \n*Minimum*: `1` \n*Maximum*: `256` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AliasName", "type": "string" }, @@ -106971,7 +109935,7 @@ "type": "string" }, "EnableKeyRotation": { - "markdownDescription": "Enables automatic rotation of the key material for the specified KMS key\\. By default, automatic key rotation is not enabled\\. \nAWS KMS does not support automatic key rotation on asymmetric KMS keys\\. For asymmetric KMS keys, omit the `EnableKeyRotation` property or set it to `false`\\. \nWhen you enable automatic rotation, AWS KMS automatically creates new key material for the KMS key 365 days after the enable \\(or reenable\\) date and every 365 days thereafter\\. AWS KMS retains all key material until you delete the KMS key\\. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *AWS Key Management Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Enables automatic rotation of the key material for the specified KMS key\\. By default, automatic key rotation is not enabled\\. \nAWS KMS supports automatic rotation only for symmetric encryption KMS keys \\(`KeySpec` = `SYMMETRIC_DEFAULT`\\)\\. For asymmetric KMS keys and HMAC KMS keys, omit the `EnableKeyRotation` property or set it to `false`\\. \nTo enable automatic key rotation of the key material for a multi\\-Region KMS key, set `EnableKeyRotation` to `true` on the primary key \\(created by using `AWS::KMS::Key`\\)\\. AWS KMS copies the rotation status to all replica keys\\. For details, see [Rotating multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *AWS Key Management Service Developer Guide*\\. \nWhen you enable automatic rotation, AWS KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter\\. AWS KMS retains all key material until you delete the KMS key\\. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *AWS Key Management Service Developer Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableKeyRotation", "type": "boolean" }, @@ -106981,22 +109945,22 @@ "type": "boolean" }, "KeyPolicy": { - "markdownDescription": "The key policy that authorizes use of the KMS key\\. The key policy must conform to the following rules\\. \n+ The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key\\. This reduces the risk that the KMS key becomes unmanageable\\. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the * *AWS Key Management Service Developer Guide* *\\.\n+ Each statement in the key policy must contain one or more principals\\. The principals in the key policy must exist and be visible to AWS KMS\\. When you create a new AWS principal \\(for example, an IAM user or role\\), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS\\. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide*\\.\n+ The key policy size limit is 32 kilobytes \\(32768 bytes\\)\\.\nIf you are unsure of which policy to use, consider the *default key policy*\\. This is the key policy that AWS KMS applies to KMS keys that are created by using the CreateKey API with no specified key policy\\. It gives the AWS account that owns the key permission to perform all operations on the key\\. It also allows you write IAM policies to authorize access to the key\\. For details, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *AWS Key Management Service Developer Guide*\\. \n*Minimum*: `1` \n*Maximum*: `32768` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key policy that authorizes use of the KMS key\\. The key policy must conform to the following rules\\. \n+ The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key\\. This reduces the risk that the KMS key becomes unmanageable\\. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the * *AWS Key Management Service Developer Guide* *\\.\n+ Each statement in the key policy must contain one or more principals\\. The principals in the key policy must exist and be visible to AWS KMS\\. When you create a new AWS principal \\(for example, an IAM user or role\\), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS\\. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide*\\.\nIf you are unsure of which policy to use, consider the *default key policy*\\. This is the key policy that AWS KMS applies to KMS keys that are created by using the CreateKey API with no specified key policy\\. It gives the AWS account that owns the key permission to perform all operations on the key\\. It also allows you write IAM policies to authorize access to the key\\. For details, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *AWS Key Management Service Developer Guide*\\. \nA key policy document can include only the following characters: \n+ Printable ASCII characters\n+ Printable characters in the Basic Latin and Latin\\-1 Supplement character set\n+ The tab \\(`\\u0009`\\), line feed \\(`\\u000A`\\), and carriage return \\(`\\u000D`\\) special characters\n*Minimum*: `1` \n*Maximum*: `32768` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeyPolicy", "type": "object" }, "KeySpec": { - "markdownDescription": "Specifies the type of KMS key to create\\. The default value, `SYMMETRIC_DEFAULT`, creates a KMS key with a 256\\-bit symmetric key for encryption and decryption\\. For help choosing a key spec for your KMS key, see [How to choose Your KMS key configuration](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *AWS Key Management Service Developer Guide*\\. \nThe `KeySpec` property determines whether the KMS key contains a symmetric key or an asymmetric key pair\\. It also determines the encryption algorithms or signing algorithms that the KMS key supports\\. You can't change the `KeySpec` after the KMS key is created\\. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy\\. For more information, see [kms:EncryptionAlgorithm](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm) or [kms:Signing Algorithm](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm) in the *AWS Key Management Service Developer Guide*\\. \nIf you change the `KeySpec` of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified `KeySpec` value\\. While the scheduled deletion is pending, you can't use the existing KMS key\\. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted\\.\n[AWS services that are integrated with AWS KMS](http://aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric KMS keys to protect your data\\. These services do not support asymmetric KMS keys\\. For help determining whether a KMS key is symmetric or asymmetric, see [Identifying Symmetric and Asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *AWS Key Management Service Developer Guide*\\.\nAWS KMS supports the following key specs for KMS keys: \n+ Symmetric key \\(default\\)\n + `SYMMETRIC_DEFAULT` \\(AES\\-256\\-GCM\\)\n+ Asymmetric RSA key pairs\n + `RSA_2048`\n + `RSA_3072`\n + `RSA_4096`\n+ Asymmetric NIST\\-recommended elliptic curve key pairs\n + `ECC_NIST_P256` \\(secp256r1\\)\n + `ECC_NIST_P384` \\(secp384r1\\)\n + `ECC_NIST_P521` \\(secp521r1\\)\n+ Other asymmetric elliptic curve key pairs\n + `ECC_SECG_P256K1` \\(secp256k1\\), commonly used for cryptocurrencies\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the type of KMS key to create\\. The default value, `SYMMETRIC_DEFAULT`, creates a KMS key with a 256\\-bit symmetric key for encryption and decryption\\. In China Regions, `SYMMETRIC_DEFAULT` creates a 128\\-bit symmetric key that uses SM4 encryption\\. You can't change the `KeySpec` value after the KMS key is created\\. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *AWS Key Management Service Developer Guide*\\. \nThe `KeySpec` property determines the type of key material in the KMS key and the algorithms that the KMS key supports\\. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy\\. For more information, see [AWS KMS condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *AWS Key Management Service Developer Guide*\\. \nIf you change the value of the `KeySpec` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html)\\. This prevents you from accidentally deleting a KMS key by changing an immutable property value\\.\n[AWS services that are integrated with AWS KMS](http://aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data\\. These services do not support encryption with asymmetric KMS keys\\. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *AWS Key Management Service Developer Guide*\\.\n AWS KMS supports the following key specs for KMS keys: \n+ Symmetric encryption key \\(default\\)\n + `SYMMETRIC_DEFAULT` \\(AES\\-256\\-GCM\\)\n+ HMAC keys \\(symmetric\\)\n + `HMAC_224` \n + `HMAC_256` \n + `HMAC_384` \n + `HMAC_512` \n+ Asymmetric RSA key pairs\n + `RSA_2048` \n + `RSA_3072` \n + `RSA_4096` \n+ Asymmetric NIST\\-recommended elliptic curve key pairs\n + `ECC_NIST_P256` \\(secp256r1\\)\n + `ECC_NIST_P384` \\(secp384r1\\)\n + `ECC_NIST_P521` \\(secp521r1\\)\n+ Other asymmetric elliptic curve key pairs\n + `ECC_SECG_P256K1` \\(secp256k1\\), commonly used for cryptocurrencies\\.\n+ SM2 key pairs \\(China Regions only\\)\n + `SM2`\n*Required*: No \n*Type*: String \n*Allowed values*: `ECC_NIST_P256 | ECC_NIST_P384 | ECC_NIST_P521 | ECC_SECG_P256K1 | HMAC_224 | HMAC_256 | HMAC_384 | HMAC_512 | RSA_2048 | RSA_3072 | RSA_4096 | SM2 | SYMMETRIC_DEFAULT` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeySpec", "type": "string" }, "KeyUsage": { - "markdownDescription": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key\\. The default value is `ENCRYPT_DECRYPT`\\. This property is required only for asymmetric KMS keys\\. You can't change the `KeyUsage` value after the KMS key is created\\. \nIf you change the `KeyUsage` of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified `KeyUsage` value\\. While the scheduled deletion is pending, you can't use the existing KMS key\\. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted\\.\nSelect only one valid value\\. \n+ For symmetric KMS keys, omit the property or specify `ENCRYPT_DECRYPT`\\.\n+ For asymmetric KMS keys with RSA key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY`\\.\n+ For asymmetric KMS keys with ECC key material, specify `SIGN_VERIFY`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ENCRYPT_DECRYPT | SIGN_VERIFY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key\\. The default value is `ENCRYPT_DECRYPT`\\. This property is required for asymmetric KMS keys and HMAC KMS keys\\. You can't change the `KeyUsage` value after the KMS key is created\\. \nIf you change the value of the `KeyUsage` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html)\\. This prevents you from accidentally deleting a KMS key by changing an immutable property value\\.\nSelect only one valid value\\. \n+ For symmetric encryption KMS keys, omit the property or specify `ENCRYPT_DECRYPT`\\.\n+ For asymmetric KMS keys with RSA key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY`\\.\n+ For asymmetric KMS keys with ECC key material, specify `SIGN_VERIFY`\\.\n+ For asymmetric KMS keys with SM2 \\(China Regions only\\) key material, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY`\\.\n+ For HMAC KMS keys, specify `GENERATE_VERIFY_MAC`\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ENCRYPT_DECRYPT | GENERATE_VERIFY_MAC | SIGN_VERIFY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KeyUsage", "type": "string" }, "MultiRegion": { - "markdownDescription": "Creates a multi\\-Region primary key that you can replicate in other AWS Regions\\. \nIf you change the `MultiRegion` property of an existing KMS key, the existing KMS key is scheduled for deletion and a new KMS key is created with the specified `Multi-Region` value\\. While the scheduled deletion is pending, you can't use the existing KMS key\\. Unless you [cancel the scheduled deletion](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion) of the KMS key outside of CloudFormation, all data encrypted under the existing KMS key becomes unrecoverable when the KMS key is deleted\\.\nFor a multi\\-Region key, set to this property to `true`\\. For a single\\-Region key, omit this property or set it to `false`\\. The default value is `false`\\. \n*Multi\\-Region keys* are an AWS KMS feature that lets you create multiple interoperable KMS keys in different AWS Regions\\. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross\\-Region call or exposing the plaintext data\\. For more information, see [Multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide*\\. \nYou can create a symmetric or asymmetric multi\\-Region key, and you can create a multi\\-Region key with imported key material\\. However, you cannot create a multi\\-Region key in a custom key store\\. \nTo create a replica of this primary key in a different AWS Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region\\. Specify the key ARN of this primary key\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Creates a multi\\-Region primary key that you can replicate in other AWS Regions\\. You can't change the `MultiRegion` value after the KMS key is created\\. \nFor a list of AWS Regions in which multi\\-Region keys are supported, see [Multi\\-Region keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide*\\. \nIf you change the value of the `MultiRegion` property on an existing KMS key, the update request fails, regardless of the value of the [`UpdateReplacePolicy` attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html)\\. This prevents you from accidentally deleting a KMS key by changing an immutable property value\\.\nFor a multi\\-Region key, set to this property to `true`\\. For a single\\-Region key, omit this property or set it to `false`\\. The default value is `false`\\. \n*Multi\\-Region keys* are an AWS KMS feature that lets you create multiple interoperable KMS keys in different AWS Regions\\. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross\\-Region call or exposing the plaintext data\\. For more information, see [Multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *AWS Key Management Service Developer Guide*\\. \nYou can create a symmetric encryption, HMAC, or asymmetric multi\\-Region KMS key, and you can create a multi\\-Region key with imported key material\\. However, you cannot create a multi\\-Region key in a custom key store\\. \nTo create a replica of this primary key in a different AWS Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region\\. Specify the key ARN of this primary key\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MultiRegion", "type": "boolean" }, @@ -107086,12 +110050,12 @@ "type": "boolean" }, "KeyPolicy": { - "markdownDescription": "The key policy that authorizes use of the replica key\\. \nThe key policy is not a shared property of multi\\-Region keys\\. You can specify the same key policy or a different key policy for each key in a set of related multi\\-Region keys\\. AWS KMS does not synchronize this property\\. \nThe key policy must conform to the following rules\\. \n+ The key policy must give the caller [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) permission on the KMS key\\. This reduces the risk that the KMS key becomes unmanageable\\. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the * *AWS Key Management Service Developer Guide* *\\.\n+ Each statement in the key policy must contain one or more principals\\. The principals in the key policy must exist and be visible to AWS KMS\\. When you create a new AWSprincipal \\(for example, an IAM user or role\\), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS\\. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide*\\.\n+ The key policy size limit is 32 kilobytes \\(32768 bytes\\)\\.\n*Minimum*: `1` \n*Maximum*: `32768` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The key policy that authorizes use of the replica key\\. \nThe key policy is not a shared property of multi\\-Region keys\\. You can specify the same key policy or a different key policy for each key in a set of related multi\\-Region keys\\. AWS KMS does not synchronize this property\\. \nThe key policy must conform to the following rules\\. \n+ The key policy must give the caller [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) permission on the KMS key\\. This reduces the risk that the KMS key becomes unmanageable\\. For more information, refer to the scenario in the [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section of the * *AWS Key Management Service Developer Guide* *\\.\n+ Each statement in the key policy must contain one or more principals\\. The principals in the key policy must exist and be visible to AWS KMS\\. When you create a new AWSprincipal \\(for example, an IAM user or role\\), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS\\. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *AWS Identity and Access Management User Guide*\\.\nA key policy document can include only the following characters: \n+ Printable ASCII characters from the space character \\(`\\u0020`\\) through the end of the ASCII character range\\.\n+ Printable characters in the Basic Latin and Latin\\-1 Supplement character set \\(through `\\u00FF`\\)\\.\n+ The tab \\(`\\u0009`\\), line feed \\(`\\u000A`\\), and carriage return \\(`\\u000D`\\) special characters\n*Minimum*: `1` \n*Maximum*: `32768` \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeyPolicy", "type": "object" }, "PendingWindowInDays": { - "markdownDescription": "Specifies the number of days in the waiting period before AWS KMS deletes a replica key that has been removed from a CloudFormation stack\\. Enter a value between 7 and 30 days\\. The default value is 30 days\\. \nWhen you remove a replica key from a CloudFormation stack, AWS KMS schedules the replica key for deletion and starts the mandatory waiting period\\. The `PendingWindowInDays` property determines the length of waiting period\\. During the waiting period, the key state of replica key is `Pending Deletion`, which prevents it from being used in cryptographic operations\\. When the waiting period expires, AWS KMS permanently deletes the replica key\\. \nYou cannot use a CloudFormation template to cancel deletion of the replica after you remove it from the stack, regardless of the waiting period\\. However, if you specify a replica key in your template that is based on the same primary key as the original replica key, CloudFormation creates a new replica key with the same key ID, key material, and other shared properties of the original replica key\\. This new replica key can decrypt ciphertext that was encrypted under the original replica key, or any related multi\\-Region key\\. \nFor detailed information about deleting multi\\-Region keys, see [Deleting multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide*\\. \nFor information about the `PendingDeletion` key state, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide*\\. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide*\\. \n*Minimum*: 7 \n*Maximum*: 30 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the number of days in the waiting period before AWS KMS deletes a replica key that has been removed from a CloudFormation stack\\. Enter a value between 7 and 30 days\\. The default value is 30 days\\. \nWhen you remove a replica key from a CloudFormation stack, AWS KMS schedules the replica key for deletion and starts the mandatory waiting period\\. The `PendingWindowInDays` property determines the length of waiting period\\. During the waiting period, the key state of replica key is `Pending Deletion`, which prevents it from being used in cryptographic operations\\. When the waiting period expires, AWS KMS permanently deletes the replica key\\. \nIf the KMS key is a multi\\-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted\\. Otherwise, the waiting period begins immediately\\. \nYou cannot use a CloudFormation template to cancel deletion of the replica after you remove it from the stack, regardless of the waiting period\\. However, if you specify a replica key in your template that is based on the same primary key as the original replica key, CloudFormation creates a new replica key with the same key ID, key material, and other shared properties of the original replica key\\. This new replica key can decrypt ciphertext that was encrypted under the original replica key, or any related multi\\-Region key\\. \nFor detailed information about deleting multi\\-Region keys, see [Deleting multi\\-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *AWS Key Management Service Developer Guide*\\. \nFor information about the `PendingDeletion` key state, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *AWS Key Management Service Developer Guide*\\. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *AWS Key Management Service API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *AWS Key Management Service Developer Guide*\\. \n*Minimum*: 7 \n*Maximum*: 30 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PendingWindowInDays", "type": "number" }, @@ -107226,7 +110190,7 @@ "items": { "$ref": "#/definitions/AWS::KafkaConnect::Connector.Plugin" }, - "markdownDescription": "Specifies which plugins were used for this connector\\. \n*Required*: Yes \n*Type*: List of [Plugin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-plugin.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies which plugin to use for the connector\\. You must specify a single\\-element list\\. Amazon MSK Connect does not currently support specifying multiple plugins\\. \n*Required*: Yes \n*Type*: List of [Plugin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-plugin.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Plugins", "type": "array" }, @@ -107652,21 +110616,21 @@ "properties": { "CustomDocumentEnrichmentConfiguration": { "$ref": "#/definitions/AWS::Kendra::DataSource.CustomDocumentEnrichmentConfiguration", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [CustomDocumentEnrichmentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configuration information for altering document metadata and content during the document ingestion process\\. \n*Required*: No \n*Type*: [CustomDocumentEnrichmentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-customdocumentenrichmentconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomDocumentEnrichmentConfiguration" }, "DataSourceConfiguration": { "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceConfiguration", - "markdownDescription": "Configuration information for an Amazon Kendra data source\\. The contents of the configuration depend on the type of data source\\. You can only specify one type of data source in the configuration\\. Choose from one of the following data sources\\. \n+ Amazon S3\n+ Confluence\n+ Custom\n+ Database\n+ Microsoft OneDrive\n+ Microsoft SharePoint \n+ Salesforce\n+ ServiceNow\nYou can't specify the `Configuration` parameter when the `Type` parameter is set to `CUSTOM`\\. \nThe `Configuration` parameter is required for all other data sources\\. \n*Required*: No \n*Type*: [DataSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configuration information for an Amazon Kendra data source\\. The contents of the configuration depend on the type of data source\\. You can only specify one type of data source in the configuration\\. \nYou can't specify the `Configuration` parameter when the `Type` parameter is set to `CUSTOM`\\. \nThe `Configuration` parameter is required for all other data sources\\. \n*Required*: No \n*Type*: [DataSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataSourceConfiguration" }, "Description": { - "markdownDescription": "A description of the data source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description for the data source connector\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "IndexId": { - "markdownDescription": "The identifier of the index that should be associated with this data source\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of the index you want to use with the data source connector\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IndexId", "type": "string" }, @@ -107694,7 +110658,7 @@ "type": "array" }, "Type": { - "markdownDescription": "The type of the data source\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONFLUENCE | CUSTOM | DATABASE | FSX | GOOGLEDRIVE | ONEDRIVE | S3 | SALESFORCE | SERVICENOW | SHAREPOINT | SLACK | WEBCRAWLER | WORKDOCS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of the data source\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALFRESCO | BOX | CONFLUENCE | CUSTOM | DATABASE | FSX | GITHUB | GOOGLEDRIVE | JIRA | ONEDRIVE | QUIP | S3 | SALESFORCE | SERVICENOW | SHAREPOINT | SLACK | TEMPLATE | WEBCRAWLER | WORKDOCS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -107769,7 +110733,7 @@ "type": "string" }, "DocumentIdColumnName": { - "markdownDescription": "The column that provides the document's unique identifier\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The column that provides the document's identifier\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DocumentIdColumnName", "type": "string" }, @@ -107806,7 +110770,7 @@ "type": "array" }, "CrawlAttachments": { - "markdownDescription": "Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to index attachments of pages and blogs in Confluence\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrawlAttachments", "type": "boolean" } @@ -107894,7 +110858,7 @@ "items": { "type": "string" }, - "markdownDescription": ">A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence\\. Content that matches the patterns are excluded from the index\\. Content that doesn't match the patterns is included in the index\\. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence\\. Content that matches the patterns are excluded from the index\\. Content that doesn't match the patterns is included in the index\\. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExclusionPatterns", "type": "array" }, @@ -107912,7 +110876,7 @@ "title": "PageConfiguration" }, "SecretArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the key\\-value pairs required to connect to your Confluence server\\. The secret must contain a JSON structure with the following keys: \n+ username\u2014The user name or email address of a user with administrative privileges for the Confluence server\\.\n+ password\u2014The password associated with the user logging in to the Confluence server\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the user name and password required to connect to the Confluence instance\\. If you use Confluence Cloud, you use a generated API token as the password\\. \nYou can also provide authentication credentials in the form of a personal access token\\. For more information, see [Using a Confluence data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretArn", "type": "string" }, @@ -107927,7 +110891,7 @@ "title": "SpaceConfiguration" }, "Version": { - "markdownDescription": "Specifies the version of the Confluence installation that you are connecting to\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CLOUD | SERVER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version or the type of Confluence installation to connect to\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CLOUD | SERVER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" }, @@ -107951,7 +110915,7 @@ "items": { "$ref": "#/definitions/AWS::Kendra::DataSource.ConfluencePageToIndexFieldMapping" }, - "markdownDescription": ">Maps attributes or field names of Confluence pages to Amazon Kendra index field names\\. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields\\. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. The Confluence data source field names must exist in your Confluence custom metadata\\. \nIf you specify the `PageFieldMappings` parameter, you must specify at least one field mapping\\. \n*Required*: No \n*Type*: List of [ConfluencePageToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html) \n*Maximum*: `12` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Maps attributes or field names of Confluence pages to Amazon Kendra index field names\\. To create custom fields, use the `UpdateIndex` API before you map to Confluence fields\\. For more information, see [Mapping data source fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. The Confluence data source field names must exist in your Confluence custom metadata\\. \nIf you specify the `PageFieldMappings` parameter, you must specify at least one field mapping\\. \n*Required*: No \n*Type*: List of [ConfluencePageToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepagetoindexfieldmapping.html) \n*Maximum*: `12` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PageFieldMappings", "type": "array" } @@ -107987,12 +110951,12 @@ "additionalProperties": false, "properties": { "CrawlArchivedSpaces": { - "markdownDescription": "Specifies whether Amazon Kendra should index archived spaces\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to index archived spaces\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrawlArchivedSpaces", "type": "boolean" }, "CrawlPersonalSpaces": { - "markdownDescription": "Specifies whether Amazon Kendra should index personal spaces\\. Users can add restrictions to items in personal spaces\\. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results\\. For more information, see [Filtering on user context](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to index personal spaces\\. You can add restrictions to items in personal spaces\\. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results\\. For more information, see [Filtering on user context](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrawlPersonalSpaces", "type": "boolean" }, @@ -108329,7 +111293,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of strings\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of strings\\. The default maximum length or number of strings is 10\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StringListValue", "type": "array" }, @@ -108464,7 +111428,7 @@ "additionalProperties": false, "properties": { "DisableLocalGroups": { - "markdownDescription": "A Boolean value that specifies whether local groups are disabled \\(`True`\\) or enabled \\(`False`\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to disable local groups information\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DisableLocalGroups", "type": "boolean" }, @@ -108498,7 +111462,7 @@ "title": "OneDriveUsers" }, "SecretArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive\\. The user named should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive\\. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretArn", "type": "string" }, @@ -108697,7 +111661,7 @@ "title": "KnowledgeArticleConfiguration" }, "SecretArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance\\. The secret must contain a JSON structure with the following keys: \n+ authenticationUrl \\- The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token\\. \n+ consumerKey \\- The application public key generated when you created your Salesforce application\\.\n+ consumerSecret \\- The application private key generated when you created your Salesforce application\\.\n+ password \\- The password associated with the user logging in to the Salesforce instance\\.\n+ securityToken \\- The token associated with the user account logging in to the Salesforce instance\\.\n+ username \\- The user name of the user logging in to the Salesforce instance\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance\\. The secret must contain a JSON structure with the following keys: \n+ authenticationUrl \\- The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token\\. \n+ consumerKey \\- The application public key generated when you created your Salesforce application\\.\n+ consumerSecret \\- The application private key generated when you created your Salesforce application\\.\n+ password \\- The password associated with the user logging in to the Salesforce instance\\.\n+ securityToken \\- The token associated with the user logging in to the Salesforce instance\\.\n+ username \\- The user name of the user logging in to the Salesforce instance\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretArn", "type": "string" }, @@ -108872,7 +111836,7 @@ "additionalProperties": false, "properties": { "AuthenticationType": { - "markdownDescription": "The type of authentication used to connect to the ServiceNow instance\\. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the `SecretArn` field\\. When you choose `OAUTH2`, Amazon Kendra is authenticated using the OAuth token and secret provided in the Secrets Manager secret, and the user name and password are used to determine which information Amazon Kendra has access to\\. \nWhen you use `OAUTH2` authentication, you must generate a token and a client secret using the ServiceNow console\\. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HTTP_BASIC | OAUTH2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of authentication used to connect to the ServiceNow instance\\. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated using the user name and password provided in the AWS Secrets Manager secret in the `SecretArn` field\\. If you choose `OAUTH2`, Amazon Kendra is authenticated using the credentials of client ID, client secret, user name and password\\. \nWhen you use `OAUTH2` authentication, you must generate a token and a client secret using the ServiceNow console\\. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `HTTP_BASIC | OAUTH2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthenticationType", "type": "string" }, @@ -108887,7 +111851,7 @@ "title": "KnowledgeArticleConfiguration" }, "SecretArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS Secrets Manager secret that contains the user name and password required to connect to the ServiceNow instance\\. You can also provide OAuth authentication credentials of user name, password, client ID, and client secret\\. For more information, see [Using a ServiceNow data source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretArn", "type": "string" }, @@ -108913,7 +111877,7 @@ "additionalProperties": false, "properties": { "CrawlAttachments": { - "markdownDescription": "Indicates whether Amazon Kendra should index attachments to knowledge articles\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to index attachments to knowledge articles\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrawlAttachments", "type": "boolean" }, @@ -108966,7 +111930,7 @@ "additionalProperties": false, "properties": { "CrawlAttachments": { - "markdownDescription": "Indicates whether Amazon Kendra should crawl attachments to the service catalog items\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to index attachments to service catalog items\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrawlAttachments", "type": "boolean" }, @@ -109014,12 +111978,12 @@ "additionalProperties": false, "properties": { "CrawlAttachments": { - "markdownDescription": "`TRUE` to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, `FALSE`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to index document attachments\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CrawlAttachments", "type": "boolean" }, "DisableLocalGroups": { - "markdownDescription": "A Boolean value that specifies whether local groups are disabled \\(`True`\\) or enabled \\(`False`\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "`TRUE` to disable local groups information\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DisableLocalGroups", "type": "boolean" }, @@ -109040,7 +112004,7 @@ "items": { "$ref": "#/definitions/AWS::Kendra::DataSource.DataSourceToIndexFieldMapping" }, - "markdownDescription": "A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index\\. You must first create the index fields using the [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateIndex.html) operation before you map SharePoint attributes\\. For more information, see [Mapping Data Source Fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. \n*Required*: No \n*Type*: List of [DataSourceToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of `DataSourceToIndexFieldMapping` objects that map Microsoft SharePoint attributes or fields to Amazon Kendra index fields\\. You must first create the index fields using the [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateIndex.html) operation before you map SharePoint attributes\\. For more information, see [Mapping Data Source Fields](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)\\. \n*Required*: No \n*Type*: List of [DataSourceToIndexFieldMapping](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-datasourcetoindexfieldmapping.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldMappings", "type": "array" }, @@ -109048,17 +112012,17 @@ "items": { "type": "string" }, - "markdownDescription": "A list of regular expression patterns to include certain documents in your SharePoint\\. Documents that match the patterns are included in the index\\. Documents that don't match the patterns are excluded from the index\\. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index\\. \nThe regex is applied to the display URL of the SharePoint document\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of regular expression patterns to include certain documents in your SharePoint\\. Documents that match the patterns are included in the index\\. Documents that don't match the patterns are excluded from the index\\. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index\\. \nThe regex applies to the display URL of the SharePoint document\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InclusionPatterns", "type": "array" }, "SecretArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of credentials stored in AWS Secrets Manager\\. The credentials should be a user/password pair\\. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials\\. For more information, see [Using a Microsoft SharePoint Data Source](https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html)\\. For more information about AWS Secrets Manager see [ What Is AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) in the * AWS Secrets Manager * user guide\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance\\. For more information, see [Microsoft SharePoint](https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1284` \n*Pattern*: `arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretArn", "type": "string" }, "SharePointVersion": { - "markdownDescription": "The version of Microsoft SharePoint that you are using as a data source\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SHAREPOINT_2013 | SHAREPOINT_2016 | SHAREPOINT_ONLINE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of Microsoft SharePoint that you use\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SHAREPOINT_2013 | SHAREPOINT_2016 | SHAREPOINT_2019 | SHAREPOINT_ONLINE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SharePointVersion", "type": "string" }, @@ -109071,7 +112035,7 @@ "items": { "type": "string" }, - "markdownDescription": "The URLs of the Microsoft SharePoint site that contains the documents that should be indexed\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Microsoft SharePoint site URLs for the documents you want to index\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Urls", "type": "array" }, @@ -109149,7 +112113,7 @@ "properties": { "AuthenticationConfiguration": { "$ref": "#/definitions/AWS::Kendra::DataSource.WebCrawlerAuthenticationConfiguration", - "markdownDescription": "Configuration information required to connect to websites using authentication\\. \nYou can connect to websites using basic authentication of user name and password\\. \nYou must provide the website host name and port number\\. For example, the host name of https://a\\.example\\.com/page1\\.html is \"a\\.example\\.com\" and the port is 443, the standard port for HTTPS\\. You use a secret in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) to store your authentication credentials\\. \n*Required*: No \n*Type*: [WebCrawlerAuthenticationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerauthenticationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configuration information required to connect to websites using authentication\\. \nYou can connect to websites using basic authentication of user name and password\\. You use a secret in [AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html) to store your authentication credentials\\. \nYou must provide the website host name and port number\\. For example, the host name of https://a\\.example\\.com/page1\\.html is \"a\\.example\\.com\" and the port is 443, the standard port for HTTPS\\. \n*Required*: No \n*Type*: [WebCrawlerAuthenticationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-webcrawlerauthenticationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AuthenticationConfiguration" }, "CrawlDepth": { @@ -109343,7 +112307,7 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "A description of the FAQ\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A description for the FAQ\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Description", "type": "string" }, @@ -109467,11 +112431,11 @@ "properties": { "CapacityUnits": { "$ref": "#/definitions/AWS::Kendra::Index.CapacityUnitsConfiguration", - "markdownDescription": "Specifies capacity units configured for your index\\. You can add and remove capacity units to tune an index to your requirements\\. You can set capacity units only for Enterprise edition indexes\\. \n*Required*: No \n*Type*: [CapacityUnitsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [CapacityUnitsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CapacityUnits" }, "Description": { - "markdownDescription": "A description of the index\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A description for the index\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -109484,7 +112448,7 @@ "type": "array" }, "Edition": { - "markdownDescription": "Indicates whether the index is a enterprise edition index or a developer edition index\\. Valid values are `DEVELOPER_EDITION` and `ENTERPRISE_EDITION`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DEVELOPER_EDITION | ENTERPRISE_EDITION` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Indicates whether the index is a Enterprise Edition index or a Developer Edition index\\. Valid values are `DEVELOPER_EDITION` and `ENTERPRISE_EDITION`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DEVELOPER_EDITION | ENTERPRISE_EDITION` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Edition", "type": "string" }, @@ -109512,7 +112476,7 @@ "type": "array" }, "UserContextPolicy": { - "markdownDescription": "The user context policy\\. \nATTRIBUTE\\_FILTER \n+ All indexed content is searchable and displayable for all users\\. If there is an access control list, it is ignored\\. You can filter on user and group attributes\\.\nUSER\\_TOKEN \n+ Enables SSO and token\\-based user access control\\. All documents with no access control and all documents accessible to the user will be searchable and displayable\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The user context policy\\. \nATTRIBUTE\\_FILTER \n+ All indexed content is searchable and displayable for all users\\. If you want to filter search results on user context, you can use the attribute filters of `_user_id` and `_group_ids` or you can provide user and group information in `UserContext`\\.\nUSER\\_TOKEN \n+ Enables token\\-based user access control to filter search results on user context\\. All documents with no access control and all documents accessible to the user will be searchable and displayable\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UserContextPolicy", "type": "string" }, @@ -109557,12 +112521,12 @@ "additionalProperties": false, "properties": { "QueryCapacityUnits": { - "markdownDescription": "The amount of extra query capacity for an index and [GetQuerySuggestions](https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) capacity\\. \nA single extra capacity unit for an index provides 0\\.1 queries per second or approximately 8,000 queries per day\\. \n `GetQuerySuggestions` capacity is five times the provisioned query capacity for an index, or the base capacity of 2\\.5 calls per second, whichever is higher\\. For example, the base capacity for an index is 0\\.1 queries per second, and `GetQuerySuggestions` capacity has a base of 2\\.5 calls per second\\. If you add another 0\\.1 queries per second to total 0\\.2 queries per second for an index, the `GetQuerySuggestions` capacity is 2\\.5 calls per second \\(higher than five times 0\\.2 queries per second\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of extra query capacity for an index and [GetQuerySuggestions](https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html) capacity\\. \nA single extra capacity unit for an index provides 0\\.1 queries per second or approximately 8,000 queries per day\\. You can add up to 100 extra capacity units\\. \n `GetQuerySuggestions` capacity is five times the provisioned query capacity for an index, or the base capacity of 2\\.5 calls per second, whichever is higher\\. For example, the base capacity for an index is 0\\.1 queries per second, and `GetQuerySuggestions` capacity has a base of 2\\.5 calls per second\\. If you add another 0\\.1 queries per second to total 0\\.2 queries per second for an index, the `GetQuerySuggestions` capacity is 2\\.5 calls per second \\(higher than five times 0\\.2 queries per second\\)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "QueryCapacityUnits", "type": "number" }, "StorageCapacityUnits": { - "markdownDescription": "The amount of extra storage capacity for an index\\. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of extra storage capacity for an index\\. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first\\. You can add up to 100 extra capacity units\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StorageCapacityUnits", "type": "number" } @@ -109583,7 +112547,7 @@ }, "Relevance": { "$ref": "#/definitions/AWS::Kendra::Index.Relevance", - "markdownDescription": "Provides manual tuning parameters to determine how the field affects the search results\\. \n*Required*: No \n*Type*: [Relevance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides tuning parameters to determine how the field affects the search results\\. \n*Required*: No \n*Type*: [Relevance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Relevance" }, "Search": { @@ -109694,7 +112658,7 @@ "items": { "$ref": "#/definitions/AWS::Kendra::Index.ValueImportanceItem" }, - "markdownDescription": "An array of key\\-value pairs that contains an array of values that should be given a different boost when they appear in the search result list\\. For example, if you are boosting query terms that match the department field in the result, query terms that match the department field are boosted in the result\\. You can add entries from the department field to boost documents with those values higher\\. \nFor example, you can add entries to the map with names of departments\\. If you add \"HR\", 5 and \"Legal\",3 those departments are given special attention when they appear in the metadata of a document\\. \n*Required*: No \n*Type*: List of [ValueImportanceItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-valueimportanceitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of key\\-value pairs for different boosts when they appear in the search result list\\. For example, if you want to boost query terms that match the \"department\" field in the result, query terms that match this field are boosted in the result\\. You can add entries from the department field to boost documents with those values higher\\. \nFor example, you can add entries to the map with names of departments\\. If you add \"HR\", 5 and \"Legal\",3 those departments are given special attention when they appear in the metadata of a document\\. \n*Required*: No \n*Type*: List of [ValueImportanceItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-valueimportanceitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ValueImportanceItems", "type": "array" } @@ -109720,7 +112684,7 @@ "type": "boolean" }, "Sortable": { - "markdownDescription": "Indicates that the field can be used to sort the search results\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether the field can be used to sort the results of a query\\. The default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Sortable", "type": "boolean" } @@ -109731,7 +112695,7 @@ "additionalProperties": false, "properties": { "KmsKeyId": { - "markdownDescription": "The identifier of the AWS KMScustomer master key \\(CMK\\)\\. Amazon Kendra doesn't support asymmetric CMKs\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The identifier of the AWS KMS key\\. Amazon Kendra doesn't support asymmetric keys\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" } @@ -109758,12 +112722,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The document metadata value that receives the search boost\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The document metadata value used for the search boost\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Value": { - "markdownDescription": "The boost value that a document receives when the key is part of the metadata of a document\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The boost value for a document when the key is part of the metadata of a document\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "number" } @@ -109806,18 +112770,26 @@ "additionalProperties": false, "properties": { "CapacityUnits": { - "$ref": "#/definitions/AWS::KendraRanking::ExecutionPlan.CapacityUnitsConfiguration" + "$ref": "#/definitions/AWS::KendraRanking::ExecutionPlan.CapacityUnitsConfiguration", + "markdownDescription": "You can set additional capacity units to meet the needs of your rescore execution plan\\. You are given a single capacity unit by default\\. If you want to use the default capacity, you don't set additional capacity units\\. For more information on the default capacity and additional capacity units, see [Adjusting capacity](https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html)\\. \n*Required*: No \n*Type*: [CapacityUnitsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendraranking-executionplan-capacityunitsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CapacityUnits" }, "Description": { + "markdownDescription": "A description for the rescore execution plan\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1000` \n*Pattern*: `^\\P{C}*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A name for the rescore execution plan\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000` \n*Pattern*: `[a-zA-Z0-9][a-zA-Z0-9_-]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of key\\-value pairs that identify or categorize your rescore execution plan\\. You can also use tags to help control access to the rescore execution plan\\. Tag keys and values can consist of Unicode letters, digits, white space\\. They can also consist of underscore, period, colon, equal, plus, and asperand\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -109851,6 +112823,8 @@ "additionalProperties": false, "properties": { "RescoreCapacityUnits": { + "markdownDescription": "The amount of extra capacity for your rescore execution plan\\. \nA single extra capacity unit for a rescore execution plan provides 0\\.01 rescore requests per second\\. You can add up to 1000 extra capacity units\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `0` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RescoreCapacityUnits", "type": "number" } }, @@ -110025,7 +112999,7 @@ "type": "string" }, "StreamARN": { - "markdownDescription": "The ARN of the stream with which you registered the consumer\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:aws.*:kinesis:.*:\\d{12}:stream/.+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the stream with which you registered the consumer\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:aws.*:kinesis:.*:\\d{12}:stream/\\S+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StreamARN", "type": "string" } @@ -110855,7 +113829,9 @@ "type": "string" }, "ApplicationMaintenanceConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration" + "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.ApplicationMaintenanceConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ApplicationMaintenanceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationmaintenanceconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApplicationMaintenanceConfiguration" }, "ApplicationMode": { "markdownDescription": "To create a Kinesis Data Analytics Studio notebook, you must set the mode to `INTERACTIVE`\\. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `INTERACTIVE | STREAMING` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -110868,10 +113844,12 @@ "type": "string" }, "RunConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.RunConfiguration" + "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.RunConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [RunConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-runconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RunConfiguration" }, "RuntimeEnvironment": { - "markdownDescription": "The runtime environment for the application\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FLINK-1_11 | FLINK-1_13 | FLINK-1_6 | FLINK-1_8 | SQL-1_0 | ZEPPELIN-FLINK-1_0 | ZEPPELIN-FLINK-2_0` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The runtime environment for the application\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `FLINK-1_11 | FLINK-1_13 | FLINK-1_15 | FLINK-1_6 | FLINK-1_8 | SQL-1_0 | ZEPPELIN-FLINK-1_0 | ZEPPELIN-FLINK-2_0` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RuntimeEnvironment", "type": "string" }, @@ -110968,6 +113946,8 @@ "items": { "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.VpcConfiguration" }, + "markdownDescription": "The array of descriptions of VPC configurations available to the application\\. \n*Required*: No \n*Type*: List of [VpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-vpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcConfigurations", "type": "array" }, "ZeppelinApplicationConfiguration": { @@ -110982,6 +113962,8 @@ "additionalProperties": false, "properties": { "ApplicationMaintenanceWindowStartTime": { + "markdownDescription": "Specifies the start time of the maintence window\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApplicationMaintenanceWindowStartTime", "type": "string" } }, @@ -110994,9 +113976,13 @@ "additionalProperties": false, "properties": { "ApplicationRestoreType": { + "markdownDescription": "Specifies how the application should be restored\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `RESTORE_FROM_CUSTOM_SNAPSHOT | RESTORE_FROM_LATEST_SNAPSHOT | SKIP_RESTORE_FROM_SNAPSHOT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApplicationRestoreType", "type": "string" }, "SnapshotName": { + "markdownDescription": "The identifier of an existing snapshot of application state to use to restart an application\\. The application uses this value if `RESTORE_FROM_CUSTOM_SNAPSHOT` is specified for the `ApplicationRestoreType`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[a-zA-Z0-9_.-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SnapshotName", "type": "string" } }, @@ -111177,6 +114163,8 @@ "additionalProperties": false, "properties": { "AllowNonRestoredState": { + "markdownDescription": "When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program\\. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data\\. For more information, see [ Allowing Non\\-Restored State](https://ci.apache.org/projects/flink/flink-docs-release-1.8/ops/state/savepoints.html#allowing-non-restored-state) in the [Apache Flink documentation](https://ci.apache.org/projects/flink/flink-docs-release-1.8/)\\. \nThis value defaults to `false`\\. If you update your application without specifying this parameter, `AllowNonRestoredState` will be set to `false`, even if it was previously set to `true`\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllowNonRestoredState", "type": "boolean" } }, @@ -111444,7 +114432,7 @@ }, "PropertyMap": { "additionalProperties": true, - "markdownDescription": "Describes the value of an application execution property key\\-value pair\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Describes the value of an application execution property key\\-value pair\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -111504,10 +114492,14 @@ "additionalProperties": false, "properties": { "ApplicationRestoreConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.ApplicationRestoreConfiguration" + "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.ApplicationRestoreConfiguration", + "markdownDescription": "Describes the restore behavior of a restarting application\\. \n*Required*: No \n*Type*: [ApplicationRestoreConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-applicationrestoreconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApplicationRestoreConfiguration" }, "FlinkRunConfiguration": { - "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.FlinkRunConfiguration" + "$ref": "#/definitions/AWS::KinesisAnalyticsV2::Application.FlinkRunConfiguration", + "markdownDescription": "Describes the starting parameters for a Flink\\-based Kinesis Data Analytics application\\. \n*Required*: No \n*Type*: [FlinkRunConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-application-flinkrunconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FlinkRunConfiguration" } }, "type": "object" @@ -111516,7 +114508,7 @@ "additionalProperties": false, "properties": { "BasePath": { - "markdownDescription": "The base path for the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `[a-zA-Z0-9/!-_.*'()]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The base path for the S3 bucket\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `[a-zA-Z0-9/!-_.*'()]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BasePath", "type": "string" }, @@ -111535,12 +114527,12 @@ "additionalProperties": false, "properties": { "BucketARN": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the S3 bucket containing the application code\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the S3 bucket containing the application code\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `arn:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BucketARN", "type": "string" }, "FileKey": { - "markdownDescription": "The file key for the object containing the application code\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The file key for the object containing the application code\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FileKey", "type": "string" }, @@ -111577,12 +114569,16 @@ "items": { "type": "string" }, + "markdownDescription": "The array of [SecurityGroup](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html) IDs used by the VPC configuration\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroupIds", "type": "array" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "The array of [Subnet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html) IDs used by the VPC configuration\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `16` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetIds", "type": "array" } }, @@ -112154,7 +115150,9 @@ "additionalProperties": false, "properties": { "AmazonOpenSearchServerlessDestinationConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AmazonOpenSearchServerlessDestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AmazonOpenSearchServerlessDestinationConfiguration" }, "AmazonopensearchserviceDestinationConfiguration": { "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonopensearchserviceDestinationConfiguration", @@ -112246,9 +115244,13 @@ "additionalProperties": false, "properties": { "IntervalInSeconds": { + "markdownDescription": "Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination\\. The default value is 300 \\(5 minutes\\)\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `60` \n*Maximum*: `900` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntervalInSeconds", "type": "number" }, "SizeInMBs": { + "markdownDescription": "Buffer incoming data to the specified size, in MBs, before delivering it to the destination\\. The default value is 5\\. \nWe recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds\\. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SizeInMBs", "type": "number" } }, @@ -112258,34 +115260,54 @@ "additionalProperties": false, "properties": { "BufferingHints": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessBufferingHints" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessBufferingHints", + "markdownDescription": "The buffering options\\. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used\\. \n*Required*: No \n*Type*: [AmazonOpenSearchServerlessBufferingHints](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BufferingHints" }, "CloudWatchLoggingOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.CloudWatchLoggingOptions", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [CloudWatchLoggingOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-cloudwatchloggingoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CloudWatchLoggingOptions" }, "CollectionEndpoint": { + "markdownDescription": "The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `https:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CollectionEndpoint", "type": "string" }, "IndexName": { + "markdownDescription": "The Serverless offering for Amazon OpenSearch Service index name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `80` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IndexName", "type": "string" }, "ProcessingConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.ProcessingConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ProcessingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ProcessingConfiguration" }, "RetryOptions": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessRetryOptions" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessRetryOptions", + "markdownDescription": "The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service\\. The default value is 300 \\(5 minutes\\)\\. \n*Required*: No \n*Type*: [AmazonOpenSearchServerlessRetryOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetryOptions" }, "RoleARN": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `arn:.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleARN", "type": "string" }, "S3BackupMode": { + "markdownDescription": "Defines how documents should be delivered to Amazon S3\\. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService\\-failed/ appended to the key prefix\\. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService\\-failed/ appended to the prefix\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AllDocuments | FailedDocumentsOnly` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3BackupMode", "type": "string" }, "S3Configuration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.S3DestinationConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [S3DestinationConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3Configuration" }, "VpcConfiguration": { - "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.VpcConfiguration" + "$ref": "#/definitions/AWS::KinesisFirehose::DeliveryStream.VpcConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-vpcconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VpcConfiguration" } }, "required": [ @@ -112299,6 +115321,8 @@ "additionalProperties": false, "properties": { "DurationInSeconds": { + "markdownDescription": "After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery \\(including the first attempt\\)\\. After this time has elapsed, the failed documents are written to Amazon S3\\. Default value is 300 seconds \\(5 minutes\\)\\. A value of 0 \\(zero\\) results in no retries\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `7200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DurationInSeconds", "type": "number" } }, @@ -113094,7 +116118,7 @@ "additionalProperties": false, "properties": { "ParameterName": { - "markdownDescription": "The name of the parameter\\. Currently the following default values are supported: 3 for `NumberOfRetries`, 60 for the `BufferIntervalInSeconds`, and 3 for the `BufferSizeInMBs`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BufferIntervalInSeconds | BufferSizeInMBs | Delimiter | JsonParsingEngine | LambdaArn | MetadataExtractionQuery | NumberOfRetries | RoleArn | SubRecordType` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the parameter\\. Currently the following default values are supported: 3 for `NumberOfRetries` and 60 for the `BufferIntervalInSeconds`\\. The `BufferSizeInMBs` ranges between 0\\.2 MB and up to 3MB\\. The default buffering hint is 1MB for all destinations, except Splunk\\. For Splunk, the default buffering hint is 256 KB\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BufferIntervalInSeconds | BufferSizeInMBs | Delimiter | JsonParsingEngine | LambdaArn | MetadataExtractionQuery | NumberOfRetries | RoleArn | SubRecordType` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ParameterName", "type": "string" }, @@ -113614,24 +116638,38 @@ "items": { "type": "string" }, + "markdownDescription": "An array of UTF\\-8 strings\\. A list of column names\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ColumnNames", "type": "array" }, "ColumnWildcard": { - "$ref": "#/definitions/AWS::LakeFormation::DataCellsFilter.ColumnWildcard" + "$ref": "#/definitions/AWS::LakeFormation::DataCellsFilter.ColumnWildcard", + "markdownDescription": "A wildcard with exclusions\\. You must specify either a `ColumnNames` list or the `ColumnWildCard`\\. \n*Required*: No \n*Type*: [ColumnWildcard](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-columnwildcard.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ColumnWildcard" }, "DatabaseName": { + "markdownDescription": "UTF\\-8 string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nA database in the Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatabaseName", "type": "string" }, "Name": { + "markdownDescription": "UTF\\-8 string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nThe name given by the user to the data filter cell\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "RowFilter": { - "$ref": "#/definitions/AWS::LakeFormation::DataCellsFilter.RowFilter" + "$ref": "#/definitions/AWS::LakeFormation::DataCellsFilter.RowFilter", + "markdownDescription": "A PartiQL predicate\\. \n*Required*: No \n*Type*: [RowFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-datacellsfilter-rowfilter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RowFilter" }, "TableCatalogId": { + "markdownDescription": "Catalog id string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nThe ID of the catalog to which the table belongs\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableCatalogId", "type": "string" }, "TableName": { + "markdownDescription": "UTF\\-8 string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nA table in the database\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableName", "type": "string" } }, @@ -113671,6 +116709,8 @@ "items": { "type": "string" }, + "markdownDescription": "Excludes column names\\. Any column with this name will be excluded\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExcludedColumnNames", "type": "array" } }, @@ -113680,9 +116720,13 @@ "additionalProperties": false, "properties": { "AllRowsWildcard": { + "markdownDescription": "A wildcard for all rows\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AllRowsWildcard", "type": "object" }, "FilterExpression": { + "markdownDescription": "A filter expression\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FilterExpression", "type": "string" } }, @@ -113732,6 +116776,8 @@ "items": { "type": "string" }, + "markdownDescription": "An array of UTF\\-8 strings\\. \nA list of the resource\\-owning account IDs that the caller's account can use to share their user access details \\(user ARNs\\)\\. The user ARNs can be logged in the resource owner's CloudTrail log\\. You may want to specify this property when you are in a high\\-trust boundary, such as the same team or company\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrustedResourceOwners", "type": "array" } }, @@ -113825,7 +116871,7 @@ "items": { "type": "string" }, - "markdownDescription": "Indicates whether to grant the ability to grant permissions \\(as a subset of permissions granted\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates the ability to grant permissions \\(as a subset of permissions granted\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PermissionsWithGrantOption", "type": "array" }, @@ -113891,12 +116937,12 @@ "additionalProperties": false, "properties": { "CatalogId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CatalogId", "type": "string" }, "S3Resource": { - "markdownDescription": "Currently not supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) that uniquely identifies the data location resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3Resource", "type": "string" } @@ -113907,7 +116953,7 @@ "additionalProperties": false, "properties": { "CatalogId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CatalogId", "type": "string" }, @@ -113939,7 +116985,7 @@ }, "TableWithColumnsResource": { "$ref": "#/definitions/AWS::LakeFormation::Permissions.TableWithColumnsResource", - "markdownDescription": "Currently not supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [TableWithColumnsResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A structure for a table with columns object\\. This object is only used when granting a SELECT permission\\. \n*Required*: No \n*Type*: [TableWithColumnsResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-permissions-tablewithcolumnsresource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TableWithColumnsResource" } }, @@ -113949,7 +116995,7 @@ "additionalProperties": false, "properties": { "CatalogId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CatalogId", "type": "string" }, @@ -113980,7 +117026,7 @@ "additionalProperties": false, "properties": { "CatalogId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CatalogId", "type": "string" }, @@ -114046,25 +117092,35 @@ "additionalProperties": false, "properties": { "Catalog": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, the account ID\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Catalog", "type": "string" }, "Permissions": { "items": { "type": "string" }, + "markdownDescription": "The permissions granted or revoked\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Permissions", "type": "array" }, "PermissionsWithGrantOption": { "items": { "type": "string" }, + "markdownDescription": "Indicates the ability to grant permissions \\(as a subset of permissions granted\\)\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PermissionsWithGrantOption", "type": "array" }, "Principal": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DataLakePrincipal" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DataLakePrincipal", + "markdownDescription": "The principal to be granted a permission\\. \n*Required*: Yes \n*Type*: [DataLakePrincipal](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalakeprincipal.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Principal" }, "Resource": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.Resource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.Resource", + "markdownDescription": "The resource to be granted or revoked permissions\\. \n*Required*: Yes \n*Type*: [Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-resource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Resource" } }, "required": [ @@ -114103,6 +117159,8 @@ "items": { "type": "string" }, + "markdownDescription": "Excludes column names\\. Any column with this name will be excluded\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExcludedColumnNames", "type": "array" } }, @@ -114112,15 +117170,23 @@ "additionalProperties": false, "properties": { "DatabaseName": { + "markdownDescription": "A database in the Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatabaseName", "type": "string" }, "Name": { + "markdownDescription": "The name given by the user to the data filter cell\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "TableCatalogId": { + "markdownDescription": "The ID of the catalog to which the table belongs\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableCatalogId", "type": "string" }, "TableName": { + "markdownDescription": "The name of the table\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableName", "type": "string" } }, @@ -114136,6 +117202,8 @@ "additionalProperties": false, "properties": { "DataLakePrincipalIdentifier": { + "markdownDescription": "An identifier for the AWS Lake Formation principal\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataLakePrincipalIdentifier", "type": "string" } }, @@ -114145,9 +117213,13 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog where the location is registered with AWS Lake Formation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "ResourceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) that uniquely identifies the data location resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceArn", "type": "string" } }, @@ -114161,9 +117233,13 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "Name": { + "markdownDescription": "The name of the database resource\\. Unique to the Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -114177,12 +117253,16 @@ "additionalProperties": false, "properties": { "TagKey": { + "markdownDescription": "The key\\-name for the LF\\-tag\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagKey", "type": "string" }, "TagValues": { "items": { "type": "string" }, + "markdownDescription": "A list of possible values of the corresponding `TagKey` of an LF\\-tag key\\-value pair\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagValues", "type": "array" } }, @@ -114192,15 +117272,21 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog where the location is registered with Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "TagKey": { + "markdownDescription": "The key\\-name for the LF\\-tag\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagKey", "type": "string" }, "TagValues": { "items": { "type": "string" }, + "markdownDescription": "A list of possible values for the corresponding `TagKey` of an LF\\-tag key\\-value pair\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagValues", "type": "array" } }, @@ -114215,15 +117301,21 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "Expression": { "items": { "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.LFTag" }, + "markdownDescription": "A list of LF\\-tag conditions that apply to the resource's LF\\-tag policy\\. \n*Required*: Yes \n*Type*: List of [LFTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftag.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Expression", "type": "array" }, "ResourceType": { + "markdownDescription": "The resource type for which the LF\\-tag policy applies\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceType", "type": "string" } }, @@ -114238,28 +117330,44 @@ "additionalProperties": false, "properties": { "Catalog": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, the account ID\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Catalog", "type": "object" }, "DataCellsFilter": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DataCellsFilterResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DataCellsFilterResource", + "markdownDescription": "A data cell filter\\. \n*Required*: No \n*Type*: [DataCellsFilterResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datacellsfilterresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataCellsFilter" }, "DataLocation": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DataLocationResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DataLocationResource", + "markdownDescription": "The location of an Amazon S3 path where permissions are granted or revoked\\. \n*Required*: No \n*Type*: [DataLocationResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-datalocationresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataLocation" }, "Database": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DatabaseResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.DatabaseResource", + "markdownDescription": "The database for the resource\\. Unique to the Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database permissions to a principal\\. \n*Required*: No \n*Type*: [DatabaseResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-databaseresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Database" }, "LFTag": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.LFTagKeyResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.LFTagKeyResource", + "markdownDescription": "The LF\\-tag key and values attached to a resource\\. \n*Required*: No \n*Type*: [LFTagKeyResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagkeyresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LFTag" }, "LFTagPolicy": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.LFTagPolicyResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.LFTagPolicyResource", + "markdownDescription": "A list of LF\\-tag conditions that define a resource's LF\\-tag policy\\. \n*Required*: No \n*Type*: [LFTagPolicyResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-lftagpolicyresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LFTagPolicy" }, "Table": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.TableResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.TableResource", + "markdownDescription": "The table for the resource\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: No \n*Type*: [TableResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tableresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Table" }, "TableWithColumns": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.TableWithColumnsResource" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.TableWithColumnsResource", + "markdownDescription": "The table with columns for the resource\\. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3\\. \n*Required*: No \n*Type*: [TableWithColumnsResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-tablewithcolumnsresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableWithColumns" } }, "type": "object" @@ -114268,15 +117376,23 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "DatabaseName": { + "markdownDescription": "The name of the database for the table\\. Unique to a Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatabaseName", "type": "string" }, "Name": { + "markdownDescription": "The name of the table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "TableWildcard": { + "markdownDescription": "A wildcard object representing every table under a database\\. \nAt least one of `TableResource$Name` or `TableResource$TableWildcard` is required\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableWildcard", "type": "object" } }, @@ -114290,21 +117406,31 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog where the location is registered with AWS Lake Formation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "ColumnNames": { "items": { "type": "string" }, + "markdownDescription": "The list of column names for the table\\. At least one of `ColumnNames` or `ColumnWildcard` is required\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ColumnNames", "type": "array" }, "ColumnWildcard": { - "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.ColumnWildcard" + "$ref": "#/definitions/AWS::LakeFormation::PrincipalPermissions.ColumnWildcard", + "markdownDescription": "A wildcard specified by a `ColumnWildcard` object\\. At least one of `ColumnNames` or `ColumnWildcard` is required\\. \n*Required*: No \n*Type*: [ColumnWildcard](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-principalpermissions-columnwildcard.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ColumnWildcard" }, "DatabaseName": { + "markdownDescription": "The name of the database for the table with columns resource\\. Unique to the Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatabaseName", "type": "string" }, "Name": { + "markdownDescription": "The name of the table resource\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -114429,15 +117555,21 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "Catalog id string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nThe identifier for the Data Catalog\\. By default, the account ID\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "TagKey": { + "markdownDescription": "UTF\\-8 string, not less than 1 or more than 255 bytes long, matching the [single\\-line string pattern](lake-formation/latest/dg/aws-lake-formation-api-aws-lake-formation-api-common.html#aws-glue-api-regex-oneLine)\\. \nThe key\\-name for the LF\\-tag\\. \nFor more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagKey", "type": "string" }, "TagValues": { "items": { "type": "string" }, + "markdownDescription": "An array of UTF\\-8 strings, not less than 1 or more than 50 strings\\. \n A list of possible values of the corresponding `TagKey` of an LF\\-tag key\\-value pair\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TagValues", "type": "array" } }, @@ -114507,10 +117639,14 @@ "items": { "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.LFTagPair" }, + "markdownDescription": "A structure containing an LF\\-tag key\\-value pair\\. \n*Required*: Yes \n*Type*: List of [LFTagPair](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LFTags", "type": "array" }, "Resource": { - "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.Resource" + "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.Resource", + "markdownDescription": "UTF\\-8 string \\(valid values: `DATABASE | TABLE`\\)\\. \nThe resource for which the LF\\-tag policy applies\\. \n*Required*: Yes \n*Type*: [Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-resource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Resource" } }, "required": [ @@ -114544,9 +117680,13 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, it should be the account ID of the caller\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "Name": { + "markdownDescription": "The name of the database resource\\. Unique to the Data Catalog\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -114560,15 +117700,21 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "TagKey": { + "markdownDescription": "The key\\-name for the LF\\-tag\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagKey", "type": "string" }, "TagValues": { "items": { "type": "string" }, + "markdownDescription": "A list of possible values of the corresponding `TagKey` of an LF\\-tag key\\-value pair\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TagValues", "type": "array" } }, @@ -114583,16 +117729,24 @@ "additionalProperties": false, "properties": { "Catalog": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, the account ID\\. The Data Catalog is the persistent metadata store\\. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Catalog", "type": "object" }, "Database": { - "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.DatabaseResource" + "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.DatabaseResource", + "markdownDescription": "The database for the resource\\. Unique to the Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database permissions to a principal\\. \n*Required*: No \n*Type*: [DatabaseResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-databaseresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Database" }, "Table": { - "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.TableResource" + "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.TableResource", + "markdownDescription": "The table for the resource\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: No \n*Type*: [TableResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tableresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Table" }, "TableWithColumns": { - "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.TableWithColumnsResource" + "$ref": "#/definitions/AWS::LakeFormation::TagAssociation.TableWithColumnsResource", + "markdownDescription": "The table with columns for the resource\\. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3\\. \n*Required*: No \n*Type*: [TableWithColumnsResource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-tablewithcolumnsresource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableWithColumns" } }, "type": "object" @@ -114601,15 +117755,23 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "The identifier for the Data Catalog\\. By default, it is the account ID of the caller\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "DatabaseName": { + "markdownDescription": "The name of the database for the table\\. Unique to a Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatabaseName", "type": "string" }, "Name": { + "markdownDescription": "The name of the table\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "TableWildcard": { + "markdownDescription": "A wildcard object representing every table under a database\\.This is an object with no properties that effectively behaves as a true or false depending on whether not it is passed as a parameter\\. The valid inputs for a property with this type in either yaml or json is null or \\{\\}\\. \nAt least one of `TableResource$Name` or `TableResource$TableWildcard` is required\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableWildcard", "type": "object" } }, @@ -114623,18 +117785,26 @@ "additionalProperties": false, "properties": { "CatalogId": { + "markdownDescription": "A wildcard object representing every table under a database\\. \nAt least one of TableResource$Name or TableResource$TableWildcard is required\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CatalogId", "type": "string" }, "ColumnNames": { "items": { "type": "string" }, + "markdownDescription": "The list of column names for the table\\. At least one of `ColumnNames` or `ColumnWildcard` is required\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ColumnNames", "type": "array" }, "DatabaseName": { + "markdownDescription": "The name of the database for the table with columns resource\\. Unique to the Data Catalog\\. A database is a set of associated table definitions organized into a logical group\\. You can Grant and Revoke database privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatabaseName", "type": "string" }, "Name": { + "markdownDescription": "The name of the table resource\\. A table is a metadata definition that represents your data\\. You can Grant and Revoke table privileges to a principal\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -115631,7 +118801,7 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies parameters that you want to pass in with ENTRYPOINT\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies parameters that you want to pass in with ENTRYPOINT\\. You can specify a maximum of 1,500 parameters in the list\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Command", "type": "array" }, @@ -115639,12 +118809,12 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies the entry point to their application, which is typically the location of the runtime executable\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the entry point to their application, which is typically the location of the runtime executable\\. You can specify a maximum of 1,500 string entries in the list\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `1500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EntryPoint", "type": "array" }, "WorkingDirectory": { - "markdownDescription": "Specifies the working directory\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the working directory\\. The length of the directory string cannot exceed 1,000 characters\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WorkingDirectory", "type": "string" } @@ -116339,7 +119509,7 @@ }, "DataPrivacy": { "$ref": "#/definitions/AWS::Lex::Bot.DataPrivacy", - "markdownDescription": "Provides information on additional privacy protections Amazon Lex should use with the bot's data\\. \n*Required*: Yes \n*Type*: [DataPrivacy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dataprivacy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [DataPrivacy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dataprivacy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataPrivacy" }, "Description": { @@ -116353,7 +119523,7 @@ "type": "number" }, "Name": { - "markdownDescription": "The name of the field to filter the list of bots\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `BotLocaleName` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the bot locale\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -116409,7 +119579,7 @@ "additionalProperties": false, "properties": { "AudioRecognitionStrategy": { - "markdownDescription": "Specifies that Amazon Lex should use slot values as a custom vocabulary when recognizing user utterances\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Enables using the slot values as a custom vocabulary for recognizing user utterances\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AudioRecognitionStrategy", "type": "string" } @@ -116420,12 +119590,12 @@ "additionalProperties": false, "properties": { "AllowAudioInput": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether audio input is allowed\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowAudioInput", "type": "boolean" }, "AllowDTMFInput": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether DTMF input is allowed\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowDTMFInput", "type": "boolean" } @@ -116441,16 +119611,16 @@ "properties": { "AudioSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.AudioSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AudioSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiospecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the settings on audio input\\. \n*Required*: No \n*Type*: [AudioSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiospecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AudioSpecification" }, "DTMFSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.DTMFSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DTMFSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dtmfspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the settings on DTMF input\\. \n*Required*: No \n*Type*: [DTMFSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dtmfspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DTMFSpecification" }, "StartTimeoutMs": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Time for which a bot waits before assuming that the customer isn't going to speak or press a key\\. This timeout is shared between Audio and DTMF inputs\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartTimeoutMs", "type": "number" } @@ -116483,7 +119653,7 @@ "title": "Destination" }, "Enabled": { - "markdownDescription": "Specifies whether audio logging is enabled for the bot\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether audio logging in enabled for the bot\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -116498,12 +119668,12 @@ "additionalProperties": false, "properties": { "EndTimeoutMs": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Time for which a bot waits after the customer stops speaking to assume the utterance is finished\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EndTimeoutMs", "type": "number" }, "MaxLengthMs": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxLengthMs", "type": "number" } @@ -116519,11 +119689,11 @@ "properties": { "CodeHookSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.CodeHookSpecification", - "markdownDescription": "Specifies the Lambda function to use in this locale\\. \n*Required*: No \n*Type*: [CodeHookSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-codehookspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the Lambda function that should be used in the locale\\. \n*Required*: No \n*Type*: [CodeHookSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-codehookspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CodeHookSpecification" }, "Enabled": { - "markdownDescription": "Specifies whether the locale is enabled for the bot\\. If the value is false, the locale isn't available for use\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether the locale is enabled for the bot\\. If the value is `false`, the locale isn't available for use\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -116580,7 +119750,7 @@ "type": "string" }, "NluConfidenceThreshold": { - "markdownDescription": "Determines the threshold where Amazon Lex will insert the AMAZON\\.FallbackIntent, AMAZON\\.KendraSearchIntent, or both when returning alternative intents\\. You must configure an AMAZON\\.FallbackIntent\\. AMAZON\\.KendraSearchIntent is only inserted if it is configured for the bot\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the threshold where Amazon Lex will insert the `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents\\. You must configure an `AMAZON.FallbackIntent`\\. `AMAZON.KendraSearchIntent` is only inserted if it is configured for the bot\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NluConfidenceThreshold", "type": "number" }, @@ -116594,7 +119764,7 @@ }, "VoiceSettings": { "$ref": "#/definitions/AWS::Lex::Bot.VoiceSettings", - "markdownDescription": "Identifies the Amazon Polly voice used for audio interaction with the user\\. \n*Required*: No \n*Type*: [VoiceSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-voicesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Defines settings for using an Amazon Polly voice to communicate with a user\\. \n*Required*: No \n*Type*: [VoiceSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-voicesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VoiceSettings" } }, @@ -116608,7 +119778,7 @@ "additionalProperties": false, "properties": { "Text": { - "markdownDescription": "The text that appears on the button\\. Use this to tell the user the value that is returned when they choose this button\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The text that appears on the button\\. Use this to tell the user what value is returned when they choose this button\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Text", "type": "string" }, @@ -116628,12 +119798,12 @@ "additionalProperties": false, "properties": { "CloudWatchLogGroupArn": { - "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of the log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatchLogGroupArn", "type": "string" }, "LogPrefix": { - "markdownDescription": "Specifies the prefix of the log stream name within the log group that you specified\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The prefix of the log stream name within the log group that you specified \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogPrefix", "type": "string" } @@ -116662,7 +119832,7 @@ "additionalProperties": false, "properties": { "ExpressionString": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The expression string that is evaluated\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExpressionString", "type": "string" } @@ -116677,22 +119847,22 @@ "properties": { "Condition": { "$ref": "#/definitions/AWS::Lex::Bot.Condition", - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [Condition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-condition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains the expression to evaluate\\. If the condition is true, the branch's actions are taken\\. \n*Required*: Yes \n*Type*: [Condition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-condition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Condition" }, "Name": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the branch\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "NextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The next step in the conversation\\. \n*Required*: Yes \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NextStep" }, "Response": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Response" } }, @@ -116710,17 +119880,17 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalBranch" }, - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: List of [ConditionalBranch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalbranch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches\\. A conditional branch is made up of a condition, a response and a next step\\. The response and next step are executed when the condition is true\\. \n*Required*: Yes \n*Type*: List of [ConditionalBranch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalbranch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConditionalBranches", "type": "array" }, "DefaultBranch": { "$ref": "#/definitions/AWS::Lex::Bot.DefaultConditionalBranch", - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [DefaultConditionalBranch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-defaultconditionalbranch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The conditional branch that should be followed when the conditions for other branches are not satisfied\\. A conditional branch is made up of a condition, a response and a next step\\. \n*Required*: Yes \n*Type*: [DefaultConditionalBranch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-defaultconditionalbranch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DefaultBranch" }, "IsActive": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether a conditional branch is active\\. When `IsActive` is false, the conditions are not evaluated\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsActive", "type": "boolean" } @@ -116739,7 +119909,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.AudioLogSetting" }, - "markdownDescription": "Specifies the Amazon S3 settings for logging audio to an S3 bucket\\. \n*Required*: No \n*Type*: List of [AudioLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiologsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon S3 settings for logging audio to an S3 bucket\\. \n*Required*: No \n*Type*: List of [AudioLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiologsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AudioLogSettings", "type": "array" }, @@ -116747,7 +119917,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.TextLogSetting" }, - "markdownDescription": "Specifies settings to enable text conversation logs\\. You specify the Amazon CloudWatch Logs log group and whether logs should be stored for an alias\\. \n*Required*: No \n*Type*: List of [TextLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textlogsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon CloudWatch Logs settings for logging text and metadata\\. \n*Required*: No \n*Type*: List of [TextLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textlogsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextLogSettings", "type": "array" } @@ -116808,22 +119978,22 @@ "additionalProperties": false, "properties": { "DeletionCharacter": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The DTMF character that clears the accumulated DTMF digits and immediately ends the input\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeletionCharacter", "type": "string" }, "EndCharacter": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The DTMF character that immediately ends input\\. If the user does not press this character, the input ends after the end timeout\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EndCharacter", "type": "string" }, "EndTimeoutMs": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "How long the bot should wait after the last DTMF character input before assuming that the input has concluded\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EndTimeoutMs", "type": "number" }, "MaxLength": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum number of DTMF digits allowed in an utterance\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxLength", "type": "number" } @@ -116840,7 +120010,7 @@ "additionalProperties": false, "properties": { "ChildDirected": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act \\(COPPA\\) by specifying `true` or `false` in the `childDirected` field\\. By specifying `true` in the `childDirected` field, you confirm that your use of Amazon Lex **is** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA\\. By specifying `false` in the `childDirected` field, you confirm that your use of Amazon Lex **is not** related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA\\. You may not specify a default value for the `childDirected` field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA\\. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA\\. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the [Amazon Lex FAQ](http://aws.amazon.com/lex/faqs#data-security)\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ChildDirected", "type": "boolean" } @@ -116855,12 +120025,12 @@ "properties": { "NextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The next step in the conversation\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NextStep" }, "Response": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Response" } }, @@ -116870,17 +120040,17 @@ "additionalProperties": false, "properties": { "SlotToElicit": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If the dialog action is `ElicitSlot`, defines the slot to elicit from the user\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SlotToElicit", "type": "string" }, "SuppressNextMessage": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When true the next message for the intent is not used\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuppressNextMessage", "type": "boolean" }, "Type": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action that the bot should execute\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Type", "type": "string" } @@ -116894,23 +120064,23 @@ "additionalProperties": false, "properties": { "EnableCodeHookInvocation": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether a Lambda function should be invoked for the dialog\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableCodeHookInvocation", "type": "boolean" }, "InvocationLabel": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A label that indicates the dialog step from which the dialog code hook is happening\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InvocationLabel", "type": "string" }, "IsActive": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether a dialog code hook is used when the intent is activated\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsActive", "type": "boolean" }, "PostCodeHookSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.PostDialogCodeHookInvocationSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [PostDialogCodeHookInvocationSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains the responses and actions that Amazon Lex takes after the Lambda function is complete\\. \n*Required*: Yes \n*Type*: [PostDialogCodeHookInvocationSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PostCodeHookSpecification" } }, @@ -116925,7 +120095,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "Indicates whether an intent uses the dialog code hook during a conversation with a user\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Enables the dialog code hook so that it processes user requests\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -116940,19 +120110,19 @@ "properties": { "DialogAction": { "$ref": "#/definitions/AWS::Lex::Bot.DialogAction", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Defines the action that the bot executes at runtime when the conversation reaches this step\\. \n*Required*: No \n*Type*: [DialogAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DialogAction" }, "Intent": { "$ref": "#/definitions/AWS::Lex::Bot.IntentOverride", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [IntentOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Override settings to configure the intent state\\. \n*Required*: No \n*Type*: [IntentOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Intent" }, "SessionAttributes": { "items": { "$ref": "#/definitions/AWS::Lex::Bot.SessionAttribute" }, - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [SessionAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sessionattribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Map of key/value pairs representing session\\-specific context information\\. It contains application information passed between Amazon Lex and a client application\\. \n*Required*: No \n*Type*: List of [SessionAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sessionattribute.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SessionAttributes", "type": "array" } @@ -116963,12 +120133,12 @@ "additionalProperties": false, "properties": { "EnableCodeHookInvocation": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether a Lambda function should be invoked for the dialog\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableCodeHookInvocation", "type": "boolean" }, "InvocationLabel": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A label that indicates the dialog step from which the dialog code hook is happening\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InvocationLabel", "type": "string" } @@ -116993,7 +120163,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "Indicates whether a Lambda function should be invoked for fulfill a specific intent\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether a Lambda function should be invoked to fulfill a specific intent\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, @@ -117003,7 +120173,7 @@ "title": "FulfillmentUpdatesSpecification" }, "IsActive": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether the fulfillment code hook is used\\. When `active` is false, the code hook doesn't run\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsActive", "type": "boolean" }, @@ -117035,7 +120205,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.MessageGroup" }, - "markdownDescription": "One to 5 message groups that contain start messages\\. Amazon Lex chooses one of the messages to play to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "1 \\- 5 message groups that contain start messages\\. Amazon Lex chooses one of the messages to play to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageGroups", "type": "array" } @@ -117055,7 +120225,7 @@ "type": "boolean" }, "FrequencyInSeconds": { - "markdownDescription": "The frequency that a message is sent to the user\\. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user\\. If the fulfillment Lambda function returns before the first period ends, an update message is not played to the user\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The frequency that a message is sent to the user\\. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user\\. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FrequencyInSeconds", "type": "number" }, @@ -117063,7 +120233,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.MessageGroup" }, - "markdownDescription": "One to 5 message groups that contain update messages\\. Amazon Lex chooses one of the messages to play to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "1 \\- 5 message groups that contain update messages\\. Amazon Lex chooses one of the messages to play to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageGroups", "type": "array" } @@ -117078,7 +120248,7 @@ "additionalProperties": false, "properties": { "Active": { - "markdownDescription": "Determines whether fulfillment updates are sent to the user\\. When this field is true, updates are sent\\. \nIf the active field is set to true, the `startResponse`, `updateResponse`, and `timeoutInSeconds` fields are required\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether fulfillment updates are sent to the user\\. When this field is true, updates are sent\\. \nIf the `active` field is set to true, the `startResponse`, `updateResponse`, and `timeoutInSeconds` fields are required\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Active", "type": "boolean" }, @@ -117118,17 +120288,17 @@ "additionalProperties": false, "properties": { "KmsKeyArn": { - "markdownDescription": "The AWS Key Management Service key required to decrypt the contents of the grammar, if any\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS KMS key required to decrypt the contents of the grammar, if any\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KmsKeyArn", "type": "string" }, "S3BucketName": { - "markdownDescription": "The name of the S3 bucket that contains the grammar source\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the Amazon S3 bucket that contains the grammar source\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3BucketName", "type": "string" }, "S3ObjectKey": { - "markdownDescription": "The path to the grammar in the S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The path to the grammar in the Amazon S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3ObjectKey", "type": "string" } @@ -117146,7 +120316,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.Button" }, - "markdownDescription": "A list of buttons that should be displayed on the response card\\. The arrangement of the buttons is determined by the platform that displays the buttons\\. \n*Required*: No \n*Type*: List of [Button](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-button.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of buttons that should be displayed on the response card\\. The arrangement of the buttons is determined by the platform that displays the button\\. \n*Required*: No \n*Type*: List of [Button](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-button.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Buttons", "type": "array" }, @@ -117176,22 +120346,22 @@ "properties": { "CodeHook": { "$ref": "#/definitions/AWS::Lex::Bot.DialogCodeHookInvocationSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CodeHook" }, "Conditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides a list of conditional branches\\. Branches are evaluated in the order that they are entered in the list\\. The first branch with a condition that evaluates to true is executed\\. The last branch in the list is the default branch\\. The default branch should not have any condition expression\\. The default branch is executed if no other branch has a matching condition\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Conditional" }, "InitialResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InitialResponse" }, "NextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The next step in the conversation\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NextStep" } }, @@ -117231,7 +120401,7 @@ }, "InitialResponseSetting": { "$ref": "#/definitions/AWS::Lex::Bot.InitialResponseSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [InitialResponseSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-initialresponsesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots\\. \n*Required*: No \n*Type*: [InitialResponseSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-initialresponsesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InitialResponseSetting" }, "InputContexts": { @@ -117254,7 +120424,7 @@ }, "KendraConfiguration": { "$ref": "#/definitions/AWS::Lex::Bot.KendraConfiguration", - "markdownDescription": "Configuration information required to use the AMAZON\\.KendraSearchIntent intent to connect to an Amazon Kendra index\\. The AMAZON\\.KendraSearchIntent intent is called when Amazon Lex can't determine another intent to invoke\\. \n*Required*: No \n*Type*: [KendraConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides configuration information for the `AMAZON.KendraSearchIntent` intent\\. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance\\. \n*Required*: No \n*Type*: [KendraConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KendraConfiguration" }, "Name": { @@ -117315,17 +120485,17 @@ }, "Conditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches associated with the intent's closing response\\. These branches are executed when the `nextStep` attribute is set to `EvalutateConditional`\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Conditional" }, "IsActive": { - "markdownDescription": "Specifies whether an intent's closing response is used\\. When this field is false, the closing response isn't sent to the user and no closing input from the user is used\\. If the IsActive field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether an intent's closing response is used\\. When this field is false, the closing response isn't sent to the user\\. If the `IsActive` field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsActive", "type": "boolean" }, "NextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot executes after playing the intent's closing response\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NextStep" } }, @@ -117336,67 +120506,67 @@ "properties": { "CodeHook": { "$ref": "#/definitions/AWS::Lex::Bot.DialogCodeHookInvocationSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The `DialogCodeHookInvocationSetting` object associated with intent's confirmation step\\. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is `InvokeDialogCodeHook`\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CodeHook" }, "ConfirmationConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the intent is closed\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConfirmationConditional" }, "ConfirmationNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot executes when the customer confirms the intent\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConfirmationNextStep" }, "ConfirmationResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConfirmationResponse" }, "DeclinationConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the intent is declined\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeclinationConditional" }, "DeclinationNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot executes when the customer declines the intent\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeclinationNextStep" }, "DeclinationResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "When the user answers \"no\" to the question defined in PromptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When the user answers \"no\" to the question defined in `promptSpecification`, Amazon Lex responds with this response to acknowledge that the intent was canceled\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeclinationResponse" }, "ElicitationCodeHook": { "$ref": "#/definitions/AWS::Lex::Bot.ElicitationCodeHookInvocationSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ElicitationCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The `DialogCodeHookInvocationSetting` used when the code hook is invoked during confirmation prompt retries\\. \n*Required*: No \n*Type*: [ElicitationCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ElicitationCodeHook" }, "FailureConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides a list of conditional branches\\. Branches are evaluated in the order that they are entered in the list\\. The first branch with a condition that evaluates to true is executed\\. The last branch in the list is the default branch\\. The default branch should not have any condition expression\\. The default branch is executed if no other branch has a matching condition\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureConditional" }, "FailureNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The next step to take in the conversation if the confirmation step fails\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureNextStep" }, "FailureResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input when the intent confirmation fails\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureResponse" }, "IsActive": { - "markdownDescription": "Specifies whether the intent's confirmation is sent to the user\\. When this field is false, confirmation and declination responses aren't sent and processing continues as if the responses aren't present\\. If the active field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the intent's confirmation is sent to the user\\. When this field is false, confirmation and declination responses aren't sent\\. If the `IsActive` field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsActive", "type": "boolean" }, "PromptSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.PromptSpecification", - "markdownDescription": "Prompts the user to confirm the intent\\. This question should have a yes or no answer\\. \n*Required*: Yes \n*Type*: [PromptSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Prompts the user to confirm the intent\\. This question should have a yes or no answer\\. \nAmazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment\\. For example, with the `OrderPizza` intent, you might want to confirm that the order is correct before placing it\\. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information\\. \n*Required*: Yes \n*Type*: [PromptSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PromptSpecification" } }, @@ -117409,7 +120579,7 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the intent\\. Only required when you're switching intents\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -117417,7 +120587,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.SlotValueOverrideMap" }, - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [SlotValueOverrideMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverridemap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A map of all of the slot value overrides for the intent\\. The name of the slot maps to the value of the slot\\. Slots that are not included in the map aren't overridden\\. \n*Required*: No \n*Type*: List of [SlotValueOverrideMap](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverridemap.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Slots", "type": "array" } @@ -117428,17 +120598,17 @@ "additionalProperties": false, "properties": { "KendraIndex": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon Kendra index that you want the AMAZON\\.KendraSearchIntent intent to search\\. The index must be in the same account and Region as the Amazon Lex bot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon Kendra index that you want the `AMAZON.KendraSearchIntent` intent to search\\. The index must be in the same account and Region as the Amazon Lex bot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KendraIndex", "type": "string" }, "QueryFilterString": { - "markdownDescription": "A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query\\. The filter is in the format defined by Amazon Kendra\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query\\. The filter is in the format defined by Amazon Kendra\\. For more information, see [Filtering queries](https://docs.aws.amazon.com/kendra/latest/dg/filtering.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "QueryFilterString", "type": "string" }, "QueryFilterStringEnabled": { - "markdownDescription": "Determines whether the AMAZON\\.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether the `AMAZON.KendraSearchIntent` intent uses a custom query string to query the Amazon Kendra index\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "QueryFilterStringEnabled", "type": "boolean" } @@ -117452,12 +120622,12 @@ "additionalProperties": false, "properties": { "CodeHookInterfaceVersion": { - "markdownDescription": "Specifies the version of the request\\-response that you want Amazon Lex to use to invoke your Lambda function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the request\\-response that you want Amazon Lex to use to invoke your Lambda function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CodeHookInterfaceVersion", "type": "string" }, "LambdaArn": { - "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of the Lambda function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Lambda function\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LambdaArn", "type": "string" } @@ -117488,7 +120658,7 @@ }, "SSMLMessage": { "$ref": "#/definitions/AWS::Lex::Bot.SSMLMessage", - "markdownDescription": "A message in Speech Synthesis Markup Language \\(SSML\\) format\\. \n*Required*: No \n*Type*: [SSMLMessage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-ssmlmessage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A message in Speech Synthesis Markup Language \\(SSML\\)\\. \n*Required*: No \n*Type*: [SSMLMessage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-ssmlmessage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SSMLMessage" } }, @@ -117520,7 +120690,7 @@ "additionalProperties": false, "properties": { "AllowMultipleValues": { - "markdownDescription": "Indicates whether a slot can return multiple values\\. When true, the slot may return more than one value in a response\\. When false, the slot returns only a single value\\. If AllowMultipleValues is not set, the default value is false\\. \nMulti\\-value slots are only available in the en\\-US locale\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether a slot can return multiple values\\. When `true`, the slot may return more than one value in a response\\. When `false`, the slot returns only a single value\\. \nMulti\\-value slots are only available in the en\\-US locale\\. If you set this value to `true` in any other locale, Amazon Lex throws a `ValidationException`\\. \nIf the `allowMutlipleValues` is not set, the default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowMultipleValues", "type": "boolean" } @@ -117531,7 +120701,7 @@ "additionalProperties": false, "properties": { "ObfuscationSettingType": { - "markdownDescription": "Value that determines whether Amazon Lex obscures slot values in conversation logs\\. The default is to obscure the values\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Value that determines whether Amazon Lex obscures slot values in conversation logs\\. The default is to obscure the values\\. The valid values are `None` and `DefaultObfuscation.` \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ObfuscationSettingType", "type": "string" } @@ -117586,47 +120756,47 @@ "properties": { "FailureConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureConditional" }, "FailureNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureNextStep" }, "FailureResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input when the code hook fails\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureResponse" }, "SuccessConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the dialog code hook finishes successfully\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuccessConditional" }, "SuccessNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifics the next step the bot runs after the dialog code hook finishes successfully\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuccessNextStep" }, "SuccessResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond when the code hook succeeds\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuccessResponse" }, "TimeoutConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate if the code hook times out\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutConditional" }, "TimeoutNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot runs when the code hook times out\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutNextStep" }, "TimeoutResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond to the user input when the code hook times out\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutResponse" } }, @@ -117637,12 +120807,12 @@ "properties": { "FailureConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureConditional" }, "FailureNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the `State` field of the `Intent` object set to `Failed`\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureNextStep" }, "FailureResponse": { @@ -117652,12 +120822,12 @@ }, "SuccessConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the fulfillment code hook finishes successfully\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuccessConditional" }, "SuccessNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SuccessNextStep" }, "SuccessResponse": { @@ -117667,12 +120837,12 @@ }, "TimeoutConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate if the fulfillment code hook times out\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutConditional" }, "TimeoutNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot runs when the fulfillment code hook times out\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeoutNextStep" }, "TimeoutResponse": { @@ -117687,23 +120857,23 @@ "additionalProperties": false, "properties": { "AllowInterrupt": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether the user can interrupt a speech prompt attempt from the bot\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowInterrupt", "type": "boolean" }, "AllowedInputTypes": { "$ref": "#/definitions/AWS::Lex::Bot.AllowedInputTypes", - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [AllowedInputTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-allowedinputtypes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates the allowed input types of the prompt attempt\\. \n*Required*: Yes \n*Type*: [AllowedInputTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-allowedinputtypes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowedInputTypes" }, "AudioAndDTMFInputSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.AudioAndDTMFInputSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AudioAndDTMFInputSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audioanddtmfinputspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the settings on audio and DTMF input\\. \n*Required*: No \n*Type*: [AudioAndDTMFInputSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audioanddtmfinputspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AudioAndDTMFInputSpecification" }, "TextInputSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.TextInputSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [TextInputSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textinputspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the settings on text input\\. \n*Required*: No \n*Type*: [TextInputSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textinputspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextInputSpecification" } }, @@ -117721,7 +120891,7 @@ "type": "boolean" }, "MaxRetries": { - "markdownDescription": "The maximum number of times the bot tries to elicit a response from the user using this prompt \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum number of times the bot tries to elicit a response from the user using this prompt\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxRetries", "type": "number" }, @@ -117729,18 +120899,18 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.MessageGroup" }, - "markdownDescription": "A collection of responses that Amazon Lex can send to the user\\. Amazon Lex chooses the actual response to send at runtime\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A collection of messages that Amazon Lex can send to the user\\. Amazon Lex chooses the actual message to send at runtime\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageGroupsList", "type": "array" }, "MessageSelectionStrategy": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates how a message is selected from a message group among retries\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageSelectionStrategy", "type": "string" }, "PromptAttemptsSpecification": { "additionalProperties": false, - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Map of [PromptAttemptSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptattemptspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the advanced settings on each attempt of the prompt\\. \n*Required*: No \n*Type*: Map of [PromptAttemptSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptattemptspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::Lex::Bot.PromptAttemptSpecification" @@ -117782,17 +120952,17 @@ "additionalProperties": false, "properties": { "KmsKeyArn": { - "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of an AWS Key Management Service key for encrypting audio log files stored in an Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Key Management Service \\(KMS\\) key for encrypting audio log files stored in an Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KmsKeyArn", "type": "string" }, "LogPrefix": { - "markdownDescription": "Specifies the Amazon S3 prefix to assign to audio log files\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The S3 prefix to assign to audio log files\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogPrefix", "type": "string" }, "S3BucketArn": { - "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of the Amazon S3 bucket where audio files are stored\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an Amazon S3 bucket where audio log files are stored\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3BucketArn", "type": "string" } @@ -117846,7 +121016,7 @@ "additionalProperties": false, "properties": { "Utterance": { - "markdownDescription": "The sample utterance that Amazon Lex uses to build its machine\\-learning model to recognize intents\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A sample utterance that invokes an intent or respond to a slot elicitation prompt\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Utterance", "type": "string" } @@ -117874,7 +121044,7 @@ "additionalProperties": false, "properties": { "DetectSentiment": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DetectSentiment", "type": "boolean" } @@ -117888,12 +121058,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the session attribute\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Value": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The session\\-specific context information for the session attribute\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value", "type": "string" } @@ -117907,17 +121077,17 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "A description of the slot type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the slot\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "MultipleValuesSetting": { "$ref": "#/definitions/AWS::Lex::Bot.MultipleValuesSetting", - "markdownDescription": "Determines whether the slot can return multiple values to the application\\. \n*Required*: No \n*Type*: [MultipleValuesSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-multiplevaluessetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether a slot can return multiple values\\. \n*Required*: No \n*Type*: [MultipleValuesSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-multiplevaluessetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MultipleValuesSetting" }, "Name": { - "markdownDescription": "The name of the slot\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name given to the slot\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^([0-9a-zA-Z][_-]?)+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -117933,7 +121103,7 @@ }, "ValueElicitationSetting": { "$ref": "#/definitions/AWS::Lex::Bot.SlotValueElicitationSetting", - "markdownDescription": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ OriginalValue \\- Returns the value entered by the user, if the user value is similar to a slot value\\.\n+ TopResolution \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the valueSelectionStrategy, the default is OriginalValue\\. \n*Required*: Yes \n*Type*: [SlotValueElicitationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueelicitationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ ORIGINAL\\_VALUE \\- Returns the value entered by the user, if the user value is similar to a slot value\\.\n+ TOP\\_RESOLUTION \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`\\. \n*Required*: Yes \n*Type*: [SlotValueElicitationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueelicitationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ValueElicitationSetting" } }, @@ -117949,42 +121119,42 @@ "properties": { "CaptureConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate after the slot value is captured\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CaptureConditional" }, "CaptureNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot runs when the slot value is captured before the code hook times out\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CaptureNextStep" }, "CaptureResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CaptureResponse" }, "CodeHook": { "$ref": "#/definitions/AWS::Lex::Bot.DialogCodeHookInvocationSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Code hook called after Amazon Lex successfully captures a slot value\\. \n*Required*: No \n*Type*: [DialogCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CodeHook" }, "ElicitationCodeHook": { "$ref": "#/definitions/AWS::Lex::Bot.ElicitationCodeHookInvocationSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ElicitationCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Code hook called when Amazon Lex doesn't capture a slot value\\. \n*Required*: No \n*Type*: [ElicitationCodeHookInvocationSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ElicitationCodeHook" }, "FailureConditional": { "$ref": "#/definitions/AWS::Lex::Bot.ConditionalSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of conditional branches to evaluate when the slot value isn't captured\\. \n*Required*: No \n*Type*: [ConditionalSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureConditional" }, "FailureNextStep": { "$ref": "#/definitions/AWS::Lex::Bot.DialogState", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the next step that the bot runs when the slot value code is not recognized\\. \n*Required*: No \n*Type*: [DialogState](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureNextStep" }, "FailureResponse": { "$ref": "#/definitions/AWS::Lex::Bot.ResponseSpecification", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a list of message groups that Amazon Lex uses to respond the user input when the slot fails to be captured\\. \n*Required*: No \n*Type*: [ResponseSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FailureResponse" } }, @@ -118060,7 +121230,7 @@ "type": "string" }, "ParentSlotTypeSignature": { - "markdownDescription": "The built\\-in slot type used as a parent of this slot type\\. When you define a parent slot type, the new slot type has the configuration of the parent lot type\\. \nOnly AMAZON\\.AlphaNumeric is supported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The built\\-in slot type used as a parent of this slot type\\. When you define a parent slot type, the new slot type has the configuration of the parent lot type\\. \nOnly `AMAZON.AlphaNumeric` is supported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ParentSlotTypeSignature", "type": "string" }, @@ -118074,7 +121244,7 @@ }, "ValueSelectionSetting": { "$ref": "#/definitions/AWS::Lex::Bot.SlotValueSelectionSetting", - "markdownDescription": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ OriginalValue \\- Returns the value entered by the user, if the user value is similar to a slot value\\.\n+ TopResolution \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the valueSelectionStrategy, the default is OriginalValue\\. \n*Required*: No \n*Type*: [SlotValueSelectionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueselectionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ `ORIGINAL_VALUE` \\- Returns the value entered by the user, if the user value is similar to the slot value\\.\n+ `TOP_RESOLUTION` \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`\\. \n*Required*: No \n*Type*: [SlotValueSelectionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueselectionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ValueSelectionSetting" } }, @@ -118109,7 +121279,7 @@ "additionalProperties": false, "properties": { "InterpretedValue": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value that Amazon Lex determines for the slot\\. The actual value depends on the setting of the value selection strategy for the bot\\. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the `resolvedValues` list\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InterpretedValue", "type": "string" } @@ -118133,13 +121303,13 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.SampleUtterance" }, - "markdownDescription": "If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy\\. This is optional\\. In most cases Amazon Lex is capable of understanding user utterances\\. \n*Required*: No \n*Type*: List of [SampleUtterance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sampleutterance.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy\\. This is optional\\. In most cases, Amazon Lex is capable of understanding user utterances\\. \n*Required*: No \n*Type*: List of [SampleUtterance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sampleutterance.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SampleUtterances", "type": "array" }, "SlotCaptureSetting": { "$ref": "#/definitions/AWS::Lex::Bot.SlotCaptureSetting", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [SlotCaptureSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user\\. \n*Required*: No \n*Type*: [SlotCaptureSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SlotCaptureSetting" }, "SlotConstraint": { @@ -118149,7 +121319,7 @@ }, "WaitAndContinueSpecification": { "$ref": "#/definitions/AWS::Lex::Bot.WaitAndContinueSpecification", - "markdownDescription": "Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input\\. \n*Required*: No \n*Type*: [WaitAndContinueSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-waitandcontinuespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input\\. \n*Required*: No \n*Type*: [WaitAndContinueSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-waitandcontinuespecification.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WaitAndContinueSpecification" } }, @@ -118162,20 +121332,20 @@ "additionalProperties": false, "properties": { "Shape": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When the shape value is `List`, it indicates that the `values` field contains a list of slot values\\. When the value is `Scalar`, it indicates that the `value` field contains a single value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Shape", "type": "string" }, "Value": { "$ref": "#/definitions/AWS::Lex::Bot.SlotValue", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [SlotValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The current value of the slot\\. \n*Required*: No \n*Type*: [SlotValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Value" }, "Values": { "items": { "$ref": "#/definitions/AWS::Lex::Bot.SlotValueOverride" }, - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [SlotValueOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-lex-bot-slotvalueoverride.html#aws-properties-lex-bot-slotvalueoverride) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of one or more values that the user provided for the slot\\. For example, for a slot that elicits pizza toppings, the values might be \"pepperoni\" and \"pineapple\\.\" \n*Required*: No \n*Type*: List of [SlotValueOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-lex-bot-slotvalueoverride.html#aws-properties-lex-bot-slotvalueoverride) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -118186,13 +121356,13 @@ "additionalProperties": false, "properties": { "SlotName": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the slot\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SlotName", "type": "string" }, "SlotValueOverride": { "$ref": "#/definitions/AWS::Lex::Bot.SlotValueOverride", - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [SlotValueOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The SlotValueOverride object to which the slot name will be mapped\\. \n*Required*: No \n*Type*: [SlotValueOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SlotValueOverride" } }, @@ -118202,7 +121372,7 @@ "additionalProperties": false, "properties": { "Pattern": { - "markdownDescription": "A regular expression used to validate the value of a slot\\. \nUse a standard regular expression\\. Amazon Lex supports the following characters in the regular expression: \n+ A\\-Z, a\\-z\n+ 0\\-9\n+ Unicode characters \\(\"\\\\u\"\\)\nRepresent Unicode characters with four digits, for example \"\\]u0041\" or \"\\\\u005A\"\\. \nThe following regular expression operators are not supported: \n+ Infinite repeaters: \\*, \\+, or \\{x,\\} with no upper bound\n+ Wild card \\(\\.\\)\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A regular expression used to validate the value of a slot\\. \n Use a standard regular expression\\. Amazon Lex supports the following characters in the regular expression: \n+ A\\-Z, a\\-z\n+ 0\\-9\n+ Unicode characters \\(\"\\\\u\"\\)\n Represent Unicode characters with four digits, for example \"\\\\u0041\" or \"\\\\u005A\"\\. \n The following regular expression operators are not supported: \n+ Infinite repeaters: \\*, \\+, or \\{x,\\} with no upper bound\\.\n+ Wild card \\(\\.\\)\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Pattern", "type": "string" } @@ -118217,7 +121387,7 @@ "properties": { "AdvancedRecognitionSetting": { "$ref": "#/definitions/AWS::Lex::Bot.AdvancedRecognitionSetting", - "markdownDescription": "Specifies settings that enable advanced recognition settings for slot values\\. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances\\. \n*Required*: No \n*Type*: [AdvancedRecognitionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-advancedrecognitionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides settings that enable advanced recognition settings for slot values\\. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances\\. \n*Required*: No \n*Type*: [AdvancedRecognitionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-advancedrecognitionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdvancedRecognitionSetting" }, "RegexFilter": { @@ -118226,7 +121396,7 @@ "title": "RegexFilter" }, "ResolutionStrategy": { - "markdownDescription": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ ORIGINAL_VALUE \\- Returns the value entered by the user, if the user value is similar to a slot value\\.\n+ TOP_RESOLUTION \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the valueSelectionStrategy, the default is OriginalValue\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the slot resolution strategy that Amazon Lex uses to return slot type values\\. The field can be set to one of the following values: \n+ `ORIGINAL_VALUE` \\- Returns the value entered by the user, if the user value is similar to the slot value\\.\n+ `TOP_RESOLUTION` \\- If there is a resolution list for the slot, return the first value in the resolution list as the slot type value\\. If there is no resolution list, null is returned\\.\nIf you don't specify the `valueSelectionStrategy`, the default is `ORIGINAL_VALUE`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResolutionStrategy", "type": "string" } @@ -118253,7 +121423,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::Bot.MessageGroup" }, - "markdownDescription": "A collection of responses that Amazon Lex can send to the user\\. Amazon Lex chooses the actual response to send at runtime\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user\\. \n*Required*: Yes \n*Type*: List of [MessageGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageGroupsList", "type": "array" }, @@ -118303,7 +121473,7 @@ "additionalProperties": false, "properties": { "StartTimeoutMs": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Time for which a bot waits before re\\-prompting a customer for text input\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartTimeoutMs", "type": "number" } @@ -118318,7 +121488,7 @@ "properties": { "CloudWatch": { "$ref": "#/definitions/AWS::Lex::Bot.CloudWatchLogGroupLogDestination", - "markdownDescription": "Specifies the Amazon CloudWatch Logs log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: [CloudWatchLogGroupLogDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-cloudwatchloggrouplogdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered\\. \n*Required*: Yes \n*Type*: [CloudWatchLogGroupLogDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-cloudwatchloggrouplogdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudWatch" } }, @@ -118336,7 +121506,7 @@ "title": "Destination" }, "Enabled": { - "markdownDescription": "Specifies whether conversation logs should be stored for an alias\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether conversation logs should be stored for an alias\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -118351,12 +121521,12 @@ "additionalProperties": false, "properties": { "Engine": { - "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user\\. For more information, see the [`engine` parameter of the `SynthesizeSpeech` operation](https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine) in the *Amazon Polly developer guide*\\. \nIf you do not specify a value, the default is `standard`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Engine", "type": "string" }, "VoiceId": { - "markdownDescription": "The Amazon Polly voice used for voice interaction with the user\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identifier of the Amazon Polly voice to use\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VoiceId", "type": "string" } @@ -118375,7 +121545,7 @@ "title": "ContinueResponse" }, "IsActive": { - "markdownDescription": "Specifies whether the bot will wait for a user to respond\\. When this field is false, wait and continue responses for a slot aren't used and the bot expects an appropriate response within the configured timeout\\. If the IsActive field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the bot will wait for a user to respond\\. When this field is false, wait and continue responses for a slot aren't used\\. If the `IsActive` field isn't specified, the default is true\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IsActive", "type": "boolean" }, @@ -118435,7 +121605,7 @@ "items": { "$ref": "#/definitions/AWS::Lex::BotAlias.BotAliasLocaleSettingsItem" }, - "markdownDescription": "Maps configuration information to a specific locale\\. You can use this parameter to specify a specific Lambda function to run different functions in different locales\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettings.html) of [BotAliasLocaleSettingsItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettingsitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettings.html) of [BotAliasLocaleSettingsItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-botalias-botaliaslocalesettingsitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BotAliasLocaleSettings", "type": "array" }, @@ -118548,7 +121718,7 @@ "title": "CodeHookSpecification" }, "Enabled": { - "markdownDescription": "Determines whether the locale is enabled for the bot\\. If the value is false, the locale isn't available for use\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines whether the locale is enabled for the bot\\. If the value is `false`, the locale isn't available for use\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -118587,7 +121757,7 @@ "type": "string" }, "LogPrefix": { - "markdownDescription": "The prefix of the log stream name within the log group that you specified\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The prefix of the log stream name within the log group that you specified \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogPrefix", "type": "string" } @@ -118658,7 +121828,7 @@ "additionalProperties": false, "properties": { "KmsKeyArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Key Management Service key for encrypting audio log files stored in an S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Key Management Service \\(KMS\\) key for encrypting audio log files stored in an Amazon S3 bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KmsKeyArn", "type": "string" }, @@ -118683,7 +121853,7 @@ "additionalProperties": false, "properties": { "DetectSentiment": { - "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DetectSentiment", "type": "boolean" } @@ -118977,7 +122147,7 @@ "items": { "type": "string" }, - "markdownDescription": "The grant principals\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The grant principals\\. You can specify one of the following as an Amazon Resource Name \\(ARN\\): \n+ An AWS account, which includes only the account specified\\.\n+ An organizational unit \\(OU\\), which includes all accounts in the OU\\.\n+ An organization, which will include all accounts across your organization\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Principals", "type": "array" }, @@ -120230,9 +123400,13 @@ "additionalProperties": false, "properties": { "AvailabilityZone": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AvailabilityZone", "type": "string" }, "RegionName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RegionName", "type": "string" } }, @@ -120584,7 +123758,9 @@ "type": "string" }, "Location": { - "$ref": "#/definitions/AWS::Lightsail::Instance.Location" + "$ref": "#/definitions/AWS::Lightsail::Instance.Location", + "markdownDescription": "The location for the instance, such as the AWS Region and Availability Zone\\. \nThe `Location` property is read\\-only and should not be specified in a create instance or update instance request\\.\n*Required*: No \n*Type*: [Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-location.html) \n*Update requires*: Updates are not supported\\.", + "title": "Location" }, "Networking": { "$ref": "#/definitions/AWS::Lightsail::Instance.Networking", @@ -120592,7 +123768,9 @@ "title": "Networking" }, "State": { - "$ref": "#/definitions/AWS::Lightsail::Instance.State" + "$ref": "#/definitions/AWS::Lightsail::Instance.State", + "markdownDescription": "The status code and the state \\(for example, `running`\\) of the instance\\. \nThe `State` property is read\\-only and should not be specified in a create instance or update instance request\\.\n*Required*: No \n*Type*: [State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-state.html) \n*Update requires*: Updates are not supported\\.", + "title": "State" }, "Tags": { "items": { @@ -120952,6 +124130,8 @@ "type": "array" }, "TlsPolicyName": { + "markdownDescription": "The name of the TLS security policy for the load balancer\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\w[\\w\\-]*\\w` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TlsPolicyName", "type": "string" } }, @@ -121036,6 +124216,8 @@ "type": "string" }, "HttpsRedirectionEnabled": { + "markdownDescription": "A Boolean value indicating whether HTTPS redirection is enabled for the load balancer that the TLS certificate is attached to\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HttpsRedirectionEnabled", "type": "boolean" }, "IsAttached": { @@ -121185,7 +124367,7 @@ "additionalProperties": false, "properties": { "CollectionName": { - "markdownDescription": "The name for the geofence collection\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A custom name for the geofence collection\\. \nRequirements: \n+ Contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\. \n+ Must be a unique geofence collection name\\.\n+ No spaces allowed\\. For example, `ExampleGeofenceCollection`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CollectionName", "type": "string" }, @@ -121195,7 +124377,7 @@ "type": "string" }, "KmsKeyId": { - "markdownDescription": "A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html)\\. Enter a key ID, key ARN, alias name, or alias ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html)\\. Enter a key ID, key ARN, alias name, or alias ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" } @@ -121263,7 +124445,7 @@ "properties": { "Configuration": { "$ref": "#/definitions/AWS::Location::Map.MapConfiguration", - "markdownDescription": "Specifies the map style selected from an available data provider\\. \n*Required*: Yes \n*Type*: [MapConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-map-mapconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the `MapConfiguration`, including the map style, for the map resource that you create\\. The map style defines the look of maps and the data provider for your map resource\\. \n*Required*: Yes \n*Type*: [MapConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-map-mapconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Configuration" }, "Description": { @@ -121272,7 +124454,7 @@ "type": "string" }, "MapName": { - "markdownDescription": "The name for the map resource\\. \nRequirements: \n+ Must contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique map resource name\\.\n+ No spaces allowed\\. For example, `ExampleMap`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name for the map resource\\. \nRequirements: \n+ Must contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\. \n+ Must be a unique map resource name\\. \n+ No spaces allowed\\. For example, `ExampleMap`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MapName", "type": "string" }, @@ -121313,7 +124495,7 @@ "additionalProperties": false, "properties": { "Style": { - "markdownDescription": "Specifies the map style selected from an available data provider\\. \nValid styles: `VectorEsriStreets`, `VectorEsriTopographic`, `VectorEsriNavigation`, `VectorEsriDarkGrayCanvas`, `VectorEsriLightGrayCanvas`, `VectorHereBerlin`\\. \nWhen using HERE as your data provider, and selecting the Style `VectorHereBerlin`, you may not use HERE Technologies maps for Asset Management\\. See the [AWS Service Terms](http://aws.amazon.com/service-terms/) for Amazon Location Service\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the map style selected from an available data provider\\. \nValid [Esri map styles](https://docs.aws.amazon.com/location/latest/developerguide/esri.html): \n+ `VectorEsriDarkGrayCanvas` \u2013 The Esri Dark Gray Canvas map style\\. A vector basemap with a dark gray, neutral background with minimal colors, labels, and features that's designed to draw attention to your thematic content\\. \n+ `RasterEsriImagery` \u2013 The Esri Imagery map style\\. A raster basemap that provides one meter or better satellite and aerial imagery in many parts of the world and lower resolution satellite imagery worldwide\\. \n+ `VectorEsriLightGrayCanvas` \u2013 The Esri Light Gray Canvas map style, which provides a detailed vector basemap with a light gray, neutral background style with minimal colors, labels, and features that's designed to draw attention to your thematic content\\. \n+ `VectorEsriTopographic` \u2013 The Esri Light map style, which provides a detailed vector basemap with a classic Esri map style\\.\n+ `VectorEsriStreets` \u2013 The Esri World Streets map style, which provides a detailed vector basemap for the world symbolized with a classic Esri street map style\\. The vector tile layer is similar in content and style to the World Street Map raster map\\.\n+ `VectorEsriNavigation` \u2013 The Esri World Navigation map style, which provides a detailed basemap for the world symbolized with a custom navigation map style that's designed for use during the day in mobile devices\\.\nValid [HERE Technologies map styles](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html): \n+ `VectorHereContrast` \u2013 The HERE Contrast \\(Berlin\\) map style is a high contrast detailed base map of the world that blends 3D and 2D rendering\\.\n**Note** \nThe `VectorHereContrast` style has been renamed from `VectorHereBerlin`\\. `VectorHereBerlin` has been deprecated, but will continue to work in applications that use it\\.\n+ `VectorHereExplore` \u2013 A default HERE map style containing a neutral, global map and its features including roads, buildings, landmarks, and water features\\. It also now includes a fully designed map of Japan\\.\n+ `VectorHereExploreTruck` \u2013 A global map containing truck restrictions and attributes \\(e\\.g\\. width / height / HAZMAT\\) symbolized with highlighted segments and icons on top of HERE Explore to support use cases within transport and logistics\\.\n+ `RasterHereExploreSatellite` \u2013 A global map containing high resolution satellite imagery\\.\n+ `HybridHereExploreSatellite` \u2013 A global map displaying the road network, street names, and city labels over satellite imagery\\. This style will automatically retrieve both raster and vector tiles, and your charges will be based on total tiles retrieved\\.\n**Note** \nHybrid styles use both vector and raster tiles when rendering the map that you see\\. This means that more tiles are retrieved than when using either vector or raster tiles alone\\. Your charges will include all tiles retrieved\\.\nValid [GrabMaps map styles](https://docs.aws.amazon.com/location/latest/developerguide/grab.html): \n+ `VectorGrabStandardLight` \u2013 The Grab Standard Light map style provides a basemap with detailed land use coloring, area names, roads, landmarks, and points of interest covering Southeast Asia\\.\n+ `VectorGrabStandardDark` \u2013 The Grab Standard Dark map style provides a dark variation of the standard basemap covering Southeast Asia\\.\nGrab provides maps only for countries in Southeast Asia, and is only available in the Asia Pacific \\(Singapore\\) Region \\(`ap-southeast-1`\\)\\. For more information, see [GrabMaps countries and area covered](https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area)\\.\nValid [Open Data \\(Preview\\) map styles](https://docs.aws.amazon.com/location/latest/developerguide/open-data.html): \n+ `VectorOpenDataStandardLight` \u2013 The Open Data Standard Light \\(preview\\) map style provides a detailed basemap for the world suitable for website and mobile application use\\. The map includes highways major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries\\.\n**Important** \nOpen Data maps is in preview\\. We may add, change, or remove features before announcing general availability\\. For more information, see [Open Data is in preview release](https://docs.aws.amazon.com/location/latest/developerguide/open-data.html#open-data-preview)\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Style", "type": "string" } @@ -121359,13 +124541,13 @@ "additionalProperties": false, "properties": { "DataSource": { - "markdownDescription": "Specifies the data provider of geospatial data\\. \nThis field is case\\-sensitive\\. Enter the valid values as shown\\. For example, entering `HERE` will return an error\\.\nValid values include: \n+ `Esri`\n+ `Here`\n**Important** \nPlace index resources using HERE as a data provider can't be used to [store](https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html) results for locations in Japan\\. For more information, see the [AWS Service Terms](http://aws.amazon.com/service-terms/) for Amazon Location Service\\.\nFor additional details on data providers, see the [Amazon Location Service data providers page](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the geospatial data provider for the new place index\\. \nThis field is case\\-sensitive\\. Enter the valid values as shown\\. For example, entering `HERE` returns an error\\.\nValid values include: \n+ `Esri` \u2013 For additional information about [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s coverage in your region of interest, see [Esri details on geocoding coverage](https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm)\\.\n+ `Grab` \u2013 Grab provides place index functionality for Southeast Asia\\. For additional information about [GrabMaps](https://docs.aws.amazon.com/location/latest/developerguide/grab.html)' coverage, see [GrabMaps countries and areas covered](https://docs.aws.amazon.com/location/latest/developerguide/grab.html#grab-coverage-area)\\.\n+ `Here` \u2013 For additional information about [HERE Technologies](https://docs.aws.amazon.com/location/latest/developerguide/HERE.html)' coverage in your region of interest, see [HERE details on goecoding coverage](https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html)\\.\n**Important** \nIf you specify HERE Technologies \\(`Here`\\) as the data provider, you may not [store results](https://docs.aws.amazon.com/location-places/latest/APIReference/API_DataSourceConfiguration.html) for locations in Japan\\. For more information, see the [AWS Service Terms](http://aws.amazon.com/service-terms/) for Amazon Location Service\\.\nFor additional information , see [Data providers](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html) on the *Amazon Location Service Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DataSource", "type": "string" }, "DataSourceConfiguration": { "$ref": "#/definitions/AWS::Location::PlaceIndex.DataSourceConfiguration", - "markdownDescription": "Specifies the data storage option for requesting Places\\. \n*Required*: No \n*Type*: [DataSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-placeindex-datasourceconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the data storage option requesting Places\\. \n*Required*: No \n*Type*: [DataSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-location-placeindex-datasourceconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DataSourceConfiguration" }, "Description": { @@ -121374,7 +124556,7 @@ "type": "string" }, "IndexName": { - "markdownDescription": "The name of the place index resource\\. \nRequirements: \n+ Contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique place index resource name\\.\n+ No spaces allowed\\. For example, `ExamplePlaceIndex`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the place index resource\\. \nRequirements: \n+ Contain only alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\), hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique place index resource name\\.\n+ No spaces allowed\\. For example, `ExamplePlaceIndex`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IndexName", "type": "string" }, @@ -121415,7 +124597,7 @@ "additionalProperties": false, "properties": { "IntendedUse": { - "markdownDescription": "Specifies how the results of an operation will be stored by the caller\\. \nValid values include: \n+ `SingleUse` specifies that the results won't be stored\\.\n+ `Storage` specifies that the result can be cached or stored in a database\\.\n**Important** \nPlace index resources using HERE as a data provider can't be configured to store results for locations in Japan when choosing `Storage` for the `IntendedUse` parameter\\.\nDefault value: `SingleUse` \n*Required*: No \n*Type*: String \n*Allowed values*: `SingleUse | Storage` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies how the results of an operation will be stored by the caller\\. \nValid values include: \n+ `SingleUse` specifies that the results won't be stored\\. \n+ `Storage` specifies that the result can be cached or stored in a database\\.\nDefault value: `SingleUse` \n*Required*: No \n*Type*: String \n*Allowed values*: `SingleUse | Storage` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IntendedUse", "type": "string" } @@ -121458,12 +124640,12 @@ "additionalProperties": false, "properties": { "CalculatorName": { - "markdownDescription": "The name of the route calculator resource\\. \nRequirements: \n+ Can use alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\) , hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique route calculator resource name\\.\n+ No spaces allowed\\. For example, `ExampleRouteCalculator`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the route calculator resource\\. \nRequirements: \n+ Can use alphanumeric characters \\(A\u2013Z, a\u2013z, 0\u20139\\) , hyphens \\(\\-\\), periods \\(\\.\\), and underscores \\(\\_\\)\\.\n+ Must be a unique Route calculator resource name\\.\n+ No spaces allowed\\. For example, `ExampleRouteCalculator`\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `100` \n*Pattern*: `^[-._\\w]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CalculatorName", "type": "string" }, "DataSource": { - "markdownDescription": "Specifies the data provider of traffic and road network data\\. \nThis field is case\\-sensitive\\. Enter the valid values as shown\\. For example, entering `HERE` returns an error\\.\nValid values include: \n+ `Esri`\n+ `Here`\nFor more information about data providers, see the [Amazon Location Service data providers page](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the data provider of traffic and road network data\\. \nThis field is case\\-sensitive\\. Enter the valid values as shown\\. For example, entering `HERE` returns an error\\.\nValid values include: \n+ `Esri` \u2013 For additional information about [Esri](https://docs.aws.amazon.com/location/latest/developerguide/esri.html)'s coverage in your region of interest, see [Esri details on street networks and traffic coverage](https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm)\\.", "title": "DataSource", "type": "string" }, @@ -121561,7 +124743,7 @@ "type": "string" }, "PricingPlanDataSource": { - "markdownDescription": "This parameter is no longer used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "This parameter is no longer used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PricingPlanDataSource", "type": "string" }, @@ -121633,7 +124815,7 @@ "additionalProperties": false, "properties": { "ConsumerArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the geofence collection that consumes the tracker resource updates\\. \n+ Format example: `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`\n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1600` \n*Pattern*: `^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the geofence collection to be associated to tracker resource\\. Used when you need to specify a resource across all AWS\\. \n+ Format example: `arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer`\n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1600` \n*Pattern*: `^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ConsumerArn", "type": "string" }, @@ -121711,7 +124893,7 @@ "type": "string" }, "DestinationPolicy": { - "markdownDescription": "An IAM policy document that governs which AWS accounts can create subscription filters against this destination\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An IAM policy document that governs which AWS accounts can create subscription filters against this destination\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DestinationPolicy", "type": "string" }, @@ -121790,6 +124972,8 @@ "additionalProperties": false, "properties": { "DataProtectionPolicy": { + "markdownDescription": "Creates a data protection policy and assigns it to the log group\\. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data\\. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks\\. \nFor more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataProtectionPolicy", "type": "object" }, "KmsKeyId": { @@ -121803,7 +124987,7 @@ "type": "string" }, "RetentionInDays": { - "markdownDescription": "The number of days to retain the log events in the specified log group\\. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653\\. \nTo set a log group to never have log events expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of days to retain the log events in the specified log group\\. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653\\. \nTo set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RetentionInDays", "type": "number" }, @@ -121946,6 +125130,8 @@ "additionalProperties": false, "properties": { "FilterName": { + "markdownDescription": "The name of the metric filter\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[^:*]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FilterName", "type": "string" }, "FilterPattern": { @@ -121999,9 +125185,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The name for the CloudWatch metric dimension that the metric filter creates\\. \nDimension names must contain only ASCII characters, must include at least one non\\-whitespace character, and cannot start with a colon \\(:\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "The log event field that will contain the value for this dimension\\. This dimension will only be published for a metric if the value is found in the log event\\. For example, `$.eventType` for JSON log events, or `$server` for space\\-delimited log events\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -122023,6 +125213,8 @@ "items": { "$ref": "#/definitions/AWS::Logs::MetricFilter.Dimension" }, + "markdownDescription": "The fields to use as dimensions for the metric\\. One metric filter can include as many as three dimensions\\. \nMetrics extracted from log events are charged as custom metrics\\. To prevent unexpected high charges, do not specify high\\-cardinality fields such as `IPAddress` or `requestID` as dimensions\\. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric\\. \nCloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time\\. This helps to prevent accidental high charges\\. \nYou can also set up a billing alarm to alert you if your charges are higher than expected\\. For more information, see [ Creating a Billing Alarm to Monitor Your Estimated AWS Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html)\\. \n*Required*: No \n*Type*: List of [Dimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-metricfilter-dimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Dimensions", "type": "array" }, "MetricName": { @@ -122036,11 +125228,13 @@ "type": "string" }, "MetricValue": { - "markdownDescription": "The value that is published to the CloudWatch metric\\. For example, if you're counting the occurrences of a particular term like `Error`, specify 1 for the metric value\\. If you're counting the number of bytes transferred, reference the value that is in the log event by using $ followed by the name of the field that you specified in the filter pattern, such as `$.size`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The value that is published to the CloudWatch metric\\. For example, if you're counting the occurrences of a particular term like `Error`, specify 1 for the metric value\\. If you're counting the number of bytes transferred, reference the value that is in the log event by using $\\. followed by the name of the field that you specified in the filter pattern, such as `$.size`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricValue", "type": "string" }, "Unit": { + "markdownDescription": "The unit to assign to the metric\\. If you omit this, the unit is set as `None`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Bits | Bits/Second | Bytes | Bytes/Second | Count | Count/Second | Gigabits | Gigabits/Second | Gigabytes | Gigabytes/Second | Kilobits | Kilobits/Second | Kilobytes | Kilobytes/Second | Megabits | Megabits/Second | Megabytes | Megabytes/Second | Microseconds | Milliseconds | None | Percent | Seconds | Terabits | Terabits/Second | Terabytes | Terabytes/Second` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Unit", "type": "string" } }, @@ -122246,9 +125440,13 @@ "type": "string" }, "Distribution": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Distribution", "type": "string" }, "FilterName": { + "markdownDescription": "The name of the subscription filter\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[^:*]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FilterName", "type": "string" }, "FilterPattern": { @@ -122337,12 +125535,12 @@ }, "DataInputConfiguration": { "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.DataInputConfiguration", - "markdownDescription": "Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location\\. \n*Required*: Yes \n*Type*: [DataInputConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-datainputconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataInputConfiguration" }, "DataOutputConfiguration": { "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.DataOutputConfiguration", - "markdownDescription": "Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies configuration information for the output results for the inference scheduler, including the Amazon S3 location for the output\\. \n*Required*: Yes \n*Type*: [DataOutputConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-dataoutputconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataOutputConfiguration" }, "DataUploadFrequency": { @@ -122413,13 +125611,19 @@ "additionalProperties": false, "properties": { "InferenceInputNameConfiguration": { - "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.InputNameConfiguration" + "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.InputNameConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [InputNameConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-inputnameconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InferenceInputNameConfiguration" }, "InputTimeZoneOffset": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputTimeZoneOffset", "type": "string" }, "S3InputConfiguration": { - "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.S3InputConfiguration" + "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.S3InputConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [S3InputConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-s3inputconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3InputConfiguration" } }, "required": [ @@ -122431,10 +125635,14 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "S3OutputConfiguration": { - "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.S3OutputConfiguration" + "$ref": "#/definitions/AWS::LookoutEquipment::InferenceScheduler.S3OutputConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [S3OutputConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutequipment-inferencescheduler-s3outputconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3OutputConfiguration" } }, "required": [ @@ -122446,9 +125654,13 @@ "additionalProperties": false, "properties": { "ComponentTimestampDelimiter": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ComponentTimestampDelimiter", "type": "string" }, "TimestampFormat": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TimestampFormat", "type": "string" } }, @@ -122458,9 +125670,13 @@ "additionalProperties": false, "properties": { "Bucket": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Bucket", "type": "string" }, "Prefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Prefix", "type": "string" } }, @@ -122473,9 +125689,13 @@ "additionalProperties": false, "properties": { "Bucket": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Bucket", "type": "string" }, "Prefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Prefix", "type": "string" } }, @@ -122904,7 +126124,7 @@ "title": "MetricSource" }, "Offset": { - "markdownDescription": "After an interval ends, the amount of seconds that the detector waits before importing data\\. Offset is only supported for S3 and Redshift datasources\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "After an interval ends, the amount of seconds that the detector waits before importing data\\. Offset is only supported for S3, Redshift, Athena and datasources\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Offset", "type": "number" }, @@ -122931,22 +126151,22 @@ "properties": { "AppFlowConfig": { "$ref": "#/definitions/AWS::LookoutMetrics::AnomalyDetector.AppFlowConfig", - "markdownDescription": "An object containing information about the AppFlow configuration\\. \n*Required*: No \n*Type*: [AppFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-appflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Details about an AppFlow datasource\\. \n*Required*: No \n*Type*: [AppFlowConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-appflowconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AppFlowConfig" }, "CloudwatchConfig": { "$ref": "#/definitions/AWS::LookoutMetrics::AnomalyDetector.CloudwatchConfig", - "markdownDescription": "An object containing information about the Amazon CloudWatch monitoring configuration\\. \n*Required*: No \n*Type*: [CloudwatchConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-cloudwatchconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Details about an Amazon CloudWatch monitoring datasource\\. \n*Required*: No \n*Type*: [CloudwatchConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-cloudwatchconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CloudwatchConfig" }, "RDSSourceConfig": { "$ref": "#/definitions/AWS::LookoutMetrics::AnomalyDetector.RDSSourceConfig", - "markdownDescription": "An object containing information about the Amazon Relational Database Service \\(RDS\\) configuration\\. \n*Required*: No \n*Type*: [RDSSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Details about an Amazon Relational Database Service \\(RDS\\) datasource\\. \n*Required*: No \n*Type*: [RDSSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-rdssourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RDSSourceConfig" }, "RedshiftSourceConfig": { "$ref": "#/definitions/AWS::LookoutMetrics::AnomalyDetector.RedshiftSourceConfig", - "markdownDescription": "An object containing information about the Amazon Redshift database configuration\\. \n*Required*: No \n*Type*: [RedshiftSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Details about an Amazon Redshift database datasource\\. \n*Required*: No \n*Type*: [RedshiftSourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lookoutmetrics-anomalydetector-redshiftsourceconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RedshiftSourceConfig" }, "S3SourceConfig": { @@ -123250,27 +126470,39 @@ "additionalProperties": false, "properties": { "Definition": { - "$ref": "#/definitions/AWS::M2::Application.Definition" + "$ref": "#/definitions/AWS::M2::Application.Definition", + "markdownDescription": "The application definition for a particular application\\. You can specify either inline JSON or an Amazon S3 bucket location\\. \nFor information about application definitions, see the [AWS Mainframe Modernization User Guide](https://docs.aws.amazon.com/m2/latest/userguide/applications-m2-definition.html)\\. \n*Required*: Yes \n*Type*: [Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-application-definition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Definition" }, "Description": { + "markdownDescription": "The description of the application\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "EngineType": { + "markdownDescription": "The type of the target platform for this application\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `bluage | microfocus` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EngineType", "type": "string" }, "KmsKeyId": { + "markdownDescription": "The identifier of a customer managed key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" }, "Name": { + "markdownDescription": "The name of the application\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -123306,9 +126538,13 @@ "additionalProperties": false, "properties": { "Content": { + "markdownDescription": "The content of the application definition\\. This is a JSON object that contains the resource configuration/definitions that identify an application\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `65000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Content", "type": "string" }, "S3Location": { + "markdownDescription": "The S3 bucket that contains the application definition\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\S{1,2000}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3Location", "type": "string" } }, @@ -123350,57 +126586,83 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the runtime environment\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Description", "type": "string" }, "EngineType": { + "markdownDescription": "The target platform for the runtime environment\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `bluage | microfocus` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EngineType", "type": "string" }, "EngineVersion": { + "markdownDescription": "The version of the runtime engine\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\S{1,10}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EngineVersion", "type": "string" }, "HighAvailabilityConfig": { - "$ref": "#/definitions/AWS::M2::Environment.HighAvailabilityConfig" + "$ref": "#/definitions/AWS::M2::Environment.HighAvailabilityConfig", + "markdownDescription": "Defines the details of a high availability configuration\\. \n*Required*: No \n*Type*: [HighAvailabilityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-highavailabilityconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HighAvailabilityConfig" }, "InstanceType": { + "markdownDescription": "The instance type of the runtime environment\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,20}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InstanceType", "type": "string" }, "KmsKeyId": { + "markdownDescription": "The identifier of a customer managed key\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" }, "Name": { + "markdownDescription": "The name of the runtime environment\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "PreferredMaintenanceWindow": { + "markdownDescription": "Configures the maintenance window you want for the runtime environment\\. If you do not provide a value, a random system\\-generated value will be assigned\\. \n*Required*: No \n*Type*: String \n*Pattern*: `\\S{1,50}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PreferredMaintenanceWindow", "type": "string" }, "PubliclyAccessible": { + "markdownDescription": "Specifies whether the runtime environment is publicly accessible\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PubliclyAccessible", "type": "boolean" }, "SecurityGroupIds": { "items": { "type": "string" }, + "markdownDescription": "The list of security groups for the VPC associated with this runtime environment\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SecurityGroupIds", "type": "array" }, "StorageConfigurations": { "items": { "$ref": "#/definitions/AWS::M2::Environment.StorageConfiguration" }, + "markdownDescription": "Defines the storage configuration for a runtime environment\\. \n*Required*: No \n*Type*: List of [StorageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-storageconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StorageConfigurations", "type": "array" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "The list of subnets associated with the VPC for this runtime environment\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SubnetIds", "type": "array" }, "Tags": { "additionalProperties": true, + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -123436,9 +126698,13 @@ "additionalProperties": false, "properties": { "FileSystemId": { + "markdownDescription": "The file system identifier\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,200}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemId", "type": "string" }, "MountPoint": { + "markdownDescription": "The mount point for the file system\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,200}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MountPoint", "type": "string" } }, @@ -123452,9 +126718,13 @@ "additionalProperties": false, "properties": { "FileSystemId": { + "markdownDescription": "The file system identifier\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,200}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemId", "type": "string" }, "MountPoint": { + "markdownDescription": "The mount point for the file system\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `\\S{1,200}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MountPoint", "type": "string" } }, @@ -123468,6 +126738,8 @@ "additionalProperties": false, "properties": { "DesiredCapacity": { + "markdownDescription": "The number of instances in a high availability configuration\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DesiredCapacity", "type": "number" } }, @@ -123480,10 +126752,14 @@ "additionalProperties": false, "properties": { "Efs": { - "$ref": "#/definitions/AWS::M2::Environment.EfsStorageConfiguration" + "$ref": "#/definitions/AWS::M2::Environment.EfsStorageConfiguration", + "markdownDescription": "Defines the storage configuration for an Amazon EFS file system\\. \n*Required*: No \n*Type*: [EfsStorageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-efsstorageconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Efs" }, "Fsx": { - "$ref": "#/definitions/AWS::M2::Environment.FsxStorageConfiguration" + "$ref": "#/definitions/AWS::M2::Environment.FsxStorageConfiguration", + "markdownDescription": "Defines the storage configuration for an Amazon FSx file system\\. \n*Required*: No \n*Type*: [FsxStorageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-fsxstorageconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Fsx" } }, "type": "object" @@ -123654,6 +126930,8 @@ "title": "OpenMonitoring" }, "StorageMode": { + "markdownDescription": "This controls storage mode for supported storage tiers\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageMode", "type": "string" }, "Tags": { @@ -123730,7 +127008,7 @@ "items": { "type": "string" }, - "markdownDescription": "The list of subnets to connect to in the client virtual private cloud \\(VPC\\)\\. Amazon creates elastic network interfaces inside these subnets\\. Client applications use elastic network interfaces to produce and consume data\\. \nSpecify exactly two subnets if you are using the US West \\(N\\. California\\) Region\\. For other Regions where Amazon MSK is available, you can specify either two or three subnets\\. The subnets that you specify must be in distinct Availability Zones\\. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify\\. \nClient subnets can't be in Availability Zone us\\-east\\-1e\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The list of subnets to connect to in the client virtual private cloud \\(VPC\\)\\. Amazon creates elastic network interfaces inside these subnets\\. Client applications use elastic network interfaces to produce and consume data\\. \nIf you use the US West \\(N\\. California\\) Region, specify exactly two subnets\\. For other Regions where Amazon MSK is available, you can specify either two or three subnets\\. The subnets that you specify must be in distinct Availability Zones\\. When you create a cluster, Amazon MSK distributes the broker nodes evenly across the subnets that you specify\\. \nClient subnets can't occupy the Availability Zone with ID `use1-az3`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ClientSubnets", "type": "array" }, @@ -123740,7 +127018,7 @@ "title": "ConnectivityInfo" }, "InstanceType": { - "markdownDescription": "The type of Amazon EC2 instances to use for brokers\\. The following instance types are allowed: kafka\\.m5\\.large, kafka\\.m5\\.xlarge, kafka\\.m5\\.2xlarge, kafka\\.m5\\.4xlarge, kafka\\.m5\\.8xlarge, kafka\\.m5\\.12xlarge, kafka\\.m5\\.16xlarge, and kafka\\.m5\\.24xlarge\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of Amazon EC2 instances to use for brokers\\. The following instance types are allowed: kafka\\.m5\\.large, kafka\\.m5\\.xlarge, kafka\\.m5\\.2xlarge, kafka\\.m5\\.4xlarge, kafka\\.m5\\.8xlarge, kafka\\.m5\\.12xlarge, kafka\\.m5\\.16xlarge, kafka\\.m5\\.24xlarge, and kafka\\.t3\\.small\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InstanceType", "type": "string" }, @@ -123754,7 +127032,7 @@ }, "StorageInfo": { "$ref": "#/definitions/AWS::MSK::Cluster.StorageInfo", - "markdownDescription": "Contains information about storage volumes attached to MSK broker nodes\\. \n*Required*: No \n*Type*: [StorageInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-storageinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains information about storage volumes attached to Amazon MSK broker nodes\\. \n*Required*: No \n*Type*: [StorageInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-storageinfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StorageInfo" } }, @@ -123833,7 +127111,9 @@ "title": "PublicAccess" }, "VpcConnectivity": { - "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivity" + "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivity", + "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [VpcConnectivity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcConnectivity" } }, "type": "object" @@ -124134,7 +127414,9 @@ "additionalProperties": false, "properties": { "ClientAuthentication": { - "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityClientAuthentication" + "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityClientAuthentication", + "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [VpcConnectivityClientAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityclientauthentication.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientAuthentication" } }, "type": "object" @@ -124143,10 +127425,14 @@ "additionalProperties": false, "properties": { "Sasl": { - "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivitySasl" + "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivitySasl", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConnectivitySasl](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivitysasl.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sasl" }, "Tls": { - "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityTls" + "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityTls", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConnectivityTls](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivitytls.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tls" } }, "type": "object" @@ -124155,6 +127441,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" } }, @@ -124167,10 +127455,14 @@ "additionalProperties": false, "properties": { "Iam": { - "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityIam" + "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityIam", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConnectivityIam](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityiam.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Iam" }, "Scram": { - "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityScram" + "$ref": "#/definitions/AWS::MSK::Cluster.VpcConnectivityScram", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [VpcConnectivityScram](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-cluster-vpcconnectivityscram.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Scram" } }, "type": "object" @@ -124179,6 +127471,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" } }, @@ -124191,6 +127485,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" } }, @@ -124248,7 +127544,7 @@ "type": "array" }, "Name": { - "markdownDescription": "The name of the configuration\\. Configuration names are strings that match the regex \"^\\[0\\-9A\\-Za\\-z\\]\\[0\\-9A\\-Za\\-z\\-\\]\\{0,\\}$\"\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the configuration\\. Configuration names are strings that match the regex \"^\\[0\\-9A\\-Za\\-z\\]\\[0\\-9A\\-Za\\-z\\-\\]\\{0,\\}$\"\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -124321,24 +127617,32 @@ "additionalProperties": false, "properties": { "ClientAuthentication": { - "$ref": "#/definitions/AWS::MSK::ServerlessCluster.ClientAuthentication" + "$ref": "#/definitions/AWS::MSK::ServerlessCluster.ClientAuthentication", + "markdownDescription": "Specifies client authentication information for the serverless cluster\\. \n*Required*: Yes \n*Type*: [ClientAuthentication](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-clientauthentication.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ClientAuthentication" }, "ClusterName": { + "markdownDescription": "The name of the serverless cluster\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ClusterName", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "A map of key:value pairs to apply to this serverless cluster\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "VpcConfigs": { "items": { "$ref": "#/definitions/AWS::MSK::ServerlessCluster.VpcConfig" }, + "markdownDescription": "VPC configuration information\\. \n*Required*: Yes \n*Type*: List of [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-vpcconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VpcConfigs", "type": "array" } }, @@ -124374,7 +127678,9 @@ "additionalProperties": false, "properties": { "Sasl": { - "$ref": "#/definitions/AWS::MSK::ServerlessCluster.Sasl" + "$ref": "#/definitions/AWS::MSK::ServerlessCluster.Sasl", + "markdownDescription": "Details for client authentication using SASL\\. To turn on SASL, you must also turn on `EncryptionInTransit` by setting `inCluster` to true\\. You must set `clientBroker` to either `TLS` or `TLS_PLAINTEXT`\\. If you choose `TLS_PLAINTEXT`, then you must also set `unauthenticated` to true\\. \n*Required*: Yes \n*Type*: [Sasl](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-sasl.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Sasl" } }, "required": [ @@ -124386,6 +127692,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "SASL/IAM authentication is enabled or not\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Enabled", "type": "boolean" } }, @@ -124398,7 +127706,9 @@ "additionalProperties": false, "properties": { "Iam": { - "$ref": "#/definitions/AWS::MSK::ServerlessCluster.Iam" + "$ref": "#/definitions/AWS::MSK::ServerlessCluster.Iam", + "markdownDescription": "Details for client authentication using IAM\\. \n*Required*: Yes \n*Type*: [Iam](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-iam.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Iam" } }, "required": [ @@ -124413,12 +127723,16 @@ "items": { "type": "string" }, + "markdownDescription": "Specifies up to five security groups that control inbound and outbound traffic for the serverless cluster\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SecurityGroups", "type": "array" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "A list of subnets in at least two different Availability Zones that host your client applications\\. We recommend that you specify a backup subnet in a different Availability Zone for failover in case of an outage\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SubnetIds", "type": "array" } }, @@ -124468,7 +127782,7 @@ "type": "object" }, "AirflowVersion": { - "markdownDescription": "The version of Apache Airflow to use for the environment\\. If no value is specified, defaults to the latest version\\. Valid values: `2.0.2`, `1.10.12`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of Apache Airflow to use for the environment\\. If no value is specified, defaults to the latest version\\. Valid values: `2.0.2`, `1.10.12`, `2.2.2`, and `2.4.3`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AirflowVersion", "type": "string" }, @@ -124538,7 +127852,7 @@ "type": "string" }, "Schedulers": { - "markdownDescription": "The number of schedulers that you want to run in your environment\\. Valid values: \n+ **v2\\.0\\.2** \\- Accepts between 2 to 5\\. Defaults to 2\\.\n+ **v1\\.10\\.12** \\- Accepts 1\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of schedulers that you want to run in your environment\\. Valid values: \n+ **v2** \\- Accepts between 2 to 5\\. Defaults to 2\\.\n+ **v1** \\- Accepts 1\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Schedulers", "type": "number" }, @@ -124699,18 +128013,26 @@ "additionalProperties": false, "properties": { "Criteria": { - "$ref": "#/definitions/AWS::Macie::AllowList.Criteria" + "$ref": "#/definitions/AWS::Macie::AllowList.Criteria", + "markdownDescription": "The criteria that specify the text or text pattern to ignore\\. The criteria can be the location and name of an Amazon S3 object that lists specific text to ignore \\(`S3WordsList`\\), or a regular expression \\(`Regex`\\) that defines a text pattern to ignore\\. \n*Required*: Yes \n*Type*: [Criteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-allowlist-criteria.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Criteria" }, "Description": { + "markdownDescription": "A custom description of the allow list\\. The description can contain 1\\-512 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A custom name for the allow list\\. The name can contain 1\\-128 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An array of key\\-value pairs to apply to the allow list\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -124745,10 +128067,14 @@ "additionalProperties": false, "properties": { "Regex": { + "markdownDescription": "The regular expression \\(*regex*\\) that defines the text pattern to ignore\\. The expression can contain 1\\-512 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Regex", "type": "string" }, "S3WordsList": { - "$ref": "#/definitions/AWS::Macie::AllowList.S3WordsList" + "$ref": "#/definitions/AWS::Macie::AllowList.S3WordsList", + "markdownDescription": "The location and name of an Amazon S3 object that lists specific text to ignore\\. \n*Required*: No \n*Type*: [S3WordsList](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-allowlist-s3wordslist.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3WordsList" } }, "type": "object" @@ -124757,9 +128083,13 @@ "additionalProperties": false, "properties": { "BucketName": { + "markdownDescription": "The full name of the S3 bucket that contains the object\\. This value correlates to the `Name` field of a bucket's properties in Amazon S3\\. \nThis value is case sensitive\\. In addition, don't use wildcard characters or specify partial values for the name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketName", "type": "string" }, "ObjectKey": { + "markdownDescription": "The full name of the S3 object\\. This value correlates to the `Key` field of an object's properties in Amazon S3\\. If the name includes a path, include the complete path\\. For example, `AllowLists/Macie/MyList.txt`\\. \nThis value is case sensitive\\. In addition, don't use wildcard characters or specify partial values for the name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObjectKey", "type": "string" } }, @@ -124805,7 +128135,7 @@ "additionalProperties": false, "properties": { "Description": { - "markdownDescription": "The description of the custom data identifier\\. The description can contain as many as 512 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A custom description of the custom data identifier\\. The description can contain 1\\-512 characters\\. \nAvoid including sensitive data in the description\\. Users of the account might be able to see the description, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Description", "type": "string" }, @@ -124813,7 +128143,7 @@ "items": { "type": "string" }, - "markdownDescription": "An array that lists specific character sequences \\(ignore words\\) to exclude from the results\\. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it\\. The array can contain as many as 10 ignore words\\. Each ignore word can contain 4\\-90 characters\\. Ignore words are case sensitive\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An array of character sequences \\(*ignore words*\\) to exclude from the results\\. If text matches the regular expression \\(`Regex`\\) but it contains a string in this array, Amazon Macie ignores the text and doesn't include it in the results\\. \nThe array can contain 1\\-10 ignore words\\. Each ignore word can contain 4\\-90 UTF\\-8 characters\\. Ignore words are case sensitive\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IgnoreWords", "type": "array" }, @@ -124821,22 +128151,22 @@ "items": { "type": "string" }, - "markdownDescription": "An array that lists specific character sequences \\(keywords\\), one of which must be within proximity \\(`MaximumMatchDistance`\\) of the regular expression to match\\. The array can contain as many as 50 keywords\\. Each keyword can contain 3\\-90 characters\\. Keywords aren't case sensitive\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An array of character sequences \\(*keywords*\\), one of which must precede and be in proximity \\(`MaximumMatchDistance`\\) of the regular expression \\(`Regex`\\) to match\\. \nThe array can contain 1\\-50 keywords\\. Each keyword can contain 3\\-90 UTF\\-8 characters\\. Keywords aren't case sensitive\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Keywords", "type": "array" }, "MaximumMatchDistance": { - "markdownDescription": "The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the `Keywords` array\\. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern\\. The distance can be 1\\-300 characters\\. The default value is 50\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum number of characters that can exist between the end of at least one complete character sequence specified by the `Keywords` array and the end of text that matches the regular expression \\(`Regex`\\)\\. If a complete keyword precedes all the text that matches the regular expression and the keyword is within the specified distance, Amazon Macie includes the result\\. \nThe distance can be 1\\-300 characters\\. The default value is 50\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaximumMatchDistance", "type": "number" }, "Name": { - "markdownDescription": "A custom name for the custom data identifier\\. The name can contain as many as 128 characters\\. \nWe strongly recommend that you avoid including any sensitive data in the name of a custom data identifier\\. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A custom name for the custom data identifier\\. The name can contain 1\\-128 characters\\. \nAvoid including sensitive data in the name of a custom data identifier\\. Users of the account might be able to see the name, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, "Regex": { - "markdownDescription": "The regular expression \\(*regex*\\) that defines the pattern to match\\. The expression can contain as many as 512 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The regular expression \\(*regex*\\) that defines the text pattern to match\\. The expression can contain 1\\-512 characters\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Regex", "type": "string" } @@ -124904,12 +128234,12 @@ "additionalProperties": false, "properties": { "Action": { - "markdownDescription": "The action to perform on findings that meet the filter criteria \\(`FindingCriteria`\\)\\. Valid values are: \n+ ARCHIVE \\- Suppress \\(automatically archive\\) the findings\\.\n+ NOOP \\- Don't perform any action on the findings\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action to perform on findings that match the filter criteria \\(`FindingCriteria`\\)\\. Valid values are: \n+ `ARCHIVE` \\- Suppress \\(automatically archive\\) the findings\\.\n+ `NOOP` \\- Don't perform any action on the findings\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Action", "type": "string" }, "Description": { - "markdownDescription": "A custom description of the filter\\. The description can contain as many as 512 characters\\. \nWe strongly recommend that you avoid including any sensitive data in the description of a filter\\. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A custom description of the findings filter\\. The description can contain 1\\-512 characters\\. \nAvoid including sensitive data in the description\\. Users of the account might be able to see the description, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, @@ -124919,12 +128249,12 @@ "title": "FindingCriteria" }, "Name": { - "markdownDescription": "A custom name for the filter\\. The name must contain at least 3 characters and can contain as many as 64 characters\\. \nWe strongly recommend that you avoid including any sensitive data in the name of a filter\\. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A custom name for the findings filter\\. The name can contain 3\\-64 characters\\. \nAvoid including sensitive data in the name\\. Users of the account might be able to see the name, depending on the actions that they're allowed to perform in Amazon Macie\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Position": { - "markdownDescription": "The position of the filter in the list of saved filters on the Amazon Macie console\\. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The position of the findings filter in the list of saved filters on the Amazon Macie console\\. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to findings\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Position", "type": "number" } @@ -124963,24 +128293,36 @@ "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "eq", "type": "array" }, "gt": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "gt", "type": "number" }, "gte": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "gte", "type": "number" }, "lt": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "lt", "type": "number" }, "lte": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "lte", "type": "number" }, "neq": { "items": { "type": "string" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "neq", "type": "array" } }, @@ -124991,7 +128333,7 @@ "properties": { "Criterion": { "additionalProperties": false, - "markdownDescription": "Specifies a condition that defines the property, operator, and value to use to filter the results\\. \n*Required*: No \n*Type*: [Criterion](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-findingsfilter-criterion.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a condition that defines the property, operator, and one or more values to use to filter the results\\. \n*Required*: No \n*Type*: Map of [CriterionAdditionalProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-macie-findingsfilter-criterionadditionalproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::Macie::FindingsFilter.CriterionAdditionalProperties" @@ -125007,12 +128349,12 @@ "additionalProperties": false, "properties": { "Id": { - "markdownDescription": "The unique identifier for the filter\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unique identifier for the findings filter\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Id", "type": "string" }, "Name": { - "markdownDescription": "The custom name of the filter\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The custom name of the findings filter\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" } @@ -125055,12 +128397,12 @@ "additionalProperties": false, "properties": { "FindingPublishingFrequency": { - "markdownDescription": "The frequency with which Amazon Macie publishes updates to policy findings for an account\\. This includes publishing updates to AWS Security Hub and Amazon EventBridge \\(formerly called Amazon CloudWatch Events\\)\\. Valid values are: \n+ FIFTEEN\\_MINUTES\n+ ONE\\_HOUR\n+ SIX\\_HOURS\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies how often Amazon Macie publishes updates to policy findings for the account\\. This includes publishing updates to AWS Security Hub and Amazon EventBridge \\(formerly Amazon CloudWatch Events\\)\\. Valid values are: \n+ FIFTEEN\\_MINUTES\n+ ONE\\_HOUR\n+ SIX\\_HOURS\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FindingPublishingFrequency", "type": "string" }, "Status": { - "markdownDescription": "The `MacieStatus` of the `Session`\\. Valid values include `ENABLED` and `PAUSED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The status of Amazon Macie for the account\\. Valid values are: `ENABLED`, start or resume all Macie activities for the account; and, `PAUSED`, suspend all Macie activities for the account\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Status", "type": "string" } @@ -125173,7 +128515,7 @@ "additionalProperties": false, "properties": { "ProposalDurationInHours": { - "markdownDescription": "The duration from the time that a proposal is created until it expires\\. If members cast neither the required number of `YES` votes to approve the proposal nor the number of `NO` votes required to reject it before the duration expires, the proposal is `EXPIRED` and `ProposalActions` are not carried out\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `168` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The duration from the time that a proposal is created until it expires\\. If members cast neither the required number of `YES` votes to approve the proposal nor the number of `NO` votes required to reject it before the duration expires, the proposal is `EXPIRED` and `ProposalActions` aren't carried out\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `168` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProposalDurationInHours", "type": "number" }, @@ -125364,7 +128706,7 @@ "type": "string" }, "NetworkId": { - "markdownDescription": "The unique identifier of the network for the node\\. \nEthereum public networks have the following `NetworkId`s: \n+ `n-ethereum-mainnet` \n+ `n-ethereum-rinkeby` \n+ `n-ethereum-ropsten` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unique identifier of the network for the node\\. \nEthereum public networks have the following `NetworkId`s: \n+ `n-ethereum-mainnet` \n+ `n-ethereum-goerli` \n+ `n-ethereum-rinkeby` \n+ `n-ethereum-ropsten` \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `32` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NetworkId", "type": "string" }, @@ -125562,15 +128904,19 @@ "additionalProperties": false, "properties": { "FailoverMode": { + "markdownDescription": "The type of failover you choose for this flow\\. MERGE combines the source streams into a single stream, allowing graceful recovery from any single\\-source loss\\. FAILOVER allows switching between different streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailoverMode", "type": "string" }, "RecoveryWindow": { - "markdownDescription": "The size of the buffer \\(delay\\) that the service maintains\\. A larger buffer means a longer delay in transmitting the stream, but more room for error correction\\. A smaller buffer means a shorter delay, but less room for error correction\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The size of the buffer \\(delay\\) that the service maintains\\. A larger buffer means a longer delay in transmitting the stream, but more room for error correction\\. A smaller buffer means a shorter delay, but less room for error correction\\. You can choose a value from 100\\-500 ms\\. If you keep this field blank, the service uses the default value of 200 ms\\. This setting only applies when Failover Mode is set to MERGE\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RecoveryWindow", "type": "number" }, "SourcePriority": { - "$ref": "#/definitions/AWS::MediaConnect::Flow.SourcePriority" + "$ref": "#/definitions/AWS::MediaConnect::Flow.SourcePriority", + "markdownDescription": "The priority you want to assign to a source\\. You can have a primary stream and a backup stream or two equally prioritized streams\\. This setting only applies when Failover Mode is set to FAILOVER\\. \n*Required*: No \n*Type*: [SourcePriority](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediaconnect-flow-sourcepriority.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourcePriority" }, "State": { "markdownDescription": "The state of source failover on the flow\\. If the state is disabled, the flow can have only one source\\. If the state is enabled, the flow can have one or two sources\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -125629,14 +128975,18 @@ "type": "string" }, "Protocol": { - "markdownDescription": "The protocol that is used by the source\\. For a full list of available protocols, see: [Source protocols](https://docs.aws.amazon.com/mediaconnect/latest/api/v1-flows-flowarn-source.html#v1-flows-flowarn-source-prop-setsourcerequest-protocol) in the *AWS Elemental MediaConnect API Reference*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The protocol that is used by the source\\. AWS CloudFormation does not currently support CDI or ST 2110 JPEG XS source protocols\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Protocol", "type": "string" }, "SenderControlPort": { + "markdownDescription": "The port that the flow uses to send outbound requests to initiate connection with the sender\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SenderControlPort", "type": "number" }, "SenderIpAddress": { + "markdownDescription": "The IP address that the flow communicates with to initiate connection with the sender\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SenderIpAddress", "type": "string" }, "SourceArn": { @@ -125650,9 +129000,13 @@ "type": "string" }, "SourceListenerAddress": { + "markdownDescription": "Source IP or domain name for SRT\\-caller protocol\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceListenerAddress", "type": "string" }, "SourceListenerPort": { + "markdownDescription": "Source port for SRT\\-caller protocol\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceListenerPort", "type": "number" }, "StreamId": { @@ -125677,6 +129031,8 @@ "additionalProperties": false, "properties": { "PrimarySource": { + "markdownDescription": "The name of the source you choose as the primary source for this flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PrimarySource", "type": "string" } }, @@ -125902,12 +129258,12 @@ "title": "Encryption" }, "FlowArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow this output is attached to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FlowArn", "type": "string" }, "MaxLatency": { - "markdownDescription": "The maximum latency in milliseconds for Zixi\\-based streams\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum latency in milliseconds\\. This parameter applies only to RIST\\-based, Zixi\\-based, and Fujitsu\\-based streams\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxLatency", "type": "number" }, @@ -125942,7 +129298,7 @@ "type": "number" }, "StreamId": { - "markdownDescription": "The stream ID that you want to use for the transport\\. This parameter applies only to Zixi\\-based streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The stream ID that you want to use for this transport\\. This parameter applies only to Zixi and SRT caller\\-based streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamId", "type": "string" }, @@ -126071,7 +129427,7 @@ "type": "string" }, "FlowArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the flow this source is connected to\\. The flow must have Failover enabled to add an additional source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FlowArn", "type": "string" }, @@ -126096,12 +129452,12 @@ "type": "string" }, "Protocol": { - "markdownDescription": "The protocol that the source uses to deliver the content to MediaConnect\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The protocol that the source uses to deliver the content to MediaConnect\\. Adding additional sources to an existing flow requires Failover to be enabled\\. When you enable Failover, the additional source must use the same protocol as the existing source\\. Only the following protocols support failover: Zixi\\-push, RTP\\-FEC, RTP, and RIST\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Protocol", "type": "string" }, "StreamId": { - "markdownDescription": "The stream ID that you want to use for the transport\\. This parameter applies only to Zixi\\-based streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The stream ID that you want to use for this transport\\. This parameter applies only to Zixi and SRT caller\\-based streams\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamId", "type": "string" }, @@ -128962,7 +132318,7 @@ "type": "string" }, "ProgramDateTimeClock": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the algorithm used to drive the HLS EXT\\-X\\-PROGRAM\\-DATE\\-TIME clock\\. Options include: INITIALIZE\\_FROM\\_OUTPUT\\_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment\\. SYSTEM\\_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment\\. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProgramDateTimeClock", "type": "string" }, @@ -129330,7 +132686,7 @@ "title": "NetworkInputSettings" }, "Scte35Pid": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Scte35Pid", "type": "number" }, @@ -131274,12 +134630,12 @@ "type": "string" }, "SourceArn": { - "markdownDescription": "The ARN for the source content in Amazon S3\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN for the source content in Amazon S3\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceArn", "type": "string" }, "SourceRoleArn": { - "markdownDescription": "The ARN for the IAM role that provides AWS Elemental MediaPackage access to the Amazon S3 bucket where the source content is stored\\. Valid format: arn:aws:iam::\\{accountID\\}:role/\\{name\\} \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN for the IAM role that provides AWS Elemental MediaPackage access to the Amazon S3 bucket where the source content is stored\\. Valid format: arn:aws:iam::\\{accountID\\}:role/\\{name\\} \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceRoleArn", "type": "string" }, @@ -131383,11 +134739,13 @@ }, "EgressAccessLogs": { "$ref": "#/definitions/AWS::MediaPackage::Channel.LogConfiguration", - "markdownDescription": "Configures egress access logs\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configures egress access logs\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EgressAccessLogs" }, "HlsIngest": { - "$ref": "#/definitions/AWS::MediaPackage::Channel.HlsIngest" + "$ref": "#/definitions/AWS::MediaPackage::Channel.HlsIngest", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [HlsIngest](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-hlsingest.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HlsIngest" }, "Id": { "markdownDescription": "Unique identifier that you assign to the channel\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -131396,7 +134754,7 @@ }, "IngressAccessLogs": { "$ref": "#/definitions/AWS::MediaPackage::Channel.LogConfiguration", - "markdownDescription": "Configures ingress access logs\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Configures ingress access logs\\. \n*Required*: No \n*Type*: [LogConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-logconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IngressAccessLogs" }, "Tags": { @@ -131441,6 +134799,8 @@ "items": { "$ref": "#/definitions/AWS::MediaPackage::Channel.IngestEndpoint" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [IngestEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-channel-ingestendpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ingestEndpoints", "type": "array" } }, @@ -131450,15 +134810,23 @@ "additionalProperties": false, "properties": { "Id": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Id", "type": "string" }, "Password": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Password", "type": "string" }, "Url": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Url", "type": "string" }, "Username": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Username", "type": "string" } }, @@ -131474,7 +134842,7 @@ "additionalProperties": false, "properties": { "LogGroupName": { - "markdownDescription": "Sets a custom Amazon CloudWatch log group name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Sets a custom Amazon CloudWatch log group name\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogGroupName", "type": "string" } @@ -131522,7 +134890,7 @@ "title": "Authorization" }, "ChannelId": { - "markdownDescription": "The ID of the channel associated with this endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of the channel associated with this endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ChannelId", "type": "string" }, @@ -131562,12 +134930,12 @@ "title": "MssPackage" }, "Origination": { - "markdownDescription": "Controls video origination from this endpoint\\. \n+ **ALLOW** \\- enables this endpoint to serve content to requesting devices\\.\n+ **DENY** \\- prevents this endpoint from serving content\\. Denying origination is helpful for harvesting live\\-to\\-VOD assets\\. For more information about harvesting and origination, see [Live\\-to\\-VOD Requirements](https://docs.aws.amazon.com/mediapackage/latest/ug/ltov-reqmts.html)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Controls video origination from this endpoint\\. \nValid values: \n+ **ALLOW** \\- enables this endpoint to serve content to requesting devices\\.\n+ **DENY** \\- prevents this endpoint from serving content\\. Denying origination is helpful for harvesting live\\-to\\-VOD assets\\. For more information about harvesting and origination, see [Live\\-to\\-VOD Requirements](https://docs.aws.amazon.com/mediapackage/latest/ug/ltov-reqmts.html)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Origination", "type": "string" }, "StartoverWindowSeconds": { - "markdownDescription": "Maximum duration \\(seconds\\) of content to retain for startover playback\\. Omit this attribute or enter `0` to indicate that startover playback is disabled for this endpoint\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Maximum duration \\(seconds\\) of content to retain for startover playback\\. Omit this attribute or enter `0` to indicate that startover playback is disabled for this endpoint\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StartoverWindowSeconds", "type": "number" }, @@ -131580,7 +134948,7 @@ "type": "array" }, "TimeDelaySeconds": { - "markdownDescription": "Minimum duration \\(seconds\\) of delay to enforce on the playback of live content\\. Omit this attribute or enter `0` to indicate that there is no time delay in effect for this endpoint \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Minimum duration \\(seconds\\) of delay to enforce on the playback of live content\\. Omit this attribute or enter `0` to indicate that there is no time delay in effect for this endpoint\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TimeDelaySeconds", "type": "number" }, @@ -131624,12 +134992,12 @@ "additionalProperties": false, "properties": { "CdnIdentifierSecret": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the secret in AWS Secrets Manager that your Content Distribution Network \\(CDN\\) uses for authorization to access your endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the secret in AWS Secrets Manager that your Content Delivery Network \\(CDN\\) uses for authorization to access your endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CdnIdentifierSecret", "type": "string" }, "SecretsRoleArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the IAM role that allows AWS Elemental MediaPackage to communicate with AWS Secrets Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsRoleArn", "type": "string" } @@ -131644,15 +135012,17 @@ "additionalProperties": false, "properties": { "ConstantInitializationVector": { - "markdownDescription": "An optional 128\\-bit, 16\\-byte hex value represented by a 32\\-character string, used in conjunction with the key for encrypting blocks\\. If you don't specify a value, then MediaPackage creates the constant initialization vector \\(IV\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional 128\\-bit, 16\\-byte hex value represented by a 32\\-character string, used in conjunction with the key for encrypting blocks\\. If you don't specify a value, then AWS Elemental MediaPackage creates the constant initialization vector \\(IV\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConstantInitializationVector", "type": "string" }, "EncryptionMethod": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionMethod", "type": "string" }, "KeyRotationIntervalSeconds": { - "markdownDescription": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeyRotationIntervalSeconds", "type": "number" }, @@ -131695,7 +135065,7 @@ }, "StreamSelection": { "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.StreamSelection", - "markdownDescription": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamSelection" } }, @@ -131705,7 +135075,7 @@ "additionalProperties": false, "properties": { "KeyRotationIntervalSeconds": { - "markdownDescription": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeyRotationIntervalSeconds", "type": "number" }, @@ -131727,12 +135097,12 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies the SCTE\\-35 message types that MediaPackage treats as ad markers in the output manifest\\. \n Valid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **PROVIDER\\_ADVERTISEMENT**\\.\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **SPLICE\\_INSERT**\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the SCTE\\-35 message types that AWS Elemental MediaPackage treats as ad markers in the output manifest\\. \nValid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **PROVIDER\\_ADVERTISEMENT**\\.\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\\.\n+ **SPLICE\\_INSERT**\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdTriggers", "type": "array" }, "AdsOnDeliveryRestrictions": { - "markdownDescription": "The flags on SCTE\\-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The flags on SCTE\\-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in AWS Elemental MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdsOnDeliveryRestrictions", "type": "string" }, @@ -131742,10 +135112,12 @@ "title": "Encryption" }, "IncludeIframeOnlyStream": { + "markdownDescription": "This applies only to stream sets with a single video track\\. When true, the stream set includes an additional I\\-frame trick\\-play only stream, along with the other tracks\\. If false, this extra stream is not included\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludeIframeOnlyStream", "type": "boolean" }, "ManifestLayout": { - "markdownDescription": "Determines the position of some tags in the manifest\\. \nOptions: \n+ **FULL** \\- elements like `SegmentTemplate` and `ContentProtection` are included in each `Representation`\\.\n+ **COMPACT** \\- duplicate elements are combined and presented at the `AdaptationSet` level\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the position of some tags in the manifest\\. \nValid values: \n+ **FULL** \\- Elements like `SegmentTemplate` and `ContentProtection` are included in each `Representation`\\.\n+ **COMPACT** \\- Duplicate elements are combined and presented at the `AdaptationSet` level\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ManifestLayout", "type": "string" }, @@ -131768,22 +135140,22 @@ "items": { "type": "string" }, - "markdownDescription": "Controls whether MediaPackage produces single\\-period or multi\\-period DASH manifests\\. For more information about periods, see [Multi\\-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html)\\. \nValid values: \n+ **ADS** \\- MediaPackage will produce multi\\-period DASH manifests\\. Periods are created based on the SCTE\\-35 ad markers present in the input manifest\\.\n+ *No value* \\- MediaPackage will produce single\\-period DASH manifests\\. This is the default setting\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Controls whether AWS Elemental MediaPackage produces single\\-period or multi\\-period DASH manifests\\. For more information about periods, see [Multi\\-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html)\\. \nValid values: \n+ **ADS** \\- AWS Elemental MediaPackage will produce multi\\-period DASH manifests\\. Periods are created based on the SCTE\\-35 ad markers present in the input manifest\\.\n+ *No value* \\- AWS Elemental MediaPackage will produce single\\-period DASH manifests\\. This is the default setting\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PeriodTriggers", "type": "array" }, "Profile": { - "markdownDescription": "DASH profile for the output, such as HbbTV\\. \nValid values: \n+ **NONE** \\- the output doesn't use a DASH profile\\.\n+ **HBBTV\\_1\\_5** \\- the output is HbbTV\\-compliant\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The DASH profile for the output\\. \nValid values: \n+ **NONE** \\- The output doesn't use a DASH profile\\.\n+ **HBBTV\\_1\\_5** \\- The output is compliant with HbbTV v1\\.5\\.\n+ **DVB\\_DASH\\_2014** \\- The output is compliant with DVB\\-DASH 2014\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Profile", "type": "string" }, "SegmentDurationSeconds": { - "markdownDescription": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SegmentDurationSeconds", "type": "number" }, "SegmentTemplateFormat": { - "markdownDescription": "Determines the type of variable used in the `media` URL of the `SegmentTemplate` tag in the manifest\\. Also specifies if segment timeline information is included in `SegmentTimeline` or `SegmentTemplate`\\. \n+ **NUMBER\\_WITH\\_TIMELINE** \\- The `$Number$` variable is used in the `media` URL\\. The value of this variable is the sequential number of the segment\\. A full `SegmentTimeline` object is presented in each `SegmentTemplate`\\.\n+ **NUMBER\\_WITH\\_DURATION** \\- The `$Number$` variable is used in the `media` URL and a `duration` attribute is added to the segment template\\. The `SegmentTimeline` object is removed from the representation\\.\n+ **TIME\\_WITH\\_TIMELINE** \\- The `$Time$` variable is used in the `media` URL\\. The value of this variable is the timestamp of when the segment starts\\. A full `SegmentTimeline` object is presented in each `SegmentTemplate`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the type of variable used in the `media` URL of the `SegmentTemplate` tag in the manifest\\. Also specifies if segment timeline information is included in `SegmentTimeline` or `SegmentTemplate`\\. \nValid values: \n+ **NUMBER\\_WITH\\_TIMELINE** \\- The `$Number$` variable is used in the `media` URL\\. The value of this variable is the sequential number of the segment\\. A full `SegmentTimeline` object is presented in each `SegmentTemplate`\\.\n+ **NUMBER\\_WITH\\_DURATION** \\- The `$Number$` variable is used in the `media` URL and a `duration` attribute is added to the segment template\\. The `SegmentTimeline` object is removed from the representation\\.\n+ **TIME\\_WITH\\_TIMELINE** \\- The `$Time$` variable is used in the `media` URL\\. The value of this variable is the timestamp of when the segment starts\\. A full `SegmentTimeline` object is presented in each `SegmentTemplate`\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SegmentTemplateFormat", "type": "string" }, @@ -131798,12 +135170,12 @@ "type": "number" }, "UtcTiming": { - "markdownDescription": "Determines the type of UTC timing included in the DASH Media Presentation Description \\(MPD\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines the type of UTC timing included in the DASH Media Presentation Description \\(MPD\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UtcTiming", "type": "string" }, "UtcTimingUri": { - "markdownDescription": "Specifies the value attribute of the UTC timing field when utcTiming is set to HTTP\\-ISO or HTTP\\-HEAD\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the value attribute of the UTC timing field when utcTiming is set to HTTP\\-ISO or HTTP\\-HEAD\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UtcTimingUri", "type": "string" } @@ -131814,9 +135186,13 @@ "additionalProperties": false, "properties": { "PresetSpeke20Audio": { + "markdownDescription": "A collection of audio encryption presets\\. \nValue description: \n+ `PRESET-AUDIO-1` \\- Use one content key to encrypt all of the audio tracks in your stream\\.\n+ `PRESET-AUDIO-2` \\- Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks\\.\n+ `PRESET-AUDIO-3` \\- Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels\\.\n+ `SHARED` \\- Use the same content key for all of the audio and video tracks in your stream\\.\n+ `UNENCRYPTED` \\- Don't encrypt any of the audio tracks in your stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PresetSpeke20Audio", "type": "string" }, "PresetSpeke20Video": { + "markdownDescription": "A collection of video encryption presets\\. \nValue description: \n+ `PRESET-VIDEO-1` \\- Use one content key to encrypt all of the video tracks in your stream\\.\n+ `PRESET-VIDEO-2` \\- Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks\\.\n+ `PRESET-VIDEO-3` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-4` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `PRESET-VIDEO-5` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `PRESET-VIDEO-6` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-7` \\- Use one content key to encrypt all of the SD\\+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-8` \\- Use one content key to encrypt all of the SD\\+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `SHARED` \\- Use the same content key for all of the video and audio tracks in your stream\\.\n+ `UNENCRYPTED` \\- Don't encrypt any of the video tracks in your stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PresetSpeke20Video", "type": "string" } }, @@ -131835,17 +135211,17 @@ "type": "string" }, "EncryptionMethod": { - "markdownDescription": "HLS encryption type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "HLS encryption type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EncryptionMethod", "type": "string" }, "KeyRotationIntervalSeconds": { - "markdownDescription": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Number of seconds before AWS Elemental MediaPackage rotates to a new key\\. By default, rotation is set to 60 seconds\\. Set to `0` to disable key rotation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KeyRotationIntervalSeconds", "type": "number" }, "RepeatExtXKey": { - "markdownDescription": "Repeat the `EXT-X-KEY `directive for every media segment\\. This might result in an increase in client requests to the DRM server\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Repeat the `EXT-X-KEY `directive for every media segment\\. This might result in an increase in client requests to the DRM server\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RepeatExtXKey", "type": "boolean" }, @@ -131864,7 +135240,7 @@ "additionalProperties": false, "properties": { "AdMarkers": { - "markdownDescription": "Controls how ad markers are included in the packaged endpoint\\. Valid values are `none`, `passthrough`, or `scte35_enhanced`\\. \n+ **NONE** \\- omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Controls how ad markers are included in the packaged endpoint\\. \nValid values: \n+ **NONE** \\- Omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- Creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- Generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdMarkers", "type": "string" }, @@ -131872,12 +135248,12 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies the SCTE\\-35 message types that MediaPackage treats as ad markers in the output manifest\\. \nValid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_ADVERTISEMENT**\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\n+ **SPLICE\\_INSERT**\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the SCTE\\-35 message types that AWS Elemental MediaPackage treats as ad markers in the output manifest\\. \nValid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_ADVERTISEMENT**\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\n+ **SPLICE\\_INSERT**\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdTriggers", "type": "array" }, "AdsOnDeliveryRestrictions": { - "markdownDescription": "The flags on SCTE\\-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The flags on SCTE\\-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in AWS Elemental MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdsOnDeliveryRestrictions", "type": "string" }, @@ -131926,7 +135302,7 @@ "additionalProperties": false, "properties": { "AdMarkers": { - "markdownDescription": "Controls how ad markers are included in the packaged endpoint\\. Valid values are `none`, `passthrough`, or `scte35_enhanced`\\. \n+ **NONE** \\- omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Controls how ad markers are included in the packaged endpoint\\. \nValid values: \n+ **NONE** \\- Omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- Creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- Generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdMarkers", "type": "string" }, @@ -131934,12 +135310,12 @@ "items": { "type": "string" }, - "markdownDescription": "Specifies the SCTE\\-35 message types that MediaPackage treats as ad markers in the output manifest\\. \n Valid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_ADVERTISEMENT**\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\n+ **SPLICE\\_INSERT**\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the SCTE\\-35 message types that AWS Elemental MediaPackage treats as ad markers in the output manifest\\. \nValid values: \n+ **BREAK**\n+ **DISTRIBUTOR\\_ADVERTISEMENT**\n+ **DISTRIBUTOR\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **DISTRIBUTOR\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_ADVERTISEMENT**\n+ **PROVIDER\\_OVERLAY\\_PLACEMENT\\_OPPORTUNITY**\n+ **PROVIDER\\_PLACEMENT\\_OPPORTUNITY**\n+ **SPLICE\\_INSERT**\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdTriggers", "type": "array" }, "AdsOnDeliveryRestrictions": { - "markdownDescription": "The flags on SCTE\\-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The flags on SCTE\\-35 segmentation descriptors that have to be present for AWS Elemental MediaPackage to insert ad markers in the output manifest\\. For information about SCTE\\-35 in AWS Elemental MediaPackage, see [SCTE\\-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdsOnDeliveryRestrictions", "type": "string" }, @@ -131949,10 +135325,12 @@ "title": "Encryption" }, "IncludeDvbSubtitles": { + "markdownDescription": "When enabled, MediaPackage passes through digital video broadcasting \\(DVB\\) subtitles into the output\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludeDvbSubtitles", "type": "boolean" }, "IncludeIframeOnlyStream": { - "markdownDescription": "Only applies to stream sets with a single video track\\. When true, the stream set includes an additional I\\-frame only stream, along with the other tracks\\. If false, this extra stream is not included\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Only applies to stream sets with a single video track\\. When true, the stream set includes an additional I\\-frame only stream, along with the other tracks\\. If false, this extra stream is not included\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeIframeOnlyStream", "type": "boolean" }, @@ -131972,7 +135350,7 @@ "type": "number" }, "SegmentDurationSeconds": { - "markdownDescription": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SegmentDurationSeconds", "type": "number" }, @@ -132023,7 +135401,7 @@ }, "StreamSelection": { "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.StreamSelection", - "markdownDescription": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamSelection" } }, @@ -132033,15 +135411,17 @@ "additionalProperties": false, "properties": { "CertificateArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the certificate that you imported to AWS Certificate Manager to add content key encryption to this endpoint\\. For this feature to work, your DRM key provider must support content key encryption\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the certificate that you imported to AWS Certificate Manager to add content key encryption to this endpoint\\. For this feature to work, your DRM key provider must support content key encryption\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CertificateArn", "type": "string" }, "EncryptionContractConfiguration": { - "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.EncryptionContractConfiguration" + "$ref": "#/definitions/AWS::MediaPackage::OriginEndpoint.EncryptionContractConfiguration", + "markdownDescription": "Use `encryptionContractConfiguration` to configure one or more content encryption keys for your endpoints that use SPEKE Version 2\\.0\\. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream\\. To configure the encryption contract, specify which audio and video encryption presets to use\\. \n*Required*: No \n*Type*: [EncryptionContractConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-originendpoint-encryptioncontractconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionContractConfiguration" }, "ResourceId": { - "markdownDescription": "Unique identifier for this endpoint, as it is configured in the key provider service\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Unique identifier for this endpoint, as it is configured in the key provider service\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceId", "type": "string" }, @@ -132054,7 +135434,7 @@ "items": { "type": "string" }, - "markdownDescription": "List of unique identifiers for the DRM systems to use, as defined in the CPIX specification\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "List of unique identifiers for the DRM systems to use, as defined in the CPIX specification\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SystemIds", "type": "array" }, @@ -132150,7 +135530,7 @@ }, "MssPackage": { "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.MssPackage", - "markdownDescription": "Parameters for Microsoft Smooth Streaming packaging\\. \n*Required*: No \n*Type*: [MssPackage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-msspackage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Parameters for Microsoft Smooth Streaming packaging\\. \n*Required*: No \n*Type*: [MssPackage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-msspackage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MssPackage" }, "PackagingGroupId": { @@ -132225,7 +135605,7 @@ "type": "array" }, "IncludeEncoderConfigurationInSegments": { - "markdownDescription": "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set \\(SPS\\), Picture Parameter Set \\(PPS\\), and Video Parameter Set \\(VPS\\) metadata in every video segment instead of in the init fragment\\. This lets you use different SPS/PPS/VPS settings for your assets during content playback\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When includeEncoderConfigurationInSegments is set to true, AWS Elemental MediaPackage places your encoder's Sequence Parameter Set \\(SPS\\), Picture Parameter Set \\(PPS\\), and Video Parameter Set \\(VPS\\) metadata in every video segment instead of in the init fragment\\. This lets you use different SPS/PPS/VPS settings for your assets during content playback\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeEncoderConfigurationInSegments", "type": "boolean" }, @@ -132278,11 +135658,13 @@ "type": "string" }, "ScteMarkersSource": { + "markdownDescription": "The source of scte markers used\\. \nValue description: \n+ `SEGMENTS` \\- The scte markers are sourced from the segments of the ingested content\\.\n+ `MANIFEST` \\- the scte markers are sourced from the manifest of the ingested content\\. The MANIFEST value is compatible with source HLS playlists using the SCTE\\-35 Enhanced syntax \\(`EXT-OATCLS-SCTE35` tags\\)\\. SCTE\\-35 Elemental and SCTE\\-35 Daterange syntaxes are not supported with this option\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ScteMarkersSource", "type": "string" }, "StreamSelection": { "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.StreamSelection", - "markdownDescription": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Limitations for outputs from the endpoint, based on the video bitrate\\. \n*Required*: No \n*Type*: [StreamSelection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-streamselection.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StreamSelection" } }, @@ -132305,18 +135687,20 @@ "title": "Encryption" }, "IncludeEncoderConfigurationInSegments": { - "markdownDescription": "When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set \\(SPS\\), Picture Parameter Set \\(PPS\\), and Video Parameter Set \\(VPS\\) metadata in every video segment instead of in the init fragment\\. This lets you use different SPS/PPS/VPS settings for your assets during content playback\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "When includeEncoderConfigurationInSegments is set to true, AWS Elemental MediaPackage places your encoder's Sequence Parameter Set \\(SPS\\), Picture Parameter Set \\(PPS\\), and Video Parameter Set \\(VPS\\) metadata in every video segment instead of in the init fragment\\. This lets you use different SPS/PPS/VPS settings for your assets during content playback\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludeEncoderConfigurationInSegments", "type": "boolean" }, "IncludeIframeOnlyStream": { + "markdownDescription": "This applies only to stream sets with a single video track\\. When true, the stream set includes an additional I\\-frame trick\\-play only stream, along with the other tracks\\. If false, this extra stream is not included\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludeIframeOnlyStream", "type": "boolean" }, "PeriodTriggers": { "items": { "type": "string" }, - "markdownDescription": "Controls whether MediaPackage produces single\\-period or multi\\-period DASH manifests\\. For more information about periods, see [Multi\\-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html)\\. \nValid values: \n+ **ADS** \\- MediaPackage will produce multi\\-period DASH manifests\\. Periods are created based on the SCTE\\-35 ad markers present in the input manifest\\.\n+ *No value* \\- MediaPackage will produce single\\-period DASH manifests\\. This is the default setting\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Controls whether AWS Elemental MediaPackage produces single\\-period or multi\\-period DASH manifests\\. For more information about periods, see [Multi\\-period DASH in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html)\\. \nValid values: \n+ **ADS** \\- AWS Elemental MediaPackage will produce multi\\-period DASH manifests\\. Periods are created based on the SCTE\\-35 ad markers present in the input manifest\\.\n+ *No value* \\- AWS Elemental MediaPackage will produce single\\-period DASH manifests\\. This is the default setting\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PeriodTriggers", "type": "array" }, @@ -132340,9 +135724,13 @@ "additionalProperties": false, "properties": { "PresetSpeke20Audio": { + "markdownDescription": "A collection of audio encryption presets\\. \nValue description: \n+ `PRESET-AUDIO-1` \\- Use one content key to encrypt all of the audio tracks in your stream\\.\n+ `PRESET-AUDIO-2` \\- Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks\\.\n+ `PRESET-AUDIO-3` \\- Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels\\.\n+ `SHARED` \\- Use the same content key for all of the audio and video tracks in your stream\\.\n+ `UNENCRYPTED` \\- Don't encrypt any of the audio tracks in your stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PresetSpeke20Audio", "type": "string" }, "PresetSpeke20Video": { + "markdownDescription": "A collection of video encryption presets\\. \nValue description: \n+ `PRESET-VIDEO-1` \\- Use one content key to encrypt all of the video tracks in your stream\\.\n+ `PRESET-VIDEO-2` \\- Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks\\.\n+ `PRESET-VIDEO-3` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-4` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `PRESET-VIDEO-5` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `PRESET-VIDEO-6` \\- Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-7` \\- Use one content key to encrypt all of the SD\\+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks\\.\n+ `PRESET-VIDEO-8` \\- Use one content key to encrypt all of the SD\\+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks\\.\n+ `SHARED` \\- Use the same content key for all of the video and audio tracks in your stream\\.\n+ `UNENCRYPTED` \\- Don't encrypt any of the video tracks in your stream\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PresetSpeke20Video", "type": "string" } }, @@ -132356,12 +135744,12 @@ "additionalProperties": false, "properties": { "ConstantInitializationVector": { - "markdownDescription": "A 128\\-bit, 16\\-byte hex value represented by a 32\\-character string, used with the key for encrypting blocks\\. If you don't specify a constant initialization vector \\(IV\\), MediaPackage periodically rotates the IV\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A 128\\-bit, 16\\-byte hex value represented by a 32\\-character string, used with the key for encrypting blocks\\. If you don't specify a constant initialization vector \\(IV\\), AWS Elemental MediaPackage periodically rotates the IV\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ConstantInitializationVector", "type": "string" }, "EncryptionMethod": { - "markdownDescription": "HLS encryption type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "HLS encryption type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EncryptionMethod", "type": "string" }, @@ -132380,7 +135768,7 @@ "additionalProperties": false, "properties": { "AdMarkers": { - "markdownDescription": "This setting controls ad markers in the packaged content\\. **NONE** omits SCTE\\-35 ad markers from the output\\. **PASSTHROUGH** copies SCTE\\-35 ad markers from the source content to the output\\. **SCTE35\\_ENHANCED** generates ad markers and blackout tags in the output, based on SCTE\\-35 messages in the source content\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This setting controls ad markers in the packaged content\\. \nValid values: \n+ **NONE** \\- Omits all SCTE\\-35 ad markers from the output\\.\n+ **PASSTHROUGH** \\- Creates a copy in the output of the SCTE\\-35 ad markers \\(comments\\) taken directly from the input manifest\\.\n+ **SCTE35\\_ENHANCED** \\- Generates ad markers and blackout tags in the output based on the SCTE\\-35 messages from the input manifest\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdMarkers", "type": "string" }, @@ -132429,6 +135817,8 @@ "type": "array" }, "IncludeDvbSubtitles": { + "markdownDescription": "When enabled, MediaPackage passes through digital video broadcasting \\(DVB\\) subtitles into the output\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludeDvbSubtitles", "type": "boolean" }, "SegmentDurationSeconds": { @@ -132494,7 +135884,7 @@ "type": "array" }, "SegmentDurationSeconds": { - "markdownDescription": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Duration \\(in seconds\\) of each fragment\\. Actual fragments are rounded to the nearest multiple of the source fragment duration\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SegmentDurationSeconds", "type": "number" } @@ -132508,7 +135898,9 @@ "additionalProperties": false, "properties": { "EncryptionContractConfiguration": { - "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.EncryptionContractConfiguration" + "$ref": "#/definitions/AWS::MediaPackage::PackagingConfiguration.EncryptionContractConfiguration", + "markdownDescription": "Use `encryptionContractConfiguration` to configure one or more content encryption keys for your endpoints that use SPEKE Version 2\\.0\\. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream\\. To configure the encryption contract, specify which audio and video encryption presets to use\\. \n*Required*: No \n*Type*: [EncryptionContractConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediapackage-packagingconfiguration-encryptioncontractconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionContractConfiguration" }, "RoleArn": { "markdownDescription": "The ARN for the IAM role that's granted by the key provider to provide access to the key provider API\\. Valid format: arn:aws:iam::\\{accountID\\}:role/\\{name\\} \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -132519,7 +135911,7 @@ "items": { "type": "string" }, - "markdownDescription": "List of unique identifiers for the DRM systems to use, as defined in the CPIX specification\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "List of unique identifiers for the DRM systems to use, as defined in the CPIX specification\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SystemIds", "type": "array" }, @@ -132540,12 +135932,12 @@ "additionalProperties": false, "properties": { "MaxVideoBitsPerSecond": { - "markdownDescription": "The upper limit of the bitrates that this endpoint serves\\. If the video track exceeds this threshold, then AWS Elemental MediaPackage excludes it from output\\. If you don't specify a value, it defaults to 2147483647 bits per second\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The upper limit of the bitrates that this endpoint serves\\. If the video track exceeds this threshold, then AWS Elemental MediaPackage excludes it from output\\. If you don't specify a value, it defaults to 2147483647 bits per second\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxVideoBitsPerSecond", "type": "number" }, "MinVideoBitsPerSecond": { - "markdownDescription": "The lower limit of the bitrates that this endpoint serves\\. If the video track is below this threshold, then AWS Elemental MediaPackage excludes it from output\\. If you don't specify a value, it defaults to 0 bits per second\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The lower limit of the bitrates that this endpoint serves\\. If the video track is below this threshold, then AWS Elemental MediaPackage excludes it from output\\. If you don't specify a value, it defaults to 0 bits per second\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MinVideoBitsPerSecond", "type": "number" }, @@ -132651,7 +136043,7 @@ "type": "string" }, "SecretsRoleArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the IAM role that allows AWS Elemental MediaPackage to communicate with AWS Secrets Manager\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SecretsRoleArn", "type": "string" } @@ -132733,7 +136125,7 @@ }, "MetricPolicy": { "$ref": "#/definitions/AWS::MediaStore::Container.MetricPolicy", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [MetricPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-metricpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [MetricPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediastore-container-metricpolicy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricPolicy" }, "Policy": { @@ -132745,7 +136137,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -132897,57 +136289,87 @@ "additionalProperties": false, "properties": { "AdDecisionServerUrl": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdDecisionServerUrl", "type": "string" }, "AvailSuppression": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.AvailSuppression" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.AvailSuppression", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AvailSuppression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-availsuppression.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AvailSuppression" }, "Bumper": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.Bumper" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.Bumper", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Bumper](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-bumper.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Bumper" }, "CdnConfiguration": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.CdnConfiguration" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.CdnConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [CdnConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-cdnconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CdnConfiguration" }, "ConfigurationAliases": { "additionalProperties": true, + "markdownDescription": "The player parameters and aliases used as dynamic variables during session initialization\\. For more information, see [Domain Variables](https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html)\\. \n*Required*: No \n*Type*: Map of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "object" } }, + "title": "ConfigurationAliases", "type": "object" }, "DashConfiguration": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.DashConfiguration" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.DashConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DashConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-dashconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DashConfiguration" }, "HlsConfiguration": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.HlsConfiguration" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.HlsConfiguration", + "markdownDescription": "The configuration for HLS content\\. \n*Required*: No \n*Type*: [HlsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-hlsconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HlsConfiguration" }, "LivePreRollConfiguration": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.LivePreRollConfiguration" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.LivePreRollConfiguration", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [LivePreRollConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-liveprerollconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LivePreRollConfiguration" }, "ManifestProcessingRules": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.ManifestProcessingRules" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.ManifestProcessingRules", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ManifestProcessingRules](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-manifestprocessingrules.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManifestProcessingRules" }, "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "PersonalizationThresholdSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PersonalizationThresholdSeconds", "type": "number" }, "SlateAdUrl": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SlateAdUrl", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TranscodeProfileName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TranscodeProfileName", "type": "string" }, "VideoContentSourceUrl": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VideoContentSourceUrl", "type": "string" } }, @@ -132983,6 +136405,8 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" } }, @@ -132992,9 +136416,13 @@ "additionalProperties": false, "properties": { "Mode": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Mode", "type": "string" }, "Value": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -133004,9 +136432,13 @@ "additionalProperties": false, "properties": { "EndUrl": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndUrl", "type": "string" }, "StartUrl": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StartUrl", "type": "string" } }, @@ -133016,9 +136448,13 @@ "additionalProperties": false, "properties": { "AdSegmentUrlPrefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdSegmentUrlPrefix", "type": "string" }, "ContentSegmentUrlPrefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContentSegmentUrlPrefix", "type": "string" } }, @@ -133028,12 +136464,18 @@ "additionalProperties": false, "properties": { "ManifestEndpointPrefix": { + "markdownDescription": "The URL generated by MediaTailor to initiate a playback session\\. The session uses server\\-side reporting\\. This setting is ignored in PUT operations\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManifestEndpointPrefix", "type": "string" }, "MpdLocation": { + "markdownDescription": "The setting that controls whether MediaTailor includes the Location tag in DASH manifests\\. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects\\. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client\\-side reporting or your players support sticky HTTP redirects\\. Valid values are `DISABLED` and `EMT_DEFAULT`\\. The `EMT_DEFAULT` setting enables the inclusion of the tag and is the default value\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MpdLocation", "type": "string" }, "OriginManifestType": { + "markdownDescription": "The setting that controls whether MediaTailor handles manifests from the origin server as multi\\-period manifests or single\\-period manifests\\. If your origin server produces single\\-period manifests, set this to `SINGLE_PERIOD`\\. The default setting is `MULTI_PERIOD`\\. For multi\\-period manifests, omit this setting or set it to `MULTI_PERIOD`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OriginManifestType", "type": "string" } }, @@ -133043,6 +136485,8 @@ "additionalProperties": false, "properties": { "ManifestEndpointPrefix": { + "markdownDescription": "The URL that is used to initiate a playback session for devices that support Apple HLS\\. The session uses server\\-side reporting\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManifestEndpointPrefix", "type": "string" } }, @@ -133052,9 +136496,13 @@ "additionalProperties": false, "properties": { "AdDecisionServerUrl": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdDecisionServerUrl", "type": "string" }, "MaxDurationSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxDurationSeconds", "type": "number" } }, @@ -133064,7 +136512,9 @@ "additionalProperties": false, "properties": { "AdMarkerPassthrough": { - "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.AdMarkerPassthrough" + "$ref": "#/definitions/AWS::MediaTailor::PlaybackConfiguration.AdMarkerPassthrough", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [AdMarkerPassthrough](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-playbackconfiguration-admarkerpassthrough.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdMarkerPassthrough" } }, "type": "object" @@ -133198,7 +136648,9 @@ "type": "boolean" }, "ClusterEndpoint": { - "$ref": "#/definitions/AWS::MemoryDB::Cluster.Endpoint" + "$ref": "#/definitions/AWS::MemoryDB::Cluster.Endpoint", + "markdownDescription": "The cluster's configuration endpoint\\. \n*Required*: No \n*Type*: [Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-cluster-endpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClusterEndpoint" }, "ClusterName": { "markdownDescription": "The name of the cluster\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -133206,6 +136658,8 @@ "type": "string" }, "DataTiering": { + "markdownDescription": "Enables data tiering\\. Data tiering is only supported for replication groups using the r6gd node type\\. This parameter must be set to true when using r6gd nodes\\. For more information, see [Data tiering](https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataTiering", "type": "string" }, "Description": { @@ -133234,7 +136688,7 @@ "type": "string" }, "NodeType": { - "markdownDescription": "The cluster's [node type](https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.supportedtypes.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The cluster's node type\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NodeType", "type": "string" }, @@ -133584,7 +137038,7 @@ }, "AuthenticationMode": { "$ref": "#/definitions/AWS::MemoryDB::User.AuthenticationMode", - "markdownDescription": "Denotes whether the user requires a password to authenticate\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Denotes whether the user requires a password to authenticate\\. \n**Example:**", "title": "AuthenticationMode" }, "Tags": { @@ -133636,9 +137090,13 @@ "items": { "type": "string" }, + "markdownDescription": "The password\\(s\\) used for authentication \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Passwords", "type": "array" }, "Type": { + "markdownDescription": "Indicates whether the user requires a password to authenticate\\. All newly\\-created users require a password\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `password` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -133887,7 +137345,7 @@ "type": "string" }, "Family": { - "markdownDescription": "Must be `neptune1`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Must be `neptune1` for engine versions prior to [1\\.2\\.0\\.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html), or `neptune1.2` for engine version `1.2.0.0` and higher\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Family", "type": "string" }, @@ -133994,7 +137452,7 @@ "type": "string" }, "DBInstanceClass": { - "markdownDescription": "Contains the name of the compute and memory capacity class of the DB instance\\. \nIf you update this property, some interruptions may occur\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains the name of the compute and memory capacity class of the DB instance\\. \nIf you update this property, some interruptions may occur\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "DBInstanceClass", "type": "string" }, @@ -134099,7 +137557,7 @@ "type": "string" }, "Family": { - "markdownDescription": "Must be `neptune1`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Must be `neptune1` for engine versions prior to [1\\.2\\.0\\.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html), or `neptune1.2` for engine version `1.2.0.0` and higher\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Family", "type": "string" }, @@ -134359,6 +137817,8 @@ "additionalProperties": false, "properties": { "IPAddressType": { + "markdownDescription": "The subnet's IP address type\\. You can't change the IP address type after you create the subnet\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DUALSTACK | IPV4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IPAddressType", "type": "string" }, "SubnetId": { @@ -134592,6 +138052,8 @@ "type": "string" }, "StreamExceptionPolicy": { + "markdownDescription": "Configures how Network Firewall processes traffic when a network connection breaks midstream\\. Network connections can break due to disruptions in external networks or within the firewall itself\\. \n+ `DROP` \\- Network Firewall fails closed and drops all subsequent traffic going to the firewall\\. This is the default behavior\\.\n+ `CONTINUE` \\- Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break\\. This impacts the behavior of rules that depend on this context\\. For example, if you have a stateful rule to `drop http` traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP\\. However, this behavior is rule dependent\u2014a TCP\\-layer rule using a `flow:stateless` rule would still match, as would the `aws:drop_strict` default action\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | DROP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StreamExceptionPolicy", "type": "string" } }, @@ -134601,6 +138063,8 @@ "additionalProperties": false, "properties": { "Action": { + "markdownDescription": "The action that changes the rule group from `DROP` to `ALERT`\\. This only applies to managed rule groups\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DROP_TO_ALERT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Action", "type": "string" } }, @@ -134610,7 +138074,9 @@ "additionalProperties": false, "properties": { "Override": { - "$ref": "#/definitions/AWS::NetworkFirewall::FirewallPolicy.StatefulRuleGroupOverride" + "$ref": "#/definitions/AWS::NetworkFirewall::FirewallPolicy.StatefulRuleGroupOverride", + "markdownDescription": "The action that allows the policy owner to override the behavior of the rule group within a policy\\. \n*Required*: No \n*Type*: [StatefulRuleGroupOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Override" }, "Priority": { "markdownDescription": "An integer setting that indicates the order in which to run the stateful rule groups in a single [AWS::NetworkFirewall::FirewallPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html)\\. This setting only applies to firewall policies that specify the `STRICT_ORDER` rule order in the stateful engine options settings\\. \nNetwork Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting\\. You must ensure that the priority settings are unique within each policy\\. \nYou can change the priority settings of your rule groups at any time\\. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -134887,7 +138353,7 @@ "additionalProperties": false, "properties": { "AddressDefinition": { - "markdownDescription": "Specify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^([a-fA-F\\d:\\.]+($|/\\d{1,3}))$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4 and IPv6\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^([a-fA-F\\d:\\.]+($|/\\d{1,3}))$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AddressDefinition", "type": "string" } @@ -134935,7 +138401,7 @@ "additionalProperties": false, "properties": { "Destination": { - "markdownDescription": "The destination IP address or address range to inspect for, in CIDR notation\\. To match with any address, specify `ANY`\\. \nSpecify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The destination IP address or address range to inspect for, in CIDR notation\\. To match with any address, specify `ANY`\\. \nSpecify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4 and IPv6\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Destination", "type": "string" }, @@ -134955,7 +138421,7 @@ "type": "string" }, "Source": { - "markdownDescription": "The source IP address or address range to inspect for, in CIDR notation\\. To match with any address, specify `ANY`\\. \nSpecify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The source IP address or address range to inspect for, in CIDR notation\\. To match with any address, specify `ANY`\\. \nSpecify an IP address or a block of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. Network Firewall supports all address ranges for IPv4 and IPv6\\. \nExamples: \n+ To configure Network Firewall to inspect for the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure Network Firewall to inspect for IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^.*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Source", "type": "string" }, @@ -134993,6 +138459,8 @@ "additionalProperties": false, "properties": { "ReferenceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the resource to include in the [AWS::NetworkFirewall::RuleGroup IPSetReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-networkfirewall-rulegroup-ipsetreference.html#aws-properties-networkfirewall-rulegroup-ipsetreference)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `^arn:aws.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReferenceArn", "type": "string" } }, @@ -135108,11 +138576,13 @@ "properties": { "IPSetReferences": { "additionalProperties": false, + "markdownDescription": "The IP set references to use in the stateful rule group\\. \n*Required*: No \n*Type*: Map of [IPSetReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ipsetreference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.IPSetReference" } }, + "title": "IPSetReferences", "type": "object" } }, @@ -135145,7 +138615,9 @@ "additionalProperties": false, "properties": { "ReferenceSets": { - "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.ReferenceSets" + "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.ReferenceSets", + "markdownDescription": "The reference sets for the stateful rule group\\. \n*Required*: No \n*Type*: [ReferenceSets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-referencesets.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReferenceSets" }, "RuleVariables": { "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.RuleVariables", @@ -135235,7 +138707,7 @@ "items": { "$ref": "#/definitions/AWS::NetworkFirewall::RuleGroup.StatefulRule" }, - "markdownDescription": "An array of individual stateful rules inspection criteria to be used together in a stateful rule group\\. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options\\. For information about the Suricata `Rules` format, see [Rules Format](https://suricata.readthedocs.io/en/suricata-5.0.0/rules/intro.html#)\\. \n*Required*: No \n*Type*: List of [StatefulRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of individual stateful rules inspection criteria to be used together in a stateful rule group\\. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options\\. For information about the Suricata `Rules` format, see [Rules Format](https://suricata.readthedocs.io/rules/intro.html#)\\. \n*Required*: No \n*Type*: List of [StatefulRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StatefulRules", "type": "array" }, @@ -135283,7 +138755,7 @@ "additionalProperties": false, "properties": { "Action": { - "markdownDescription": "Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria\\. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow\\. \nThe actions for a stateful rule are defined as follows: \n+ **PASS** \\- Permits the packets to go to the intended destination\\.\n+ **DROP** \\- Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the firewall's [AWS::NetworkFirewall::LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html)\\. \n+ **ALERT** \\- Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the firewall's [AWS::NetworkFirewall::LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html)\\.", + "markdownDescription": "Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria\\. For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow\\. \nThe actions for a stateful rule are defined as follows: \n+ **PASS** \\- Permits the packets to go to the intended destination\\.\n+ **DROP** \\- Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the [AWS::NetworkFirewall::Firewall](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html) [AWS::NetworkFirewall::LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html)\\. \n+ **ALERT** \\- Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the [AWS::NetworkFirewall::Firewall](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html) [AWS::NetworkFirewall::LoggingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html)\\.", "title": "Action", "type": "string" }, @@ -135425,21 +138897,31 @@ "additionalProperties": false, "properties": { "CoreNetworkId": { + "markdownDescription": "The ID of the core network where the Connect attachment is located\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CoreNetworkId", "type": "string" }, "EdgeLocation": { + "markdownDescription": "The Region where the edge is located\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EdgeLocation", "type": "string" }, "Options": { - "$ref": "#/definitions/AWS::NetworkManager::ConnectAttachment.ConnectAttachmentOptions" + "$ref": "#/definitions/AWS::NetworkManager::ConnectAttachment.ConnectAttachmentOptions", + "markdownDescription": "Options for connecting an attachment\\. \n*Required*: Yes \n*Type*: [ConnectAttachmentOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectattachment-connectattachmentoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Options" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TransportAttachmentId": { + "markdownDescription": "The ID of the transport attachment\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `50` \n*Pattern*: `^attachment-([0-9a-f]{8,17})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TransportAttachmentId", "type": "string" } }, @@ -135476,6 +138958,8 @@ "additionalProperties": false, "properties": { "Protocol": { + "markdownDescription": "The protocol used for the attachment connection\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GRE` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Protocol", "type": "string" } }, @@ -135485,15 +138969,21 @@ "additionalProperties": false, "properties": { "AttachmentPolicyRuleNumber": { + "markdownDescription": "The rule number in the policy document that applies to this change\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AttachmentPolicyRuleNumber", "type": "number" }, "SegmentName": { + "markdownDescription": "The name of the segment to change\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SegmentName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value tags that changed for the segment\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -135535,27 +139025,39 @@ "additionalProperties": false, "properties": { "BgpOptions": { - "$ref": "#/definitions/AWS::NetworkManager::ConnectPeer.BgpOptions" + "$ref": "#/definitions/AWS::NetworkManager::ConnectPeer.BgpOptions", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [BgpOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-bgpoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BgpOptions" }, "ConnectAttachmentId": { + "markdownDescription": "The ID of the attachment to connect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `50` \n*Pattern*: `^attachment-([0-9a-f]{8,17})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConnectAttachmentId", "type": "string" }, "CoreNetworkAddress": { + "markdownDescription": "The IP address of a core network\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CoreNetworkAddress", "type": "string" }, "InsideCidrBlocks": { "items": { "type": "string" }, + "markdownDescription": "The inside IP addresses used for a Connect peer configuration\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InsideCidrBlocks", "type": "array" }, "PeerAddress": { + "markdownDescription": "The IP address of the Connect peer\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PeerAddress", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value tags associated with the Connect peer\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -135591,6 +139093,8 @@ "additionalProperties": false, "properties": { "PeerAsn": { + "markdownDescription": "The Peer ASN of the BGP\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PeerAsn", "type": "number" } }, @@ -135600,15 +139104,23 @@ "additionalProperties": false, "properties": { "CoreNetworkAddress": { + "markdownDescription": "The address of a core network\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CoreNetworkAddress", "type": "string" }, "CoreNetworkAsn": { + "markdownDescription": "The ASN of the Coret Network\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CoreNetworkAsn", "type": "number" }, "PeerAddress": { + "markdownDescription": "The address of a core network Connect peer\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PeerAddress", "type": "string" }, "PeerAsn": { + "markdownDescription": "The ASN of the Connect peer\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PeerAsn", "type": "number" } }, @@ -135621,21 +139133,31 @@ "items": { "$ref": "#/definitions/AWS::NetworkManager::ConnectPeer.ConnectPeerBgpConfiguration" }, + "markdownDescription": "The Connect peer BGP configurations\\. \n*Required*: No \n*Type*: List of [ConnectPeerBgpConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-connectpeer-connectpeerbgpconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BgpConfigurations", "type": "array" }, "CoreNetworkAddress": { + "markdownDescription": "The IP address of a core network\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CoreNetworkAddress", "type": "string" }, "InsideCidrBlocks": { "items": { "type": "string" }, + "markdownDescription": "The inside IP addresses used for a Connect peer configuration\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InsideCidrBlocks", "type": "array" }, "PeerAddress": { + "markdownDescription": "The IP address of the Connect peer\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PeerAddress", "type": "string" }, "Protocol": { + "markdownDescription": "The protocol used for a Connect peer configuration\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GRE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Protocol", "type": "string" } }, @@ -135677,18 +139199,26 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of a core network\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "GlobalNetworkId": { + "markdownDescription": "The ID of the global network that your core network is a part of\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `50` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "GlobalNetworkId", "type": "string" }, "PolicyDocument": { + "markdownDescription": "Describes a core network policy\\. For more information, see [Core network policies](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-policy-changesets.html)\\. \nIf you update the policy document, CloudFormation will apply the core network change set generated from the updated policy document, and then set it as the LIVE policy\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyDocument", "type": "object" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value tags associated with a core network\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -135722,15 +139252,21 @@ "additionalProperties": false, "properties": { "Asn": { + "markdownDescription": "The ASN of a core network edge\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Asn", "type": "number" }, "EdgeLocation": { + "markdownDescription": "The Region where a core network edge is located\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EdgeLocation", "type": "string" }, "InsideCidrBlocks": { "items": { "type": "string" }, + "markdownDescription": "The inside IP addresses used for core network edges\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InsideCidrBlocks", "type": "array" } }, @@ -135743,15 +139279,21 @@ "items": { "type": "string" }, + "markdownDescription": "The Regions where the edges are located\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EdgeLocations", "type": "array" }, "Name": { + "markdownDescription": "The name of a core network segment\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "SharedSegments": { "items": { "type": "string" }, + "markdownDescription": "The shared segments of a core network\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SharedSegments", "type": "array" } }, @@ -136382,15 +139924,21 @@ "additionalProperties": false, "properties": { "CoreNetworkId": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CoreNetworkId", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "VpnConnectionArn": { + "markdownDescription": "The ARN of the site\\-to\\-site VPN attachment\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:vpn-connection\\/vpn-[0-9a-f]{8,17}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VpnConnectionArn", "type": "string" } }, @@ -136425,15 +139973,21 @@ "additionalProperties": false, "properties": { "AttachmentPolicyRuleNumber": { + "markdownDescription": "The rule number in the policy document that applies to this change\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AttachmentPolicyRuleNumber", "type": "number" }, "SegmentName": { + "markdownDescription": "The name of the segment to change\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SegmentName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value tags that changed for the segment\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -136475,15 +140029,21 @@ "additionalProperties": false, "properties": { "CoreNetworkId": { + "markdownDescription": "The ID of the core network\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CoreNetworkId", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value tags associated with the peering\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TransitGatewayArn": { + "markdownDescription": "The ARN of the transit gateway\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `500` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TransitGatewayArn", "type": "string" } }, @@ -136623,24 +140183,34 @@ "additionalProperties": false, "properties": { "CoreNetworkId": { + "markdownDescription": "The core network ID\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CoreNetworkId", "type": "string" }, "Options": { - "$ref": "#/definitions/AWS::NetworkManager::VpcAttachment.VpcOptions" + "$ref": "#/definitions/AWS::NetworkManager::VpcAttachment.VpcOptions", + "markdownDescription": "Options for creating the VPC attachment\\. \n*Required*: No \n*Type*: [VpcOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkmanager-vpcattachment-vpcoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Options" }, "SubnetArns": { "items": { "type": "string" }, + "markdownDescription": "The subnet ARNs\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetArns", "type": "array" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags associated with the VPC attachment\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "VpcArn": { + "markdownDescription": "The ARN of the VPC attachment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VpcArn", "type": "string" } }, @@ -136676,15 +140246,21 @@ "additionalProperties": false, "properties": { "AttachmentPolicyRuleNumber": { + "markdownDescription": "The rule number in the policy document that applies to this change\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AttachmentPolicyRuleNumber", "type": "number" }, "SegmentName": { + "markdownDescription": "The name of the segment to change\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SegmentName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value tags that changed for the segment\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -136694,9 +140270,13 @@ "additionalProperties": false, "properties": { "ApplianceModeSupport": { + "markdownDescription": "Indicates whether appliance mode is supported\\. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApplianceModeSupport", "type": "boolean" }, "Ipv6Support": { + "markdownDescription": "Indicates whether IPv6 is supported\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Ipv6Support", "type": "boolean" } }, @@ -136828,10 +140408,12 @@ "additionalProperties": false, "properties": { "AutomaticTerminationMode": { + "markdownDescription": "Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a `STOPPED` state\\. \n+ When `ACTIVATED`, the streaming session is scheduled for termination after being in the `STOPPED` state for the time specified in `maxStoppedSessionLengthInMinutes`\\.\n+ When `DEACTIVATED`, the streaming session can remain in the `STOPPED` state indefinitely\\.\nThis parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED`\\. When allowed, the default value for this parameter is `DEACTIVATED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutomaticTerminationMode", "type": "string" }, "ClipboardMode": { - "markdownDescription": "Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClipboardMode", "type": "string" }, @@ -136849,19 +140431,23 @@ "type": "number" }, "MaxStoppedSessionLengthInMinutes": { - "markdownDescription": "Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state\\. The default value is 0\\. The maximum value is 5760\\. \nIf the value is missing or set to 0, your sessions can\u2019t be stopped\\. If you then call `StopStreamingSession`, the session fails\\. If the time that a session stays in the READY state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be terminated \\(instead of stopped\\)\\. \nIf the value is set to a positive number, the session can be stopped\\. You can call `StopStreamingSession` to stop sessions in the READY state\\. If the time that a session stays in the READY state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be stopped \\(instead of terminated\\)\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Integer that determines if you can start and stop your sessions and how long a session can stay in the `STOPPED` state\\. The default value is 0\\. The maximum value is 5760\\. \nThis field is allowed only when `sessionPersistenceMode` is `ACTIVATED` and `automaticTerminationMode` is `ACTIVATED`\\. \nIf the value is set to 0, your sessions can\u2019t be `STOPPED`\\. If you then call `StopStreamingSession`, the session fails\\. If the time that a session stays in the `READY` state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be terminated \\(instead of `STOPPED`\\)\\. \nIf the value is set to a positive number, the session can be stopped\\. You can call `StopStreamingSession` to stop sessions in the `READY` state\\. If the time that a session stays in the `READY` state exceeds the `maxSessionLengthInMinutes` value, the session will automatically be stopped \\(instead of terminated\\)\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxStoppedSessionLengthInMinutes", "type": "number" }, "SessionBackup": { - "$ref": "#/definitions/AWS::NimbleStudio::LaunchProfile.StreamConfigurationSessionBackup" + "$ref": "#/definitions/AWS::NimbleStudio::LaunchProfile.StreamConfigurationSessionBackup", + "markdownDescription": "Information about the streaming session backup\\. \n*Required*: No \n*Type*: [StreamConfigurationSessionBackup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionbackup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionBackup" }, "SessionPersistenceMode": { + "markdownDescription": "Determine if a streaming session created from this launch profile can configure persistent storage\\. This means that `volumeConfiguration` and `automaticTerminationMode` are configured\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionPersistenceMode", "type": "string" }, "SessionStorage": { "$ref": "#/definitions/AWS::NimbleStudio::LaunchProfile.StreamConfigurationSessionStorage", - "markdownDescription": "\\(Optional\\) The upload storage for a streaming session\\. \n*Required*: No \n*Type*: [StreamConfigurationSessionStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionstorage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The upload storage for a streaming session\\. \n*Required*: No \n*Type*: [StreamConfigurationSessionStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionstorage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SessionStorage" }, "StreamingImageIds": { @@ -136873,7 +140459,9 @@ "type": "array" }, "VolumeConfiguration": { - "$ref": "#/definitions/AWS::NimbleStudio::LaunchProfile.VolumeConfiguration" + "$ref": "#/definitions/AWS::NimbleStudio::LaunchProfile.VolumeConfiguration", + "markdownDescription": "Custom volume configuration for the root volumes that are attached to streaming sessions\\. \nThis parameter is only allowed when `sessionPersistenceMode` is `ACTIVATED`\\. \n*Required*: No \n*Type*: [VolumeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VolumeConfiguration" } }, "required": [ @@ -136887,9 +140475,13 @@ "additionalProperties": false, "properties": { "MaxBackupsToRetain": { + "markdownDescription": "The maximum number of backups that each streaming session created from this launch profile can have\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxBackupsToRetain", "type": "number" }, "Mode": { + "markdownDescription": "Specifies how artists sessions are backed up\\. \nConfigures backups for streaming sessions launched with this launch profile\\. The default value is `DEACTIVATED`, which means that backups are deactivated\\. To allow backups, set this value to `AUTOMATIC`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Mode", "type": "string" } }, @@ -136902,7 +140494,7 @@ "items": { "type": "string" }, - "markdownDescription": "Allows artists to upload files to their workstations\\. The only valid option is `UPLOAD`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Allows artists to upload files to their workstations\\. The only valid option is `UPLOAD`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Mode", "type": "array" }, @@ -136937,12 +140529,18 @@ "additionalProperties": false, "properties": { "Iops": { + "markdownDescription": "The number of I/O operations per second for the root volume that is attached to streaming session\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Iops", "type": "number" }, "Size": { + "markdownDescription": "The size of the root volume that is attached to the streaming session\\. The root volume size is measured in GiBs\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Size", "type": "number" }, "Throughput": { + "markdownDescription": "The throughput to provision for the root volume that is attached to the streaming session\\. The throughput is measured in MiB/s\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Throughput", "type": "number" } }, @@ -137047,9 +140645,13 @@ "additionalProperties": false, "properties": { "KeyArn": { + "markdownDescription": "The ARN for a KMS key that is used to encrypt studio data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KeyArn", "type": "string" }, "KeyType": { + "markdownDescription": "The type of KMS key that is used to encrypt studio data\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KeyType", "type": "string" } }, @@ -137335,7 +140937,7 @@ "type": "array" }, "DirectoryId": { - "markdownDescription": "The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The directory ID of the AWS Directory Service for Microsoft Active Directory to access using this studio component\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DirectoryId", "type": "string" }, @@ -137426,7 +141028,7 @@ "properties": { "ActiveDirectoryConfiguration": { "$ref": "#/definitions/AWS::NimbleStudio::StudioComponent.ActiveDirectoryConfiguration", - "markdownDescription": "The configuration for a Microsoft Active Directory \\(Microsoft AD\\) studio resource\\. \n*Required*: No \n*Type*: [ActiveDirectoryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectoryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The configuration for a AWS Directory Service for Microsoft Active Directory studio resource\\. \n*Required*: No \n*Type*: [ActiveDirectoryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-studiocomponent-activedirectoryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ActiveDirectoryConfiguration" }, "ComputeFarmConfiguration": { @@ -137456,7 +141058,7 @@ "type": "string" }, "Platform": { - "markdownDescription": "The platform of the initialization script, either WINDOWS or LINUX\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The platform of the initialization script, either Windows or Linux\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Platform", "type": "string" }, @@ -137670,30 +141272,44 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description for the store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the Annotation Store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Reference": { - "$ref": "#/definitions/AWS::Omics::AnnotationStore.ReferenceItem" + "$ref": "#/definitions/AWS::Omics::AnnotationStore.ReferenceItem", + "markdownDescription": "The genome reference for the store's annotations\\. \n*Required*: No \n*Type*: [ReferenceItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-referenceitem.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Reference" }, "SseConfig": { - "$ref": "#/definitions/AWS::Omics::AnnotationStore.SseConfig" + "$ref": "#/definitions/AWS::Omics::AnnotationStore.SseConfig", + "markdownDescription": "The store's server\\-side encryption \\(SSE\\) settings\\. \n*Required*: No \n*Type*: [SseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-sseconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SseConfig" }, "StoreFormat": { + "markdownDescription": "The annotation file format of the store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StoreFormat", "type": "string" }, "StoreOptions": { - "$ref": "#/definitions/AWS::Omics::AnnotationStore.StoreOptions" + "$ref": "#/definitions/AWS::Omics::AnnotationStore.StoreOptions", + "markdownDescription": "File parsing options for the annotation store\\. \n*Required*: No \n*Type*: [StoreOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-storeoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StoreOptions" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tags for the store\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -137728,6 +141344,8 @@ "additionalProperties": false, "properties": { "ReferenceArn": { + "markdownDescription": "The reference's ARN\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ReferenceArn", "type": "string" } }, @@ -137740,9 +141358,13 @@ "additionalProperties": false, "properties": { "KeyArn": { + "markdownDescription": "An encryption key ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KeyArn", "type": "string" }, "Type": { + "markdownDescription": "The encryption type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -137755,7 +141377,9 @@ "additionalProperties": false, "properties": { "TsvStoreOptions": { - "$ref": "#/definitions/AWS::Omics::AnnotationStore.TsvStoreOptions" + "$ref": "#/definitions/AWS::Omics::AnnotationStore.TsvStoreOptions", + "markdownDescription": "Formatting options for a TSV file\\. \n*Required*: Yes \n*Type*: [TsvStoreOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-tsvstoreoptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TsvStoreOptions" } }, "required": [ @@ -137767,18 +141391,24 @@ "additionalProperties": false, "properties": { "AnnotationType": { + "markdownDescription": "The store's annotation type\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AnnotationType", "type": "string" }, "FormatToHeader": { "additionalProperties": true, + "markdownDescription": "The store's header key to column name mapping\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "FormatToHeader", "type": "object" }, "Schema": { + "markdownDescription": "The schema of an annotation store\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Schema", "type": "object" } }, @@ -137820,21 +141450,29 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description for the store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A name for the store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SseConfig": { - "$ref": "#/definitions/AWS::Omics::ReferenceStore.SseConfig" + "$ref": "#/definitions/AWS::Omics::ReferenceStore.SseConfig", + "markdownDescription": "Server\\-side encryption \\(SSE\\) settings for the store\\. \n*Required*: No \n*Type*: [SseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-referencestore-sseconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SseConfig" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tags for the store\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -137868,9 +141506,13 @@ "additionalProperties": false, "properties": { "KeyArn": { + "markdownDescription": "An encryption key ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KeyArn", "type": "string" }, "Type": { + "markdownDescription": "The encryption type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -137915,24 +141557,34 @@ "additionalProperties": false, "properties": { "MaxCpus": { + "markdownDescription": "The group's maximum CPU count setting\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `1` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxCpus", "type": "number" }, "MaxDuration": { + "markdownDescription": "The group's maximum duration setting in minutes\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `1` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxDuration", "type": "number" }, "MaxRuns": { + "markdownDescription": "The group's maximum concurrent run setting\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `1` \n*Maximum*: `100000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxRuns", "type": "number" }, "Name": { + "markdownDescription": "The group's name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tags for the group\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -137994,21 +141646,29 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description for the store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A name for the store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SseConfig": { - "$ref": "#/definitions/AWS::Omics::SequenceStore.SseConfig" + "$ref": "#/definitions/AWS::Omics::SequenceStore.SseConfig", + "markdownDescription": "Server\\-side encryption \\(SSE\\) settings for the store\\. \n*Required*: No \n*Type*: [SseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-sequencestore-sseconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SseConfig" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tags for the store\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -138042,9 +141702,13 @@ "additionalProperties": false, "properties": { "KeyArn": { + "markdownDescription": "An encryption key ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KeyArn", "type": "string" }, "Type": { + "markdownDescription": "The encryption type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -138089,24 +141753,34 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description for the store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "A name for the store\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Reference": { - "$ref": "#/definitions/AWS::Omics::VariantStore.ReferenceItem" + "$ref": "#/definitions/AWS::Omics::VariantStore.ReferenceItem", + "markdownDescription": "The genome reference for the store's variants\\. \n*Required*: Yes \n*Type*: [ReferenceItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-referenceitem.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Reference" }, "SseConfig": { - "$ref": "#/definitions/AWS::Omics::VariantStore.SseConfig" + "$ref": "#/definitions/AWS::Omics::VariantStore.SseConfig", + "markdownDescription": "Server\\-side encryption \\(SSE\\) settings for the store\\. \n*Required*: No \n*Type*: [SseConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-sseconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SseConfig" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tags for the store\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -138141,6 +141815,8 @@ "additionalProperties": false, "properties": { "ReferenceArn": { + "markdownDescription": "The reference's ARN\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ReferenceArn", "type": "string" } }, @@ -138153,9 +141829,13 @@ "additionalProperties": false, "properties": { "KeyArn": { + "markdownDescription": "An encryption key ARN\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*).*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KeyArn", "type": "string" }, "Type": { + "markdownDescription": "The encryption type\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `KMS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -138200,39 +141880,55 @@ "additionalProperties": false, "properties": { "DefinitionUri": { + "markdownDescription": "The URI of a definition for the workflow\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DefinitionUri", "type": "string" }, "Description": { + "markdownDescription": "The parameter's description\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Engine": { + "markdownDescription": "An engine for the workflow\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `NEXTFLOW | WDL` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Engine", "type": "string" }, "Main": { + "markdownDescription": "The path of the main definition file for the workflow\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Main", "type": "string" }, "Name": { + "markdownDescription": "The workflow's name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ParameterTemplate": { "additionalProperties": false, + "markdownDescription": "The workflow's parameter template\\. \n*Required*: No \n*Type*: Map of [WorkflowParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowparameter.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "patternProperties": { "^[a-zA-Z0-9]+$": { "$ref": "#/definitions/AWS::Omics::Workflow.WorkflowParameter" } }, + "title": "ParameterTemplate", "type": "object" }, "StorageCapacity": { + "markdownDescription": "A storage capacity for the workflow in gigabytes\\. \n*Required*: No \n*Type*: Double \n*Minimum*: `0` \n*Maximum*: `100000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StorageCapacity", "type": "number" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tags for the workflow\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" } }, @@ -138262,9 +141958,13 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The parameter's description\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `256` \n*Pattern*: `[\\p{L}||\\p{M}||\\p{Z}||\\p{S}||\\p{N}||\\p{P}]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Description", "type": "string" }, "Optional": { + "markdownDescription": "Whether the parameter is optional\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Optional", "type": "boolean" } }, @@ -138306,15 +142006,23 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Policy": { + "markdownDescription": "The JSON policy document without any whitespaces\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Policy", "type": "string" }, "Type": { + "markdownDescription": "The type of access policy\\. Currently the only option is `data`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -138376,18 +142084,26 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description of the collection\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the collection\\. \nCollection names must meet the following criteria: \n+ Starts with a lowercase letter\n+ Unique to your account and AWS Region\n+ Contains between 3 and 28 characters\n+ Contains only lowercase letters a\\-z, the numbers 0\\-9, and the hyphen \\(\\-\\)\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An arbitrary set of tags \\(key\u2013value pairs\\) to associate with the collection\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Tags", "type": "array" }, "Type": { + "markdownDescription": "The type of collection\\. Possible values are `SEARCH` and `TIMESERIES`\\. For more information, see [Choosing a collection type](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-usecase)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -138453,15 +142169,23 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the security configuration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the security configuration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SamlOptions": { - "$ref": "#/definitions/AWS::OpenSearchServerless::SecurityConfig.SamlConfigOptions" + "$ref": "#/definitions/AWS::OpenSearchServerless::SecurityConfig.SamlConfigOptions", + "markdownDescription": "SAML options for the security configuration in the form of a key\\-value map\\. \n*Required*: No \n*Type*: [SamlConfigOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SamlOptions" }, "Type": { + "markdownDescription": "The type of security configuration\\. Currently the only option is `saml`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -138491,15 +142215,23 @@ "additionalProperties": false, "properties": { "GroupAttribute": { + "markdownDescription": "The group attribute for this SAML integration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GroupAttribute", "type": "string" }, "Metadata": { + "markdownDescription": "The XML IdP metadata file generated from your identity provider\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Metadata", "type": "string" }, "SessionTimeout": { + "markdownDescription": "The session timeout, in minutes\\. Default is 60 minutes \\(12 hours\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionTimeout", "type": "number" }, "UserAttribute": { + "markdownDescription": "A user attribute for this SAML integration\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserAttribute", "type": "string" } }, @@ -138544,15 +142276,23 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The description of the security policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The name of the policy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Policy": { + "markdownDescription": "The JSON policy document without any whitespaces\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Policy", "type": "string" }, "Type": { + "markdownDescription": "The type of security policy\\. Can be either `encryption` or `network`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -138618,21 +142358,29 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SecurityGroupIds": { "items": { "type": "string" }, + "markdownDescription": "The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroupIds", "type": "array" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "The ID of the subnets from which you access OpenSearch Serverless\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetIds", "type": "array" }, "VpcId": { + "markdownDescription": "The ID of the VPC from which you access OpenSearch Serverless\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VpcId", "type": "string" } }, @@ -138705,7 +142453,7 @@ }, "AdvancedOptions": { "additionalProperties": true, - "markdownDescription": "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\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Additional options to specify for the OpenSearch Service domain\\. For more information, see [AdvancedOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CreateDomain.html#API_CreateDomain_RequestBody) in the OpenSearch Service API reference\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" @@ -138716,12 +142464,12 @@ }, "AdvancedSecurityOptions": { "$ref": "#/definitions/AWS::OpenSearchService::Domain.AdvancedSecurityOptionsInput", - "markdownDescription": "Specifies options for fine\\-grained access control\\. \n*Required*: No \n*Type*: [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies options for fine\\-grained access control and SAML authentication\\. \nIf you specify advanced security options, you must also enable node\\-to\\-node encryption \\([NodeToNodeEncryptionOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodetonodeencryptionoptions.html)\\) and encryption at rest \\([EncryptionAtRestOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html)\\)\\. You must also enable `EnforceHTTPS` within [DomainEndpointOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html), which requires HTTPS for all traffic to the domain\\. \n*Required*: No \n*Type*: [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AdvancedSecurityOptions" }, "ClusterConfig": { "$ref": "#/definitions/AWS::OpenSearchService::Domain.ClusterConfig", - "markdownDescription": "`ClusterConfig` is a property of the AWS::OpenSearchService::Domain resource that configures an Amazon OpenSearch Service cluster\\. \n*Required*: No \n*Type*: [ClusterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Container for the cluster configuration of a domain\\. \n*Required*: No \n*Type*: [ClusterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ClusterConfig" }, "CognitoOptions": { @@ -138735,7 +142483,7 @@ "title": "DomainEndpointOptions" }, "DomainName": { - "markdownDescription": "A name for the OpenSearch Service domain\\. For valid values, see the [DomainName](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configuration-api.html#configuration-api-datatypes-domainname) data type in the *Amazon OpenSearch Service Developer Guide*\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nRequired when creating a new domain\\. \nIf you specify a name, you can't perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A name for the OpenSearch Service domain\\. The name must have a minimum length of 3 and a maximum length of 28\\. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name\\. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html)\\. \nRequired when creating a new domain\\. \nIf you specify a name, you can't perform updates that require replacement of this resource\\. You can perform updates that require no or some interruption\\. If you must replace the resource, specify a new name\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DomainName", "type": "string" }, @@ -138750,7 +142498,7 @@ "title": "EncryptionAtRestOptions" }, "EngineVersion": { - "markdownDescription": "The version of OpenSearch to use\\. The value must be in the format `OpenSearch_X.Y` or `Elasticsearch_X.Y`\\. If not specified, the latest version of OpenSearch is used\\. For information about the versions that OpenSearch Service supports, see [Supported versions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide*\\. \nIf you set the [EnableVersionUpgrade](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain) update policy to `true`, you can update `EngineVersion` without interruption\\. When `EnableVersionUpgrade` is set to `false`, or is not specified, updating `EngineVersion` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of OpenSearch to use\\. The value must be in the format `OpenSearch_X.Y` or `Elasticsearch_X.Y`\\. If not specified, the latest version of OpenSearch is used\\. For information about the versions that OpenSearch Service supports, see [Supported versions of OpenSearch and Elasticsearch](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide*\\. \nIf you set the [EnableVersionUpgrade](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain) update policy to `true`, you can update `EngineVersion` without interruption\\. When `EnableVersionUpgrade` is set to `false`, or is not specified, updating `EngineVersion` results in [replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `14` \n*Maximum*: `18` \n*Pattern*: `^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EngineVersion", "type": "string" }, @@ -138772,7 +142520,7 @@ }, "SnapshotOptions": { "$ref": "#/definitions/AWS::OpenSearchService::Domain.SnapshotOptions", - "markdownDescription": "**DEPRECATED**\\. The automated snapshot configuration for the OpenSearch Service domain indices\\. \n*Required*: No \n*Type*: [SnapshotOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-snapshotoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "**DEPRECATED**\\. The automated snapshot configuration for the OpenSearch Service domain indexes\\. \n*Required*: No \n*Type*: [SnapshotOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-snapshotoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SnapshotOptions" }, "Tags": { @@ -138785,7 +142533,7 @@ }, "VPCOptions": { "$ref": "#/definitions/AWS::OpenSearchService::Domain.VPCOptions", - "markdownDescription": "The virtual private cloud \\(VPC\\) configuration for the OpenSearch Service domain\\. For more information, see [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer Guide*\\. \n*Required*: No \n*Type*: [VPCOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-vpcoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The virtual private cloud \\(VPC\\) configuration for the OpenSearch Service domain\\. For more information, see [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer Guide*\\. \nIf you remove this entity altogether, along with its associated properties, it causes a replacement\\. You might encounter this scenario if you're updating your security configuration from a VPC to a public endpoint\\. \n*Required*: No \n*Type*: [VPCOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-vpcoptions.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "VPCOptions" } }, @@ -138815,28 +142563,34 @@ "additionalProperties": false, "properties": { "AnonymousAuthDisableDate": { + "markdownDescription": "Date and time when the migration period will be disabled\\. Only necessary when [enabling fine\\-grained access control on an existing domain](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AnonymousAuthDisableDate", "type": "string" }, "AnonymousAuthEnabled": { + "markdownDescription": "True to enable a 30\\-day migration period during which administrators can create role mappings\\. Only necessary when [enabling fine\\-grained access control on an existing domain](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AnonymousAuthEnabled", "type": "boolean" }, "Enabled": { - "markdownDescription": "True to enable fine\\-grained access control\\. You must also enable encryption of data at rest and node\\-to\\-node encryption\\. See [Fine\\-grained access control in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "True to enable fine\\-grained access control\\. You must also enable encryption of data at rest and node\\-to\\-node encryption\\. See [Fine\\-grained access control in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, "InternalUserDatabaseEnabled": { - "markdownDescription": "True to enable the internal user database\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "True to enable the internal user database\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InternalUserDatabaseEnabled", "type": "boolean" }, "MasterUserOptions": { "$ref": "#/definitions/AWS::OpenSearchService::Domain.MasterUserOptions", - "markdownDescription": "Specifies information about the master user\\. \n*Required*: No \n*Type*: [MasterUserOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies information about the master user\\. \n*Required*: No \n*Type*: [MasterUserOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-masteruseroptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserOptions" }, "SAMLOptions": { - "$ref": "#/definitions/AWS::OpenSearchService::Domain.SAMLOptions" + "$ref": "#/definitions/AWS::OpenSearchService::Domain.SAMLOptions", + "markdownDescription": "Container for information about the SAML configuration for OpenSearch Dashboards\\. \n*Required*: No \n*Type*: [SAMLOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SAMLOptions" } }, "type": "object" @@ -138855,7 +142609,7 @@ "type": "boolean" }, "DedicatedMasterType": { - "markdownDescription": "The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.search`\\. 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)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.search`\\. 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)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | c4.large.search | c4.xlarge.search | c5.18xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.large.search | c5.xlarge.search | c6g.12xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.large.search | c6g.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | d2.xlarge.search | i2.2xlarge.search | i2.xlarge.search | i3.16xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.large.search | i3.xlarge.search | m3.2xlarge.search | m3.large.search | m3.medium.search | m3.xlarge.search | m4.10xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.large.search | m4.xlarge.search | m5.12xlarge.search | m5.24xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.large.search | m5.xlarge.search | m6g.12xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.large.search | m6g.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | r3.large.search | r3.xlarge.search | r4.16xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.large.search | r4.xlarge.search | r5.12xlarge.search | r5.24xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.large.search | r5.xlarge.search | r6g.12xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.large.search | r6g.xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.large.search | r6gd.xlarge.search | t2.medium.search | t2.micro.search | t2.small.search | t3.2xlarge.search | t3.large.search | t3.medium.search | t3.micro.search | t3.nano.search | t3.small.search | t3.xlarge.search | t4g.medium.search | t4g.small.search | ultrawarm1.large.search | ultrawarm1.medium.search | ultrawarm1.xlarge.search` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DedicatedMasterType", "type": "string" }, @@ -138865,7 +142619,7 @@ "type": "number" }, "InstanceType": { - "markdownDescription": "The instance type for your data nodes, such as `m3.medium.search`\\. For valid values, see [Supported instance types in Amazon OpenSearch Service ](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The instance type for your data nodes, such as `m3.medium.search`\\. For valid values, see [Supported instance types in Amazon OpenSearch Service ](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | c4.large.search | c4.xlarge.search | c5.18xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.large.search | c5.xlarge.search | c6g.12xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.large.search | c6g.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | d2.xlarge.search | i2.2xlarge.search | i2.xlarge.search | i3.16xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.large.search | i3.xlarge.search | m3.2xlarge.search | m3.large.search | m3.medium.search | m3.xlarge.search | m4.10xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.large.search | m4.xlarge.search | m5.12xlarge.search | m5.24xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.large.search | m5.xlarge.search | m6g.12xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.large.search | m6g.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | r3.large.search | r3.xlarge.search | r4.16xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.large.search | r4.xlarge.search | r5.12xlarge.search | r5.24xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.large.search | r5.xlarge.search | r6g.12xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.large.search | r6g.xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.large.search | r6gd.xlarge.search | t2.medium.search | t2.micro.search | t2.small.search | t3.2xlarge.search | t3.large.search | t3.medium.search | t3.micro.search | t3.nano.search | t3.small.search | t3.xlarge.search | t4g.medium.search | t4g.small.search | ultrawarm1.large.search | ultrawarm1.medium.search | ultrawarm1.xlarge.search` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InstanceType", "type": "string" }, @@ -138880,7 +142634,7 @@ "type": "boolean" }, "WarmType": { - "markdownDescription": "The instance type for the cluster's warm nodes\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The instance type for the cluster's warm nodes\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ultrawarm1.large.search | ultrawarm1.medium.search | ultrawarm1.xlarge.search` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WarmType", "type": "string" }, @@ -138906,17 +142660,17 @@ "type": "boolean" }, "IdentityPoolId": { - "markdownDescription": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `55` \n*Pattern*: `[\\w-]+:[0-9a-f-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IdentityPoolId", "type": "string" }, "RoleArn": { - "markdownDescription": "The `AmazonOpenSearchServiceCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The `AmazonOpenSearchServiceCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):iam::[0-9]+:role\\/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RoleArn", "type": "string" }, "UserPoolId": { - "markdownDescription": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication\\. \nRequired if you enabled Cognito Authentication for OpenSearch Dashboards\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `55` \n*Pattern*: `[\\w-]+_[0-9a-zA-Z]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UserPoolId", "type": "string" } @@ -138927,7 +142681,7 @@ "additionalProperties": false, "properties": { "CustomEndpoint": { - "markdownDescription": "The fully qualified URL for your custom endpoint\\. Required if you enabled a custom endpoint for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The fully qualified URL for your custom endpoint\\. Required if you enabled a custom endpoint for the domain\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomEndpoint", "type": "string" }, @@ -138942,12 +142696,12 @@ "type": "boolean" }, "EnforceHTTPS": { - "markdownDescription": "True to require that all traffic to the domain arrive over HTTPS\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "True to require that all traffic to the domain arrive over HTTPS\\. Required if you enable fine\\-grained access control in [AdvancedSecurityOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \n*Required*: Conditional \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "EnforceHTTPS", "type": "boolean" }, "TLSSecurityPolicy": { - "markdownDescription": "The minimum TLS version required for traffic to the domain\\. Valid values are TLS 1\\.0 \\(default\\) or 1\\.2: \n+ `Policy-Min-TLS-1-0-2019-07`\n+ `Policy-Min-TLS-1-2-2019-07`\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The minimum TLS version required for traffic to the domain\\. Valid values are TLS 1\\.0 \\(default\\) or 1\\.2: \n+ `Policy-Min-TLS-1-0-2019-07`\n+ `Policy-Min-TLS-1-2-2019-07`\n*Required*: No \n*Type*: String \n*Allowed values*: `Policy-Min-TLS-1-0-2019-07 | Policy-Min-TLS-1-2-2019-07` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TLSSecurityPolicy", "type": "string" } @@ -138963,11 +142717,13 @@ "type": "boolean" }, "Iops": { - "markdownDescription": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. This property applies only to the Provisioned IOPS \\(SSD\\) EBS volume type\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of I/O operations per second \\(IOPS\\) that the volume supports\\. This property applies only to the `gp3` and provisioned IOPS EBS volume types\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Iops", "type": "number" }, "Throughput": { + "markdownDescription": "The throughput \\(in MiB/s\\) of the EBS volumes attached to data nodes\\. Applies only to the `gp3` volume type\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Throughput", "type": "number" }, "VolumeSize": { @@ -138976,7 +142732,7 @@ "type": "number" }, "VolumeType": { - "markdownDescription": "The EBS volume type to use with the OpenSearch Service domain, such as standard, gp2, or io1\\. For more information about each type, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide for Linux Instances*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The EBS volume type to use with the OpenSearch Service domain\\. If you choose `gp3`, you must also specify values for `Iops` and `Throughput`\\. For more information about each type, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide for Linux Instances*\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `gp2 | gp3 | io1 | standard` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VolumeType", "type": "string" } @@ -138987,12 +142743,12 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "Specify `true` to enable encryption at rest\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify `true` to enable encryption at rest\\. Required if you enable fine\\-grained access control in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \n*Required*: Conditional \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, "KmsKeyId": { - "markdownDescription": "The KMS key ID\\. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`\\. Required if you enable encryption at rest\\. \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The KMS key ID\\. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`\\. Required if you enable encryption at rest\\. \nYou can also use `keyAlias` as a value\\. \n*Required*: Conditional \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `500` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KmsKeyId", "type": "string" } @@ -139003,9 +142759,13 @@ "additionalProperties": false, "properties": { "EntityId": { + "markdownDescription": "The unique entity ID of the application in the SAML identity provider\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EntityId", "type": "string" }, "MetadataContent": { + "markdownDescription": "The metadata of the SAML application, in XML format\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1048576` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetadataContent", "type": "string" } }, @@ -139035,17 +142795,17 @@ "additionalProperties": false, "properties": { "MasterUserARN": { - "markdownDescription": "ARN for the master user\\. Only specify if `InternalUserDatabaseEnabled` is false in `AdvancedSecurityOptions`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Amazon Resource Name \\(ARN\\) for the master user\\. The ARN can point to an IAM user or role\\. This property is required for Amazon Cognito to work, and it must match the role configured for Cognito\\. Only specify if `InternalUserDatabaseEnabled` is false in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserARN", "type": "string" }, "MasterUserName": { - "markdownDescription": "Username for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. If you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Username for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \nIf you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserName", "type": "string" }, "MasterUserPassword": { - "markdownDescription": "Password for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in `AdvancedSecurityOptions`\\. If you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Password for the master user\\. Only specify if `InternalUserDatabaseEnabled` is true in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \nIf you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead\\. \n*Required*: No \n*Type*: String \n*Minimum*: `8` \n*Maximum*: `128` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserPassword", "type": "string" } @@ -139056,7 +142816,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "Specifies to enable or disable node\\-to\\-node encryption on the domain\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies to enable or disable node\\-to\\-node encryption on the domain\\. Required if you enable fine\\-grained access control in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html)\\. \n*Required*: Conditional \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" } @@ -139067,24 +142827,38 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "True to enable SAML authentication for a domain\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "Idp": { - "$ref": "#/definitions/AWS::OpenSearchService::Domain.Idp" + "$ref": "#/definitions/AWS::OpenSearchService::Domain.Idp", + "markdownDescription": "The SAML Identity Provider's information\\. \n*Required*: No \n*Type*: [Idp](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-idp.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Idp" }, "MasterBackendRole": { + "markdownDescription": "The backend role that the SAML master user is mapped to\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MasterBackendRole", "type": "string" }, "MasterUserName": { + "markdownDescription": "The SAML master user name, which is stored in the domain's internal user database\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MasterUserName", "type": "string" }, "RolesKey": { + "markdownDescription": "Element of the SAML assertion to use for backend roles\\. Default is `roles`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RolesKey", "type": "string" }, "SessionTimeoutMinutes": { + "markdownDescription": "The duration, in minutes, after which a user session becomes inactive\\. Acceptable values are between 1 and 1440, and the default value is 60\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionTimeoutMinutes", "type": "number" }, "SubjectKey": { + "markdownDescription": "Element of the SAML assertion to use for the user name\\. Default is `NameID`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubjectKey", "type": "string" } }, @@ -139094,27 +142868,43 @@ "additionalProperties": false, "properties": { "AutomatedUpdateDate": { + "markdownDescription": "The timestamp, in Epoch time, until which you can manually request a service software update\\. After this date, we automatically update your service software\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutomatedUpdateDate", "type": "string" }, "Cancellable": { + "markdownDescription": "True if you're able to cancel your service software version update\\. False if you can't cancel your service software update\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cancellable", "type": "boolean" }, "CurrentVersion": { + "markdownDescription": "The current service software version present on the domain\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CurrentVersion", "type": "string" }, "Description": { + "markdownDescription": "A description of the service software update status\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "NewVersion": { + "markdownDescription": "The new service software version, if one is available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NewVersion", "type": "string" }, "OptionalDeployment": { + "markdownDescription": "True if a service software is never automatically updated\\. False if a service software is automatically updated after the automated update date\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OptionalDeployment", "type": "boolean" }, "UpdateAvailable": { + "markdownDescription": "True if you're able to update your service software version\\. False if you can't update your service software version\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UpdateAvailable", "type": "boolean" }, "UpdateStatus": { + "markdownDescription": "The status of your service software update\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `COMPLETED | ELIGIBLE | IN_PROGRESS | NOT_ELIGIBLE | PENDING_UPDATE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UpdateStatus", "type": "string" } }, @@ -139124,7 +142914,7 @@ "additionalProperties": false, "properties": { "AutomatedSnapshotStartHour": { - "markdownDescription": "The hour in UTC during which the service takes an automated daily snapshot of the indices in the OpenSearch Service domain\\. For example, if you specify 0, OpenSearch Service takes an automated snapshot everyday between midnight and 1 am\\. You can specify a value between 0 and 23\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The hour in UTC during which the service takes an automated daily snapshot of the indexes in the OpenSearch Service domain\\. For example, if you specify 0, OpenSearch Service takes an automated snapshot everyday between midnight and 1 am\\. You can specify a value between 0 and 23\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AutomatedSnapshotStartHour", "type": "number" } @@ -139146,7 +142936,7 @@ "items": { "type": "string" }, - "markdownDescription": "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*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provide one subnet ID for each Availability Zone that your domain uses\\. For example, you must specify three subnet IDs for a three\\-AZ 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*\\. \nIf you specify more than one subnet, you must also configure `ZoneAwarenessEnabled` and `ZoneAwarenessConfig` within [ClusterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html), otherwise you'll see the error \"You must specify exactly one subnet\" during template creation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SubnetIds", "type": "array" } @@ -140865,24 +144655,34 @@ "additionalProperties": false, "properties": { "AccountName": { + "markdownDescription": "The account name given to the account when it was created\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `50` \n*Pattern*: `[\\u0020-\\u007E]+` \n*Update requires*: Updates are not supported\\.", + "title": "AccountName", "type": "string" }, "Email": { + "markdownDescription": "The email address associated with the AWS account\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) for this parameter is a string of characters that represents a standard internet email address\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `6` \n*Maximum*: `64` \n*Pattern*: `[^\\s@]+@[^\\s@]+\\.[^\\s@]+` \n*Update requires*: Updates are not supported\\.", + "title": "Email", "type": "string" }, "ParentIds": { "items": { "type": "string" }, + "markdownDescription": "The unique identifier \\(ID\\) of the root or organizational unit \\(OU\\) that you want to create the new account in\\. If you don't specify this parameter, the `ParentId` defaults to the root ID\\. \nThis parameter only accepts a string array with one string value\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) for a parent ID string requires one of the following: \n+ **Root** \\- A string that begins with \"r\\-\" followed by from 4 to 32 lowercase letters or digits\\.\n+ **Organizational unit \\(OU\\)** \\- A string that begins with \"ou\\-\" followed by from 4 to 32 lowercase letters or digits \\(the ID of the root that the OU is in\\)\\. This string is followed by a second \"\\-\" dash and from 8 to 32 additional lowercase letters or digits\\.\n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Pattern*: `^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ParentIds", "type": "array" }, "RoleName": { + "markdownDescription": "The name of an IAM role that AWS Organizations automatically preconfigures in the new member account\\. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator\\. The role has administrator permissions in the new member account\\. \nIf you don't specify this parameter, the role name defaults to `OrganizationAccountAccessRole`\\. \nFor more information about how to use this role to access the member account, see the following links: \n+ [Accessing and Administering the Member Accounts in Your Organization](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role) in the * AWS Organizations User Guide* \n+ Steps 2 and 3 in [Tutorial: Delegate Access Across AWS accounts Using IAM Roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html) in the *IAM User Guide* \nThe [regex pattern](http://wikipedia.org/wiki/regex) that is used to validate this parameter\\. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,\\.@\\- \n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Pattern*: `[\\w+=,.@-]{1,64}` \n*Update requires*: Updates are not supported\\.", + "title": "RoleName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags that you want to attach to the newly created account\\. For each tag in the list, you must specify both a tag key and a value\\. You can set the value to an empty string, but you can't set it to `null`\\. For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide\\. \nIf any one of the tags is not valid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -140949,15 +144749,21 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The friendly name of this OU\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) that is used to validate this parameter is a string of any of the characters in the ASCII character range\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ParentId": { + "markdownDescription": "The unique identifier \\(ID\\) of the parent root or OU that you want to create the new OU in\\. \nTo update the `ParentId` parameter value, you must first remove all accounts attached to the organizational unit \\(OU\\)\\. OUs can't be moved within the organization with accounts still attached\\.\nThe [regex pattern](http://wikipedia.org/wiki/regex) for a parent ID string requires one of the following: \n+ **Root** \\- A string that begins with \"r\\-\" followed by from 4 to 32 lowercase letters or digits\\.\n+ **Organizational unit \\(OU\\)** \\- A string that begins with \"ou\\-\" followed by from 4 to 32 lowercase letters or digits \\(the ID of the root that the OU is in\\)\\. This string is followed by a second \"\\-\" dash and from 8 to 32 additional lowercase letters or digits\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `100` \n*Pattern*: `^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ParentId", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags that you want to attach to the newly created OU\\. For each tag in the list, you must specify both a tag key and a value\\. You can set the value to an empty string, but you can't set it to `null`\\. For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide\\. \nIf any one of the tags is not valid or if you exceed the allowed number of tags for an OU, then the entire request fails and the OU is not created\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -141024,27 +144830,39 @@ "additionalProperties": false, "properties": { "Content": { + "markdownDescription": "The policy text content\\. The text that you supply must adhere to the rules of the policy type you specify in the `Type` parameter\\. The following AWS Organizations quotas are enforced for the maximum size of a policy document: \n+ Service control policies: 5,120 bytes *\\(not characters\\)*\n+ AI services opt\\-out policies: 2,500 characters\n+ Backup policies: 10,000 characters\n+ Tag policies: 10,000 characters\nFor more information about Organizations service quotas, see [Quotas for AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_reference_limits.html) in the *AWS Organizations User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1000000` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Content", "type": "string" }, "Description": { + "markdownDescription": "Human readable description of the policy\\. \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "Name of the policy\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) that is used to validate this parameter is a string of any of the characters in the ASCII character range\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags that you want to attach to the newly created policy\\. For each tag in the list, you must specify both a tag key and a value\\. You can set the value to an empty string, but you can't set it to `null`\\. For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the AWS Organizations User Guide\\. \nIf any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire request fails and the policy is not created\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TargetIds": { "items": { "type": "string" }, + "markdownDescription": "List of unique identifiers \\(IDs\\) of the root, OU, or account that you want to attach the policy to\\. You can get the ID by calling the [ListRoots](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html), [ListOrganizationalUnitsForParent](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListOrganizationalUnitsForParent.html), or [ListAccounts](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListAccounts.html) operations\\. If you don't specify this parameter, the policy is created but not attached to any organization resource\\. \nThe [regex pattern](http://wikipedia.org/wiki/regex) for a target ID string requires one of the following: \n+ **Root** \\- A string that begins with \"r\\-\" followed by from 4 to 32 lowercase letters or digits\\.\n+ **Account** \\- A string that consists of exactly 12 digits\\.\n+ **Organizational unit \\(OU\\)** \\- A string that begins with \"ou\\-\" followed by from 4 to 32 lowercase letters or digits \\(the ID of the root that the OU is in\\)\\. This string is followed by a second \"\\-\" dash and from 8 to 32 additional lowercase letters or digits\\.\n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Pattern*: `^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetIds", "type": "array" }, "Type": { + "markdownDescription": "The type of policy to create\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AISERVICES_OPT_OUT_POLICY | BACKUP_POLICY | SERVICE_CONTROL_POLICY | TAG_POLICY` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -141076,6 +144894,81 @@ ], "type": "object" }, + "AWS::Organizations::ResourcePolicy": { + "additionalProperties": false, + "properties": { + "Condition": { + "type": "string" + }, + "DeletionPolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + }, + "DependsOn": { + "anyOf": [ + { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + { + "items": { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "type": "array" + } + ] + }, + "Metadata": { + "type": "object" + }, + "Properties": { + "additionalProperties": false, + "properties": { + "Content": { + "markdownDescription": "The policy text of the organization resource policy\\. You can specify the resource policy content as a JSON object or a JSON string\\. \nWhen you specify the resource policy content as a JSON string, you can't perform drift detection on the CloudFormation stack\\. For this reason, we recommend specifying the resource policy content as a JSON object instead\\.\n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `40000` \n*Pattern*: `[\\s\\S]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Content", + "type": "object" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "markdownDescription": "A list of tags that you want to attach to the newly created resource policy\\. For each tag in the list, you must specify both a tag key and a value\\. You can set the value to an empty string, but you can't set it to `null`\\. For more information about tagging, see [Tagging AWS Organizations resources](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) in the *AWS Organizations User Guide*\\. \nIf any one of the tags is not valid or if you exceed the allowed number of tags for the resource policy, then the entire request fails and the resource policy is not created\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", + "type": "array" + } + }, + "required": [ + "Content" + ], + "type": "object" + }, + "Type": { + "enum": [ + "AWS::Organizations::ResourcePolicy" + ], + "type": "string" + }, + "UpdateReplacePolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Properties" + ], + "type": "object" + }, "AWS::Panorama::ApplicationInstance": { "additionalProperties": false, "properties": { @@ -141152,7 +145045,7 @@ "type": "string" }, "StatusFilter": { - "markdownDescription": "Only include instances with a specific status\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEPLOYMENT_ERROR | DEPLOYMENT_SUCCEEDED | PROCESSING_DEPLOYMENT | PROCESSING_REMOVAL | REMOVAL_FAILED | REMOVAL_SUCCEEDED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Only include instances with a specific status\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DEPLOYMENT_ERROR | DEPLOYMENT_FAILED | DEPLOYMENT_SUCCEEDED | PROCESSING_DEPLOYMENT | PROCESSING_REMOVAL | REMOVAL_FAILED | REMOVAL_SUCCEEDED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "StatusFilter", "type": "string" }, @@ -141255,7 +145148,9 @@ "type": "string" }, "StorageLocation": { - "$ref": "#/definitions/AWS::Panorama::Package.StorageLocation" + "$ref": "#/definitions/AWS::Panorama::Package.StorageLocation", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [StorageLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-panorama-package-storagelocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageLocation" }, "Tags": { "items": { @@ -141296,18 +145191,28 @@ "additionalProperties": false, "properties": { "BinaryPrefixLocation": { + "markdownDescription": "The location's binary prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BinaryPrefixLocation", "type": "string" }, "Bucket": { + "markdownDescription": "The location's bucket\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Bucket", "type": "string" }, "GeneratedPrefixLocation": { + "markdownDescription": "The location's generated prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GeneratedPrefixLocation", "type": "string" }, "ManifestPrefixLocation": { + "markdownDescription": "The location's manifest prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManifestPrefixLocation", "type": "string" }, "RepoPrefixLocation": { + "markdownDescription": "The location's repo prefix\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RepoPrefixLocation", "type": "string" } }, @@ -141501,6 +145406,8 @@ "additionalProperties": false, "properties": { "DataLocation": { + "markdownDescription": "The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored\\. For example: \n `s3://bucket-name/folder-name/` \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `(s3|http|https)://.+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataLocation", "type": "string" } }, @@ -141511,7 +145418,7 @@ "properties": { "DataSource": { "$ref": "#/definitions/AWS::Personalize::Dataset.DataSource", - "markdownDescription": "The Amazon S3 bucket that contains the training data to import\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon S3 bucket that contains the training data to import\\. \n*Required*: No \n*Type*: [DataSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasource.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataSource" }, "DatasetArn": { @@ -141748,7 +145655,7 @@ "type": "string" }, "PerformAutoML": { - "markdownDescription": "When true, Amazon Personalize performs a search for the best USER\\_PERSONALIZATION recipe from the list specified in the solution configuration \\(`recipeArn` must not be specified\\)\\. When false \\(the default\\), Amazon Personalize uses `recipeArn` for training\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "We don't recommend enabling automated machine learning\\. Instead, match your use case to the available Amazon Personalize recipes\\. For more information, see [Determining your use case\\.](https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html) \nWhen true, Amazon Personalize performs a search for the best USER\\_PERSONALIZATION recipe from the list specified in the solution configuration \\(`recipeArn` must not be specified\\)\\. When false \\(the default\\), Amazon Personalize uses `recipeArn` for training\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PerformAutoML", "type": "boolean" }, @@ -141802,18 +145709,24 @@ "items": { "$ref": "#/definitions/AWS::Personalize::Solution.CategoricalHyperParameterRange" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [CategoricalHyperParameterRange](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-categoricalhyperparameterrange.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CategoricalHyperParameterRanges", "type": "array" }, "ContinuousHyperParameterRanges": { "items": { "$ref": "#/definitions/AWS::Personalize::Solution.ContinuousHyperParameterRange" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ContinuousHyperParameterRange](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContinuousHyperParameterRanges", "type": "array" }, "IntegerHyperParameterRanges": { "items": { "$ref": "#/definitions/AWS::Personalize::Solution.IntegerHyperParameterRange" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [IntegerHyperParameterRange](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "IntegerHyperParameterRanges", "type": "array" } }, @@ -141823,12 +145736,16 @@ "additionalProperties": false, "properties": { "MetricName": { + "markdownDescription": "The metric to optimize\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MetricName", "type": "string" }, "RecipeList": { "items": { "type": "string" }, + "markdownDescription": "The list of candidate recipes\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RecipeList", "type": "array" } }, @@ -141838,12 +145755,16 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the hyperparameter\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "Values": { "items": { "type": "string" }, + "markdownDescription": "A list of the categories for the hyperparameter\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Values", "type": "array" } }, @@ -141853,12 +145774,18 @@ "additionalProperties": false, "properties": { "MaxValue": { + "markdownDescription": "The maximum allowable value for the hyperparameter\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaxValue", "type": "number" }, "MinValue": { + "markdownDescription": "The minimum allowable value for the hyperparameter\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MinValue", "type": "number" }, "Name": { + "markdownDescription": "The name of the hyperparameter\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -141868,13 +145795,19 @@ "additionalProperties": false, "properties": { "AlgorithmHyperParameterRanges": { - "$ref": "#/definitions/AWS::Personalize::Solution.AlgorithmHyperParameterRanges" + "$ref": "#/definitions/AWS::Personalize::Solution.AlgorithmHyperParameterRanges", + "markdownDescription": "The hyperparameters and their allowable ranges\\. \n*Required*: No \n*Type*: [AlgorithmHyperParameterRanges](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-algorithmhyperparameterranges.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "AlgorithmHyperParameterRanges" }, "HpoObjective": { - "$ref": "#/definitions/AWS::Personalize::Solution.HpoObjective" + "$ref": "#/definitions/AWS::Personalize::Solution.HpoObjective", + "markdownDescription": "The metric to optimize during HPO\\. \nAmazon Personalize doesn't support configuring the `hpoObjective` at this time\\.\n*Required*: No \n*Type*: [HpoObjective](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "HpoObjective" }, "HpoResourceConfig": { - "$ref": "#/definitions/AWS::Personalize::Solution.HpoResourceConfig" + "$ref": "#/definitions/AWS::Personalize::Solution.HpoResourceConfig", + "markdownDescription": "Describes the resource configuration for HPO\\. \n*Required*: No \n*Type*: [HpoResourceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hporesourceconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "HpoResourceConfig" } }, "type": "object" @@ -141883,12 +145816,18 @@ "additionalProperties": false, "properties": { "MetricName": { + "markdownDescription": "The name of the metric\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MetricName", "type": "string" }, "MetricRegex": { + "markdownDescription": "A regular expression for finding the metric in the training job logs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MetricRegex", "type": "string" }, "Type": { + "markdownDescription": "The type of the metric\\. Valid values are `Maximize` and `Minimize`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -141898,9 +145837,13 @@ "additionalProperties": false, "properties": { "MaxNumberOfTrainingJobs": { + "markdownDescription": "The maximum number of training jobs when you create a solution version\\. The maximum value for `maxNumberOfTrainingJobs` is `40`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaxNumberOfTrainingJobs", "type": "string" }, "MaxParallelTrainingJobs": { + "markdownDescription": "The maximum number of parallel training jobs when you create a solution version\\. The maximum value for `maxParallelTrainingJobs` is `10`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaxParallelTrainingJobs", "type": "string" } }, @@ -141910,12 +145853,18 @@ "additionalProperties": false, "properties": { "MaxValue": { + "markdownDescription": "The maximum allowable value for the hyperparameter\\. \n*Required*: No \n*Type*: Integer \n*Maximum*: `1000000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaxValue", "type": "number" }, "MinValue": { + "markdownDescription": "The minimum allowable value for the hyperparameter\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `-1000000` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MinValue", "type": "number" }, "Name": { + "markdownDescription": "The name of the hyperparameter\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -141937,7 +145886,7 @@ }, "AutoMLConfig": { "$ref": "#/definitions/AWS::Personalize::Solution.AutoMLConfig", - "markdownDescription": "The [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) object containing a list of recipes to search when AutoML is performed\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) object containing a list of recipes to search when AutoML is performed\\. \n*Required*: No \n*Type*: [AutoMLConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-automlconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AutoMLConfig" }, "EventValueThreshold": { @@ -141958,7 +145907,7 @@ }, "HpoConfig": { "$ref": "#/definitions/AWS::Personalize::Solution.HpoConfig", - "markdownDescription": "Describes the properties for hyperparameter optimization \\(HPO\\)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Describes the properties for hyperparameter optimization \\(HPO\\)\\. \n*Required*: No \n*Type*: [HpoConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "HpoConfig" } }, @@ -142840,7 +146789,9 @@ "title": "CampaignHook" }, "CustomDeliveryConfiguration": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.CustomDeliveryConfiguration" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.CustomDeliveryConfiguration", + "markdownDescription": "The delivery configuration settings for sending the treatment through a custom channel\\. This object is required if the `MessageConfiguration` object for the treatment specifies a `CustomMessage` object\\. \n*Required*: No \n*Type*: [CustomDeliveryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomDeliveryConfiguration" }, "Description": { "markdownDescription": "A custom description of the campaign\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -142864,7 +146815,7 @@ }, "MessageConfiguration": { "$ref": "#/definitions/AWS::Pinpoint::Campaign.MessageConfiguration", - "markdownDescription": "The message configuration settings for the campaign\\. \n*Required*: Yes \n*Type*: [MessageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The message configuration settings for the campaign\\. \n*Required*: No \n*Type*: [MessageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MessageConfiguration" }, "Name": { @@ -142898,7 +146849,9 @@ "type": "object" }, "TemplateConfiguration": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.TemplateConfiguration" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.TemplateConfiguration", + "markdownDescription": "The message template to use for the treatment\\. \n*Required*: No \n*Type*: [TemplateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TemplateConfiguration" }, "TreatmentDescription": { "markdownDescription": "A custom description of the default treatment for the campaign\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -142963,6 +146916,8 @@ "additionalProperties": false, "properties": { "Data": { + "markdownDescription": "The raw, JSON\\-formatted string to use as the payload for the message\\. The maximum size is 5 KB\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Data", "type": "string" } }, @@ -143048,7 +147003,7 @@ "type": "object" }, "Layout": { - "markdownDescription": "A string that describes how the in\\-app message will appear\\. You can specify one of the following: \n+ `BOTTOM_BANNER` \u2013 a message that appears as a banner at the bottom of the page\\.\n+ `TOP_BANNER` \u2013 a message that appears as a banner at the top of the page\\.\n+ `OVERLAYS` \u2013 a message that covers entire screen\\.\n+ `MOBILE_FEED` \u2013 a message that appears in a window in front of the page\\.\n+ `MIDDLE_BANNER` \u2013 a message that appears as a banner in the middle of the page\\.\n+ `CAROUSEL` \u2013 a scrollable layout of up to five unique messages\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string that describes how the in\\-app message will appear\\. You can specify one of the following: \n+ `BOTTOM_BANNER` \u2013 a message that appears as a banner at the bottom of the page\\.\n+ `TOP_BANNER` \u2013 a message that appears as a banner at the top of the page\\.\n+ `OVERLAYS` \u2013 a message that covers entire screen\\.\n+ `MOBILE_FEED` \u2013 a message that appears in a window in front of the page\\.\n+ `MIDDLE_BANNER` \u2013 a message that appears as a banner in the middle of the page\\.\n+ `CAROUSEL` \u2013 a scrollable layout of up to five unique messages\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Layout", "type": "string" } @@ -143095,12 +147050,16 @@ "additionalProperties": false, "properties": { "DeliveryUri": { + "markdownDescription": "The destination to send the campaign or treatment to\\. This value can be one of the following: \n+ The name or Amazon Resource Name \\(ARN\\) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment\\.\n+ The URL for a web application or service that supports HTTPS and can receive the message\\. The URL has to be a full URL, including the HTTPS protocol\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeliveryUri", "type": "string" }, "EndpointTypes": { "items": { "type": "string" }, + "markdownDescription": "The types of endpoints to send the campaign or treatment to\\. Each valid value maps to a type of channel that you can associate with an endpoint by using the `ChannelType` property of an endpoint\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndpointTypes", "type": "array" } }, @@ -143120,7 +147079,7 @@ "type": "number" }, "ButtonAction": { - "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ButtonAction", "type": "string" }, @@ -143152,7 +147111,7 @@ }, "EventType": { "$ref": "#/definitions/AWS::Pinpoint::Campaign.SetDimension", - "markdownDescription": "The name of the event that causes the campaign to be sent or the journey activity to be performed\\. This can be a standard event that Amazon Pinpoint generates, such as `_email.delivered`\\. For campaigns, this can also be a custom event that's specific to your application\\. For information about standard events, see [Streaming Amazon Pinpoint Events](https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html) in the *Amazon Pinpoint Developer Guide*\\. \n*Required*: No \n*Type*: [SetDimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the event that causes the campaign to be sent or the journey activity to be performed\\. This can be a standard event that Amazon Pinpoint generates, such as `_email.delivered` or `_custom.delivered`\\. For campaigns, this can also be a custom event that's specific to your application\\. For information about standard events, see [Streaming Amazon Pinpoint Events](https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html) in the * Amazon Pinpoint Developer Guide*\\. \n*Required*: No \n*Type*: [SetDimension](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventType" }, "Metrics": { @@ -143286,7 +147245,7 @@ "type": "number" }, "Session": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Session", "type": "number" }, @@ -143383,7 +147342,9 @@ "title": "BaiduMessage" }, "CustomMessage": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.CampaignCustomMessage" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.CampaignCustomMessage", + "markdownDescription": "The message that the campaign sends through a custom channel, as specified by the delivery configuration \\(`CustomDeliveryConfiguration`\\) settings for the campaign\\. If specified, this message overrides the default message\\. \n*Required*: No \n*Type*: [CampaignCustomMessage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigncustommessage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomMessage" }, "DefaultMessage": { "$ref": "#/definitions/AWS::Pinpoint::Campaign.Message", @@ -143433,7 +147394,7 @@ "additionalProperties": false, "properties": { "ButtonAction": { - "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ButtonAction", "type": "string" }, @@ -143529,9 +147490,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the message template to use for the message\\. If specified, this value must match the name of an existing message template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Version": { + "markdownDescription": "The unique identifier for the version of the message template to use for the message\\. If specified, this value must match the identifier for an existing template version\\. To retrieve a list of versions and version identifiers for a template, use the [Template Versions](https://docs.aws.amazon.com/pinpoint/latest/apireference/templates-template-name-template-type-versions.html) resource\\. \nIf you don't specify a value for this property, Amazon Pinpoint uses the *active version* of the template\\. The *active version* is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow\\. It isn't necessarily the latest version of a template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Version", "type": "string" } }, @@ -143541,16 +147506,24 @@ "additionalProperties": false, "properties": { "EmailTemplate": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template", + "markdownDescription": "The email template to use for the message\\. \n*Required*: No \n*Type*: [Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EmailTemplate" }, "PushTemplate": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template", + "markdownDescription": "The push notification template to use for the message\\. \n*Required*: No \n*Type*: [Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PushTemplate" }, "SMSTemplate": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template", + "markdownDescription": "The SMS template to use for the message\\. \n*Required*: No \n*Type*: [Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SMSTemplate" }, "VoiceTemplate": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.Template", + "markdownDescription": "The voice template to use for the message\\. This object isn't supported for campaigns\\. \n*Required*: No \n*Type*: [Template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VoiceTemplate" } }, "type": "object" @@ -143559,7 +147532,9 @@ "additionalProperties": false, "properties": { "CustomDeliveryConfiguration": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.CustomDeliveryConfiguration" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.CustomDeliveryConfiguration", + "markdownDescription": "The delivery configuration settings for sending the treatment through a custom channel\\. This object is required if the `MessageConfiguration` object for the treatment specifies a `CustomMessage` object\\. \n*Required*: No \n*Type*: [CustomDeliveryConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomDeliveryConfiguration" }, "MessageConfiguration": { "$ref": "#/definitions/AWS::Pinpoint::Campaign.MessageConfiguration", @@ -143577,7 +147552,9 @@ "type": "number" }, "TemplateConfiguration": { - "$ref": "#/definitions/AWS::Pinpoint::Campaign.TemplateConfiguration" + "$ref": "#/definitions/AWS::Pinpoint::Campaign.TemplateConfiguration", + "markdownDescription": "The message template to use for the treatment\\. \n*Required*: No \n*Type*: [TemplateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TemplateConfiguration" }, "TreatmentDescription": { "markdownDescription": "A custom description of the treatment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -143990,7 +147967,7 @@ "type": "object" }, "Layout": { - "markdownDescription": "A string that determines the appearance of the in\\-app message\\. You can specify one of the following: \n+ `BOTTOM_BANNER` \u2013 a message that appears as a banner at the bottom of the page\\.\n+ `TOP_BANNER` \u2013 a message that appears as a banner at the top of the page\\.\n+ `OVERLAYS` \u2013 a message that covers entire screen\\.\n+ `MOBILE_FEED` \u2013 a message that appears in a window in front of the page\\.\n+ `MIDDLE_BANNER` \u2013 a message that appears as a banner in the middle of the page\\.\n+ `CAROUSEL` \u2013 a scrollable layout of up to five unique messages\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string that determines the appearance of the in\\-app message\\. You can specify one of the following: \n+ `BOTTOM_BANNER` \u2013 a message that appears as a banner at the bottom of the page\\.\n+ `TOP_BANNER` \u2013 a message that appears as a banner at the top of the page\\.\n+ `OVERLAYS` \u2013 a message that covers entire screen\\.\n+ `MOBILE_FEED` \u2013 a message that appears in a window in front of the page\\.\n+ `MIDDLE_BANNER` \u2013 a message that appears as a banner in the middle of the page\\.\n+ `CAROUSEL` \u2013 a scrollable layout of up to five unique messages\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Layout", "type": "string" }, @@ -144097,7 +148074,7 @@ "type": "number" }, "ButtonAction": { - "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ButtonAction", "type": "string" }, @@ -144180,7 +148157,7 @@ "additionalProperties": false, "properties": { "ButtonAction": { - "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action that occurs when a recipient chooses a button in an in\\-app message\\. You can specify one of the following: \n+ `LINK` \u2013 A link to a web destination\\.\n+ `DEEP_LINK` \u2013 A link to a specific page in an application\\.\n+ `CLOSE` \u2013 Dismisses the message\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ButtonAction", "type": "string" }, @@ -144540,7 +148517,7 @@ "title": "Dimensions" }, "Name": { - "markdownDescription": "The name of the segment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the segment\\. \nA segment must have a name otherwise it will not appear in the Amazon Pinpoint console\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -145614,43 +149591,65 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "A description of the pipe\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "DesiredState": { + "markdownDescription": "The state the pipe should be in\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DesiredState", "type": "string" }, "Enrichment": { + "markdownDescription": "The ARN of the enrichment resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enrichment", "type": "string" }, "EnrichmentParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeEnrichmentParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeEnrichmentParameters", + "markdownDescription": "The parameters required to set up enrichment on your pipe\\. \n*Required*: No \n*Type*: [PipeEnrichmentParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmentparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnrichmentParameters" }, "Name": { + "markdownDescription": "The name of the pipe\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "RoleArn": { + "markdownDescription": "The ARN of the role that allows the pipe to send data to the target\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "Source": { + "markdownDescription": "The ARN of the source resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Source", "type": "string" }, "SourceParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceParameters", + "markdownDescription": "The parameters required to set up a source for your pipe\\. \n*Required*: No \n*Type*: [PipeSourceParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceParameters" }, "Tags": { "additionalProperties": true, + "markdownDescription": "The list of key\\-value pairs to associate with the pipe\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "Target": { + "markdownDescription": "The ARN of the target resource\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Target", "type": "string" }, "TargetParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetParameters", + "markdownDescription": "The parameters required to set up a target for your pipe\\. \nFor more information about pipe target parameters, including how to use dynamic path parameters, see [Target parameters](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) in the *Amazon EventBridge User Guide*\\. \n*Required*: No \n*Type*: [PipeTargetParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TargetParameters" } }, "required": [ @@ -145685,18 +149684,24 @@ "additionalProperties": false, "properties": { "AssignPublicIp": { + "markdownDescription": "Specifies whether the task's elastic network interface receives a public IP address\\. You can specify `ENABLED` only when `LaunchType` in `EcsParameters` is set to `FARGATE`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AssignPublicIp", "type": "string" }, "SecurityGroups": { "items": { "type": "string" }, + "markdownDescription": "Specifies the security groups associated with the task\\. These security groups must all be in the same VPC\\. You can specify as many as five security groups\\. If you do not specify a security group, the default security group for the VPC is used\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroups", "type": "array" }, "Subnets": { "items": { "type": "string" }, + "markdownDescription": "Specifies the subnets associated with the task\\. These subnets must all be in the same VPC\\. You can specify as many as 16 subnets\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Subnets", "type": "array" } }, @@ -145709,6 +149714,8 @@ "additionalProperties": false, "properties": { "Size": { + "markdownDescription": "The size of the array, if this is an array batch job\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Size", "type": "number" } }, @@ -145721,21 +149728,29 @@ "items": { "type": "string" }, + "markdownDescription": "The command to send to the container that overrides the default command from the Docker image or the task definition\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Command", "type": "array" }, "Environment": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.BatchEnvironmentVariable" }, + "markdownDescription": "The environment variables to send to the container\\. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition\\. \nEnvironment variables cannot start with \"`AWS Batch`\"\\. This naming convention is reserved for variables that AWS Batch sets\\.\n*Required*: No \n*Type*: List of [BatchEnvironmentVariable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchenvironmentvariable.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Environment", "type": "array" }, "InstanceType": { + "markdownDescription": "The instance type to use for a multi\\-node parallel job\\. \nThis parameter isn't applicable to single\\-node container jobs or jobs that run on Fargate resources, and shouldn't be provided\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InstanceType", "type": "string" }, "ResourceRequirements": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.BatchResourceRequirement" }, + "markdownDescription": "The type and amount of resources to assign to a container\\. This overrides the settings in the job definition\\. The supported resources include `GPU`, `MEMORY`, and `VCPU`\\. \n*Required*: No \n*Type*: List of [BatchResourceRequirement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchresourcerequirement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceRequirements", "type": "array" } }, @@ -145745,9 +149760,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the key\\-value pair\\. For environment variables, this is the name of the environment variable\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Value": { + "markdownDescription": "The value of the key\\-value pair\\. For environment variables, this is the value of the environment variable\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -145757,9 +149776,13 @@ "additionalProperties": false, "properties": { "JobId": { + "markdownDescription": "The job ID of the AWS Batch job that's associated with this dependency\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "JobId", "type": "string" }, "Type": { + "markdownDescription": "The type of the job dependency\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -145769,9 +149792,13 @@ "additionalProperties": false, "properties": { "Type": { + "markdownDescription": "The type of resource to assign to a container\\. The supported resources include `GPU`, `MEMORY`, and `VCPU`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "Value": { + "markdownDescription": "The quantity of the specified resource to reserve for the container\\. The values vary based on the `type` specified\\. \ntype=\"GPU\" \nThe number of physical GPUs to reserve for the container\\. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on\\. \nGPUs aren't available for jobs that are running on Fargate resources\\. \ntype=\"MEMORY\" \nThe memory hard limit \\(in MiB\\) present to the container\\. This parameter is supported for jobs that are running on EC2 resources\\. If your container attempts to exceed the memory specified, the container is terminated\\. This parameter maps to `Memory` in the [ Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. You must specify at least 4 MiB of memory for a job\\. This is required but can be specified in several places for multi\\-node parallel \\(MNP\\) jobs\\. It must be specified for each node at least once\\. This parameter maps to `Memory` in the [ Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. \nIf you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see [Memory management](https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in the *AWS Batch User Guide*\\.\nFor jobs that are running on Fargate resources, then `value` is the hard limit \\(in MiB\\), and must match one of the supported values and the `VCPU` values must be one of the values supported for that memory value\\. \nvalue = 512 \n`VCPU` = 0\\.25 \nvalue = 1024 \n`VCPU` = 0\\.25 or 0\\.5 \nvalue = 2048 \n`VCPU` = 0\\.25, 0\\.5, or 1 \nvalue = 3072 \n`VCPU` = 0\\.5, or 1 \nvalue = 4096 \n`VCPU` = 0\\.5, 1, or 2 \nvalue = 5120, 6144, or 7168 \n`VCPU` = 1 or 2 \nvalue = 8192 \n`VCPU` = 1, 2, 4, or 8 \nvalue = 9216, 10240, 11264, 12288, 13312, 14336, or 15360 \n`VCPU` = 2 or 4 \nvalue = 16384 \n`VCPU` = 2, 4, or 8 \nvalue = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720 \n`VCPU` = 4 \nvalue = 20480, 24576, or 28672 \n`VCPU` = 4 or 8 \nvalue = 36864, 45056, 53248, or 61440 \n`VCPU` = 8 \nvalue = 32768, 40960, 49152, or 57344 \n`VCPU` = 8 or 16 \nvalue = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880 \n`VCPU` = 16 \ntype=\"VCPU\" \nThe number of vCPUs reserved for the container\\. This parameter maps to `CpuShares` in the [ Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--cpu-shares` option to [docker run](https://docs.docker.com/engine/reference/run/)\\. Each vCPU is equivalent to 1,024 CPU shares\\. For EC2 resources, you must specify at least one vCPU\\. This is required but can be specified in several places; it must be specified for each node at least once\\. \nThe default for the Fargate On\\-Demand vCPU resource count quota is 6 vCPUs\\. For more information about Fargate quotas, see [AWS Fargate quotas](https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate) in the *AWS General Reference*\\. \nFor jobs that are running on Fargate resources, then `value` must match one of the supported values and the `MEMORY` values must be one of the values supported for that `VCPU` value\\. The supported values are 0\\.25, 0\\.5, 1, 2, 4, 8, and 16 \nvalue = 0\\.25 \n`MEMORY` = 512, 1024, or 2048 \nvalue = 0\\.5 \n`MEMORY` = 1024, 2048, 3072, or 4096 \nvalue = 1 \n`MEMORY` = 2048, 3072, 4096, 5120, 6144, 7168, or 8192 \nvalue = 2 \n`MEMORY` = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384 \nvalue = 4 \n`MEMORY` = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720 \nvalue = 8 \n`MEMORY` = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440 \nvalue = 16 \n`MEMORY` = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880 \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -145785,6 +149812,8 @@ "additionalProperties": false, "properties": { "Attempts": { + "markdownDescription": "The number of times to move a job to the `RUNNABLE` status\\. If the value of `attempts` is greater than one, the job is retried on failure the same number of attempts as the value\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Attempts", "type": "number" } }, @@ -145794,12 +149823,18 @@ "additionalProperties": false, "properties": { "Base": { + "markdownDescription": "The base value designates how many tasks, at a minimum, to run on the specified capacity provider\\. Only one capacity provider in a capacity provider strategy can have a base defined\\. If no value is specified, the default value of 0 is used\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Base", "type": "number" }, "CapacityProvider": { + "markdownDescription": "The short name of the capacity provider\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CapacityProvider", "type": "string" }, "Weight": { + "markdownDescription": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider\\. The weight value is taken into consideration after the base value, if defined, is satisfied\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Weight", "type": "number" } }, @@ -145812,6 +149847,8 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "The ARN of the Amazon SQS queue specified as the target for the dead\\-letter queue\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Arn", "type": "string" } }, @@ -145824,36 +149861,52 @@ "items": { "type": "string" }, + "markdownDescription": "The command to send to the container that overrides the default command from the Docker image or the task definition\\. You must also specify a container name\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Command", "type": "array" }, "Cpu": { + "markdownDescription": "The number of `cpu` units reserved for the container, instead of the default value from the task definition\\. You must also specify a container name\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cpu", "type": "number" }, "Environment": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.EcsEnvironmentVariable" }, + "markdownDescription": "The environment variables to send to the container\\. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition\\. You must also specify a container name\\. \n*Required*: No \n*Type*: List of [EcsEnvironmentVariable](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentvariable.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Environment", "type": "array" }, "EnvironmentFiles": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.EcsEnvironmentFile" }, + "markdownDescription": "A list of files containing the environment variables to pass to a container, instead of the value from the container definition\\. \n*Required*: No \n*Type*: List of [EcsEnvironmentFile](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsenvironmentfile.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnvironmentFiles", "type": "array" }, "Memory": { + "markdownDescription": "The hard limit \\(in MiB\\) of memory to present to the container, instead of the default value from the task definition\\. If your container attempts to exceed the memory specified here, the container is killed\\. You must also specify a container name\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Memory", "type": "number" }, "MemoryReservation": { + "markdownDescription": "The soft limit \\(in MiB\\) of memory to reserve for the container, instead of the default value from the task definition\\. You must also specify a container name\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MemoryReservation", "type": "number" }, "Name": { + "markdownDescription": "The name of the container that receives the override\\. This parameter is required if any override is specified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ResourceRequirements": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.EcsResourceRequirement" }, + "markdownDescription": "The type and amount of a resource to assign to a container, instead of the default value from the task definition\\. The only supported resource is a GPU\\. \n*Required*: No \n*Type*: List of [EcsResourceRequirement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsresourcerequirement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceRequirements", "type": "array" } }, @@ -145863,9 +149916,13 @@ "additionalProperties": false, "properties": { "Type": { + "markdownDescription": "The file type to use\\. The only supported value is `s3`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "Value": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Amazon S3 object containing the environment variable file\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -145879,9 +149936,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the key\\-value pair\\. For environment variables, this is the name of the environment variable\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Value": { + "markdownDescription": "The value of the key\\-value pair\\. For environment variables, this is the value of the environment variable\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -145891,6 +149952,8 @@ "additionalProperties": false, "properties": { "SizeInGiB": { + "markdownDescription": "The total amount, in GiB, of ephemeral storage to set for the task\\. The minimum supported value is `21` GiB and the maximum supported value is `200` GiB\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SizeInGiB", "type": "number" } }, @@ -145903,9 +149966,13 @@ "additionalProperties": false, "properties": { "DeviceName": { + "markdownDescription": "The Elastic Inference accelerator device name to override for the task\\. This parameter must match a `deviceName` specified in the task definition\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeviceName", "type": "string" }, "DeviceType": { + "markdownDescription": "The Elastic Inference accelerator type to use\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeviceType", "type": "string" } }, @@ -145915,9 +149982,13 @@ "additionalProperties": false, "properties": { "Type": { + "markdownDescription": "The type of resource to assign to a container\\. The supported values are `GPU` or `InferenceAccelerator`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "Value": { + "markdownDescription": "The value for the specified resource type\\. \nIf the `GPU` type is used, the value is the number of physical `GPUs` the Amazon ECS container agent reserves for the container\\. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on\\. \nIf the `InferenceAccelerator` type is used, the `value` matches the `deviceName` for an InferenceAccelerator specified in a task definition\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -145934,27 +150005,41 @@ "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.EcsContainerOverride" }, + "markdownDescription": "One or more container overrides that are sent to a task\\. \n*Required*: No \n*Type*: List of [EcsContainerOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecscontaineroverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContainerOverrides", "type": "array" }, "Cpu": { + "markdownDescription": "The cpu override for the task\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cpu", "type": "string" }, "EphemeralStorage": { - "$ref": "#/definitions/AWS::Pipes::Pipe.EcsEphemeralStorage" + "$ref": "#/definitions/AWS::Pipes::Pipe.EcsEphemeralStorage", + "markdownDescription": "The ephemeral storage setting override for the task\\. \nThis parameter is only supported for tasks hosted on Fargate that use the following platform versions: \n+ Linux platform version `1.4.0` or later\\.\n+ Windows platform version `1.0.0` or later\\.\n*Required*: No \n*Type*: [EcsEphemeralStorage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsephemeralstorage.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EphemeralStorage" }, "ExecutionRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the task execution IAM role override for the task\\. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExecutionRoleArn", "type": "string" }, "InferenceAcceleratorOverrides": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.EcsInferenceAcceleratorOverride" }, + "markdownDescription": "The Elastic Inference accelerator override for the task\\. \n*Required*: No \n*Type*: List of [EcsInferenceAcceleratorOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecsinferenceacceleratoroverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InferenceAcceleratorOverrides", "type": "array" }, "Memory": { + "markdownDescription": "The memory override for the task\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Memory", "type": "string" }, "TaskRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IAM role that containers in this task can assume\\. All containers in this task are granted the permissions that are specified in this role\\. For more information, see [IAM Role for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TaskRoleArn", "type": "string" } }, @@ -145964,6 +150049,8 @@ "additionalProperties": false, "properties": { "Pattern": { + "markdownDescription": "The event pattern\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Pattern", "type": "string" } }, @@ -145976,6 +150063,8 @@ "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.Filter" }, + "markdownDescription": "The event patterns\\. \n*Required*: No \n*Type*: List of [Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Filters", "type": "array" } }, @@ -145985,6 +150074,8 @@ "additionalProperties": false, "properties": { "BasicAuth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BasicAuth", "type": "string" } }, @@ -145997,9 +150088,13 @@ "additionalProperties": false, "properties": { "ClientCertificateTlsAuth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientCertificateTlsAuth", "type": "string" }, "SaslScram512Auth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SaslScram512Auth", "type": "string" } }, @@ -146009,7 +150104,9 @@ "additionalProperties": false, "properties": { "AwsvpcConfiguration": { - "$ref": "#/definitions/AWS::Pipes::Pipe.AwsVpcConfiguration" + "$ref": "#/definitions/AWS::Pipes::Pipe.AwsVpcConfiguration", + "markdownDescription": "Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used\\. This structure is relevant only for ECS tasks that use the `awsvpc` network mode\\. \n*Required*: No \n*Type*: [AwsVpcConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-awsvpcconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AwsvpcConfiguration" } }, "type": "object" @@ -146019,26 +150116,32 @@ "properties": { "HeaderParameters": { "additionalProperties": true, + "markdownDescription": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "HeaderParameters", "type": "object" }, "PathParameterValues": { "items": { "type": "string" }, + "markdownDescription": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards \\(\"\\*\"\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PathParameterValues", "type": "array" }, "QueryStringParameters": { "additionalProperties": true, + "markdownDescription": "The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "QueryStringParameters", "type": "object" } }, @@ -146048,9 +150151,13 @@ "additionalProperties": false, "properties": { "HttpParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeEnrichmentHttpParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeEnrichmentHttpParameters", + "markdownDescription": "Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination\\. \nIf you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request\\. If you're using ApiDestinations, the corresponding Connection can also have these values configured\\. In case of any conflicting keys, values from the Connection take precedence\\. \n*Required*: No \n*Type*: [PipeEnrichmentHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipeenrichmenthttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HttpParameters" }, "InputTemplate": { + "markdownDescription": "Valid JSON text passed to the enrichment\\. In this case, nothing from the event itself is passed to the enrichment\\. For more information, see [The JavaScript Object Notation \\(JSON\\) Data Interchange Format](http://www.rfc-editor.org/rfc/rfc7159.txt)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputTemplate", "type": "string" } }, @@ -146060,15 +150167,23 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "Credentials": { - "$ref": "#/definitions/AWS::Pipes::Pipe.MQBrokerAccessCredentials" + "$ref": "#/definitions/AWS::Pipes::Pipe.MQBrokerAccessCredentials", + "markdownDescription": "The credentials needed to access the resource\\. \n*Required*: Yes \n*Type*: [MQBrokerAccessCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mqbrokeraccesscredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Credentials" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" }, "QueueName": { + "markdownDescription": "The name of the destination queue to consume\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "QueueName", "type": "string" } }, @@ -146082,27 +150197,43 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "DeadLetterConfig": { - "$ref": "#/definitions/AWS::Pipes::Pipe.DeadLetterConfig" + "$ref": "#/definitions/AWS::Pipes::Pipe.DeadLetterConfig", + "markdownDescription": "Define the target queue to send dead\\-letter queue events to\\. \n*Required*: No \n*Type*: [DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-deadletterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeadLetterConfig" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" }, "MaximumRecordAgeInSeconds": { + "markdownDescription": "\\(Streams only\\) Discard records older than the specified age\\. The default value is \\-1, which sets the maximum age to infinite\\. When the value is set to infinite, EventBridge never discards old records\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumRecordAgeInSeconds", "type": "number" }, "MaximumRetryAttempts": { + "markdownDescription": "\\(Streams only\\) Discard records after the specified number of retries\\. The default value is \\-1, which sets the maximum number of retries to infinite\\. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumRetryAttempts", "type": "number" }, "OnPartialBatchItemFailure": { + "markdownDescription": "\\(Streams only\\) Define how to handle item process failures\\. `AUTOMATIC_BISECT` halves each batch and retry each half until all the records are processed or there is one failed message left in the batch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OnPartialBatchItemFailure", "type": "string" }, "ParallelizationFactor": { + "markdownDescription": "\\(Streams only\\) The number of batches to process concurrently from each shard\\. The default value is 1\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ParallelizationFactor", "type": "number" }, "StartingPosition": { + "markdownDescription": "\\(Streams only\\) The position in a stream from which to start reading\\. \n*Valid values*: `TRIM_HORIZON | LATEST` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StartingPosition", "type": "string" } }, @@ -146115,30 +150246,48 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "DeadLetterConfig": { - "$ref": "#/definitions/AWS::Pipes::Pipe.DeadLetterConfig" + "$ref": "#/definitions/AWS::Pipes::Pipe.DeadLetterConfig", + "markdownDescription": "Define the target queue to send dead\\-letter queue events to\\. \n*Required*: No \n*Type*: [DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-deadletterconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeadLetterConfig" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" }, "MaximumRecordAgeInSeconds": { + "markdownDescription": "\\(Streams only\\) Discard records older than the specified age\\. The default value is \\-1, which sets the maximum age to infinite\\. When the value is set to infinite, EventBridge never discards old records\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumRecordAgeInSeconds", "type": "number" }, "MaximumRetryAttempts": { + "markdownDescription": "\\(Streams only\\) Discard records after the specified number of retries\\. The default value is \\-1, which sets the maximum number of retries to infinite\\. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumRetryAttempts", "type": "number" }, "OnPartialBatchItemFailure": { + "markdownDescription": "\\(Streams only\\) Define how to handle item process failures\\. `AUTOMATIC_BISECT` halves each batch and retry each half until all the records are processed or there is one failed message left in the batch\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OnPartialBatchItemFailure", "type": "string" }, "ParallelizationFactor": { + "markdownDescription": "\\(Streams only\\) The number of batches to process concurrently from each shard\\. The default value is 1\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ParallelizationFactor", "type": "number" }, "StartingPosition": { + "markdownDescription": "\\(Streams only\\) The position in a stream from which to start reading\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StartingPosition", "type": "string" }, "StartingPositionTimestamp": { + "markdownDescription": "With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading, in Unix time seconds\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StartingPositionTimestamp", "type": "string" } }, @@ -146151,21 +150300,33 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "ConsumerGroupID": { + "markdownDescription": "The name of the destination queue to consume\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConsumerGroupID", "type": "string" }, "Credentials": { - "$ref": "#/definitions/AWS::Pipes::Pipe.MSKAccessCredentials" + "$ref": "#/definitions/AWS::Pipes::Pipe.MSKAccessCredentials", + "markdownDescription": "The credentials needed to access the resource\\. \n*Required*: No \n*Type*: [MSKAccessCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mskaccesscredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Credentials" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" }, "StartingPosition": { + "markdownDescription": "\\(Streams only\\) The position in a stream from which to start reading\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StartingPosition", "type": "string" }, "TopicName": { + "markdownDescription": "The name of the topic that the pipe will read from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TopicName", "type": "string" } }, @@ -146178,28 +150339,44 @@ "additionalProperties": false, "properties": { "ActiveMQBrokerParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceActiveMQBrokerParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceActiveMQBrokerParameters", + "markdownDescription": "The parameters for using an Active MQ broker as a source\\. \n*Required*: No \n*Type*: [PipeSourceActiveMQBrokerParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActiveMQBrokerParameters" }, "DynamoDBStreamParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceDynamoDBStreamParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceDynamoDBStreamParameters", + "markdownDescription": "The parameters for using a DynamoDB stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceDynamoDBStreamParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DynamoDBStreamParameters" }, "FilterCriteria": { - "$ref": "#/definitions/AWS::Pipes::Pipe.FilterCriteria" + "$ref": "#/definitions/AWS::Pipes::Pipe.FilterCriteria", + "markdownDescription": "The collection of event patterns used to filter events\\. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*\\. \n*Required*: No \n*Type*: [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-filtercriteria.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FilterCriteria" }, "KinesisStreamParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceKinesisStreamParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceKinesisStreamParameters", + "markdownDescription": "The parameters for using a Kinesis stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceKinesisStreamParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KinesisStreamParameters" }, "ManagedStreamingKafkaParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceManagedStreamingKafkaParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceManagedStreamingKafkaParameters", + "markdownDescription": "The parameters for using an MSK stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceManagedStreamingKafkaParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManagedStreamingKafkaParameters" }, "RabbitMQBrokerParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceRabbitMQBrokerParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceRabbitMQBrokerParameters", + "markdownDescription": "The parameters for using a Rabbit MQ broker as a source\\. \n*Required*: No \n*Type*: [PipeSourceRabbitMQBrokerParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RabbitMQBrokerParameters" }, "SelfManagedKafkaParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceSelfManagedKafkaParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceSelfManagedKafkaParameters", + "markdownDescription": "The parameters for using a self\\-managed Apache Kafka stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceSelfManagedKafkaParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SelfManagedKafkaParameters" }, "SqsQueueParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceSqsQueueParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeSourceSqsQueueParameters", + "markdownDescription": "The parameters for using a Amazon SQS stream as a source\\. \n*Required*: No \n*Type*: [PipeSourceSqsQueueParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcesqsqueueparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SqsQueueParameters" } }, "type": "object" @@ -146208,18 +150385,28 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "Credentials": { - "$ref": "#/definitions/AWS::Pipes::Pipe.MQBrokerAccessCredentials" + "$ref": "#/definitions/AWS::Pipes::Pipe.MQBrokerAccessCredentials", + "markdownDescription": "The credentials needed to access the resource\\. \n*Required*: Yes \n*Type*: [MQBrokerAccessCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-mqbrokeraccesscredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Credentials" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" }, "QueueName": { + "markdownDescription": "The name of the destination queue to consume\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "QueueName", "type": "string" }, "VirtualHost": { + "markdownDescription": "The name of the virtual host associated with the source broker\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VirtualHost", "type": "string" } }, @@ -146236,31 +150423,49 @@ "items": { "type": "string" }, + "markdownDescription": "An array of server URLs\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalBootstrapServers", "type": "array" }, "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "ConsumerGroupID": { + "markdownDescription": "The name of the destination queue to consume\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConsumerGroupID", "type": "string" }, "Credentials": { - "$ref": "#/definitions/AWS::Pipes::Pipe.SelfManagedKafkaAccessConfigurationCredentials" + "$ref": "#/definitions/AWS::Pipes::Pipe.SelfManagedKafkaAccessConfigurationCredentials", + "markdownDescription": "The credentials needed to access the resource\\. \n*Required*: No \n*Type*: [SelfManagedKafkaAccessConfigurationCredentials](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Credentials" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" }, "ServerRootCaCertificate": { + "markdownDescription": "The ARN of the Secrets Manager secret used for certification\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerRootCaCertificate", "type": "string" }, "StartingPosition": { + "markdownDescription": "\\(Streams only\\) The position in a stream from which to start reading\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StartingPosition", "type": "string" }, "TopicName": { + "markdownDescription": "The name of the topic that the pipe will read from\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TopicName", "type": "string" }, "Vpc": { - "$ref": "#/definitions/AWS::Pipes::Pipe.SelfManagedKafkaAccessConfigurationVpc" + "$ref": "#/definitions/AWS::Pipes::Pipe.SelfManagedKafkaAccessConfigurationVpc", + "markdownDescription": "This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used\\. \n*Required*: No \n*Type*: [SelfManagedKafkaAccessConfigurationVpc](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Vpc" } }, "required": [ @@ -146272,9 +150477,13 @@ "additionalProperties": false, "properties": { "BatchSize": { + "markdownDescription": "The maximum number of records to include in each batch\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchSize", "type": "number" }, "MaximumBatchingWindowInSeconds": { + "markdownDescription": "The maximum length of a time to wait for events\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaximumBatchingWindowInSeconds", "type": "number" } }, @@ -146284,34 +150493,48 @@ "additionalProperties": false, "properties": { "ArrayProperties": { - "$ref": "#/definitions/AWS::Pipes::Pipe.BatchArrayProperties" + "$ref": "#/definitions/AWS::Pipes::Pipe.BatchArrayProperties", + "markdownDescription": "The array properties for the submitted job, such as the size of the array\\. The array size can be between 2 and 10,000\\. If you specify array properties for a job, it becomes an array job\\. This parameter is used only if the target is an AWS Batch job\\. \n*Required*: No \n*Type*: [BatchArrayProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batcharrayproperties.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ArrayProperties" }, "ContainerOverrides": { - "$ref": "#/definitions/AWS::Pipes::Pipe.BatchContainerOverrides" + "$ref": "#/definitions/AWS::Pipes::Pipe.BatchContainerOverrides", + "markdownDescription": "The overrides that are sent to a container\\. \n*Required*: No \n*Type*: [BatchContainerOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchcontaineroverrides.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContainerOverrides" }, "DependsOn": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.BatchJobDependency" }, + "markdownDescription": "A list of dependencies for the job\\. A job can depend upon a maximum of 20 jobs\\. You can specify a `SEQUENTIAL` type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0\\. You can also specify an `N_TO_N` type dependency with a job ID for array jobs\\. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin\\. \n*Required*: No \n*Type*: List of [BatchJobDependency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchjobdependency.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DependsOn", "type": "array" }, "JobDefinition": { + "markdownDescription": "The job definition used by this job\\. This value can be one of `name`, `name:revision`, or the Amazon Resource Name \\(ARN\\) for the job definition\\. If name is specified without a revision then the latest active revision is used\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "JobDefinition", "type": "string" }, "JobName": { + "markdownDescription": "The name of the job\\. It can be up to 128 letters long\\. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens \\(\\-\\), and underscores \\(\\_\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "JobName", "type": "string" }, "Parameters": { "additionalProperties": true, + "markdownDescription": "Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition\\. Parameters are specified as a key and value pair mapping\\. Parameters included here override any corresponding parameter defaults from the job definition\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Parameters", "type": "object" }, "RetryStrategy": { - "$ref": "#/definitions/AWS::Pipes::Pipe.BatchRetryStrategy" + "$ref": "#/definitions/AWS::Pipes::Pipe.BatchRetryStrategy", + "markdownDescription": "The retry strategy to use for failed jobs\\. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition\\. \n*Required*: No \n*Type*: [BatchRetryStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-batchretrystrategy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RetryStrategy" } }, "required": [ @@ -146324,9 +150547,13 @@ "additionalProperties": false, "properties": { "LogStreamName": { + "markdownDescription": "The name of the log stream\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogStreamName", "type": "string" }, "Timestamp": { + "markdownDescription": "The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Timestamp", "type": "string" } }, @@ -146339,57 +150566,87 @@ "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.CapacityProviderStrategyItem" }, + "markdownDescription": "The capacity provider strategy to use for the task\\. \nIf a `capacityProviderStrategy` is specified, the `launchType` parameter must be omitted\\. If no `capacityProviderStrategy` or launchType is specified, the `defaultCapacityProviderStrategy` for the cluster is used\\. \n*Required*: No \n*Type*: List of [CapacityProviderStrategyItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-capacityproviderstrategyitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CapacityProviderStrategy", "type": "array" }, "EnableECSManagedTags": { + "markdownDescription": "Specifies whether to enable Amazon ECS managed tags for the task\\. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon Elastic Container Service Developer Guide\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableECSManagedTags", "type": "boolean" }, "EnableExecuteCommand": { + "markdownDescription": "Whether or not to enable the execute command functionality for the containers in this task\\. If true, this enables execute command functionality on all containers in the task\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableExecuteCommand", "type": "boolean" }, "Group": { + "markdownDescription": "Specifies an Amazon ECS task group for the task\\. The maximum length is 255 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Group", "type": "string" }, "LaunchType": { + "markdownDescription": "Specifies the launch type on which your task is running\\. The launch type that you specify here must match one of the launch type \\(compatibilities\\) of the target task\\. The `FARGATE` value is supported only in the Regions where AWS Fargate with Amazon ECS is supported\\. For more information, see [AWS Fargate on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LaunchType", "type": "string" }, "NetworkConfiguration": { - "$ref": "#/definitions/AWS::Pipes::Pipe.NetworkConfiguration" + "$ref": "#/definitions/AWS::Pipes::Pipe.NetworkConfiguration", + "markdownDescription": "Use this structure if the Amazon ECS task uses the `awsvpc` network mode\\. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used\\. This structure is required if `LaunchType` is `FARGATE` because the `awsvpc` mode is required for Fargate tasks\\. \nIf you specify `NetworkConfiguration` when the target ECS task does not use the `awsvpc` network mode, the task fails\\. \n*Required*: No \n*Type*: [NetworkConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-networkconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkConfiguration" }, "Overrides": { - "$ref": "#/definitions/AWS::Pipes::Pipe.EcsTaskOverride" + "$ref": "#/definitions/AWS::Pipes::Pipe.EcsTaskOverride", + "markdownDescription": "The overrides that are associated with a task\\. \n*Required*: No \n*Type*: [EcsTaskOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-ecstaskoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Overrides" }, "PlacementConstraints": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.PlacementConstraint" }, + "markdownDescription": "An array of placement constraint objects to use for the task\\. You can specify up to 10 constraints per task \\(including constraints in the task definition and those specified at runtime\\)\\. \n*Required*: No \n*Type*: List of [PlacementConstraint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementconstraint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PlacementConstraints", "type": "array" }, "PlacementStrategy": { "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.PlacementStrategy" }, + "markdownDescription": "The placement strategy objects to use for the task\\. You can specify a maximum of five strategy rules per task\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementstrategy.html) of [PlacementStrategy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-placementstrategy.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PlacementStrategy", "type": "array" }, "PlatformVersion": { + "markdownDescription": "Specifies the platform version for the task\\. Specify only the numeric portion of the platform version, such as `1.1.0`\\. \nThis structure is used only if `LaunchType` is `FARGATE`\\. For more information about valid platform versions, see [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PlatformVersion", "type": "string" }, "PropagateTags": { + "markdownDescription": "Specifies whether to propagate the tags from the task definition to the task\\. If no value is specified, the tags are not propagated\\. Tags can only be propagated to the task during task creation\\. To add tags to a task after task creation, use the `TagResource` API action\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PropagateTags", "type": "string" }, "ReferenceId": { + "markdownDescription": "The reference ID to use for the task\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReferenceId", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The metadata that you apply to the task to help you categorize and organize them\\. Each tag consists of a key and an optional value, both of which you define\\. To learn more, see [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) in the Amazon ECS API Reference\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TaskCount": { + "markdownDescription": "The number of tasks to create based on `TaskDefinition`\\. The default is 1\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TaskCount", "type": "number" }, "TaskDefinitionArn": { + "markdownDescription": "The ARN of the task definition to use if the event target is an Amazon ECS task\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TaskDefinitionArn", "type": "string" } }, @@ -146402,21 +150659,31 @@ "additionalProperties": false, "properties": { "DetailType": { + "markdownDescription": "A free\\-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DetailType", "type": "string" }, "EndpointId": { + "markdownDescription": "The URL subdomain of the endpoint\\. For example, if the URL for Endpoint is https://abcde\\.veo\\.endpoints\\.event\\.amazonaws\\.com, then the EndpointId is `abcde.veo`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndpointId", "type": "string" }, "Resources": { "items": { "type": "string" }, + "markdownDescription": "AWS resources, identified by Amazon Resource Name \\(ARN\\), which the event primarily concerns\\. Any number, including zero, may be present\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Resources", "type": "array" }, "Source": { + "markdownDescription": "The source of the event\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Source", "type": "string" }, "Time": { + "markdownDescription": "The time stamp of the event, per [RFC3339](https://www.rfc-editor.org/rfc/rfc3339.txt)\\. If no time stamp is provided, the time stamp of the [PutEvents](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) call is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Time", "type": "string" } }, @@ -146427,26 +150694,32 @@ "properties": { "HeaderParameters": { "additionalProperties": true, + "markdownDescription": "The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "HeaderParameters", "type": "object" }, "PathParameterValues": { "items": { "type": "string" }, + "markdownDescription": "The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards \\(\"\\*\"\\)\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PathParameterValues", "type": "array" }, "QueryStringParameters": { "additionalProperties": true, + "markdownDescription": "The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "QueryStringParameters", "type": "object" } }, @@ -146456,6 +150729,8 @@ "additionalProperties": false, "properties": { "PartitionKey": { + "markdownDescription": "Determines which shard in the stream the data record is assigned to\\. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key\\. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard\\. Specifically, an MD5 hash function is used to map partition keys to 128\\-bit integer values and to map associated data records to shards\\. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PartitionKey", "type": "string" } }, @@ -146468,6 +150743,8 @@ "additionalProperties": false, "properties": { "InvocationType": { + "markdownDescription": "Specify whether to invoke the function synchronously or asynchronously\\. \n+ `REQUEST_RESPONSE` \\(default\\) \\- Invoke synchronously\\. This corresponds to the `RequestResponse` option in the `InvocationType` parameter for the Lambda [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) API\\.\n+ `FIRE_AND_FORGET` \\- Invoke asynchronously\\. This corresponds to the `Event` option in the `InvocationType` parameter for the Lambda [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) API\\.\nFor more information, see [Invocation types](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) in the *Amazon EventBridge User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InvocationType", "type": "string" } }, @@ -146477,40 +150754,64 @@ "additionalProperties": false, "properties": { "BatchJobParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetBatchJobParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetBatchJobParameters", + "markdownDescription": "The parameters for using an AWS Batch job as a target\\. \n*Required*: No \n*Type*: [PipeTargetBatchJobParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BatchJobParameters" }, "CloudWatchLogsParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetCloudWatchLogsParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetCloudWatchLogsParameters", + "markdownDescription": "The parameters for using an CloudWatch Logs log stream as a target\\. \n*Required*: No \n*Type*: [PipeTargetCloudWatchLogsParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetcloudwatchlogsparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CloudWatchLogsParameters" }, "EcsTaskParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetEcsTaskParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetEcsTaskParameters", + "markdownDescription": "The parameters for using an Amazon ECS task as a target\\. \n*Required*: No \n*Type*: [PipeTargetEcsTaskParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetecstaskparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EcsTaskParameters" }, "EventBridgeEventBusParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetEventBridgeEventBusParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetEventBridgeEventBusParameters", + "markdownDescription": "The parameters for using an EventBridge event bus as a target\\. \n*Required*: No \n*Type*: [PipeTargetEventBridgeEventBusParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventBridgeEventBusParameters" }, "HttpParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetHttpParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetHttpParameters", + "markdownDescription": "These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations\\. \n*Required*: No \n*Type*: [PipeTargetHttpParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargethttpparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HttpParameters" }, "InputTemplate": { + "markdownDescription": "Valid JSON text passed to the target\\. In this case, nothing from the event itself is passed to the target\\. For more information, see [The JavaScript Object Notation \\(JSON\\) Data Interchange Format](http://www.rfc-editor.org/rfc/rfc7159.txt)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InputTemplate", "type": "string" }, "KinesisStreamParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetKinesisStreamParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetKinesisStreamParameters", + "markdownDescription": "The parameters for using a Kinesis stream as a source\\. \n*Required*: No \n*Type*: [PipeTargetKinesisStreamParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetkinesisstreamparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KinesisStreamParameters" }, "LambdaFunctionParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetLambdaFunctionParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetLambdaFunctionParameters", + "markdownDescription": "The parameters for using a Lambda function as a target\\. \n*Required*: No \n*Type*: [PipeTargetLambdaFunctionParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetlambdafunctionparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LambdaFunctionParameters" }, "RedshiftDataParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetRedshiftDataParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetRedshiftDataParameters", + "markdownDescription": "These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement\\. \n*Required*: No \n*Type*: [PipeTargetRedshiftDataParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetredshiftdataparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RedshiftDataParameters" }, "SageMakerPipelineParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetSageMakerPipelineParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetSageMakerPipelineParameters", + "markdownDescription": "The parameters for using a SageMaker pipeline as a target\\. \n*Required*: No \n*Type*: [PipeTargetSageMakerPipelineParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsagemakerpipelineparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SageMakerPipelineParameters" }, "SqsQueueParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetSqsQueueParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetSqsQueueParameters", + "markdownDescription": "The parameters for using a Amazon SQS stream as a source\\. \n*Required*: No \n*Type*: [PipeTargetSqsQueueParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetsqsqueueparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SqsQueueParameters" }, "StepFunctionStateMachineParameters": { - "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetStateMachineParameters" + "$ref": "#/definitions/AWS::Pipes::Pipe.PipeTargetStateMachineParameters", + "markdownDescription": "The parameters for using a Step Functions state machine as a target\\. \n*Required*: No \n*Type*: [PipeTargetStateMachineParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetstatemachineparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StepFunctionStateMachineParameters" } }, "type": "object" @@ -146519,24 +150820,36 @@ "additionalProperties": false, "properties": { "Database": { + "markdownDescription": "The name of the database\\. Required when authenticating using temporary credentials\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Database", "type": "string" }, "DbUser": { + "markdownDescription": "The database user name\\. Required when authenticating using temporary credentials\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DbUser", "type": "string" }, "SecretManagerArn": { + "markdownDescription": "The name or ARN of the secret that enables access to the database\\. Required when authenticating using Secrets Manager\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecretManagerArn", "type": "string" }, "Sqls": { "items": { "type": "string" }, + "markdownDescription": "The SQL statement text to run\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sqls", "type": "array" }, "StatementName": { + "markdownDescription": "The name of the SQL statement\\. You can name the SQL statement when you create it to identify the query\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StatementName", "type": "string" }, "WithEvent": { + "markdownDescription": "Indicates whether to send an event back to EventBridge after the SQL statement runs\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WithEvent", "type": "boolean" } }, @@ -146553,6 +150866,8 @@ "items": { "$ref": "#/definitions/AWS::Pipes::Pipe.SageMakerPipelineParameter" }, + "markdownDescription": "List of Parameter names and values for SageMaker Model Building Pipeline execution\\. \n*Required*: No \n*Type*: List of [SageMakerPipelineParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-sagemakerpipelineparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PipelineParameterList", "type": "array" } }, @@ -146562,9 +150877,13 @@ "additionalProperties": false, "properties": { "MessageDeduplicationId": { + "markdownDescription": "This parameter applies only to FIFO \\(first\\-in\\-first\\-out\\) queues\\. \nThe token used for deduplication of sent messages\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageDeduplicationId", "type": "string" }, "MessageGroupId": { + "markdownDescription": "The FIFO message group ID to use as the target\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageGroupId", "type": "string" } }, @@ -146574,6 +150893,8 @@ "additionalProperties": false, "properties": { "InvocationType": { + "markdownDescription": "Specify whether to invoke the Step Functions state machine synchronously or asynchronously\\. \n+ `REQUEST_RESPONSE` \\(default\\) \\- Invoke synchronously\\. For more information, see [StartSyncExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html) in the *AWS Step Functions API Reference*\\.\n**Note** \n`REQUEST_RESPONSE` is not supported for `STANDARD` state machine workflows\\.\n+ `FIRE_AND_FORGET` \\- Invoke asynchronously\\. For more information, see [StartExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html) in the *AWS Step Functions API Reference*\\.\nFor more information, see [Invocation types](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) in the *Amazon EventBridge User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InvocationType", "type": "string" } }, @@ -146583,9 +150904,13 @@ "additionalProperties": false, "properties": { "Expression": { + "markdownDescription": "A cluster query language expression to apply to the constraint\\. You cannot specify an expression if the constraint type is `distinctInstance`\\. To learn more, see [Cluster Query Language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the Amazon Elastic Container Service Developer Guide\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Expression", "type": "string" }, "Type": { + "markdownDescription": "The type of constraint\\. Use distinctInstance to ensure that each task in a particular group is running on a different container instance\\. Use memberOf to restrict the selection to a group of valid candidates\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -146595,9 +150920,13 @@ "additionalProperties": false, "properties": { "Field": { + "markdownDescription": "The field to apply the placement strategy against\\. For the spread placement strategy, valid values are instanceId \\(or host, which has the same effect\\), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs\\.availability\\-zone\\. For the binpack placement strategy, valid values are cpu and memory\\. For the random placement strategy, this field is not used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Field", "type": "string" }, "Type": { + "markdownDescription": "The type of placement strategy\\. The random placement strategy randomly places tasks on available candidates\\. The spread placement strategy spreads placement across available candidates evenly based on the field parameter\\. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter\\. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory \\(but still enough to run the task\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -146607,9 +150936,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "Name of parameter to start execution of a SageMaker Model Building Pipeline\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Value": { + "markdownDescription": "Value of parameter to start execution of a SageMaker Model Building Pipeline\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -146623,15 +150956,23 @@ "additionalProperties": false, "properties": { "BasicAuth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BasicAuth", "type": "string" }, "ClientCertificateTlsAuth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientCertificateTlsAuth", "type": "string" }, "SaslScram256Auth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SaslScram256Auth", "type": "string" }, "SaslScram512Auth": { + "markdownDescription": "The ARN of the Secrets Manager secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SaslScram512Auth", "type": "string" } }, @@ -146644,12 +150985,16 @@ "items": { "type": "string" }, + "markdownDescription": "Specifies the security groups associated with the stream\\. These security groups must all be in the same VPC\\. You can specify as many as five security groups\\. If you do not specify a security group, the default security group for the VPC is used\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroup", "type": "array" }, "Subnets": { "items": { "type": "string" }, + "markdownDescription": "Specifies the subnets associated with the stream\\. These subnets must all be in the same VPC\\. You can specify as many as 16 subnets\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Subnets", "type": "array" } }, @@ -146691,12 +151036,12 @@ "additionalProperties": false, "properties": { "DeletionProtection": { - "markdownDescription": "The flag that prevents a ledger from being deleted by any user\\. If not provided on ledger creation, this feature is enabled \\(`true`\\) by default\\. \nIf deletion protection is enabled, you must first disable it before you can delete the ledger\\. You can disable it by calling the `UpdateLedger` operation to set the flag to `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether the ledger is protected from being deleted by any user\\. If not defined during ledger creation, this feature is enabled \\(`true`\\) by default\\. \nIf deletion protection is enabled, you must first disable it before you can delete the ledger\\. You can disable it by calling the `UpdateLedger` operation to set this parameter to `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeletionProtection", "type": "boolean" }, "KmsKey": { - "markdownDescription": "The key in AWS Key Management Service \\(AWS KMS\\) to use for encryption of data at rest in the ledger\\. For more information, see [Encryption at rest](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) in the *Amazon QLDB Developer Guide*\\. \nUse one of the following options to specify this parameter: \n+ `AWS_OWNED_KMS_KEY`: Use an AWS KMS key that is owned and managed by AWS on your behalf\\.\n+ **Undefined**: By default, use an AWS owned KMS key\\.\n+ **A valid symmetric customer managed KMS key**: Use the specified KMS key in your account that you create, own, and manage\\.", + "markdownDescription": "The key in AWS Key Management Service \\(AWS KMS\\) to use for encryption of data at rest in the ledger\\. For more information, see [Encryption at rest](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) in the *Amazon QLDB Developer Guide*\\. \nUse one of the following options to specify this parameter: \n+ `AWS_OWNED_KMS_KEY`: Use an AWS KMS key that is owned and managed by AWS on your behalf\\.\n+ **Undefined**: By default, use an AWS owned KMS key\\.\n+ **A valid symmetric customer managed KMS key**: Use the specified symmetric encryption KMS key in your account that you create, own, and manage\\.", "title": "KmsKey", "type": "string" }, @@ -146901,7 +151246,7 @@ "additionalProperties": false, "properties": { "AnalysisId": { - "markdownDescription": "The ID for the analysis that you're creating\\. This ID displays in the URL of the analysis\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID for the analysis that you're creating\\. This ID displays in the URL of the analysis\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AnalysisId", "type": "string" }, @@ -146914,7 +151259,7 @@ "items": { "$ref": "#/definitions/AWS::QuickSight::Analysis.AnalysisError" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [AnalysisError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysiserror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [AnalysisError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysiserror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Errors", "type": "array" }, @@ -146938,7 +151283,7 @@ }, "SourceEntity": { "$ref": "#/definitions/AWS::QuickSight::Analysis.AnalysisSourceEntity", - "markdownDescription": "A source entity to use for the analysis that you're creating\\. This metadata structure contains details that describe a source template and one or more datasets\\. \n*Required*: Yes \n*Type*: [AnalysisSourceEntity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourceentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A source entity to use for the analysis that you're creating\\. This metadata structure contains details that describe a source template and one or more datasets\\. \nEither a `SourceEntity` or a `Definition` must be provided in order for the request to be valid\\. \n*Required*: Yes \n*Type*: [AnalysisSourceEntity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourceentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceEntity" }, "Tags": { @@ -147187,12 +151532,12 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of a sheet\\. This name is displayed on the sheet's tab in the Amazon QuickSight console\\. \n*Required*: No \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of a sheet\\. This name is displayed on the sheet's tab in the Amazon QuickSight console\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "SheetId": { - "markdownDescription": "The unique identifier associated with a sheet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The unique identifier associated with a sheet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SheetId", "type": "string" } @@ -147263,7 +151608,7 @@ "type": "string" }, "DashboardId": { - "markdownDescription": "The ID for the dashboard, also added to the IAM policy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID for the dashboard, also added to the IAM policy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DashboardId", "type": "string" }, @@ -147357,9 +151702,13 @@ "additionalProperties": false, "properties": { "Message": { + "markdownDescription": "Message\\. \n*Required*: No \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Message", "type": "string" }, "Type": { + "markdownDescription": "Type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACCESS_DENIED | COLUMN_GEOGRAPHIC_ROLE_MISMATCH | COLUMN_REPLACEMENT_MISSING | COLUMN_TYPE_MISMATCH | DATA_SET_NOT_FOUND | INTERNAL_FAILURE | PARAMETER_NOT_FOUND | PARAMETER_TYPE_INVALID | PARAMETER_VALUE_INCOMPATIBLE | SOURCE_NOT_FOUND` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -147424,42 +151773,62 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Arn", "type": "string" }, "CreatedTime": { + "markdownDescription": "The time that this dashboard version was created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreatedTime", "type": "string" }, "DataSetArns": { "items": { "type": "string" }, + "markdownDescription": "The Amazon Resource Numbers \\(ARNs\\) for the datasets that are associated with this version of the dashboard\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSetArns", "type": "array" }, "Description": { + "markdownDescription": "Description\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Errors": { "items": { "$ref": "#/definitions/AWS::QuickSight::Dashboard.DashboardError" }, + "markdownDescription": "Errors associated with this dashboard version\\. \n*Required*: No \n*Type*: List of [DashboardError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboarderror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Errors", "type": "array" }, "Sheets": { "items": { "$ref": "#/definitions/AWS::QuickSight::Dashboard.Sheet" }, + "markdownDescription": "A list of the associated sheets with the unique identifier and name of each sheet\\. \n*Required*: No \n*Type*: List of [Sheet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-sheet.html) \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sheets", "type": "array" }, "SourceEntityArn": { + "markdownDescription": "Source entity ARN\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceEntityArn", "type": "string" }, "Status": { + "markdownDescription": "The HTTP status of the request\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CREATION_FAILED | CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | DELETED | UPDATE_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "ThemeArn": { + "markdownDescription": "The ARN of the theme associated with a version of the dashboard\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ThemeArn", "type": "string" }, "VersionNumber": { + "markdownDescription": "Version number for this version of the dashboard\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VersionNumber", "type": "number" } }, @@ -147630,9 +151999,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of a sheet\\. This name is displayed on the sheet's tab in the Amazon QuickSight console\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "SheetId": { + "markdownDescription": "The unique identifier associated with a sheet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SheetId", "type": "string" } }, @@ -147734,7 +152107,9 @@ "type": "string" }, "DataSetUsageConfiguration": { - "$ref": "#/definitions/AWS::QuickSight::DataSet.DataSetUsageConfiguration" + "$ref": "#/definitions/AWS::QuickSight::DataSet.DataSetUsageConfiguration", + "markdownDescription": "The usage configuration to apply to child datasets that reference this dataset as a source\\. \n*Required*: No \n*Type*: [DataSetUsageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetusageconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSetUsageConfiguration" }, "FieldFolders": { "additionalProperties": false, @@ -147995,9 +152370,13 @@ "additionalProperties": false, "properties": { "DisableUseAsDirectQuerySource": { + "markdownDescription": "An option that controls whether a child dataset of a direct query can use this dataset as a source\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DisableUseAsDirectQuerySource", "type": "boolean" }, "DisableUseAsImportedSource": { + "markdownDescription": "An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DisableUseAsImportedSource", "type": "boolean" } }, @@ -148165,7 +152544,7 @@ "items": { "$ref": "#/definitions/AWS::QuickSight::DataSet.TransformOperation" }, - "markdownDescription": "Transform operations that act on this logical table\\. \n*Required*: No \n*Type*: List of [TransformOperation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html) \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Transform operations that act on this logical table\\. For this structure to be valid, only one of the attributes can be non\\-null\\. \n*Required*: No \n*Type*: List of [TransformOperation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-transformoperation.html) \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DataTransforms", "type": "array" }, @@ -148185,6 +152564,8 @@ "additionalProperties": false, "properties": { "DataSetArn": { + "markdownDescription": "The Amazon Resource Number \\(ARN\\) of the parent dataset\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSetArn", "type": "string" }, "JoinInstruction": { @@ -148263,7 +152644,7 @@ "additionalProperties": false, "properties": { "Catalog": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Catalog", "type": "string" }, @@ -148584,7 +152965,7 @@ "type": "array" }, "Type": { - "markdownDescription": "The type of the data source\\. To return a list of all data sources, use `ListDataSources`\\. \nUse `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | AMAZON_OPENSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | EXASOL | GITHUB | JIRA | MARIADB | MYSQL | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TIMESTREAM | TWITTER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of the data source\\. To return a list of all data sources, use `ListDataSources`\\. \nUse `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | AMAZON_OPENSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | DATABRICKS | EXASOL | GITHUB | JIRA | MARIADB | MYSQL | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TIMESTREAM | TWITTER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" }, @@ -148749,6 +153130,8 @@ "title": "CredentialPair" }, "SecretArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the secret associated with the data source in Amazon Secrets Manager\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecretArn", "type": "string" } }, @@ -148799,7 +153182,9 @@ "title": "AuroraPostgreSqlParameters" }, "DatabricksParameters": { - "$ref": "#/definitions/AWS::QuickSight::DataSource.DatabricksParameters" + "$ref": "#/definitions/AWS::QuickSight::DataSource.DatabricksParameters", + "markdownDescription": "The required parameters that are needed to connect to a Databricks data source\\. \n*Required*: No \n*Type*: [DatabricksParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-datasource-databricksparameters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DatabricksParameters" }, "MariaDbParameters": { "$ref": "#/definitions/AWS::QuickSight::DataSource.MariaDbParameters", @@ -148868,12 +153253,18 @@ "additionalProperties": false, "properties": { "Host": { + "markdownDescription": "The host name of the Databricks data source\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Host", "type": "string" }, "Port": { + "markdownDescription": "The port for the Databricks data source\\. \n*Required*: Yes \n*Type*: Double \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "SqlEndpointPath": { + "markdownDescription": "The HTTP path of the Databricks data source\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `4096` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SqlEndpointPath", "type": "string" } }, @@ -149298,7 +153689,7 @@ }, "SourceEntity": { "$ref": "#/definitions/AWS::QuickSight::Template.TemplateSourceEntity", - "markdownDescription": "The entity that you are using as a source when you create the template\\. In `SourceEntity`, you specify the type of object you're using as source: `SourceTemplate` for a template or `SourceAnalysis` for an analysis\\. Both of these require an Amazon Resource Name \\(ARN\\)\\. For `SourceTemplate`, specify the ARN of the source template\\. For `SourceAnalysis`, specify the ARN of the source analysis\\. The `SourceTemplate` ARN can contain any AWS account and any Amazon QuickSight\\-supported AWS Region\\. \nUse the `DataSetReferences` entity within `SourceTemplate` or `SourceAnalysis` to list the replacement datasets for the placeholders listed in the original\\. The schema in each dataset must match its placeholder\\. \n*Required*: Yes \n*Type*: [TemplateSourceEntity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The entity that you are using as a source when you create the template\\. In `SourceEntity`, you specify the type of object you're using as source: `SourceTemplate` for a template or `SourceAnalysis` for an analysis\\. Both of these require an Amazon Resource Name \\(ARN\\)\\. For `SourceTemplate`, specify the ARN of the source template\\. For `SourceAnalysis`, specify the ARN of the source analysis\\. The `SourceTemplate` ARN can contain any AWS account and any Amazon QuickSight\\-supported AWS Region\\. \nUse the `DataSetReferences` entity within `SourceTemplate` or `SourceAnalysis` to list the replacement datasets for the placeholders listed in the original\\. The schema in each dataset must match its placeholder\\. \nEither a `SourceEntity` or a `Definition` must be provided in order for the request to be valid\\. \n*Required*: Yes \n*Type*: [TemplateSourceEntity](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceEntity" }, "Tags": { @@ -149310,7 +153701,7 @@ "type": "array" }, "TemplateId": { - "markdownDescription": "An ID for the template that you want to create\\. This template is unique per AWS Region; in each AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An ID for the template that you want to create\\. This template is unique per AWS Region; in each AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TemplateId", "type": "string" }, @@ -149352,6 +153743,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the column group's column schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -149364,9 +153757,13 @@ "items": { "$ref": "#/definitions/AWS::QuickSight::Template.ColumnGroupColumnSchema" }, + "markdownDescription": "A structure containing the list of schemas for column group columns\\. \n*Required*: No \n*Type*: List of [ColumnGroupColumnSchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupcolumnschema.html) \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ColumnGroupColumnSchemaList", "type": "array" }, "Name": { + "markdownDescription": "The name of the column group schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -149376,12 +153773,18 @@ "additionalProperties": false, "properties": { "DataType": { + "markdownDescription": "The data type of the column schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataType", "type": "string" }, "GeographicRole": { + "markdownDescription": "The geographic role of the column schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GeographicRole", "type": "string" }, "Name": { + "markdownDescription": "The name of the column schema\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -149394,12 +153797,18 @@ "items": { "$ref": "#/definitions/AWS::QuickSight::Template.ColumnGroupSchema" }, + "markdownDescription": "A structure containing the list of column group schemas\\. \n*Required*: No \n*Type*: List of [ColumnGroupSchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupschema.html) \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ColumnGroupSchemaList", "type": "array" }, "DataSetSchema": { - "$ref": "#/definitions/AWS::QuickSight::Template.DataSetSchema" + "$ref": "#/definitions/AWS::QuickSight::Template.DataSetSchema", + "markdownDescription": "Dataset schema\\. \n*Required*: No \n*Type*: [DataSetSchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetschema.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSetSchema" }, "Placeholder": { + "markdownDescription": "Placeholder\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Placeholder", "type": "string" } }, @@ -149432,6 +153841,8 @@ "items": { "$ref": "#/definitions/AWS::QuickSight::Template.ColumnSchema" }, + "markdownDescription": "A structure containing the list of column schemas\\. \n*Required*: No \n*Type*: List of [ColumnSchema](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html) \n*Maximum*: `500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ColumnSchemaList", "type": "array" } }, @@ -149464,9 +153875,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of a sheet\\. This name is displayed on the sheet's tab in the Amazon QuickSight console\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "SheetId": { + "markdownDescription": "The unique identifier associated with a sheet\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SheetId", "type": "string" } }, @@ -149476,9 +153891,13 @@ "additionalProperties": false, "properties": { "Message": { + "markdownDescription": "Description of the error type\\. \n*Required*: No \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Message", "type": "string" }, "Type": { + "markdownDescription": "Type of error\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACCESS_DENIED | DATA_SET_NOT_FOUND | INTERNAL_FAILURE | SOURCE_NOT_FOUND` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -149541,39 +153960,57 @@ "additionalProperties": false, "properties": { "CreatedTime": { + "markdownDescription": "The time that this template version was created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreatedTime", "type": "string" }, "DataSetConfigurations": { "items": { "$ref": "#/definitions/AWS::QuickSight::Template.DataSetConfiguration" }, + "markdownDescription": "Schema of the dataset identified by the placeholder\\. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation\\. \n*Required*: No \n*Type*: List of [DataSetConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html) \n*Maximum*: `30` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataSetConfigurations", "type": "array" }, "Description": { + "markdownDescription": "The description of the template\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Errors": { "items": { "$ref": "#/definitions/AWS::QuickSight::Template.TemplateError" }, + "markdownDescription": "Errors associated with this template version\\. \n*Required*: No \n*Type*: List of [TemplateError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateerror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Errors", "type": "array" }, "Sheets": { "items": { "$ref": "#/definitions/AWS::QuickSight::Template.Sheet" }, + "markdownDescription": "A list of the associated sheets with the unique identifier and name of each sheet\\. \n*Required*: No \n*Type*: List of [Sheet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheet.html) \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Sheets", "type": "array" }, "SourceEntityArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an analysis or template that was used to create this template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceEntityArn", "type": "string" }, "Status": { + "markdownDescription": "The status that is associated with the template\\. \n+ `CREATION_IN_PROGRESS` \n+ `CREATION_SUCCESSFUL` \n+ `CREATION_FAILED` \n+ `UPDATE_IN_PROGRESS` \n+ `UPDATE_SUCCESSFUL` \n+ `UPDATE_FAILED` \n+ `DELETED` \n*Required*: No \n*Type*: String \n*Allowed values*: `CREATION_FAILED | CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | DELETED | UPDATE_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "ThemeArn": { + "markdownDescription": "The ARN of the theme associated with this version of the template\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ThemeArn", "type": "string" }, "VersionNumber": { + "markdownDescription": "The version number of the template version\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VersionNumber", "type": "number" } }, @@ -149620,7 +154057,7 @@ "type": "string" }, "BaseThemeId": { - "markdownDescription": "The ID of the theme that a custom theme will inherit from\\. All themes inherit from one of the starting themes defined by Amazon QuickSight\\. For a list of the starting themes, use `ListThemes` or choose **Themes** from within an analysis\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of the theme that a custom theme will inherit from\\. All themes inherit from one of the starting themes defined by Amazon QuickSight\\. For a list of the starting themes, use `ListThemes` or choose **Themes** from within an analysis\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BaseThemeId", "type": "string" }, @@ -149651,7 +154088,7 @@ "type": "array" }, "ThemeId": { - "markdownDescription": "An ID for the theme that you want to create\\. The theme ID is unique per AWS Region in each AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An ID for the theme that you want to create\\. The theme ID is unique per AWS Region in each AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ThemeId", "type": "string" }, @@ -149730,7 +154167,7 @@ "additionalProperties": false, "properties": { "FontFamily": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FontFamily", "type": "string" } @@ -149813,7 +154250,7 @@ }, "Typography": { "$ref": "#/definitions/AWS::QuickSight::Theme.Typography", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [Typography](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-typography.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Typography](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-typography.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Typography" }, "UIColorPalette": { @@ -149828,9 +154265,13 @@ "additionalProperties": false, "properties": { "Message": { + "markdownDescription": "The error message\\. \n*Required*: No \n*Type*: String \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Message", "type": "string" }, "Type": { + "markdownDescription": "The type of error\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `INTERNAL_FAILURE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -149840,30 +154281,46 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the resource\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Arn", "type": "string" }, "BaseThemeId": { + "markdownDescription": "The Amazon QuickSight\\-defined ID of the theme that a custom theme inherits from\\. All themes initially inherit from a default Amazon QuickSight theme\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `[\\w\\-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BaseThemeId", "type": "string" }, "Configuration": { - "$ref": "#/definitions/AWS::QuickSight::Theme.ThemeConfiguration" + "$ref": "#/definitions/AWS::QuickSight::Theme.ThemeConfiguration", + "markdownDescription": "The theme configuration, which contains all the theme display properties\\. \n*Required*: No \n*Type*: [ThemeConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Configuration" }, "CreatedTime": { + "markdownDescription": "The date and time that this theme version was created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreatedTime", "type": "string" }, "Description": { + "markdownDescription": "The description of the theme\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Errors": { "items": { "$ref": "#/definitions/AWS::QuickSight::Theme.ThemeError" }, + "markdownDescription": "Errors associated with the theme\\. \n*Required*: No \n*Type*: List of [ThemeError](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-themeerror.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Errors", "type": "array" }, "Status": { + "markdownDescription": "The status of the theme version\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `CREATION_FAILED | CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | DELETED | UPDATE_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "VersionNumber": { + "markdownDescription": "The version number of the theme\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VersionNumber", "type": "number" } }, @@ -149903,7 +154360,7 @@ "items": { "$ref": "#/definitions/AWS::QuickSight::Theme.Font" }, - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: List of [Font](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-font.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [Font](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-theme-font.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FontFamilies", "type": "array" } @@ -150136,231 +154593,269 @@ "additionalProperties": false, "properties": { "AllocatedStorage": { + "markdownDescription": "The amount of storage in gibibytes \\(GiB\\) to allocate to each DB instance in the Multi\\-AZ DB cluster\\. \nThis setting is required to create a Multi\\-AZ DB cluster\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AllocatedStorage", "type": "number" }, "AssociatedRoles": { "items": { "$ref": "#/definitions/AWS::RDS::DBCluster.DBClusterRole" }, - "markdownDescription": "Provides a list of the AWS Identity and Access Management \\(IAM\\) roles that are associated with the DB cluster\\. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf\\. \n*Required*: No \n*Type*: List of [DBClusterRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides a list of the AWS Identity and Access Management \\(IAM\\) roles that are associated with the DB cluster\\. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: List of [DBClusterRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AssociatedRoles", "type": "array" }, "AutoMinorVersionUpgrade": { + "markdownDescription": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window\\. By default, minor engine upgrades are applied automatically\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AutoMinorVersionUpgrade", "type": "boolean" }, "AvailabilityZones": { "items": { "type": "string" }, - "markdownDescription": "A list of Availability Zones \\(AZs\\) where instances in the DB cluster can be created\\. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of Availability Zones \\(AZs\\) where instances in the DB cluster can be created\\. For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AvailabilityZones", "type": "array" }, "BacktrackWindow": { - "markdownDescription": "The target backtrack window, in seconds\\. To disable backtracking, set this value to 0\\. \nCurrently, Backtrack is only supported for Aurora MySQL DB clusters\\.\nDefault: 0 \nConstraints: \n+ If specified, this value must be set to a number from 0 to 259,200 \\(72 hours\\)\\.\n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The target backtrack window, in seconds\\. To disable backtracking, set this value to 0\\. \nCurrently, Backtrack is only supported for Aurora MySQL DB clusters\\.\nDefault: 0 \nConstraints: \n+ If specified, this value must be set to a number from 0 to 259,200 \\(72 hours\\)\\.\nValid for: Aurora MySQL DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BacktrackWindow", "type": "number" }, "BackupRetentionPeriod": { - "markdownDescription": "The number of days for which automated backups are retained\\. \nDefault: 1 \nConstraints: \n+ Must be a value from 1 to 35\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of days for which automated backups are retained\\. \nDefault: 1 \nConstraints: \n+ Must be a value from 1 to 35\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "BackupRetentionPeriod", "type": "number" }, "CopyTagsToSnapshot": { - "markdownDescription": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster\\. The default is not to copy them\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster\\. The default is not to copy them\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CopyTagsToSnapshot", "type": "boolean" }, "DBClusterIdentifier": { - "markdownDescription": "The DB cluster identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain from 1 to 63 letters, numbers, or hyphens\\.\n+ First character must be a letter\\.\n+ Can't end with a hyphen or contain two consecutive hyphens\\.\nExample: `my-cluster1` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The DB cluster identifier\\. This parameter is stored as a lowercase string\\. \nConstraints: \n+ Must contain from 1 to 63 letters, numbers, or hyphens\\.\n+ First character must be a letter\\.\n+ Can't end with a hyphen or contain two consecutive hyphens\\.\nExample: `my-cluster1` \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DBClusterIdentifier", "type": "string" }, "DBClusterInstanceClass": { + "markdownDescription": "The compute and memory capacity of each DB instance in the Multi\\-AZ DB cluster, for example db\\.m6gd\\.xlarge\\. Not all DB instance classes are available in all AWS Regions, or for all database engines\\. \nFor the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide*\\. \nThis setting is required to create a Multi\\-AZ DB cluster\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DBClusterInstanceClass", "type": "string" }, "DBClusterParameterGroupName": { - "markdownDescription": "The name of the DB cluster parameter group to associate with this DB cluster\\. \nIf you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot\\. This can result in an outage while the DB instances are rebooting\\. \nIf you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started\\.\nTo list all of the available DB cluster parameter group names, use the following command: \n`aws rds describe-db-cluster-parameter-groups --query \"DBClusterParameterGroups[].DBClusterParameterGroupName\" --output text` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the DB cluster parameter group to associate with this DB cluster\\. \nIf you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot\\. This can result in an outage while the DB instances are rebooting\\. \nIf you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started\\.\nTo list all of the available DB cluster parameter group names, use the following command: \n`aws rds describe-db-cluster-parameter-groups --query \"DBClusterParameterGroups[].DBClusterParameterGroupName\" --output text` \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DBClusterParameterGroupName", "type": "string" }, "DBInstanceParameterGroupName": { + "markdownDescription": "The name of the DB parameter group to apply to all instances of the DB cluster\\. \nWhen you apply a parameter group using the `DBInstanceParameterGroupName` parameter, the DB cluster isn't rebooted automatically\\. Also, parameter changes are applied immediately rather than during the next maintenance window\\.\nDefault: The existing name setting \nConstraints: \n+ The DB parameter group must be in the same DB parameter group family as this DB cluster\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DBInstanceParameterGroupName", "type": "string" }, "DBSubnetGroupName": { - "markdownDescription": "A DB subnet group that you want to associate with this DB cluster\\. \nIf you are restoring a DB cluster to a point in time with `RestoreType` set to `copy-on-write`, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A DB subnet group that you want to associate with this DB cluster\\. \nIf you are restoring a DB cluster to a point in time with `RestoreType` set to `copy-on-write`, and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DBSubnetGroupName", "type": "string" }, "DBSystemId": { + "markdownDescription": "Reserved for future use\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DBSystemId", "type": "string" }, "DatabaseName": { - "markdownDescription": "The name of your database\\. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster\\. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of your database\\. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster\\. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DatabaseName", "type": "string" }, "DeletionProtection": { - "markdownDescription": "A value that indicates whether the DB cluster has deletion protection enabled\\. The database can't be deleted when deletion protection is enabled\\. By default, deletion protection is disabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether the DB cluster has deletion protection enabled\\. The database can't be deleted when deletion protection is enabled\\. By default, deletion protection is disabled\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeletionProtection", "type": "boolean" }, "Domain": { + "markdownDescription": "Indicates the directory ID of the Active Directory to create the DB cluster\\. \nFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster\\. \nFor more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Domain", "type": "string" }, "DomainIAMRoleName": { + "markdownDescription": "Specifies the name of the IAM role to use when making API calls to the Directory Service\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DomainIAMRoleName", "type": "string" }, "EnableCloudwatchLogsExports": { "items": { "type": "string" }, - "markdownDescription": "The list of log types that need to be enabled for exporting to CloudWatch Logs\\. The values in the list depend on the DB engine being used\\. For more information, see [ Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*\\. \n **Aurora MySQL** \nValid values: `audit`, `error`, `general`, `slowquery` \n **Aurora PostgreSQL** \nValid values: `postgresql` \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The list of log types that need to be enabled for exporting to CloudWatch Logs\\. The values in the list depend on the DB engine being used\\. For more information, see [ Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide*\\. \n **Aurora MySQL** \nValid values: `audit`, `error`, `general`, `slowquery` \n **Aurora PostgreSQL** \nValid values: `postgresql` \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableCloudwatchLogsExports", "type": "array" }, "EnableHttpEndpoint": { - "markdownDescription": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster\\. By default, the HTTP endpoint is disabled\\. \nWhen enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster\\. You can also query your database from inside the RDS console with the query editor\\. \nFor more information, see [Using the Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster\\. By default, the HTTP endpoint is disabled\\. \nWhen enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster\\. You can also query your database from inside the RDS console with the query editor\\. \nFor more information, see [Using the Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableHttpEndpoint", "type": "boolean" }, "EnableIAMDatabaseAuthentication": { - "markdownDescription": "A value that indicates whether to enable mapping of AWS Identity and Access Management \\(IAM\\) accounts to database accounts\\. By default, mapping is disabled\\. \nFor more information, see [ IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide\\.* \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether to enable mapping of AWS Identity and Access Management \\(IAM\\) accounts to database accounts\\. By default, mapping is disabled\\. \nFor more information, see [ IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide\\.* \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableIAMDatabaseAuthentication", "type": "boolean" }, "Engine": { - "markdownDescription": "The name of the database engine to be used for this DB cluster\\. \nValid Values: `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\), `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\), and `aurora-postgresql` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The name of the database engine to be used for this DB cluster\\. \nValid Values: \n+ `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\)\n+ `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\)\n+ `aurora-postgresql`\n+ `mysql`\n+ `postgres`\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "Engine", "type": "string" }, "EngineMode": { - "markdownDescription": "The DB engine mode of the DB cluster, either `provisioned`, `serverless`, `parallelquery`, `global`, or `multimaster`\\. \nThe `parallelquery` engine mode isn't required for Aurora MySQL version 1\\.23 and higher 1\\.x versions, and version 2\\.09 and higher 2\\.x versions\\. \nThe `global` engine mode isn't required for Aurora MySQL version 1\\.22 and higher 1\\.x versions, and `global` engine mode isn't required for any 2\\.x versions\\. \nThe `multimaster` engine mode only applies for DB clusters created with Aurora MySQL version 5\\.6\\.10a\\. \nFor Aurora PostgreSQL, the `global` engine mode isn't required, and both the `parallelquery` and the `multimaster` engine modes currently aren't supported\\. \nLimitations and requirements apply to some DB engine modes\\. For more information, see the following sections in the *Amazon Aurora User Guide*: \n+ [ Limitations of Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) \n+ [ Limitations of Parallel Query](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations) \n+ [ Limitations of Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations) \n+ [ Limitations of Multi\\-Master Clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations) \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The DB engine mode of the DB cluster, either `provisioned`, `serverless`, `parallelquery`, `global`, or `multimaster`\\. \nThe `parallelquery` engine mode isn't required for Aurora MySQL version 1\\.23 and higher 1\\.x versions, and version 2\\.09 and higher 2\\.x versions\\. \nThe `global` engine mode isn't required for Aurora MySQL version 1\\.22 and higher 1\\.x versions, and `global` engine mode isn't required for any 2\\.x versions\\. \nThe `multimaster` engine mode only applies for DB clusters created with Aurora MySQL version 5\\.6\\.10a\\. \nFor Aurora PostgreSQL, the `global` engine mode isn't required, and both the `parallelquery` and the `multimaster` engine modes currently aren't supported\\. \nLimitations and requirements apply to some DB engine modes\\. For more information, see the following sections in the *Amazon Aurora User Guide*: \n+ [ Limitations of Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations) \n+ [ Limitations of Parallel Query](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations) \n+ [ Limitations of Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations) \n+ [ Limitations of Multi\\-Master Clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations) \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EngineMode", "type": "string" }, "EngineVersion": { - "markdownDescription": "The version number of the database engine to use\\. \nTo list all of the available engine versions for `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\), use the following command: \n`aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"` \nTo list all of the available engine versions for `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\), use the following command: \n`aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"` \nTo list all of the available engine versions for `aurora-postgresql`, use the following command: \n`aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"` \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The version number of the database engine to use\\. \nTo list all of the available engine versions for `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\), use the following command: \n`aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"` \nTo list all of the available engine versions for `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\), use the following command: \n`aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"` \nTo list all of the available engine versions for `aurora-postgresql`, use the following command: \n`aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"` \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "EngineVersion", "type": "string" }, "GlobalClusterIdentifier": { - "markdownDescription": "If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster\\. To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource\\. \n If you aren't configuring a global database cluster, don't specify this property\\. \nTo remove the DB cluster from a global database cluster, specify an empty value for the `GlobalClusterIdentifier` property\\.\nFor information about Aurora global databases, see [ Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster\\. To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource\\. \n If you aren't configuring a global database cluster, don't specify this property\\. \nTo remove the DB cluster from a global database cluster, specify an empty value for the `GlobalClusterIdentifier` property\\.\nFor information about Aurora global databases, see [ Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide*\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "GlobalClusterIdentifier", "type": "string" }, "Iops": { + "markdownDescription": "The amount of Provisioned IOPS \\(input/output operations per second\\) to be initially allocated for each DB instance in the Multi\\-AZ DB cluster\\. \nFor information about valid IOPS values, see [Amazon RDS Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*\\. \nThis setting is required to create a Multi\\-AZ DB cluster\\. \nConstraints: Must be a multiple between \\.5 and 50 of the storage amount for the DB cluster\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Iops", "type": "number" }, "KmsKeyId": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`\\. If you enable the `StorageEncrypted` property but don't specify this property, the default KMS key is used\\. If you specify this property, you must set the `StorageEncrypted` property to `true`\\. \nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`\\. If you enable the `StorageEncrypted` property but don't specify this property, the default KMS key is used\\. If you specify this property, you must set the `StorageEncrypted` property to `true`\\. \nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" }, "ManageMasterUserPassword": { + "markdownDescription": "A value that indicates whether to manage the master user password with AWS Secrets Manager\\. \nFor more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide\\.* \nConstraints: \n+ Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManageMasterUserPassword", "type": "boolean" }, "MasterUserPassword": { - "markdownDescription": "The master password for the DB instance\\. \nIf you specify the `SourceDBClusterIdentifier` or `SnapshotIdentifier` property, don't specify this property\\. The value is inherited from the source DB instance or snapshot\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The master password for the DB instance\\. \nIf you specify the `SourceDBClusterIdentifier`, `SnapshotIdentifier`, or `GlobalClusterIdentifier` property, don't specify this property\\. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserPassword", "type": "string" }, "MasterUserSecret": { - "$ref": "#/definitions/AWS::RDS::DBCluster.MasterUserSecret" + "$ref": "#/definitions/AWS::RDS::DBCluster.MasterUserSecret", + "markdownDescription": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password\\. \nFor more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide\\.* \n*Required*: No \n*Type*: [MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MasterUserSecret" }, "MasterUsername": { - "markdownDescription": "The name of the master user for the DB cluster\\. \nIf you specify the `SourceDBClusterIdentifier` or `SnapshotIdentifier` property, don't specify this property\\. The value is inherited from the source DB instance or snapshot\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the master user for the DB cluster\\. \nIf you specify the `SourceDBClusterIdentifier`, `SnapshotIdentifier`, or `GlobalClusterIdentifier` property, don't specify this property\\. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: Conditional \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "MasterUsername", "type": "string" }, "MonitoringInterval": { + "markdownDescription": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster\\. To turn off collecting Enhanced Monitoring metrics, specify 0\\. The default is 0\\. \nIf `MonitoringRoleArn` is specified, also set `MonitoringInterval` to a value other than 0\\. \nValid Values: `0, 1, 5, 10, 15, 30, 60` \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MonitoringInterval", "type": "number" }, "MonitoringRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs\\. An example is `arn:aws:iam:123456789012:role/emaccess`\\. For information on creating a monitoring role, see [Setting up and enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*\\. \nIf `MonitoringInterval` is set to a value other than 0, supply a `MonitoringRoleArn` value\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MonitoringRoleArn", "type": "string" }, "NetworkType": { + "markdownDescription": "The network type of the DB cluster\\. \nValid values: \n+ `IPV4` \n+ `DUAL` \nThe network type is determined by the `DBSubnetGroup` specified for the DB cluster\\. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and IPv6 protocols \\(`DUAL`\\)\\. \nFor more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide\\.* \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkType", "type": "string" }, "PerformanceInsightsEnabled": { + "markdownDescription": "A value that indicates whether to turn on Performance Insights for the DB cluster\\. \nFor more information, see [ Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PerformanceInsightsEnabled", "type": "boolean" }, "PerformanceInsightsKmsKeyId": { + "markdownDescription": "The AWS KMS key identifier for encryption of Performance Insights data\\. \nThe AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key\\. \nIf you don't specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key\\. There is a default KMS key for your AWS account\\. Your AWS account has a different default KMS key for each AWS Region\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PerformanceInsightsKmsKeyId", "type": "string" }, "PerformanceInsightsRetentionPeriod": { + "markdownDescription": "The number of days to retain Performance Insights data\\. The default is 7 days\\. The following values are valid: \n+ 7\n+ *month* \\* 31, where *month* is a number of months from 1\\-23\n+ 731\nFor example, the following values are valid: \n+ 93 \\(3 months \\* 31\\)\n+ 341 \\(11 months \\* 31\\)\n+ 589 \\(19 months \\* 31\\)\n+ 731\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error\\. \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PerformanceInsightsRetentionPeriod", "type": "number" }, "Port": { - "markdownDescription": "The port number on which the DB instances in the DB cluster accept connections\\. \nDefault: \n+ When `EngineMode` is `provisioned`, `3306` \\(for both Aurora MySQL and Aurora PostgreSQL\\)\n+ When `EngineMode` is `serverless`:\n + `3306` when `Engine` is `aurora` or `aurora-mysql`\n + `5432` when `Engine` is `aurora-postgresql`\nThe `No interruption` on update behavior only applies to DB clusters\\. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource\\.\n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The port number on which the DB instances in the DB cluster accept connections\\. \nDefault: \n+ When `EngineMode` is `provisioned`, `3306` \\(for both Aurora MySQL and Aurora PostgreSQL\\)\n+ When `EngineMode` is `serverless`:\n + `3306` when `Engine` is `aurora` or `aurora-mysql`\n + `5432` when `Engine` is `aurora-postgresql`\nThe `No interruption` on update behavior only applies to DB clusters\\. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Port", "type": "number" }, "PreferredBackupWindow": { - "markdownDescription": "The daily time range during which automated backups are created\\. For more information, see [ Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide\\.* \nConstraints: \n+ Must be in the format `hh24:mi-hh24:mi`\\.\n+ Must be in Universal Coordinated Time \\(UTC\\)\\.\n+ Must not conflict with the preferred maintenance window\\.\n+ Must be at least 30 minutes\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The daily time range during which automated backups are created\\. For more information, see [ Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide\\.* \nConstraints: \n+ Must be in the format `hh24:mi-hh24:mi`\\.\n+ Must be in Universal Coordinated Time \\(UTC\\)\\.\n+ Must not conflict with the preferred maintenance window\\.\n+ Must be at least 30 minutes\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PreferredBackupWindow", "type": "string" }, "PreferredMaintenanceWindow": { - "markdownDescription": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \nFormat: `ddd:hh24:mi-ddd:hh24:mi` \nThe default is a 30\\-minute window selected at random from an 8\\-hour block of time for each AWS Region, occurring on a random day of the week\\. To see the time blocks available, see [ Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide\\.* \nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun\\. \nConstraints: Minimum 30\\-minute window\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time \\(UTC\\)\\. \nFormat: `ddd:hh24:mi-ddd:hh24:mi` \nThe default is a 30\\-minute window selected at random from an 8\\-hour block of time for each AWS Region, occurring on a random day of the week\\. To see the time blocks available, see [ Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide\\.* \nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun\\. \nConstraints: Minimum 30\\-minute window\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PreferredMaintenanceWindow", "type": "string" }, "PubliclyAccessible": { + "markdownDescription": "A value that indicates whether the DB cluster is publicly accessible\\. \nWhen the DB cluster is publicly accessible, its Domain Name System \\(DNS\\) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud \\(VPC\\)\\. It resolves to the public IP address from outside of the DB cluster's VPC\\. Access to the DB cluster is ultimately controlled by the security group it uses\\. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it\\. \nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address\\. \nDefault: The default behavior varies depending on whether `DBSubnetGroupName` is specified\\. \nIf `DBSubnetGroupName` isn't specified, and `PubliclyAccessible` isn't specified, the following applies: \n+ If the default VPC in the target Region doesn\u2019t have an internet gateway attached to it, the DB cluster is private\\.\n+ If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public\\.\nIf `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't specified, the following applies: \n+ If the subnets are part of a VPC that doesn\u2019t have an internet gateway attached to it, the DB cluster is private\\.\n+ If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public\\.\nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PubliclyAccessible", "type": "boolean" }, "ReplicationSourceIdentifier": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the source DB instance or DB cluster if this DB cluster is created as a read replica\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the source DB instance or DB cluster if this DB cluster is created as a read replica\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReplicationSourceIdentifier", "type": "string" }, "RestoreType": { - "markdownDescription": "The type of restore to be performed\\. You can specify one of the following values: \n+ `full-copy` \\- The new DB cluster is restored as a full copy of the source DB cluster\\.\n+ `copy-on-write` \\- The new DB cluster is restored as a clone of the source DB cluster\\.\nConstraints: You can't specify `copy-on-write` if the engine version of the source DB cluster is earlier than 1\\.11\\. \nIf you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of restore to be performed\\. You can specify one of the following values: \n+ `full-copy` \\- The new DB cluster is restored as a full copy of the source DB cluster\\.\n+ `copy-on-write` \\- The new DB cluster is restored as a clone of the source DB cluster\\.\nConstraints: You can't specify `copy-on-write` if the engine version of the source DB cluster is earlier than 1\\.11\\. \nIf you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RestoreType", "type": "string" }, "ScalingConfiguration": { "$ref": "#/definitions/AWS::RDS::DBCluster.ScalingConfiguration", - "markdownDescription": "The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster\\. \n*Required*: No \n*Type*: [ScalingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster\\. \nThis property is only supported for Aurora Serverless v1\\. For Aurora Serverless v2, use `ServerlessV2ScalingConfiguration` property\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: [ScalingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScalingConfiguration" }, "ServerlessV2ScalingConfiguration": { - "$ref": "#/definitions/AWS::RDS::DBCluster.ServerlessV2ScalingConfiguration" + "$ref": "#/definitions/AWS::RDS::DBCluster.ServerlessV2ScalingConfiguration", + "markdownDescription": "The `ServerlessV2ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster\\. \nThis property is only supported for Aurora Serverless v2\\. For Aurora Serverless v1, use `ScalingConfiguration` property\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: [ServerlessV2ScalingConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerlessV2ScalingConfiguration" }, "SnapshotIdentifier": { - "markdownDescription": "The identifier for the DB snapshot or DB cluster snapshot to restore from\\. \nYou can use either the name or the Amazon Resource Name \\(ARN\\) to specify a DB cluster snapshot\\. However, you can use only the ARN to specify a DB snapshot\\. \nAfter you restore a DB cluster with a `SnapshotIdentifier` property, you must specify the same `SnapshotIdentifier` property for any future updates to the DB cluster\\. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed\\. However, if you don't specify the `SnapshotIdentifier` property, an empty DB cluster is created, and the original DB cluster is deleted\\. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified `SnapshotIdentifier` property, and the original DB cluster is deleted\\. \nIf you specify the `SnapshotIdentifier` property to restore a DB cluster \\(as opposed to specifying it for DB cluster updates\\), then don't specify the following properties: \n+ `GlobalClusterIdentifier`\n+ `MasterUsername`\n+ `ReplicationSourceIdentifier`\n+ `RestoreType`\n+ `SourceDBClusterIdentifier`\n+ `SourceRegion`\n+ `StorageEncrypted`\n+ `UseLatestRestorableTime`\nConstraints: \n+ Must match the identifier of an existing Snapshot\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The identifier for the DB snapshot or DB cluster snapshot to restore from\\. \nYou can use either the name or the Amazon Resource Name \\(ARN\\) to specify a DB cluster snapshot\\. However, you can use only the ARN to specify a DB snapshot\\. \nAfter you restore a DB cluster with a `SnapshotIdentifier` property, you must specify the same `SnapshotIdentifier` property for any future updates to the DB cluster\\. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed\\. However, if you don't specify the `SnapshotIdentifier` property, an empty DB cluster is created, and the original DB cluster is deleted\\. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified `SnapshotIdentifier` property, and the original DB cluster is deleted\\. \nIf you specify the `SnapshotIdentifier` property to restore a DB cluster \\(as opposed to specifying it for DB cluster updates\\), then don't specify the following properties: \n+ `GlobalClusterIdentifier`\n+ `MasterUsername`\n+ `MasterUserPassword`\n+ `ReplicationSourceIdentifier`\n+ `RestoreType`\n+ `SourceDBClusterIdentifier`\n+ `SourceRegion`\n+ `StorageEncrypted` \\(for an encrypted snapshot\\)\n+ `UseLatestRestorableTime`\nConstraints: \n+ Must match the identifier of an existing Snapshot\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SnapshotIdentifier", "type": "string" }, "SourceDBClusterIdentifier": { - "markdownDescription": "When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore\\. \nConstraints: \n+ Must match the identifier of an existing DBCluster\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore\\. \nConstraints: \n+ Must match the identifier of an existing DBCluster\\.\nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SourceDBClusterIdentifier", "type": "string" }, "SourceRegion": { - "markdownDescription": "The AWS Region which contains the source DB cluster when replicating a DB cluster\\. For example, `us-east-1`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The AWS Region which contains the source DB cluster when replicating a DB cluster\\. For example, `us-east-1`\\. \nValid for: Aurora DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SourceRegion", "type": "string" }, "StorageEncrypted": { - "markdownDescription": "Indicates whether the DB cluster is encrypted\\. \nIf you specify the `KmsKeyId` property, then you must enable encryption\\. \nIf you specify the `SnapshotIdentifier` or `SourceDBClusterIdentifier` property, don't specify this property\\. The value is inherited from the snapshot or source DB cluster, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Indicates whether the DB cluster is encrypted\\. \nIf you specify the `KmsKeyId` property, then you must enable encryption\\. \nIf you specify the `SourceDBClusterIdentifier` property, don't specify this property\\. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used\\. \nIf you specify the `SnapshotIdentifier` and the specified snapshot is encrypted, don't specify this property\\. The value is inherited from the snapshot, and the specified `KmsKeyId` property is used\\. \nIf you specify the `SnapshotIdentifier` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted\\. Specify the `KmsKeyId` property for the KMS key to use for encryption\\. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to `false`\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StorageEncrypted", "type": "boolean" }, "StorageType": { + "markdownDescription": "Specifies the storage type to be associated with the DB cluster\\. \nThis setting is required to create a Multi\\-AZ DB cluster\\. \nValid values: `io1` \nWhen specified, a value for the `Iops` parameter is required\\. \nDefault: `io1` \nValid for: Multi\\-AZ DB clusters only \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageType", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the DB cluster\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this DB cluster\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, "UseLatestRestorableTime": { - "markdownDescription": "A value that indicates whether to restore the DB cluster to the latest restorable backup time\\. By default, the DB cluster is not restored to the latest restorable backup time\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A value that indicates whether to restore the DB cluster to the latest restorable backup time\\. By default, the DB cluster is not restored to the latest restorable backup time\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "UseLatestRestorableTime", "type": "boolean" }, @@ -150368,7 +154863,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of EC2 VPC security groups to associate with this DB cluster\\. \nIf you plan to update the resource, don't specify VPC security groups in a shared VPC\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of EC2 VPC security groups to associate with this DB cluster\\. \nIf you plan to update the resource, don't specify VPC security groups in a shared VPC\\. \nValid for: Aurora DB clusters and Multi\\-AZ DB clusters \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VpcSecurityGroupIds", "type": "array" } @@ -150418,9 +154913,13 @@ "additionalProperties": false, "properties": { "Address": { + "markdownDescription": "Specifies the connection endpoint for the primary instance of the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Address", "type": "string" }, "Port": { + "markdownDescription": "Specifies the port that the database engine is listening on\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "string" } }, @@ -150430,9 +154929,13 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "The AWS KMS key identifier that is used to encrypt the secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "SecretArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecretArn", "type": "string" } }, @@ -150442,6 +154945,8 @@ "additionalProperties": false, "properties": { "Address": { + "markdownDescription": "The host address of the reader endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Address", "type": "string" } }, @@ -150466,6 +154971,8 @@ "type": "number" }, "SecondsBeforeTimeout": { + "markdownDescription": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action\\. The default is 300\\. \nSpecify a value between 60 and 600 seconds\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecondsBeforeTimeout", "type": "number" }, "SecondsUntilAutoPause": { @@ -150474,6 +154981,8 @@ "type": "number" }, "TimeoutAction": { + "markdownDescription": "The action to take when the timeout is reached, either `ForceApplyCapacityChange` or `RollbackCapacityChange`\\. \n `ForceApplyCapacityChange` sets the capacity to the specified value as soon as possible\\. \n `RollbackCapacityChange`, the default, ignores the capacity change if a scaling point isn't found in the timeout period\\. \nIf you specify `ForceApplyCapacityChange`, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped\\.\nFor more information, see [ Autoscaling for Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TimeoutAction", "type": "string" } }, @@ -150483,9 +154992,13 @@ "additionalProperties": false, "properties": { "MaxCapacity": { + "markdownDescription": "The maximum number of Aurora capacity units \\(ACUs\\) for a DB instance in an Aurora Serverless v2 cluster\\. You can specify ACU values in half\\-step increments, such as 40, 40\\.5, 41, and so on\\. The largest value that you can use is 128\\. \nThe maximum capacity must be higher than 0\\.5 ACUs\\. For more information, see [ Choosing the maximum Aurora Serverless v2 capacity setting for a cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.setting-capacity.html#aurora-serverless-v2.max_capacity_considerations) in the *Amazon Aurora User Guide*\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MaxCapacity", "type": "number" }, "MinCapacity": { + "markdownDescription": "The minimum number of Aurora capacity units \\(ACUs\\) for a DB instance in an Aurora Serverless v2 cluster\\. You can specify ACU values in half\\-step increments, such as 8, 8\\.5, 9, and so on\\. The smallest value that you can use is 0\\.5\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MinCapacity", "type": "number" } }, @@ -150527,6 +155040,8 @@ "additionalProperties": false, "properties": { "DBClusterParameterGroupName": { + "markdownDescription": "The name of the DB cluster parameter group\\. \nConstraints: \n+ Must not match the name of an existing DB cluster parameter group\\.\nIf you don't specify a value for `DBClusterParameterGroupName` property, a name is automatically created for the DB cluster paramter group\\. \nThis value is stored as a lowercase string\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DBClusterParameterGroupName", "type": "string" }, "Description": { @@ -150548,7 +155063,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the DB cluster parameter group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this DB cluster parameter group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -150617,7 +155132,7 @@ "additionalProperties": false, "properties": { "AllocatedStorage": { - "markdownDescription": "The amount of storage \\(in gigabytes\\) to be initially allocated for the database instance\\. \nIf any value is set in the `Iops` parameter, `AllocatedStorage` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000\\. If you increase the `Iops` value \\(in 1,000 IOPS increments\\), then you must also increase the `AllocatedStorage` value \\(in 100\\-GiB increments\\)\\. \n **Amazon Aurora** \nNot applicable\\. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume\\. \n **MySQL** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **MariaDB** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **PostgreSQL** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **Oracle** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 10 to 3072\\.\n **SQL Server** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384\\.\n + Web and Express editions: Must be an integer from 20 to 16384\\.\n+ Provisioned IOPS storage \\(io1\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384\\.\n + Web and Express editions: Must be an integer from 20 to 16384\\.\n+ Magnetic storage \\(standard\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 1024\\.\n + Web and Express editions: Must be an integer from 20 to 1024\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of storage in gibibytes \\(GiB\\) to be initially allocated for the database instance\\. \nIf any value is set in the `Iops` parameter, `AllocatedStorage` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000\\. If you increase the `Iops` value \\(in 1,000 IOPS increments\\), then you must also increase the `AllocatedStorage` value \\(in 100\\-GiB increments\\)\\. \n **Amazon Aurora** \nNot applicable\\. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume\\. \n **MySQL** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **MariaDB** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **PostgreSQL** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 5 to 3072\\.\n **Oracle** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\): Must be an integer from 20 to 65536\\.\n+ Provisioned IOPS storage \\(io1\\): Must be an integer from 100 to 65536\\.\n+ Magnetic storage \\(standard\\): Must be an integer from 10 to 3072\\.\n **SQL Server** \nConstraints to the amount of storage for each storage type are the following: \n+ General Purpose \\(SSD\\) storage \\(gp2\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384\\.\n + Web and Express editions: Must be an integer from 20 to 16384\\.\n+ Provisioned IOPS storage \\(io1\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 16384\\.\n + Web and Express editions: Must be an integer from 20 to 16384\\.\n+ Magnetic storage \\(standard\\):\n + Enterprise and Standard editions: Must be an integer from 20 to 1024\\.\n + Web and Express editions: Must be an integer from 20 to 1024\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllocatedStorage", "type": "string" }, @@ -150630,17 +155145,17 @@ "items": { "$ref": "#/definitions/AWS::RDS::DBInstance.DBInstanceRole" }, - "markdownDescription": "The AWS Identity and Access Management \\(IAM\\) roles associated with the DB instance\\. \n*Required*: No \n*Type*: List of [DBInstanceRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS Identity and Access Management \\(IAM\\) roles associated with the DB instance\\. \n **Amazon Aurora** \nNot applicable\\. The associated roles are managed by the DB cluster\\. \n*Required*: No \n*Type*: List of [DBInstanceRole](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AssociatedRoles", "type": "array" }, "AutoMinorVersionUpgrade": { - "markdownDescription": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window\\. By default, minor engine upgrades are applied automatically\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window\\. By default, minor engine upgrades are applied automatically\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "AutoMinorVersionUpgrade", "type": "boolean" }, "AvailabilityZone": { - "markdownDescription": "The Availability Zone that the database instance will be created in\\. \nDefault: A random, system\\-chosen Availability Zone in the endpoint's region\\. \n Example: `us-east-1d` \n Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to `true`\\. The specified Availability Zone must be in the same region as the current endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Availability Zone \\(AZ\\) where the database will be created\\. For information on AWS Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)\\. \n **Amazon Aurora** \nEach Aurora DB cluster hosts copies of its storage in three separate Availability Zones\\. Specify one of these Availability Zones\\. Aurora automatically chooses an appropriate Availability Zone if you don't specify one\\. \nDefault: A random, system\\-chosen Availability Zone in the endpoint's AWS Region\\. \nExample: `us-east-1d` \nConstraint: The `AvailabilityZone` parameter can't be specified if the DB instance is a Multi\\-AZ deployment\\. The specified Availability Zone must be in the same AWS Region as the current endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "AvailabilityZone", "type": "string" }, @@ -150655,9 +155170,13 @@ "type": "string" }, "CertificateDetails": { - "$ref": "#/definitions/AWS::RDS::DBInstance.CertificateDetails" + "$ref": "#/definitions/AWS::RDS::DBInstance.CertificateDetails", + "markdownDescription": "The details of the DB instance's server certificate\\. \n*Required*: No \n*Type*: [CertificateDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-certificatedetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertificateDetails" }, "CertificateRotationRestart": { + "markdownDescription": "A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate\\. \nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate\\. The certificate is not updated until the DB instance is restarted\\. \nSet this parameter only if you are *not* using SSL/TLS to connect to the DB instance\\.\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: \n+ For more information about rotating your SSL/TLS certificate for RDS DB engines, see [ Rotating Your SSL/TLS Certificate\\.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide\\.* \n+ For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [ Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*\\.\nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertificateRotationRestart", "type": "boolean" }, "CharacterSetName": { @@ -150671,6 +155190,8 @@ "type": "boolean" }, "CustomIAMInstanceProfile": { + "markdownDescription": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance\\. The instance profile must meet the following requirements: \n+ The profile must exist in your account\\.\n+ The profile must have an IAM role that Amazon EC2 has permissions to assume\\.\n+ The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom`\\.\nFor the list of permissions required for the IAM role, see [ Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*\\. \nThis setting is required for RDS Custom\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CustomIAMInstanceProfile", "type": "string" }, "DBClusterIdentifier": { @@ -150679,10 +155200,12 @@ "type": "string" }, "DBClusterSnapshotIdentifier": { + "markdownDescription": "The identifier for the RDS for MySQL Multi\\-AZ DB cluster snapshot to restore from\\. \nFor more information on Multi\\-AZ DB clusters, see [ Multi\\-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*\\. \nConstraints: \n+ Must match the identifier of an existing Multi\\-AZ DB cluster snapshot\\.\n+ Can't be specified when `DBSnapshotIdentifier` is specified\\.\n+ Must be specified when `DBSnapshotIdentifier` isn't specified\\.\n+ If you are restoring from a shared manual Multi\\-AZ DB cluster snapshot, the `DBClusterSnapshotIdentifier` must be the ARN of the shared snapshot\\.\n+ Can't be the identifier of an Aurora DB cluster snapshot\\.\n+ Can't be the identifier of an RDS for PostgreSQL Multi\\-AZ DB cluster snapshot\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "DBClusterSnapshotIdentifier", "type": "string" }, "DBInstanceClass": { - "markdownDescription": "The compute and memory capacity of the DB instance, for example, `db.m4.large`\\. Not all DB instance classes are available in all AWS Regions, or for all database engines\\. \nFor the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide\\.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](http://aws.amazon.com/rds/pricing/)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The compute and memory capacity of the DB instance, for example, `db.m4.large`\\. Not all DB instance classes are available in all AWS Regions, or for all database engines\\. \nFor the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide\\.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](http://aws.amazon.com/rds/pricing/)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "DBInstanceClass", "type": "string" }, @@ -150692,12 +155215,12 @@ "type": "string" }, "DBName": { - "markdownDescription": "The meaning of this parameter differs according to the database engine you use\\. \n If you specify the ` [ DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)` property, AWS CloudFormation ignores this property\\. \nIf you restore DB instances from snapshots, this property doesn't apply to the MySQL, PostgreSQL, or MariaDB engines\\.\n **MySQL** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, no database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 64 letters or numbers\\.\n+ Can't be a word reserved by the specified database engine\n **MariaDB** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, no database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 64 letters or numbers\\.\n+ Can't be a word reserved by the specified database engine\n **PostgreSQL** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, the default `postgres` database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 63 letters, numbers, or underscores\\.\n+ Must begin with a letter or an underscore\\. Subsequent characters can be letters, underscores, or digits \\(0\\-9\\)\\.\n+ Can't be a word reserved by the specified database engine\n **Oracle** \nThe Oracle System ID \\(SID\\) of the created DB instance\\. If you specify `null`, the default value `ORCL` is used\\. You can't specify the string NULL, or any other reserved word, for `DBName`\\. \nDefault: `ORCL` \nConstraints: \n+ Can't be longer than 8 characters\n **SQL Server** \nNot applicable\\. Must be null\\. \n **Amazon Aurora MySQL** \nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created\\. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster\\. \nConstraints: \n+ It must contain 1 to 64 alphanumeric characters\\.\n+ It can't be a word reserved by the database engine\\.\n **Amazon Aurora PostgreSQL** \nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created\\. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named `postgres` is created in the DB cluster\\. \nConstraints: \n+ It must contain 1 to 63 alphanumeric characters\\.\n+ It must begin with a letter or an underscore\\. Subsequent characters can be letters, underscores, or digits \\(0 to 9\\)\\.\n+ It can't be a word reserved by the database engine\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The meaning of this parameter differs according to the database engine you use\\. \nIf you specify the `[ DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)` property, this property only applies to RDS for Oracle\\.\n **Amazon Aurora** \nNot applicable\\. The database name is managed by the DB cluster\\. \n **MySQL** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, no database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 64 letters or numbers\\.\n+ Can't be a word reserved by the specified database engine\n **MariaDB** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, no database is created in the DB instance\\. \nConstraints: \n+ Must contain 1 to 64 letters or numbers\\.\n+ Can't be a word reserved by the specified database engine\n **PostgreSQL** \nThe name of the database to create when the DB instance is created\\. If this parameter is not specified, the default `postgres` database is created in the DB instance\\. \nConstraints: \n+ Must begin with a letter\\. Subsequent characters can be letters, underscores, or digits \\(0\\-9\\)\\.\n+ Must contain 1 to 63 characters\\.\n+ Can't be a word reserved by the specified database engine\n **Oracle** \nThe Oracle System ID \\(SID\\) of the created DB instance\\. If you specify `null`, the default value `ORCL` is used\\. You can't specify the string NULL, or any other reserved word, for `DBName`\\. \nDefault: `ORCL` \nConstraints: \n+ Can't be longer than 8 characters\n **SQL Server** \nNot applicable\\. Must be null\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DBName", "type": "string" }, "DBParameterGroupName": { - "markdownDescription": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template\\. \nTo list all of the available DB parameter group names, use the following command: \n`aws rds describe-db-parameter-groups --query \"DBParameterGroups[].DBParameterGroupName\" --output text` \nIf any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption\\. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot\\.\nIf you don't specify a value for the `DBParameterGroupName` property, the default DB parameter group for the specified engine and engine version is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template\\. \nTo list all of the available DB parameter group names, use the following command: \n`aws rds describe-db-parameter-groups --query \"DBParameterGroups[].DBParameterGroupName\" --output text` \nIf any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption\\. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot\\.\nIf you don't specify a value for `DBParameterGroupName` property, the default DB parameter group for the specified engine and engine version is used\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "DBParameterGroupName", "type": "string" }, @@ -150710,7 +155233,7 @@ "type": "array" }, "DBSnapshotIdentifier": { - "markdownDescription": "The name or Amazon Resource Name \\(ARN\\) of the DB snapshot that's used to restore the DB instance\\. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot\\. \nBy specifying this property, you can create a DB instance from the specified DB snapshot\\. If the `DBSnapshotIdentifier` property is an empty string or the `AWS::RDS::DBInstance` declaration has no `DBSnapshotIdentifier` property, AWS CloudFormation creates a new database\\. If the property contains a value \\(other than an empty string\\), AWS CloudFormation creates a database from the specified snapshot\\. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack\\. \nSome DB instance properties aren't valid when you restore from a snapshot, such as the `MasterUsername` and `MasterUserPassword` properties\\. For information about the properties that you can specify, see the `RestoreDBInstanceFromDBSnapshot` action in the *Amazon RDS API Reference*\\. \nAfter you restore a DB instance with a `DBSnapshotIdentifier` property, you must specify the same `DBSnapshotIdentifier` property for any future updates to the DB instance\\. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed\\. However, if you don't specify the `DBSnapshotIdentifier` property, an empty DB instance is created, and the original DB instance is deleted\\. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified `DBSnapshotIdentifier` property, and the original DB instance is deleted\\. \nIf you specify the `DBSnapshotIdentifier` property to restore a DB instance \\(as opposed to specifying it for DB instance updates\\), then don't specify the following properties: \n+ `CharacterSetName`\n+ `DBClusterIdentifier`\n+ `DBName`\n+ `DeleteAutomatedBackups`\n+ `EnablePerformanceInsights`\n+ `KmsKeyId`\n+ `MasterUsername`\n+ `MonitoringInterval`\n+ `MonitoringRoleArn`\n+ `PerformanceInsightsKMSKeyId`\n+ `PerformanceInsightsRetentionPeriod`\n+ `PromotionTier`\n+ `SourceDBInstanceIdentifier`\n+ `SourceRegion`\n+ `StorageEncrypted`\n+ `Timezone`\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name or Amazon Resource Name \\(ARN\\) of the DB snapshot that's used to restore the DB instance\\. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot\\. \nBy specifying this property, you can create a DB instance from the specified DB snapshot\\. If the `DBSnapshotIdentifier` property is an empty string or the `AWS::RDS::DBInstance` declaration has no `DBSnapshotIdentifier` property, AWS CloudFormation creates a new database\\. If the property contains a value \\(other than an empty string\\), AWS CloudFormation creates a database from the specified snapshot\\. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack\\. \nSome DB instance properties aren't valid when you restore from a snapshot, such as the `MasterUsername` and `MasterUserPassword` properties\\. For information about the properties that you can specify, see the `RestoreDBInstanceFromDBSnapshot` action in the *Amazon RDS API Reference*\\. \nAfter you restore a DB instance with a `DBSnapshotIdentifier` property, you must specify the same `DBSnapshotIdentifier` property for any future updates to the DB instance\\. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed\\. However, if you don't specify the `DBSnapshotIdentifier` property, an empty DB instance is created, and the original DB instance is deleted\\. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified `DBSnapshotIdentifier` property, and the original DB instance is deleted\\. \nIf you specify the `DBSnapshotIdentifier` property to restore a DB instance \\(as opposed to specifying it for DB instance updates\\), then don't specify the following properties: \n+ `CharacterSetName`\n+ `DBClusterIdentifier`\n+ `DBName`\n+ `DeleteAutomatedBackups`\n+ `EnablePerformanceInsights`\n+ `KmsKeyId`\n+ `MasterUsername`\n+ `MasterUserPassword`\n+ `PerformanceInsightsKMSKeyId`\n+ `PerformanceInsightsRetentionPeriod`\n+ `PromotionTier`\n+ `SourceDBInstanceIdentifier`\n+ `SourceRegion`\n+ `StorageEncrypted` \\(for an encrypted snapshot\\)\n+ `Timezone`\n **Amazon Aurora** \nNot applicable\\. Snapshot restore is managed by the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "DBSnapshotIdentifier", "type": "string" }, @@ -150720,7 +155243,7 @@ "type": "string" }, "DeleteAutomatedBackups": { - "markdownDescription": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted\\. This parameter isn't case\\-sensitive\\. The default is to remove automated backups immediately after the DB instance is deleted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted\\. This parameter isn't case\\-sensitive\\. The default is to remove automated backups immediately after the DB instance is deleted\\. \n**Amazon Aurora** \nNot applicable\\. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered\\. Manual DB cluster snapshots of the DB cluster are not deleted\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeleteAutomatedBackups", "type": "boolean" }, @@ -150735,7 +155258,7 @@ "type": "string" }, "DomainIAMRoleName": { - "markdownDescription": "Specify the name of the IAM role to be used when making API calls to the Directory Service\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify the name of the IAM role to be used when making API calls to the Directory Service\\. \nThis setting doesn't apply to RDS Custom\\. \n **Amazon Aurora** \nNot applicable\\. The domain is managed by the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DomainIAMRoleName", "type": "string" }, @@ -150748,7 +155271,7 @@ "type": "array" }, "EnableIAMDatabaseAuthentication": { - "markdownDescription": "A value that indicates whether to enable mapping of AWS Identity and Access Management \\(IAM\\) accounts to database accounts\\. By default, mapping is disabled\\. \nFor more information, see [ IAM Database Authentication for MySQL and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide\\.* \n **Amazon Aurora** \nNot applicable\\. Mapping AWS IAM accounts to database accounts is managed by the DB cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether to enable mapping of AWS Identity and Access Management \\(IAM\\) accounts to database accounts\\. By default, mapping is disabled\\. \nThis property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL\\. For more information, see [ IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide\\.* \n **Amazon Aurora** \nNot applicable\\. Mapping AWS IAM accounts to database accounts is managed by the DB cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EnableIAMDatabaseAuthentication", "type": "boolean" }, @@ -150758,15 +155281,17 @@ "type": "boolean" }, "Endpoint": { - "$ref": "#/definitions/AWS::RDS::DBInstance.Endpoint" + "$ref": "#/definitions/AWS::RDS::DBInstance.Endpoint", + "markdownDescription": "Specifies the connection endpoint\\. \nThe endpoint might not be shown for instances whose status is `creating`\\.\n*Required*: No \n*Type*: [Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Endpoint" }, "Engine": { - "markdownDescription": "The name of the database engine that you want to use for this DB instance\\. \nWhen you are creating a DB instance, the `Engine` property is required\\.\nValid Values: \n+ `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\)\n+ `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\)\n+ `aurora-postgresql`\n+ `mariadb`\n+ `mysql`\n+ `oracle-ee`\n+ `oracle-se2`\n+ `oracle-se1`\n+ `oracle-se`\n+ `postgres`\n+ `sqlserver-ee`\n+ `sqlserver-se`\n+ `sqlserver-ex`\n+ `sqlserver-web`\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The name of the database engine that you want to use for this DB instance\\. \nWhen you are creating a DB instance, the `Engine` property is required\\.\nValid Values: \n+ `aurora` \\(for MySQL 5\\.6\\-compatible Aurora\\)\n+ `aurora-mysql` \\(for MySQL 5\\.7\\-compatible Aurora\\)\n+ `aurora-postgresql`\n+ `custom-oracle-ee`\n+ `custom-oracle-ee-cdb`\n+ `custom-sqlserver-ee`\n+ `custom-sqlserver-se`\n+ `custom-sqlserver-web`\n+ `mariadb`\n+ `mysql`\n+ `oracle-ee`\n+ `oracle-ee-cdb`\n+ `oracle-se2`\n+ `oracle-se2-cdb`\n+ `postgres`\n+ `sqlserver-ee`\n+ `sqlserver-se`\n+ `sqlserver-ex`\n+ `sqlserver-web`\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "Engine", "type": "string" }, "EngineVersion": { - "markdownDescription": "The version number of the database engine to use\\. \nFor a list of valid engine versions, use the `DescribeDBEngineVersions` action\\. \nThe following are the database engines and links to information about the major and minor versions that are available with Amazon RDS\\. Not every database engine is available for every AWS Region\\. \n **Amazon Aurora** \nNot applicable\\. The version number of the database engine to be used by the DB instance is managed by the DB cluster\\. \n**MariaDB** \nSee [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide\\.* \n**Microsoft SQL Server** \nSee [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide\\.* \n**MySQL** \nSee [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide\\.* \n**Oracle** \nSee [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide\\.* \n**PostgreSQL** \nSee [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The version number of the database engine to use\\. \nFor a list of valid engine versions, use the `DescribeDBEngineVersions` action\\. \nThe following are the database engines and links to information about the major and minor versions that are available with Amazon RDS\\. Not every database engine is available for every AWS Region\\. \n **Amazon Aurora** \nNot applicable\\. The version number of the database engine to be used by the DB instance is managed by the DB cluster\\. \n**MariaDB** \nSee [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide\\.* \n**Microsoft SQL Server** \nSee [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide\\.* \n**MySQL** \nSee [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide\\.* \n**Oracle** \nSee [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide\\.* \n**PostgreSQL** \nSee [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EngineVersion", "type": "string" }, @@ -150786,6 +155311,8 @@ "type": "string" }, "ManageMasterUserPassword": { + "markdownDescription": "A value that indicates whether to manage the master user password with AWS Secrets Manager\\. \nFor more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide\\.* \nConstraints: \n+ Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManageMasterUserPassword", "type": "boolean" }, "MasterUserPassword": { @@ -150794,7 +155321,9 @@ "type": "string" }, "MasterUserSecret": { - "$ref": "#/definitions/AWS::RDS::DBInstance.MasterUserSecret" + "$ref": "#/definitions/AWS::RDS::DBInstance.MasterUserSecret", + "markdownDescription": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password\\. \nFor more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide\\.* \n*Required*: No \n*Type*: [MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-masterusersecret.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MasterUserSecret" }, "MasterUsername": { "markdownDescription": "The master user name for the DB instance\\. \nIf you specify the `SourceDBInstanceIdentifier` or `DBSnapshotIdentifier` property, don't specify this property\\. The value is inherited from the source DB instance or snapshot\\.\n **Amazon Aurora** \nNot applicable\\. The name for the master user is managed by the DB cluster\\. \n **MariaDB** \nConstraints: \n+ Required for MariaDB\\.\n+ Must be 1 to 16 letters or numbers\\.\n+ Can't be a reserved word for the chosen database engine\\.\n **Microsoft SQL Server** \nConstraints: \n+ Required for SQL Server\\.\n+ Must be 1 to 128 letters or numbers\\.\n+ The first character must be a letter\\.\n+ Can't be a reserved word for the chosen database engine\\.\n **MySQL** \nConstraints: \n+ Required for MySQL\\.\n+ Must be 1 to 16 letters or numbers\\.\n+ First character must be a letter\\.\n+ Can't be a reserved word for the chosen database engine\\.\n **Oracle** \nConstraints: \n+ Required for Oracle\\.\n+ Must be 1 to 30 letters or numbers\\.\n+ First character must be a letter\\.\n+ Can't be a reserved word for the chosen database engine\\.\n **PostgreSQL** \nConstraints: \n+ Required for PostgreSQL\\.\n+ Must be 1 to 63 letters or numbers\\.\n+ First character must be a letter\\.\n+ Can't be a reserved word for the chosen database engine\\.\n*Required*: Conditional \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -150802,12 +155331,12 @@ "type": "string" }, "MaxAllocatedStorage": { - "markdownDescription": "The upper limit in gibibytes \\(GiB\\) to which Amazon RDS can automatically scale the storage of the DB instance\\. \nFor more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The upper limit in gibibytes \\(GiB\\) to which Amazon RDS can automatically scale the storage of the DB instance\\. \nFor more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*\\. \nThis setting doesn't apply to RDS Custom\\. \n **Amazon Aurora** \nNot applicable\\. Storage is managed by the DB cluster\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxAllocatedStorage", "type": "number" }, "MonitoringInterval": { - "markdownDescription": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance\\. To disable collection of Enhanced Monitoring metrics, specify 0\\. The default is 0\\. \nIf `MonitoringRoleArn` is specified, then you must set `MonitoringInterval` to a value other than 0\\. \nThis setting doesn't apply to RDS Custom\\. \nValid Values: `0, 1, 5, 10, 15, 30, 60` \n*Required*: No \n*Type*: Integer \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance\\. To disable collection of Enhanced Monitoring metrics, specify 0\\. The default is 0\\. \nIf `MonitoringRoleArn` is specified, then you must set `MonitoringInterval` to a value other than 0\\. \nThis setting doesn't apply to RDS Custom\\. \nValid Values: `0, 1, 5, 10, 15, 30, 60` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MonitoringInterval", "type": "number" }, @@ -150817,14 +155346,18 @@ "type": "string" }, "MultiAZ": { - "markdownDescription": "Specifies whether the database instance is a multiple Availability Zone deployment\\. You can't set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to true\\. \n **Amazon Aurora** \nNot applicable\\. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the `MultiAZ` option to be set\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "Specifies whether the database instance is a Multi\\-AZ DB instance deployment\\. You can't set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to true\\. \nFor more information, see [ Multi\\-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*\\. \n **Amazon Aurora** \nNot applicable\\. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the `MultiAZ` option to be set\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "MultiAZ", "type": "boolean" }, "NcharCharacterSetName": { + "markdownDescription": "The name of the NCHAR character set for the Oracle DB instance\\. \nThis parameter doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NcharCharacterSetName", "type": "string" }, "NetworkType": { + "markdownDescription": "The network type of the DB instance\\. \nValid values: \n+ `IPV4` \n+ `DUAL` \nThe network type is determined by the `DBSubnetGroup` specified for the DB instance\\. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and IPv6 protocols \\(`DUAL`\\)\\. \nFor more information, see [ Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide\\.* \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkType", "type": "string" }, "OptionGroupName": { @@ -150833,7 +155366,7 @@ "type": "string" }, "PerformanceInsightsKMSKeyId": { - "markdownDescription": "The AWS KMS key identifier for encryption of Performance Insights data\\. \nThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key\\. \nIf you do not specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key\\. There is a default KMS key for your AWS account\\. Your AWS account has a different default KMS key for each AWS Region\\. \nFor information about enabling Performance Insights, see [ EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The AWS KMS key identifier for encryption of Performance Insights data\\. \nThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key\\. \nIf you do not specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key\\. There is a default KMS key for your AWS account\\. Your AWS account has a different default KMS key for each AWS Region\\. \nFor information about enabling Performance Insights, see [ EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "PerformanceInsightsKMSKeyId", "type": "string" }, @@ -150843,7 +155376,7 @@ "type": "number" }, "Port": { - "markdownDescription": "The port number on which the database accepts connections\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The port number on which the database accepts connections\\. \n **Amazon Aurora** \nNot applicable\\. The port number is managed by the DB cluster\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Port", "type": "string" }, @@ -150861,7 +155394,7 @@ "items": { "$ref": "#/definitions/AWS::RDS::DBInstance.ProcessorFeature" }, - "markdownDescription": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: List of [ProcessorFeature](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance\\. \nThis setting doesn't apply to RDS Custom\\. \n **Amazon Aurora** \nNot applicable\\. \n*Required*: No \n*Type*: List of [ProcessorFeature](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProcessorFeatures", "type": "array" }, @@ -150871,25 +155404,33 @@ "type": "number" }, "PubliclyAccessible": { - "markdownDescription": "Indicates whether the DB instance is an internet\\-facing instance\\. If you specify `true`, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address\\. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address\\. \n The default behavior value depends on your VPC setup and the database subnet group\\. For more information, see the `PubliclyAccessible` parameter in [https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*\\. \n If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the *DependsOn* attribute to declare a dependency on the VPC\\-gateway attachment\\. For more information, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html)\\. \nIf you specify DBSecurityGroups, AWS CloudFormation ignores this property\\. To specify a security group and this property, you must use a VPC security group\\. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Indicates whether the DB instance is an internet\\-facing instance\\. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address\\. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address\\. \nThe default behavior value depends on your VPC setup and the database subnet group\\. For more information, see the `PubliclyAccessible` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PubliclyAccessible", "type": "boolean" }, "ReplicaMode": { + "markdownDescription": "The open mode of an Oracle read replica\\. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*\\. \nThis setting is only supported in RDS for Oracle\\. \nDefault: `open-read-only` \nValid Values: `open-read-only` or `mounted` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReplicaMode", "type": "string" }, "RestoreTime": { + "markdownDescription": "The date and time to restore from\\. \nValid Values: Value must be a time in Universal Coordinated Time \\(UTC\\) format \nConstraints: \n+ Must be before the latest restorable time for the DB instance\n+ Can't be specified if the `UseLatestRestorableTime` parameter is enabled\nExample: `2009-09-07T23:45:00Z` \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "RestoreTime", "type": "string" }, "SourceDBInstanceAutomatedBackupsArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the replicated automated backups from which to restore, for example, `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`\\. \nThis setting doesn't apply to RDS Custom\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "SourceDBInstanceAutomatedBackupsArn", "type": "string" }, "SourceDBInstanceIdentifier": { - "markdownDescription": "If you want to create a read replica DB instance, specify the ID of the source DB instance\\. Each DB instance can have a limited number of read replicas\\. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*\\. \nFor information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*\\. \nThe `SourceDBInstanceIdentifier` property determines whether a DB instance is a read replica\\. If you remove the `SourceDBInstanceIdentifier` property from your template and then update your stack, AWS CloudFormation deletes the Read Replica and creates a new DB instance \\(not a read replica\\)\\. \n+ If you specify a source DB instance that uses VPC security groups, we recommend that you specify the `VPCSecurityGroups` property\\. If you don't specify the property, the read replica inherits the value of the `VPCSecurityGroups` property from the source DB when you create the replica\\. However, if you update the stack, AWS CloudFormation reverts the replica's `VPCSecurityGroups` property to the default value because it's not defined in the stack's template\\. This change might cause unexpected issues\\.\n+ Read replicas don't support deletion policies\\. AWS CloudFormation ignores any deletion policy that's associated with a read replica\\.\n+ If you specify `SourceDBInstanceIdentifier`, don't specify the `DBSnapshotIdentifier` property\\. You can't create a read replica from a snapshot\\.\n+ Don't set the `BackupRetentionPeriod`, `DBName`, `MasterUsername`, `MasterUserPassword`, and `PreferredBackupWindow` properties\\. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas\\.\n+ If the source DB instance is in a different region than the read replica, specify the source region in `SourceRegion`, and specify an ARN for a valid DB instance in `SourceDBInstanceIdentifier`\\. For more information, see [ Constructing a Amazon RDS Amazon Resource Name \\(ARN\\)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*\\.\n+ For DB instances in Amazon Aurora clusters, don't specify this property\\. Amazon RDS automatically assigns writer and reader DB instances\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "If you want to create a read replica DB instance, specify the ID of the source DB instance\\. Each DB instance can have a limited number of read replicas\\. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*\\. \nFor information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*\\. \nThe `SourceDBInstanceIdentifier` property determines whether a DB instance is a read replica\\. If you remove the `SourceDBInstanceIdentifier` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance\\. \n+ If you specify a source DB instance that uses VPC security groups, we recommend that you specify the `VPCSecurityGroups` property\\. If you don't specify the property, the read replica inherits the value of the `VPCSecurityGroups` property from the source DB when you create the replica\\. However, if you update the stack, AWS CloudFormation reverts the replica's `VPCSecurityGroups` property to the default value because it's not defined in the stack's template\\. This change might cause unexpected issues\\.\n+ Read replicas don't support deletion policies\\. AWS CloudFormation ignores any deletion policy that's associated with a read replica\\.\n+ If you specify `SourceDBInstanceIdentifier`, don't specify the `DBSnapshotIdentifier` property\\. You can't create a read replica from a snapshot\\.\n+ Don't set the `BackupRetentionPeriod`, `DBName`, `MasterUsername`, `MasterUserPassword`, and `PreferredBackupWindow` properties\\. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas\\.\n+ If the source DB instance is in a different region than the read replica, specify the source region in `SourceRegion`, and specify an ARN for a valid DB instance in `SourceDBInstanceIdentifier`\\. For more information, see [ Constructing a Amazon RDS Amazon Resource Name \\(ARN\\)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*\\.\n+ For DB instances in Amazon Aurora clusters, don't specify this property\\. Amazon RDS automatically assigns writer and reader DB instances\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "SourceDBInstanceIdentifier", "type": "string" }, "SourceDbiResourceId": { + "markdownDescription": "The resource ID of the source DB instance from which to restore\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "SourceDbiResourceId", "type": "string" }, "SourceRegion": { @@ -150898,15 +155439,17 @@ "type": "string" }, "StorageEncrypted": { - "markdownDescription": "A value that indicates whether the DB instance is encrypted\\. By default, it isn't encrypted\\. \nIf you specify the `KmsKeyId` property, then you must enable encryption\\. \nIf you specify the `SnapshotIdentifier` or `SourceDBInstanceIdentifier` property, don't specify this property\\. The value is inherited from the snapshot or source DB instance, and if the DB instance is encrypted, the specified `KmsKeyId` property is used\\. \n **Amazon Aurora** \nNot applicable\\. The encryption for DB instances is managed by the DB cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A value that indicates whether the DB instance is encrypted\\. By default, it isn't encrypted\\. \nIf you specify the `KmsKeyId` property, then you must enable encryption\\. \nIf you specify the `SourceDBInstanceIdentifier` property, don't specify this property\\. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified `KmsKeyId` property is used\\. \nIf you specify the `SnapshotIdentifier` and the specified snapshot is encrypted, don't specify this property\\. The value is inherited from the snapshot, and the specified `KmsKeyId` property is used\\. \nIf you specify the `SnapshotIdentifier` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted\\. Specify the `KmsKeyId` property for the KMS key to use for encryption\\. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to `false`\\. \n**Amazon Aurora** \nNot applicable\\. The encryption for DB instances is managed by the DB cluster\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StorageEncrypted", "type": "boolean" }, "StorageThroughput": { + "markdownDescription": "Specifies the storage throughput value for the DB instance\\. This setting applies only to the `gp3` storage type\\. \nThis setting doesn't apply to RDS Custom or Amazon Aurora\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "StorageThroughput", "type": "number" }, "StorageType": { - "markdownDescription": "Specifies the storage type to be associated with the DB instance\\. \n Valid values: `standard | gp2 | io1` \nThe `standard` value is also known as magnetic\\. \n If you specify `io1`, you must also include a value for the `Iops` parameter\\. \n Default: `io1` if the `Iops` parameter is specified, otherwise `standard` \nFor more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*\\. \n **Amazon Aurora** \nNot applicable\\. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives \\(SSDs\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "Specifies the storage type to be associated with the DB instance\\. \n Valid values: ` gp2 | gp3 | io1 | standard` \nThe `standard` value is also known as magnetic\\. \n If you specify `io1` or `gp3`, you must also include a value for the `Iops` parameter\\. \n Default: `io1` if the `Iops` parameter is specified, otherwise `gp2` \nFor more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide*\\. \n **Amazon Aurora** \nNot applicable\\. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives \\(SSDs\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "StorageType", "type": "string" }, @@ -150914,7 +155457,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the DB instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this DB instance\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" }, @@ -150929,6 +155472,8 @@ "type": "boolean" }, "UseLatestRestorableTime": { + "markdownDescription": "A value that indicates whether the DB instance is restored from the latest backup time\\. By default, the DB instance isn't restored from the latest backup time\\. \nConstraints: Can't be specified if the `RestoreTime` parameter is provided\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "UseLatestRestorableTime", "type": "boolean" }, "VPCSecurityGroups": { @@ -150966,9 +155511,13 @@ "additionalProperties": false, "properties": { "CAIdentifier": { + "markdownDescription": "The CA identifier of the CA certificate used for the DB instance's server certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CAIdentifier", "type": "string" }, "ValidTill": { + "markdownDescription": "The expiration date of the DB instance\u2019s server certificate\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ValidTill", "type": "string" } }, @@ -150998,12 +155547,18 @@ "additionalProperties": false, "properties": { "Address": { + "markdownDescription": "Specifies the DNS address of the DB instance\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Address", "type": "string" }, "HostedZoneId": { + "markdownDescription": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HostedZoneId", "type": "string" }, "Port": { + "markdownDescription": "Specifies the port that the database engine is listening on\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "string" } }, @@ -151013,9 +155568,13 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "The AWS KMS key identifier that is used to encrypt the secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "SecretArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the secret\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecretArn", "type": "string" } }, @@ -151073,20 +155632,22 @@ "additionalProperties": false, "properties": { "DBParameterGroupName": { + "markdownDescription": "The name of the DB parameter group\\. \nConstraints: \n+ Must be 1 to 255 letters, numbers, or hyphens\\.\n+ First character must be a letter\n+ Can't end with a hyphen or contain two consecutive hyphens\nIf you don't specify a value for `DBParameterGroupName` property, a name is automatically created for the DB parameter group\\. \nThis value is stored as a lowercase string\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DBParameterGroupName", "type": "string" }, "Description": { - "markdownDescription": "Provides the customer\\-specified description for this DB parameter group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Provides the customer\\-specified description for this DB parameter group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Description", "type": "string" }, "Family": { - "markdownDescription": "The DB parameter group family name\\. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family\\. \nThe DB parameter group family can't be changed when updating a DB parameter group\\.\nTo list all of the available parameter group families, use the following command: \n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"` \nThe output contains duplicates\\. \nFor more information, see [`CreateDBParameterGroup`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The DB parameter group family name\\. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family\\. \nThe DB parameter group family can't be changed when updating a DB parameter group\\.\nTo list all of the available parameter group families, use the following command: \n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"` \nThe output contains duplicates\\. \nFor more information, see [`CreateDBParameterGroup`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Family", "type": "string" }, "Parameters": { - "markdownDescription": "An array of parameter names and values for the parameter update\\. At least one parameter name and value must be supplied\\. Subsequent arguments are optional\\. \nFor more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*\\. \nFor more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [ Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*\\. \nAWS CloudFormation doesn't support specifying an apply method for each individual parameter\\. The default apply method for each parameter is used\\.\n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of parameter names and values for the parameter update\\. At least one parameter name and value must be supplied\\. Subsequent arguments are optional\\. \nFor more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*\\. \nFor more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [ Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*\\. \nAWS CloudFormation doesn't support specifying an apply method for each individual parameter\\. The default apply method for each parameter is used\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Parameters", "type": "object" }, @@ -151094,7 +155655,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the DB parameter group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this DB parameter group\\. \nCurrently, this is the only property that supports drift detection\\.\n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -151180,7 +155741,7 @@ "type": "boolean" }, "EngineFamily": { - "markdownDescription": "The kinds of databases that the proxy can connect to\\. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database\\. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora\\. \n*Valid values*: `MYSQL` \\| `POSTGRESQL` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The kinds of databases that the proxy can connect to\\. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database\\. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify `MYSQL`\\. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify `POSTGRESQL`\\. For RDS for Microsoft SQL Server, specify `SQLSERVER`\\. \n*Valid values*: `MYSQL` \\| `POSTGRESQL` \\| `SQLSERVER` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EngineFamily", "type": "string" }, @@ -151263,6 +155824,8 @@ "type": "string" }, "ClientPasswordAuthType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClientPasswordAuthType", "type": "string" }, "Description": { @@ -151271,7 +155834,7 @@ "type": "string" }, "IAMAuth": { - "markdownDescription": "Whether to require or disallow AWS Identity and Access Management \\(IAM\\) authentication for connections to the proxy\\. \nValid Values: `DISABLED | REQUIRED` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Whether to require or disallow AWS Identity and Access Management \\(IAM\\) authentication for connections to the proxy\\. The `ENABLED` value is valid only for proxies with RDS for Microsoft SQL Server\\. \nValid Values: `ENABLED | DISABLED | REQUIRED` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IAMAuth", "type": "string" }, @@ -151470,7 +156033,7 @@ "type": "array" }, "DBProxyName": { - "markdownDescription": "The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DBProxyName", "type": "string" }, @@ -151521,12 +156084,12 @@ "type": "string" }, "MaxConnectionsPercent": { - "markdownDescription": "The maximum size of the connection pool for each target in a target group\\. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group\\. \nDefault: 100 \nConstraints: between 1 and 100 \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The maximum size of the connection pool for each target in a target group\\. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group\\. \nIf you specify `MaxIdleConnectionsPercent`, then you must also include a value for this parameter\\. \nDefault: 10 for RDS for Microsoft SQL Server, and 100 for all other engines \nConstraints: Must be between 1 and 100\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxConnectionsPercent", "type": "number" }, "MaxIdleConnectionsPercent": { - "markdownDescription": "Controls how actively the proxy closes idle database connections in the connection pool\\. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group\\. With a high value, the proxy leaves a high percentage of idle database connections open\\. A low value causes the proxy to close more idle connections and return them to the database\\. \nDefault: 50 \nConstraints: between 0 and `MaxConnectionsPercent` \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Controls how actively the proxy closes idle database connections in the connection pool\\. The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group\\. With a high value, the proxy leaves a high percentage of idle database connections open\\. A low value causes the proxy to close more idle connections and return them to the database\\. \nIf you specify this parameter, then you must also include a value for `MaxConnectionsPercent`\\. \nDefault: The default value is half of the value of `MaxConnectionsPercent`\\. For example, if `MaxConnectionsPercent` is 80, then the default value of `MaxIdleConnectionsPercent` is 40\\. If the value of `MaxConnectionsPercent` isn't specified, then for SQL Server, `MaxIdleConnectionsPercent` is 5, and for all other engines, the default is 50\\. \nConstraints: Must be between 0 and the value of `MaxConnectionsPercent`\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MaxIdleConnectionsPercent", "type": "number" }, @@ -151598,7 +156161,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the DB security group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this DB security group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -151639,17 +156202,17 @@ "type": "string" }, "EC2SecurityGroupId": { - "markdownDescription": "Id of the EC2 Security Group to authorize\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Id of the EC2 security group to authorize\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EC2SecurityGroupId", "type": "string" }, "EC2SecurityGroupName": { - "markdownDescription": "Name of the EC2 Security Group to authorize\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Name of the EC2 security group to authorize\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EC2SecurityGroupName", "type": "string" }, "EC2SecurityGroupOwnerId": { - "markdownDescription": "AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter\\. The AWS Access Key ID is not an acceptable value\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter\\. The AWS access key ID isn't an acceptable value\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EC2SecurityGroupOwnerId", "type": "string" } @@ -151697,22 +156260,22 @@ "type": "string" }, "DBSecurityGroupName": { - "markdownDescription": "The name of the DB Security Group to add authorization to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the DB security group to add authorization to\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DBSecurityGroupName", "type": "string" }, "EC2SecurityGroupId": { - "markdownDescription": "Id of the EC2 Security Group to authorize\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Id of the EC2 security group to authorize\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EC2SecurityGroupId", "type": "string" }, "EC2SecurityGroupName": { - "markdownDescription": "Name of the EC2 Security Group to authorize\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Name of the EC2 security group to authorize\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EC2SecurityGroupName", "type": "string" }, "EC2SecurityGroupOwnerId": { - "markdownDescription": "AWS Account Number of the owner of the EC2 Security Group specified in the EC2SecurityGroupName parameter\\. The AWS Access Key ID is not an acceptable value\\. For VPC DB Security Groups, `EC2SecurityGroupId` must be provided\\. Otherwise, EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter\\. The AWS access key ID isn't an acceptable value\\. For VPC DB security groups, `EC2SecurityGroupId` must be provided\\. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EC2SecurityGroupOwnerId", "type": "string" } @@ -151779,7 +156342,7 @@ "additionalProperties": false, "properties": { "DBSubnetGroupDescription": { - "markdownDescription": "The description for the DB Subnet Group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description for the DB subnet group\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DBSubnetGroupDescription", "type": "string" }, @@ -151792,7 +156355,7 @@ "items": { "type": "string" }, - "markdownDescription": "The EC2 Subnet IDs for the DB Subnet Group\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The EC2 Subnet IDs for the DB subnet group\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SubnetIds", "type": "array" }, @@ -151800,7 +156363,7 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the DB subnet group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this DB subnet group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -151868,7 +156431,7 @@ "additionalProperties": false, "properties": { "Enabled": { - "markdownDescription": "A Boolean value; set to **true** to activate the subscription, set to **false** to create the subscription but not active it\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A value that indicates whether to activate the subscription\\. If the event notification subscription isn't activated, the subscription is created but not active\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Enabled", "type": "boolean" }, @@ -151876,7 +156439,7 @@ "items": { "type": "string" }, - "markdownDescription": "A list of event categories for a SourceType that you want to subscribe to\\. You can see a list of the categories for a given SourceType in the [Events](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) topic in the Amazon RDS User Guide or by using the **DescribeEventCategories** action\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A list of event categories for a particular source type \\(`SourceType`\\) that you want to subscribe to\\. You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the [https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html)\\. You can also see this list by using the `DescribeEventCategories` operation\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EventCategories", "type": "array" }, @@ -151894,17 +156457,21 @@ "type": "array" }, "SourceType": { - "markdownDescription": "The type of source that is generating the events\\. For example, if you want to be notified of events generated by a DB instance, set this parameter to `db-instance`\\. If this value isn't specified, all events are returned\\. \nValid values: `db-instance` \\| `db-cluster` \\| `db-parameter-group` \\| `db-security-group` \\| `db-snapshot` \\| `db-cluster-snapshot` \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "markdownDescription": "The type of source that is generating the events\\. For example, if you want to be notified of events generated by a DB instance, set this parameter to `db-instance`\\. If this value isn't specified, all events are returned\\. \nValid values: `db-instance` \\| `db-cluster` \\| `db-parameter-group` \\| `db-security-group` \\| `db-snapshot` \\| `db-cluster-snapshot` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SourceType", "type": "string" }, "SubscriptionName": { + "markdownDescription": "The name of the subscription\\. \nConstraints: The name must be less than 255 characters\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SubscriptionName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "An optional array of key\\-value pairs to apply to this subscription\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -152058,7 +156625,7 @@ "additionalProperties": false, "properties": { "EngineName": { - "markdownDescription": "Specifies the name of the engine that this option group should be associated with\\. \nValid Values: \n+ `mariadb`\n+ `mysql`\n+ `oracle-ee`\n+ `oracle-se2`\n+ `oracle-se1`\n+ `oracle-se`\n+ `postgres`\n+ `sqlserver-ee`\n+ `sqlserver-se`\n+ `sqlserver-ex`\n+ `sqlserver-web`\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies the name of the engine that this option group should be associated with\\. \nValid Values: \n+ `mariadb`\n+ `mysql`\n+ `oracle-ee`\n+ `oracle-ee-cdb`\n+ `oracle-se2`\n+ `oracle-se2-cdb`\n+ `postgres`\n+ `sqlserver-ee`\n+ `sqlserver-se`\n+ `sqlserver-ex`\n+ `sqlserver-web`\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EngineName", "type": "string" }, @@ -152071,7 +156638,7 @@ "items": { "$ref": "#/definitions/AWS::RDS::OptionGroup.OptionConfiguration" }, - "markdownDescription": "A list of options and the settings for each option\\. \n*Required*: Conditional \n*Type*: List of [OptionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of options and the settings for each option\\. \n*Required*: Conditional \n*Type*: List of [OptionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OptionConfigurations", "type": "array" }, @@ -152081,13 +156648,15 @@ "type": "string" }, "OptionGroupName": { + "markdownDescription": "The name of the option group to be created\\. \nConstraints: \n+ Must be 1 to 255 letters, numbers, or hyphens\n+ First character must be a letter\n+ Can't end with a hyphen or contain two consecutive hyphens\nExample: `myoptiongroup` \nIf you don't specify a value for `OptionGroupName` property, a name is automatically created for the option group\\. \nThis value is stored as a lowercase string\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OptionGroupName", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to assign to the option group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional array of key\\-value pairs to apply to this option group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -152140,7 +156709,7 @@ "items": { "$ref": "#/definitions/AWS::RDS::OptionGroup.OptionSetting" }, - "markdownDescription": "The option settings to include in an option group\\. \n*Required*: No \n*Type*: List of [OptionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfigurations-optionsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The option settings to include in an option group\\. \n*Required*: No \n*Type*: List of [OptionSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionsetting.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OptionSettings", "type": "array" }, @@ -152225,7 +156794,9 @@ "title": "AppMonitorConfiguration" }, "CustomEvents": { - "$ref": "#/definitions/AWS::RUM::AppMonitor.CustomEvents" + "$ref": "#/definitions/AWS::RUM::AppMonitor.CustomEvents", + "markdownDescription": "Specifies whether this app monitor allows the web client to define and send custom events\\. If you omit this parameter, custom events are `DISABLED`\\. \n*Required*: No \n*Type*: [CustomEvents](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-customevents.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomEvents" }, "CwLogEnabled": { "markdownDescription": "Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted\\. This parameter specifies whether CloudWatch RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account\\. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges\\. \nIf you omit this parameter, the default is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -152329,6 +156900,8 @@ "items": { "$ref": "#/definitions/AWS::RUM::AppMonitor.MetricDestination" }, + "markdownDescription": "An array of structures that each define a destination that this app monitor will send extended metrics to\\. \n*Required*: No \n*Type*: List of [MetricDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetricDestinations", "type": "array" }, "SessionSampleRate": { @@ -152351,6 +156924,8 @@ "additionalProperties": false, "properties": { "Status": { + "markdownDescription": "Set this to `ENABLED` to allow the web client to send custom events for this app monitor\\. \nValid values are `ENABLED` and `DISABLED`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" } }, @@ -152361,23 +156936,33 @@ "properties": { "DimensionKeys": { "additionalProperties": true, + "markdownDescription": "This field is a map of field paths to dimension names\\. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is `CloudWatch`\\. If the metric destination is `Evidently`, the value of `DimensionKeys` is ignored\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "DimensionKeys", "type": "object" }, "EventPattern": { + "markdownDescription": "The pattern that defines the metric\\. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination\\. \nIf the metrics destination is `CloudWatch` and the event also matches a value in `DimensionKeys`, then the metric is published with the specified dimensions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EventPattern", "type": "string" }, "Name": { + "markdownDescription": "The name of the metric that is defined in this structure\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "UnitLabel": { + "markdownDescription": "Use this field only if you are sending this metric to CloudWatch\\. It defines the CloudWatch metric unit that this metric is measured in\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UnitLabel", "type": "string" }, "ValueKey": { + "markdownDescription": "The field within the event object that the metric value is sourced from\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ValueKey", "type": "string" } }, @@ -152390,18 +156975,26 @@ "additionalProperties": false, "properties": { "Destination": { + "markdownDescription": "Defines the destination to send the metrics to\\. Valid values are `CloudWatch` and `Evidently`\\. If you specify `Evidently`, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Destination", "type": "string" }, "DestinationArn": { + "markdownDescription": "Use this parameter only if `Destination` is `Evidently`\\. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DestinationArn", "type": "string" }, "IamRoleArn": { + "markdownDescription": "This parameter is required if `Destination` is `Evidently`\\. If `Destination` is `CloudWatch`, do not use this parameter\\. \nThis parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to\\. This role must have permission to write to that experiment\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IamRoleArn", "type": "string" }, "MetricDefinitions": { "items": { "$ref": "#/definitions/AWS::RUM::AppMonitor.MetricDefinition" }, + "markdownDescription": "An array of structures which define the metrics that you want to send\\. \n*Required*: No \n*Type*: List of [MetricDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-metricdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetricDefinitions", "type": "array" } }, @@ -152451,7 +157044,7 @@ "type": "boolean" }, "AquaConfigurationStatus": { - "markdownDescription": "The value represents how the cluster is configured to use AQUA \\(Advanced Query Accelerator\\) when it is created\\. Possible values include the following\\. \n+ enabled \\- Use AQUA if it is available for the current AWS Region and Amazon Redshift node type\\.\n+ disabled \\- Don't use AQUA\\. \n+ auto \\- Amazon Redshift determines whether to use AQUA\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `auto | disabled | enabled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This parameter is retired\\. It does not set the AQUA configuration status\\. Amazon Redshift automatically determines whether to use AQUA \\(Advanced Query Accelerator\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `auto | disabled | enabled` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AquaConfigurationStatus", "type": "string" }, @@ -152519,22 +157112,22 @@ "type": "string" }, "DeferMaintenance": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeferMaintenance", "type": "boolean" }, "DeferMaintenanceDuration": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeferMaintenanceDuration", "type": "number" }, "DeferMaintenanceEndTime": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeferMaintenanceEndTime", "type": "string" }, "DeferMaintenanceStartTime": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeferMaintenanceStartTime", "type": "string" }, @@ -152544,7 +157137,7 @@ "type": "string" }, "ElasticIp": { - "markdownDescription": "The Elastic IP \\(EIP\\) address for the cluster\\. \nConstraints: The cluster must be provisioned in EC2\\-VPC and publicly\\-accessible through an Internet gateway\\. For more information about provisioning clusters in EC2\\-VPC, go to [Supported Platforms to Launch Your Cluster](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms) in the Amazon Redshift Cluster Management Guide\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Elastic IP \\(EIP\\) address for the cluster\\. \nConstraints: The cluster must be provisioned in EC2\\-VPC and publicly\\-accessible through an Internet gateway\\. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on\\. For more information about provisioning clusters in EC2\\-VPC, go to [Supported Platforms to Launch Your Cluster](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms) in the Amazon Redshift Cluster Management Guide\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ElasticIp", "type": "string" }, @@ -152554,7 +157147,9 @@ "type": "boolean" }, "Endpoint": { - "$ref": "#/definitions/AWS::Redshift::Cluster.Endpoint" + "$ref": "#/definitions/AWS::Redshift::Cluster.Endpoint", + "markdownDescription": "The connection endpoint\\. \n*Required*: No \n*Type*: [Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-cluster-endpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Endpoint" }, "EnhancedVpcRouting": { "markdownDescription": "An option that specifies whether to create the cluster with enhanced VPC routing enabled\\. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC\\. For more information, see [Enhanced VPC Routing](https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in the Amazon Redshift Cluster Management Guide\\. \nIf this option is `true`, enhanced VPC routing is enabled\\. \nDefault: false \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -152600,12 +157195,12 @@ "type": "number" }, "MasterUserPassword": { - "markdownDescription": "The password associated with the admin user account for the cluster that is being created\\. \nConstraints: \n+ Must be between 8 and 64 characters in length\\.\n+ Must contain at least one uppercase letter\\.\n+ Must contain at least one lowercase letter\\.\n+ Must contain one number\\.\n+ Can be any printable ASCII character \\(ASCII code 33\\-126\\) except ' \\(single quote\\), \" \\(double quote\\), \\\\, /, or @\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The password associated with the admin user account for the cluster that is being created\\. \nConstraints: \n+ Must be between 8 and 64 characters in length\\.\n+ Must contain at least one uppercase letter\\.\n+ Must contain at least one lowercase letter\\.\n+ Must contain one number\\.\n+ Can be any printable ASCII character \\(ASCII code 33\\-126\\) except `'` \\(single quote\\), `\"` \\(double quote\\), `\\`, `/`, or `@`\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MasterUserPassword", "type": "string" }, "MasterUsername": { - "markdownDescription": "The user name associated with the admin user account for the cluster that is being created\\. \nConstraints: \n+ Must be 1 \\- 128 alphanumeric characters\\. The user name can't be `PUBLIC`\\.\n+ First character must be a letter\\.\n+ Cannot be a reserved word\\. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The user name associated with the admin user account for the cluster that is being created\\. \nConstraints: \n+ Must be 1 \\- 128 alphanumeric characters or hyphens\\. The user name can't be `PUBLIC`\\.\n+ Must contain only lowercase letters, numbers, underscore, plus sign, period \\(dot\\), at symbol \\(@\\), or hyphen\\.\n+ The first character must be a letter\\.\n+ Must not contain a colon \\(:\\) or a slash \\(/\\)\\.\n+ Cannot be a reserved word\\. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MasterUsername", "type": "string" }, @@ -152640,17 +157235,17 @@ "type": "boolean" }, "ResourceAction": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceAction", "type": "string" }, "RevisionTarget": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RevisionTarget", "type": "string" }, "RotateEncryptionKey": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RotateEncryptionKey", "type": "boolean" }, @@ -152665,17 +157260,17 @@ "type": "string" }, "SnapshotCopyManual": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SnapshotCopyManual", "type": "boolean" }, "SnapshotCopyRetentionPeriod": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region\\. \nBy default, this only changes the retention period of copied automated snapshots\\. \nIf you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period\\. \nConstraints: Must be at least 1 and no more than 35 for automated snapshots\\. \nIf you specify the `manual` option, only newly copied manual snapshots will have the new retention period\\. \nIf you specify the value of \\-1 newly copied manual snapshots are retained indefinitely\\. \nConstraints: The number of days must be either \\-1 or an integer between 1 and 3,653 for manual snapshots\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SnapshotCopyRetentionPeriod", "type": "number" }, "SnapshotIdentifier": { - "markdownDescription": "The name of the snapshot from which to create the new cluster\\. This parameter isn't case sensitive\\. \nExample: `my-snapshot-id` \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the snapshot from which to create the new cluster\\. This parameter isn't case sensitive\\. You must specify this parameter or `snapshotArn`, but not both\\. \nExample: `my-snapshot-id` \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SnapshotIdentifier", "type": "string" }, @@ -152810,7 +157405,7 @@ "items": { "$ref": "#/definitions/AWS::Redshift::ClusterParameterGroup.Parameter" }, - "markdownDescription": "An array of parameters to be modified\\. A maximum of 20 parameters can be modified in a single request\\. \nFor each parameter to be modified, you must supply at least the parameter name and parameter value; other name\\-value pairs of the parameter are optional\\. \nFor the workload management \\(WLM\\) configuration, you must supply all the name\\-value pairs in the wlm\\_json\\_configuration parameter\\. \n*Required*: No \n*Type*: List of [Parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-property-redshift-clusterparametergroup-parameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of parameters to be modified\\. A maximum of 20 parameters can be modified in a single request\\. \nFor each parameter to be modified, you must supply at least the parameter name and parameter value; other name\\-value pairs of the parameter are optional\\. \nFor the workload management \\(WLM\\) configuration, you must supply all the name\\-value pairs in the wlm\\_json\\_configuration parameter\\. \n*Required*: No \n*Type*: List of [Parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-clusterparametergroup-parameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Parameters", "type": "array" }, @@ -153147,7 +157742,7 @@ "additionalProperties": false, "properties": { "ClusterIdentifier": { - "markdownDescription": "The cluster identifier of the cluster associated with the endpoint\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The cluster identifier of the cluster associated with the endpoint\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ClusterIdentifier", "type": "string" }, @@ -153162,7 +157757,7 @@ "type": "string" }, "SubnetGroupName": { - "markdownDescription": "The subnet group name where Amazon Redshift chooses to deploy the endpoint\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The subnet group name where Amazon Redshift chooses to deploy the endpoint\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "SubnetGroupName", "type": "string" }, @@ -153208,15 +157803,23 @@ "additionalProperties": false, "properties": { "AvailabilityZone": { + "markdownDescription": "The Availability Zone\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AvailabilityZone", "type": "string" }, "NetworkInterfaceId": { + "markdownDescription": "The network interface identifier\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkInterfaceId", "type": "string" }, "PrivateIpAddress": { + "markdownDescription": "The IPv4 address of the network interface within the subnet\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PrivateIpAddress", "type": "string" }, "SubnetId": { + "markdownDescription": "The subnet identifier\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetId", "type": "string" } }, @@ -153229,12 +157832,18 @@ "items": { "$ref": "#/definitions/AWS::Redshift::EndpointAccess.NetworkInterface" }, + "markdownDescription": "One or more network interfaces of the endpoint\\. Also known as an interface endpoint\\. \n*Required*: No \n*Type*: List of [NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-endpointaccess-networkinterface.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkInterfaces", "type": "array" }, "VpcEndpointId": { + "markdownDescription": "The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcEndpointId", "type": "string" }, "VpcId": { + "markdownDescription": "The VPC identifier that the endpoint is associated\\. \n*Required*: No \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcId", "type": "string" } }, @@ -153292,7 +157901,7 @@ "additionalProperties": false, "properties": { "Account": { - "markdownDescription": "The AAWS account ID of either the cluster owner \\(grantor\\) or grantee\\. If `Grantee` parameter is true, then the `Account` value is of the grantor\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The AWS account ID of either the cluster owner \\(grantor\\) or grantee\\. If `Grantee` parameter is true, then the `Account` value is of the grantor\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `2147483647` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Account", "type": "string" }, @@ -153768,42 +158377,64 @@ "additionalProperties": false, "properties": { "AdminUsername": { + "markdownDescription": "The username of the administrator for the first database created in the namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdminUsername", "type": "string" }, "CreationDate": { + "markdownDescription": "The date of when the namespace was created\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreationDate", "type": "string" }, "DbName": { + "markdownDescription": "The name of the first database created in the namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DbName", "type": "string" }, "DefaultIamRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IAM role to set as a default in the namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultIamRoleArn", "type": "string" }, "IamRoles": { "items": { "type": "string" }, + "markdownDescription": "A list of IAM roles to associate with the namespace\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IamRoles", "type": "array" }, "KmsKeyId": { + "markdownDescription": "The ID of the AWS Key Management Service key used to encrypt your data\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "LogExports": { "items": { "type": "string" }, + "markdownDescription": "The types of logs the namespace can export\\. Available export types are User log, Connection log, and User activity log\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LogExports", "type": "array" }, "NamespaceArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) associated with a namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NamespaceArn", "type": "string" }, "NamespaceId": { + "markdownDescription": "The unique identifier of a namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NamespaceId", "type": "string" }, "NamespaceName": { + "markdownDescription": "The name of the namespace\\. Must be between 3\\-64 alphanumeric characters in lowercase, and it cannot be a reserved word\\. A list of reserved words can be found in [Reserved Words](https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html) in the Amazon Redshift Database Developer Guide\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NamespaceName", "type": "string" }, "Status": { + "markdownDescription": "The status of the namespace\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" } }, @@ -153868,6 +158499,8 @@ "type": "string" }, "Port": { + "markdownDescription": "The custom port to use when connecting to a workgroup\\. Valid port ranges are 5431\\-5455 and 8191\\-8215\\. The default is 5439\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "PubliclyAccessible": { @@ -153951,15 +158584,21 @@ "additionalProperties": false, "properties": { "Address": { + "markdownDescription": "The DNS address of the VPC endpoint\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Address", "type": "string" }, "Port": { + "markdownDescription": "The port that Amazon Redshift Serverless listens on\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "VpcEndpoints": { "items": { "$ref": "#/definitions/AWS::RedshiftServerless::Workgroup.VpcEndpoint" }, + "markdownDescription": "An array of `VpcEndpoint` objects\\. \n*Required*: No \n*Type*: List of [VpcEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-vpcendpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcEndpoints", "type": "array" } }, @@ -153969,15 +158608,23 @@ "additionalProperties": false, "properties": { "AvailabilityZone": { + "markdownDescription": "The availability Zone\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AvailabilityZone", "type": "string" }, "NetworkInterfaceId": { + "markdownDescription": "The unique identifier of the network interface\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkInterfaceId", "type": "string" }, "PrivateIpAddress": { + "markdownDescription": "The IPv4 address of the network interface within the subnet\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PrivateIpAddress", "type": "string" }, "SubnetId": { + "markdownDescription": "The unique identifier of the subnet\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetId", "type": "string" } }, @@ -153990,12 +158637,18 @@ "items": { "$ref": "#/definitions/AWS::RedshiftServerless::Workgroup.NetworkInterface" }, + "markdownDescription": "One or more network interfaces of the endpoint\\. Also known as an interface endpoint\\. \n*Required*: No \n*Type*: List of [NetworkInterface](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-networkinterface.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NetworkInterfaces", "type": "array" }, "VpcEndpointId": { + "markdownDescription": "The connection endpoint ID for connecting to Amazon Redshift Serverless\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcEndpointId", "type": "string" }, "VpcId": { + "markdownDescription": "The VPC identifier that the endpoint is associated with\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VpcId", "type": "string" } }, @@ -154005,51 +158658,77 @@ "additionalProperties": false, "properties": { "BaseCapacity": { + "markdownDescription": "The base data warehouse capacity of the workgroup in Redshift Processing Units \\(RPUs\\)\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BaseCapacity", "type": "number" }, "ConfigParameters": { "items": { "$ref": "#/definitions/AWS::RedshiftServerless::Workgroup.ConfigParameter" }, + "markdownDescription": "An array of parameters to set for advanced control over a database\\. The options are `auto_mv`, `datestyle`, `enable_case_sensitivity_identifier`, `enable_user_activity_logging`, `query_group`, , `search_path`, and query monitoring metrics that let you define performance boundaries\\. For more information about query monitoring rules and available metrics, see [ Query monitoring metrics for Amazon Redshift Serverless](https://docs.aws.amazon.com/redshift/latest/dg/cm-c-wlm-query-monitoring-rules.html#cm-c-wlm-query-monitoring-metrics-serverless)\\. \n*Required*: No \n*Type*: List of [ConfigParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-configparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConfigParameters", "type": "array" }, "CreationDate": { + "markdownDescription": "The creation date of the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreationDate", "type": "string" }, "Endpoint": { - "$ref": "#/definitions/AWS::RedshiftServerless::Workgroup.Endpoint" + "$ref": "#/definitions/AWS::RedshiftServerless::Workgroup.Endpoint", + "markdownDescription": "The endpoint that is created from the workgroup\\. \n*Required*: No \n*Type*: [Endpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshiftserverless-workgroup-endpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Endpoint" }, "EnhancedVpcRouting": { + "markdownDescription": "The value that specifies whether to enable enhanced virtual private cloud \\(VPC\\) routing, which forces Amazon Redshift Serverless to route traffic through your VPC\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnhancedVpcRouting", "type": "boolean" }, "NamespaceName": { + "markdownDescription": "The namespace the workgroup is associated with\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NamespaceName", "type": "string" }, "PubliclyAccessible": { + "markdownDescription": "A value that specifies whether the workgroup can be accessible from a public network \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PubliclyAccessible", "type": "boolean" }, "SecurityGroupIds": { "items": { "type": "string" }, + "markdownDescription": "An array of security group IDs to associate with the workgroup\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroupIds", "type": "array" }, "Status": { + "markdownDescription": "The status of the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "SubnetIds": { "items": { "type": "string" }, + "markdownDescription": "An array of subnet IDs the workgroup is associated with\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SubnetIds", "type": "array" }, "WorkgroupArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) that links to the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WorkgroupArn", "type": "string" }, "WorkgroupId": { + "markdownDescription": "The unique identifier of the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WorkgroupId", "type": "string" }, "WorkgroupName": { + "markdownDescription": "The name of the workgroup\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "WorkgroupName", "type": "string" } }, @@ -154284,7 +158963,9 @@ "type": "string" }, "DefaultRoute": { - "$ref": "#/definitions/AWS::RefactorSpaces::Route.DefaultRouteInput" + "$ref": "#/definitions/AWS::RefactorSpaces::Route.DefaultRouteInput", + "markdownDescription": "Configuration for the default route type\\. \n*Required*: No \n*Type*: [DefaultRouteInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-defaultrouteinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultRoute" }, "EnvironmentIdentifier": { "markdownDescription": "The unique identifier of the environment\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -154311,7 +158992,7 @@ }, "UriPathRoute": { "$ref": "#/definitions/AWS::RefactorSpaces::Route.UriPathRouteInput", - "markdownDescription": "The configuration for the URI path route type\\. \n*Required*: No \n*Type*: [UriPathRouteInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The configuration for the URI path route type\\. \n*Required*: No \n*Type*: [UriPathRouteInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-refactorspaces-route-uripathrouteinput.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UriPathRoute" } }, @@ -154347,6 +159028,8 @@ "additionalProperties": false, "properties": { "ActivationState": { + "markdownDescription": "If set to `ACTIVE`, traffic is forwarded to this route\u2019s service after the route is created\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActivationState", "type": "string" } }, @@ -154359,7 +159042,7 @@ "additionalProperties": false, "properties": { "ActivationState": { - "markdownDescription": "Indicates whether traffic is forwarded to this route\u2019s service after the route is created\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "If set to `ACTIVE`, traffic is forwarded to this route\u2019s service after the route is created\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ActivationState", "type": "string" }, @@ -154502,7 +159185,7 @@ "additionalProperties": false, "properties": { "Arn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Lambda endpoint\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Lambda function or alias\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Arn", "type": "string" } @@ -154712,45 +159395,71 @@ "items": { "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.BoundingBox" }, + "markdownDescription": "List of BoundingBox objects, each of which denotes a region of interest on screen\\. For more information, see the BoundingBox field of [RegionOfInterest](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RegionOfInterest)\\. \n*Required*: No \n*Type*: List of [BoundingBox](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-boundingbox.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BoundingBoxRegionsOfInterest", "type": "array" }, "ConnectedHomeSettings": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.ConnectedHomeSettings" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.ConnectedHomeSettings", + "markdownDescription": "Connected home settings to use on a streaming video\\. You can use a stream processor for connected home features and select what you want the stream processor to detect, such as people or pets\\. When the stream processor has started, one notification is sent for each object class specified\\. For more information, see the ConnectedHome section of [StreamProcessorSettings](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorSettings)\\. \n*Required*: No \n*Type*: [ConnectedHomeSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-connectedhomesettings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConnectedHomeSettings" }, "DataSharingPreference": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.DataSharingPreference" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.DataSharingPreference", + "markdownDescription": "Allows you to opt in or opt out to share data with Rekognition to improve model performance\\. You can choose this option at the account level or on a per\\-stream basis\\. Note that if you opt out at the account level this setting is ignored on individual streams\\. For more information, see [StreamProcessorDataSharingPreference](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorDataSharingPreference)\\. \n*Required*: No \n*Type*: [DataSharingPreference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-datasharingpreference.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataSharingPreference" }, "FaceSearchSettings": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.FaceSearchSettings" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.FaceSearchSettings", + "markdownDescription": "The input parameters used to recognize faces in a streaming video analyzed by an Amazon Rekognition stream processor\\. For more information regarding the contents of the parameters, see [FaceSearchSettings](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_FaceSearchSettings)\\. \n*Required*: No \n*Type*: [FaceSearchSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-facesearchsettings.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FaceSearchSettings" }, "KinesisDataStream": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.KinesisDataStream" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.KinesisDataStream", + "markdownDescription": "Amazon Rekognition's Video Stream Processor takes a Kinesis video stream as input\\. This is the Amazon Kinesis Data Streams instance to which the Amazon Rekognition stream processor streams the analysis results\\. This must be created within the constraints specified at [KinesisDataStream](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_KinesisDataStream)\\. \n*Required*: No \n*Type*: [KinesisDataStream](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-kinesisdatastream.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KinesisDataStream" }, "KinesisVideoStream": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.KinesisVideoStream" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.KinesisVideoStream", + "markdownDescription": "The Kinesis video stream that provides the source of the streaming video for an Amazon Rekognition Video stream processor\\. For more information, see [KinesisVideoStream](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_KinesisVideoStream)\\. \n*Required*: Yes \n*Type*: [KinesisVideoStream](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-kinesisvideostream.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KinesisVideoStream" }, "KmsKeyId": { + "markdownDescription": "The identifier for your Amazon Key Management Service key \\(Amazon KMS key\\)\\. Optional parameter for connected home stream processors used to encrypt results and data published to your Amazon S3 bucket\\. For more information, see the KMSKeyId section of [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" }, "Name": { + "markdownDescription": "The Name attribute specifies the name of the stream processor and it must be within the constraints described in the Name section of [StreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessor)\\. If you don't specify a name, Amazon CloudFormation generates a unique ID and uses that ID for the stream processor name\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[a-zA-Z0-9_.\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "NotificationChannel": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.NotificationChannel" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.NotificationChannel", + "markdownDescription": "The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation\\. Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream\\. Amazon Rekognition also publishes an end\\-of\\-session notification with a summary when the stream processing session is complete\\. For more information, see [StreamProcessorNotificationChannel](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorNotificationChannel)\\. \n*Required*: No \n*Type*: [NotificationChannel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-notificationchannel.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NotificationChannel" }, "PolygonRegionsOfInterest": { + "markdownDescription": "A set of ordered lists of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects\\. Each entry of the set contains a polygon denoting a region of interest on the screen\\. Each polygon is an ordered list of [Point](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_Point) objects\\. For more information, see the Polygon field of [RegionOfInterest](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RegionOfInterest)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PolygonRegionsOfInterest", "type": "object" }, "RoleArn": { + "markdownDescription": "The ARN of the IAM role that allows access to the stream processor\\. The IAM role provides Rekognition read permissions to the Kinesis stream\\. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a connected home stream processor\\. This is required for both face search and connected home stream processors\\. For information about constraints, see the RoleArn section of [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RoleArn", "type": "string" }, "S3Destination": { - "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.S3Destination" + "$ref": "#/definitions/AWS::Rekognition::StreamProcessor.S3Destination", + "markdownDescription": "The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation\\. For more information, see the S3Destination section of [StreamProcessorOutput](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StreamProcessorOutput)\\. \n*Required*: No \n*Type*: [S3Destination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-s3destination.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3Destination" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A set of tags \\(key\\-value pairs\\) that you want to attach to the stream processor\\. For more information, see the Tags section of [CreateStreamProcessor](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor)\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -154785,15 +159494,23 @@ "additionalProperties": false, "properties": { "Height": { + "markdownDescription": "Height of the bounding box as a ratio of the overall image height\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Height", "type": "number" }, "Left": { + "markdownDescription": "Left coordinate of the bounding box as a ratio of overall image width\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Left", "type": "number" }, "Top": { + "markdownDescription": "Top coordinate of the bounding box as a ratio of overall image height\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Top", "type": "number" }, "Width": { + "markdownDescription": "Width of the bounding box as a ratio of the overall image width\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Width", "type": "number" } }, @@ -154812,9 +159529,13 @@ "items": { "type": "string" }, + "markdownDescription": "Specifies what you want to detect in the video, such as people, packages, or pets\\. The current valid labels you can include in this list are: \"PERSON\", \"PET\", \"PACKAGE\", and \"ALL\"\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Labels", "type": "array" }, "MinConfidence": { + "markdownDescription": "The minimum confidence required to label an object in the video\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MinConfidence", "type": "number" } }, @@ -154827,6 +159548,8 @@ "additionalProperties": false, "properties": { "OptIn": { + "markdownDescription": "Describes the opt\\-in status applied to a stream processor's data sharing policy\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OptIn", "type": "boolean" } }, @@ -154839,9 +159562,13 @@ "additionalProperties": false, "properties": { "CollectionId": { + "markdownDescription": "The ID of a collection that contains faces that you want to search for\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[a-zA-Z0-9_.\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CollectionId", "type": "string" }, "FaceMatchThreshold": { + "markdownDescription": "Minimum face match confidence score that must be met to return a result for a recognized face\\. The default is 80\\. 0 is the lowest confidence\\. 100 is the highest confidence\\. Values between 0 and 100 are accepted, and values lower than 80 are set to 80\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FaceMatchThreshold", "type": "number" } }, @@ -154854,6 +159581,8 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "ARN of the output Amazon Kinesis Data Streams stream\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `(^arn:([a-z\\d-]+):kinesis:([a-z\\d-]+):\\d{12}:.+$)` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Arn", "type": "string" } }, @@ -154866,6 +159595,8 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "ARN of the Kinesis video stream stream that streams the source video\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `(^arn:([a-z\\d-]+):kinesisvideo:([a-z\\d-]+):\\d{12}:.+$)` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Arn", "type": "string" } }, @@ -154878,6 +159609,8 @@ "additionalProperties": false, "properties": { "Arn": { + "markdownDescription": "The ARN of the SNS topic that receives notifications\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Arn", "type": "string" } }, @@ -154890,9 +159623,13 @@ "additionalProperties": false, "properties": { "BucketName": { + "markdownDescription": "Describes the destination Amazon Simple Storage Service \\(Amazon S3\\) bucket name of a stream processor's exports\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BucketName", "type": "string" }, "ObjectKeyPrefix": { + "markdownDescription": "Describes the destination Amazon Simple Storage Service \\(Amazon S3\\) object keys of a stream processor's exports\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ObjectKeyPrefix", "type": "string" } }, @@ -154937,6 +159674,8 @@ "additionalProperties": false, "properties": { "AppAssessmentSchedule": { + "markdownDescription": "Assessment execution schedule with 'Daily' or 'Disabled' values\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppAssessmentSchedule", "type": "string" }, "AppTemplateBody": { @@ -155046,7 +159785,7 @@ "type": "string" }, "MappingType": { - "markdownDescription": "Specifies the type of resource mapping\\. \nAppRegistryApp \nThe resource is mapped to another application\\. The name of the application is contained in the `appRegistryAppName` property\\. \nCfnStack \nThe resource is mapped to a CloudFormation stack\\. The name of the CloudFormation stack is contained in the `logicalStackName` property\\. \nResource \nThe resource is mapped to another resource\\. The name of the resource is contained in the `resourceName` property\\. \nResourceGroup \nThe resource is mapped to a resource group\\. The name of the resource group is contained in the `resourceGroupName` property\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the type of resource mapping\\. \nValid Values: CfnStack \\| Resource \\| AppRegistryApp \\| ResourceGroup \\| Terraform \nAppRegistryApp \nThe resource is mapped to another application\\. The name of the application is contained in the `appRegistryAppName` property\\. \nCfnStack \nThe resource is mapped to a CloudFormation stack\\. The name of the CloudFormation stack is contained in the `logicalStackName` property\\. \nResource \nThe resource is mapped to another resource\\. The name of the resource is contained in the `resourceName` property\\. \nResourceGroup \nThe resource is mapped to a resource group\\. The name of the resource group is contained in the `resourceGroupName` property\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MappingType", "type": "string" }, @@ -155061,6 +159800,8 @@ "type": "string" }, "TerraformSourceName": { + "markdownDescription": "The short name of the Terraform source\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TerraformSourceName", "type": "string" } }, @@ -155232,6 +159973,8 @@ "additionalProperties": false, "properties": { "ViewArn": { + "markdownDescription": "The ARN of the view to set as the default for the AWS Region and AWS account in which you call this operation\\. The specified view must already exist in the specified Region\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ViewArn", "type": "string" } }, @@ -155298,14 +160041,18 @@ "properties": { "Tags": { "additionalProperties": true, + "markdownDescription": "The specified tags are attached to only the index created in this AWS Region\\. The tags don't attach to any of the resources listed in the index\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "Type": { + "markdownDescription": "Specifies the type of the index in this Region\\. For information about the aggregator index and how it differs from a local index, see [Turning on cross\\-Region search by creating an aggregator index](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html) in the *AWS Resource Explorer User Guide\\.*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AGGREGATOR | LOCAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" } }, @@ -155371,24 +160118,32 @@ "additionalProperties": false, "properties": { "Filters": { - "$ref": "#/definitions/AWS::ResourceExplorer2::View.Filters" + "$ref": "#/definitions/AWS::ResourceExplorer2::View.Filters", + "markdownDescription": "An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view\\. When you use this view in a [Search](https://docs.aws.amazon.com/resource-explorer/latest/APIReference/API_Search.html) operation, the filter string is combined with the search's `QueryString` parameter using a logical `AND` operator\\. \nFor information about the supported syntax, see [Search query reference for Resource Explorer](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) in the *AWS Resource Explorer User Guide*\\. \nThis query string in the context of this operation supports only [filter prefixes](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) with optional [operators](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators)\\. It doesn't support free\\-form text\\. For example, the string `region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any AWS Region that begin with the letters `us` and are *not* tagged with a key `Stage` that has the value `prod`\\.\n*Required*: No \n*Type*: [Filters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-filters.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Filters" }, "IncludedProperties": { "items": { "$ref": "#/definitions/AWS::ResourceExplorer2::View.IncludedProperty" }, + "markdownDescription": "A list of fields that provide additional information about the view\\. \n*Required*: No \n*Type*: List of [IncludedProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resourceexplorer2-view-includedproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludedProperties", "type": "array" }, "Tags": { "additionalProperties": true, + "markdownDescription": "Tag key and value pairs that are attached to the view\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Tags", "type": "object" }, "ViewName": { + "markdownDescription": "The name of the new view\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9\\-]{1,64}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ViewName", "type": "string" } }, @@ -155422,6 +160177,8 @@ "additionalProperties": false, "properties": { "FilterString": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FilterString", "type": "string" } }, @@ -155434,6 +160191,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the property that is included in this view\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -155863,7 +160622,7 @@ }, "RobotSoftwareSuite": { "$ref": "#/definitions/AWS::RoboMaker::RobotApplication.RobotSoftwareSuite", - "markdownDescription": "The robot software suite \\(ROS distribuition\\) used by the robot application\\. \n*Required*: Yes \n*Type*: [RobotSoftwareSuite](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The robot software suite used by the robot application\\. \n*Required*: Yes \n*Type*: [RobotSoftwareSuite](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-robotapplication-robotsoftwaresuite.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RobotSoftwareSuite" }, "Sources": { @@ -155916,12 +160675,12 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of the robot software suite \\(ROS distribution\\)\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `General | ROS | ROS2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the robot software suite\\. `General` is the only supported value\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `General | ROS | ROS2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Version": { - "markdownDescription": "The version of the robot software suite \\(ROS distribution\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Dashing | Foxy | Kinetic | Melodic` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the robot software suite\\. Not applicable for General software suite\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Dashing | Foxy | Kinetic | Melodic` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -156086,7 +160845,7 @@ }, "RobotSoftwareSuite": { "$ref": "#/definitions/AWS::RoboMaker::SimulationApplication.RobotSoftwareSuite", - "markdownDescription": "The robot software suite \\(ROS distribution\\) used by the simulation application\\. \n*Required*: Yes \n*Type*: [RobotSoftwareSuite](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The robot software suite used by the simulation application\\. \n*Required*: Yes \n*Type*: [RobotSoftwareSuite](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-robomaker-simulationapplication-robotsoftwaresuite.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RobotSoftwareSuite" }, "SimulationSoftwareSuite": { @@ -156165,12 +160924,12 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of the robot software suite \\(ROS distribution\\)\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `General | ROS | ROS2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the robot software suite\\. `General` is the only supported value\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `General | ROS | ROS2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Version": { - "markdownDescription": "The version of the robot software suite \\(ROS distribution\\)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Dashing | Foxy | Kinetic | Melodic` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the robot software suite\\. Not applicable for General software suite\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Dashing | Foxy | Kinetic | Melodic` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -156184,12 +160943,12 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of the simulation software suite\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Gazebo | RosbagPlay | SimulationRuntime` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the simulation software suite\\. `SimulationRuntime` is the only supported value\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Gazebo | RosbagPlay | SimulationRuntime` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Version": { - "markdownDescription": "The version of the simulation software suite\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Pattern*: `7|9|11|Kinetic|Melodic|Dashing|Foxy` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the simulation software suite\\. Not applicable for `SimulationRuntime`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `0` \n*Maximum*: `1024` \n*Pattern*: `7|9|11|Kinetic|Melodic|Dashing|Foxy` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -156333,21 +161092,31 @@ "additionalProperties": false, "properties": { "CrlData": { + "markdownDescription": "The revocation record for a certificate, following the x509 v3 standard\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CrlData", "type": "string" }, "Enabled": { + "markdownDescription": "Indicates whether the certificate revocation list \\(CRL\\) is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "Name": { + "markdownDescription": "The name of the certificate revocation list \\(CRL\\)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags to attach to the CRL\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "TrustAnchorArn": { + "markdownDescription": "The ARN of the TrustAnchor the certificate revocation list \\(CRL\\) will provide revocation for\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrustAnchorArn", "type": "string" } }, @@ -156414,36 +161183,52 @@ "additionalProperties": false, "properties": { "DurationSeconds": { + "markdownDescription": "Sets the maximum number of seconds that vended temporary credentials through [CreateSession](https://docs.aws.amazon.com/rolesanywhere/latest/userguide/authentication-create-session.html) will be valid for, between 900 and 3600\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DurationSeconds", "type": "number" }, "Enabled": { + "markdownDescription": "Indicates whether the profile is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "ManagedPolicyArns": { "items": { "type": "string" }, + "markdownDescription": "A list of managed policy ARNs that apply to the vended session credentials\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManagedPolicyArns", "type": "array" }, "Name": { + "markdownDescription": "The name of the profile\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[ a-zA-Z0-9-_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "RequireInstanceProperties": { + "markdownDescription": "Specifies whether instance properties are required in temporary credential requests with this profile\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RequireInstanceProperties", "type": "boolean" }, "RoleArns": { "items": { "type": "string" }, + "markdownDescription": "A list of IAM role ARNs\\. During `CreateSession`, if a matching role ARN is provided, the properties in this profile will be applied to the intersection session policy\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArns", "type": "array" }, "SessionPolicy": { + "markdownDescription": "A session policy that applies to the trust boundary of the vended session credentials\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SessionPolicy", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags to attach to the profile\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -156510,18 +161295,26 @@ "additionalProperties": false, "properties": { "Enabled": { + "markdownDescription": "Indicates whether the trust anchor is enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Enabled", "type": "boolean" }, "Name": { + "markdownDescription": "The name of the trust anchor\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[ a-zA-Z0-9-_]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Source": { - "$ref": "#/definitions/AWS::RolesAnywhere::TrustAnchor.Source" + "$ref": "#/definitions/AWS::RolesAnywhere::TrustAnchor.Source", + "markdownDescription": "The trust anchor type and its related certificate data\\. \n*Required*: Yes \n*Type*: [Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-source.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Source" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags to attach to the trust anchor\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -156556,9 +161349,13 @@ "additionalProperties": false, "properties": { "SourceData": { - "$ref": "#/definitions/AWS::RolesAnywhere::TrustAnchor.SourceData" + "$ref": "#/definitions/AWS::RolesAnywhere::TrustAnchor.SourceData", + "markdownDescription": "The data field of the trust anchor depending on its type\\. \n*Required*: No \n*Type*: [SourceData](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rolesanywhere-trustanchor-sourcedata.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceData" }, "SourceType": { + "markdownDescription": "The type of the trust anchor\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AWS_ACM_PCA | CERTIFICATE_BUNDLE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SourceType", "type": "string" } }, @@ -156568,9 +161365,13 @@ "additionalProperties": false, "properties": { "AcmPcaArn": { + "markdownDescription": "The root certificate of the AWS Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests\\. Included for trust anchors of type `AWS_ACM_PCA`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1011` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AcmPcaArn", "type": "string" }, "X509CertificateData": { + "markdownDescription": "The PEM\\-encoded data for the certificate anchor\\. Included for trust anchors of type `CERTIFICATE_BUNDLE`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `8000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "X509CertificateData", "type": "string" } }, @@ -156615,9 +161416,13 @@ "items": { "$ref": "#/definitions/AWS::Route53::CidrCollection.Location" }, + "markdownDescription": "A complex type that contains information about the list of CIDR locations\\. \n*Required*: No \n*Type*: List of [Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrcollection-location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Locations", "type": "array" }, "Name": { + "markdownDescription": "The name of a CIDR collection\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `[0-9A-Za-z_\\-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" } }, @@ -156654,9 +161459,13 @@ "items": { "type": "string" }, + "markdownDescription": "List of CIDR blocks\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `1000` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CidrList", "type": "array" }, "LocationName": { + "markdownDescription": "The CIDR collection location name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16` \n*Pattern*: `[0-9A-Za-z_\\-\\*]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LocationName", "type": "string" } }, @@ -156770,7 +161579,7 @@ "properties": { "HealthCheckConfig": { "$ref": "#/definitions/AWS::Route53::HealthCheck.HealthCheckConfig", - "markdownDescription": "A complex type that contains detailed information about one health check\\. \nFor the values to enter for `HealthCheckConfig`, see [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html) \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains detailed information about one health check\\. \nFor the values to enter for `HealthCheckConfig`, see [HealthCheckConfig](https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html) \n*Required*: Yes \n*Type*: [HealthCheckConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HealthCheckConfig" }, "HealthCheckTags": { @@ -156812,9 +161621,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy\\. \nRoute 53 supports CloudWatch alarms with the following features: \n+ Standard\\-resolution metrics\\. High\\-resolution metrics aren't supported\\. For more information, see [High\\-Resolution Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html#high-resolution-metrics) in the *Amazon CloudWatch User Guide*\\.\n+ Statistics: Average, Minimum, Maximum, Sum, and SampleCount\\. Extended statistics aren't supported\\.\n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Region": { + "markdownDescription": "For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in\\. \nFor the current list of CloudWatch regions, see [Amazon CloudWatch endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/cw_region.html) in the *Amazon Web Services General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-gov-east-1 | us-gov-west-1 | us-iso-east-1 | us-iso-west-1 | us-isob-east-1 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Region", "type": "string" } }, @@ -156828,60 +161641,94 @@ "additionalProperties": false, "properties": { "AlarmIdentifier": { - "$ref": "#/definitions/AWS::Route53::HealthCheck.AlarmIdentifier" + "$ref": "#/definitions/AWS::Route53::HealthCheck.AlarmIdentifier", + "markdownDescription": "A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy\\. \n*Required*: No \n*Type*: [AlarmIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-alarmidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlarmIdentifier" }, "ChildHealthChecks": { "items": { "type": "string" }, + "markdownDescription": "\\(CALCULATED Health Checks Only\\) A complex type that contains one `ChildHealthCheck` element for each health check that you want to associate with a `CALCULATED` health check\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ChildHealthChecks", "type": "array" }, "EnableSNI": { + "markdownDescription": "Specify whether you want Amazon Route 53 to send the value of `FullyQualifiedDomainName` to the endpoint in the `client_hello` message during TLS negotiation\\. This allows the endpoint to respond to `HTTPS` health check requests with the applicable SSL/TLS certificate\\. \nSome endpoints require that `HTTPS` requests include the host name in the `client_hello` message\\. If you don't enable SNI, the status of the health check will be `SSL alert handshake_failure`\\. A health check can also have that status for other reasons\\. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid\\. \nThe SSL/TLS certificate on your endpoint includes a domain name in the `Common Name` field and possibly several more in the `Subject Alternative Names` field\\. One of the domain names in the certificate should match the value that you specify for `FullyQualifiedDomainName`\\. If the endpoint responds to the `client_hello` message with a certificate that does not include the domain name that you specified in `FullyQualifiedDomainName`, a health checker will retry the handshake\\. In the second attempt, the health checker will omit `FullyQualifiedDomainName` from the `client_hello` message\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableSNI", "type": "boolean" }, "FailureThreshold": { + "markdownDescription": "The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa\\. For more information, see [How Amazon Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) in the *Amazon Route 53 Developer Guide*\\. \nIf you don't specify a value for `FailureThreshold`, the default value is three health checks\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `10` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailureThreshold", "type": "number" }, "FullyQualifiedDomainName": { + "markdownDescription": "Amazon Route 53 behavior depends on whether you specify a value for `IPAddress`\\. \n **If you specify a value for** `IPAddress`: \nAmazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of `FullyQualifiedDomainName` in the `Host` header for all health checks except TCP health checks\\. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks\\. \nWhen Route 53 checks the health of an endpoint, here is how it constructs the `Host` header: \n+ If you specify a value of `80` for `Port` and `HTTP` or `HTTP_STR_MATCH` for `Type`, Route 53 passes the value of `FullyQualifiedDomainName` to the endpoint in the Host header\\. \n+ If you specify a value of `443` for `Port` and `HTTPS` or `HTTPS_STR_MATCH` for `Type`, Route 53 passes the value of `FullyQualifiedDomainName` to the endpoint in the `Host` header\\.\n+ If you specify another value for `Port` and any value except `TCP` for `Type`, Route 53 passes `FullyQualifiedDomainName:Port` to the endpoint in the `Host` header\\.\nIf you don't specify a value for `FullyQualifiedDomainName`, Route 53 substitutes the value of `IPAddress` in the `Host` header in each of the preceding cases\\. \n **If you don't specify a value for `IPAddress` **: \nRoute 53 sends a DNS request to the domain that you specify for `FullyQualifiedDomainName` at the interval that you specify for `RequestInterval`\\. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint\\. \nIf you don't specify a value for `IPAddress`, Route 53 uses only IPv4 to send health checks to the endpoint\\. If there's no record with a type of A for the name that you specify for `FullyQualifiedDomainName`, the health check fails with a \"DNS resolution failed\" error\\.\nIf you want to check the health of multiple records that have the same name and type, such as multiple weighted records, and if you choose to specify the endpoint only by `FullyQualifiedDomainName`, we recommend that you create a separate health check for each endpoint\\. For example, create a health check for each HTTP server that is serving content for www\\.example\\.com\\. For the value of `FullyQualifiedDomainName`, specify the domain name of the server \\(such as us\\-east\\-2\\-www\\.example\\.com\\), not the name of the records \\(www\\.example\\.com\\)\\. \nIn this configuration, if you create a health check for which the value of `FullyQualifiedDomainName` matches the name of the records and you then associate the health check with those records, health check results will be unpredictable\\.\nIn addition, if the value that you specify for `Type` is `HTTP`, `HTTPS`, `HTTP_STR_MATCH`, or `HTTPS_STR_MATCH`, Route 53 passes the value of `FullyQualifiedDomainName` in the `Host` header, as it does when you specify a value for `IPAddress`\\. If the value of `Type` is `TCP`, Route 53 doesn't pass a `Host` header\\. \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FullyQualifiedDomainName", "type": "string" }, "HealthThreshold": { + "markdownDescription": "The number of child health checks that are associated with a `CALCULATED` health check that Amazon Route 53 must consider healthy for the `CALCULATED` health check to be considered healthy\\. To specify the child health checks that you want to associate with a `CALCULATED` health check, use the [ChildHealthChecks](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks) element\\. \nNote the following: \n+ If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy\\.\n+ If you specify `0`, Route 53 always considers this health check to be healthy\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `0` \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HealthThreshold", "type": "number" }, "IPAddress": { + "markdownDescription": "The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on\\. If you don't specify a value for `IPAddress`, Route 53 sends a DNS request to resolve the domain name that you specify in `FullyQualifiedDomainName` at the interval that you specify in `RequestInterval`\\. Using an IP address returned by DNS, Route 53 then checks the health of the endpoint\\. \nUse one of the following formats for the value of `IPAddress`: \n+ **IPv4 address**: four values between 0 and 255, separated by periods \\(\\.\\), for example, `192.0.2.44`\\.\n+ **IPv6 address**: eight groups of four hexadecimal values, separated by colons \\(:\\), for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`\\. You can also shorten IPv6 addresses as described in RFC 5952, for example, `2001:db8:85a3::abcd:1:2345`\\.\nIf the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for `IPAddress`\\. This ensures that the IP address of your instance will never change\\. \nFor more information, see [FullyQualifiedDomainName](https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName)\\. \nConstraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non\\-routable, or multicast ranges\\. For more information about IP addresses for which you can't create health checks, see the following documents: \n+ [RFC 5735, Special Use IPv4 Addresses](https://tools.ietf.org/html/rfc5735) \n+ [RFC 6598, IANA\\-Reserved IPv4 Prefix for Shared Address Space](https://tools.ietf.org/html/rfc6598) \n+ [RFC 5156, Special\\-Use IPv6 Addresses](https://tools.ietf.org/html/rfc5156) \nWhen the value of `Type` is `CALCULATED` or `CLOUDWATCH_METRIC`, omit `IPAddress`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `45` \n*Pattern*: `(^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IPAddress", "type": "string" }, "InsufficientDataHealthStatus": { + "markdownDescription": "When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check: \n+ `Healthy`: Route 53 considers the health check to be healthy\\.\n+ `Unhealthy`: Route 53 considers the health check to be unhealthy\\.\n+ `LastKnownStatus`: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state\\. For new health checks that have no last known status, the default status for the health check is healthy\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `Healthy | LastKnownStatus | Unhealthy` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InsufficientDataHealthStatus", "type": "string" }, "Inverted": { + "markdownDescription": "Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Inverted", "type": "boolean" }, "MeasureLatency": { + "markdownDescription": "Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the **Health Checks** page in the Route 53 console\\. \nYou can't change the value of `MeasureLatency` after you create a health check\\.\n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MeasureLatency", "type": "boolean" }, "Port": { + "markdownDescription": "The port on the endpoint that you want Amazon Route 53 to perform health checks on\\. \nDon't specify a value for `Port` when you specify a value for [Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-healthcheck-healthcheckconfig.html#cfn-route53-healthcheck-healthcheckconfig-type) of `CLOUDWATCH_METRIC` or `CALCULATED`\\.\n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `65535` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Port", "type": "number" }, "Regions": { "items": { "type": "string" }, + "markdownDescription": "A complex type that contains one `Region` element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint\\. \nIf you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under **Valid Values**\\. \nIf you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint \\(for example, if you replace three regions with four different regions\\)\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `64` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Regions", "type": "array" }, "RequestInterval": { + "markdownDescription": "The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request\\. Each Route 53 health checker makes requests at this interval\\. \nYou can't change the value of `RequestInterval` after you create a health check\\.\nIf you don't specify a value for `RequestInterval`, the default value is `30` seconds\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `10` \n*Maximum*: `30` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "RequestInterval", "type": "number" }, "ResourcePath": { + "markdownDescription": "The path, if any, that you want Amazon Route 53 to request when performing health checks\\. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53\\-health\\-check\\.html\\. You can also include query string parameters, for example, `/welcome.html?language=jp&login=y`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourcePath", "type": "string" }, "RoutingControlArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the Route 53 Application Recovery Controller routing control\\. \nFor more information about Route 53 Application Recovery Controller, see [Route 53 Application Recovery Controller Developer Guide\\.](https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route-53-recovery.html)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoutingControlArn", "type": "string" }, "SearchString": { + "markdownDescription": "If the value of Type is `HTTP_STR_MATCH` or `HTTPS_STR_MATCH`, the string that you want Amazon Route 53 to search for in the response body from the specified resource\\. If the string appears in the response body, Route 53 considers the resource healthy\\. \nRoute 53 considers case when searching for `SearchString` in the response body\\. \n*Required*: No \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SearchString", "type": "string" }, "Type": { + "markdownDescription": "The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy\\. \nYou can't change the value of `Type` after you create a health check\\.\nYou can create the following types of health checks: \n+ **HTTP**: Route 53 tries to establish a TCP connection\\. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400\\.\n+ **HTTPS**: Route 53 tries to establish a TCP connection\\. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400\\.\n**Important** \nIf you specify `HTTPS` for the value of `Type`, the endpoint must support TLS v1\\.0 or later\\.\n+ **HTTP\\_STR\\_MATCH**: Route 53 tries to establish a TCP connection\\. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in `SearchString`\\.\n+ **HTTPS\\_STR\\_MATCH**: Route 53 tries to establish a TCP connection\\. If successful, Route 53 submits an `HTTPS` request and searches the first 5,120 bytes of the response body for the string that you specify in `SearchString`\\.\n+ **TCP**: Route 53 tries to establish a TCP connection\\.\n+ **CLOUDWATCH\\_METRIC**: The health check is associated with a CloudWatch alarm\\. If the state of the alarm is `OK`, the health check is considered healthy\\. If the state is `ALARM`, the health check is considered unhealthy\\. If CloudWatch doesn't have sufficient data to determine whether the state is `OK` or `ALARM`, the health check status depends on the setting for `InsufficientDataHealthStatus`: `Healthy`, `Unhealthy`, or `LastKnownStatus`\\. \n+ **CALCULATED**: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of `HealthThreshold`\\. \n+ **RECOVERY\\_CONTROL**: The health check is assocated with a Route53 Application Recovery Controller routing control\\. If the routing control state is `ON`, the health check is considered healthy\\. If the state is `OFF`, the health check is considered unhealthy\\. \nFor more information, see [How Route 53 Determines Whether an Endpoint Is Healthy](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) in the *Amazon Route 53 Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CALCULATED | CLOUDWATCH_METRIC | HTTP | HTTP_STR_MATCH | HTTPS | HTTPS_STR_MATCH | RECOVERY_CONTROL | TCP` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -157186,11 +162033,13 @@ "properties": { "AliasTarget": { "$ref": "#/definitions/AWS::Route53::RecordSet.AliasTarget", - "markdownDescription": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to\\. \nIf you're creating resource records sets for a private hosted zone, note the following: \n+ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution\\.\n+ Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported\\.\n+ For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide*\\.\n*Required*: No \n*Type*: [AliasTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to\\. \nIf you're creating resource records sets for a private hosted zone, note the following: \n+ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution\\.\n+ For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide*\\.\n*Required*: No \n*Type*: [AliasTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AliasTarget" }, "CidrRoutingConfig": { - "$ref": "#/definitions/AWS::Route53::RecordSet.CidrRoutingConfig" + "$ref": "#/definitions/AWS::Route53::RecordSet.CidrRoutingConfig", + "markdownDescription": "The object that is specified in resource record set object when you are linking a resource record set to a CIDR location\\. \nA `LocationName` with an asterisk \u201c\\*\u201d can be used to create a default CIDR record\\. `CollectionId` is still required for default record\\. \n*Required*: No \n*Type*: [CidrRoutingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CidrRoutingConfig" }, "Comment": { "markdownDescription": "*Optional:* Any comments you want to include about a change batch request\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -157233,7 +162082,7 @@ "type": "string" }, "Region": { - "markdownDescription": "*Latency\\-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to\\. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type\\. \nAlthough creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported\\.\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region\\. Route 53 then returns the value that is associated with the selected resource record set\\. \nNote the following: \n+ You can only specify one `ResourceRecord` per latency resource record set\\.\n+ You can only create one latency resource record set for each Amazon EC2 Region\\.\n+ You aren't required to create latency resource record sets for all Amazon EC2 Regions\\. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for\\.\n+ You can't create non\\-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "*Latency\\-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to\\. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type\\. \nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region\\. Route 53 then returns the value that is associated with the selected resource record set\\. \nNote the following: \n+ You can only specify one `ResourceRecord` per latency resource record set\\.\n+ You can only create one latency resource record set for each Amazon EC2 Region\\.\n+ You aren't required to create latency resource record sets for all Amazon EC2 Regions\\. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for\\.\n+ You can't create non\\-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Region", "type": "string" }, @@ -157322,9 +162171,13 @@ "additionalProperties": false, "properties": { "CollectionId": { + "markdownDescription": "The CIDR collection ID\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CollectionId", "type": "string" }, "LocationName": { + "markdownDescription": "The CIDR collection location name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16` \n*Pattern*: `[0-9A-Za-z_\\-\\*]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LocationName", "type": "string" } }, @@ -157396,12 +162249,12 @@ "type": "string" }, "HostedZoneId": { - "markdownDescription": "The ID of the hosted zone that contains the resource record sets that you want to change\\. \n*Required*: Conditional \n*Type*: String \n*Maximum*: `32` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the hosted zone that you want to create records in\\. \nSpecify either `HostedZoneName` or `HostedZoneId`, but not both\\. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `32` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "HostedZoneId", "type": "string" }, "HostedZoneName": { - "markdownDescription": "The name of the hosted zone that you want to create, update, or delete resource record sets in\\. \n*Required*: Conditional \n*Type*: String \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the hosted zone that you want to create records in\\. You must include a trailing dot \\(for example, `www.example.com.`\\) as part of the `HostedZoneName`\\. \nWhen you create a stack using an `AWS::Route53::RecordSet` that specifies `HostedZoneName`, AWS CloudFormation attempts to find a hosted zone whose name matches the `HostedZoneName`\\. If AWS CloudFormation can't find a hosted zone with a matching domain name, or if there is more than one hosted zone with the specified domain name, AWS CloudFormation will not create the stack\\. \nSpecify either `HostedZoneName` or `HostedZoneId`, but not both\\. If you have multiple hosted zones with the same domain name, you must specify the hosted zone using `HostedZoneId`\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "HostedZoneName", "type": "string" }, @@ -157465,9 +162318,13 @@ "additionalProperties": false, "properties": { "CollectionId": { + "markdownDescription": "The CIDR collection ID\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CollectionId", "type": "string" }, "LocationName": { + "markdownDescription": "The CIDR collection location name\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16` \n*Pattern*: `[0-9A-Za-z_\\-\\*]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LocationName", "type": "string" } }, @@ -157503,11 +162360,13 @@ "properties": { "AliasTarget": { "$ref": "#/definitions/AWS::Route53::RecordSetGroup.AliasTarget", - "markdownDescription": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to\\. \nIf you're creating resource records sets for a private hosted zone, note the following: \n+ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution\\.\n+ Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported\\.\n+ For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide*\\.\n*Required*: No \n*Type*: [AliasTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "*Alias resource record sets only:* Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to\\. \nIf you're creating resource records sets for a private hosted zone, note the following: \n+ You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution\\.\n+ For information about creating failover resource record sets in a private hosted zone, see [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) in the *Amazon Route 53 Developer Guide*\\.\n*Required*: No \n*Type*: [AliasTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-aliastarget-1.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AliasTarget" }, "CidrRoutingConfig": { - "$ref": "#/definitions/AWS::Route53::RecordSetGroup.CidrRoutingConfig" + "$ref": "#/definitions/AWS::Route53::RecordSetGroup.CidrRoutingConfig", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [CidrRoutingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53-cidrroutingconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CidrRoutingConfig" }, "Failover": { "markdownDescription": "*Failover resource record sets only:* To configure failover, you add the `Failover` element to two resource record sets\\. For one resource record set, you specify `PRIMARY` as the value for `Failover`; for the other resource record set, you specify `SECONDARY`\\. In addition, you include the `HealthCheckId` element and specify the health check that you want Amazon Route 53 to perform for each resource record set\\. \nExcept where noted, the following failover behaviors assume that you have included the `HealthCheckId` element in both resource record sets: \n+ When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set\\.\n+ When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set\\.\n+ When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set\\.\n+ If you omit the `HealthCheckId` element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set\\. This is true regardless of the health of the associated endpoint\\.\nYou can't create non\\-failover resource record sets that have the same values for the `Name` and `Type` elements as failover resource record sets\\. \nFor failover alias resource record sets, you must also include the `EvaluateTargetHealth` element and set the value to true\\. \nFor more information about configuring failover for Route 53, see the following topics in the *Amazon Route 53 Developer Guide*: \n+ [Route 53 Health Checks and DNS Failover](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html) \n+ [Configuring Failover in a Private Hosted Zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) \n*Required*: No \n*Type*: String \n*Allowed values*: `PRIMARY | SECONDARY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -157545,7 +162404,7 @@ "type": "string" }, "Region": { - "markdownDescription": "*Latency\\-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to\\. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type\\. \nAlthough creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported\\.\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region\\. Route 53 then returns the value that is associated with the selected resource record set\\. \nNote the following: \n+ You can only specify one `ResourceRecord` per latency resource record set\\.\n+ You can only create one latency resource record set for each Amazon EC2 Region\\.\n+ You aren't required to create latency resource record sets for all Amazon EC2 Regions\\. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for\\.\n+ You can't create non\\-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "*Latency\\-based resource record sets only:* The Amazon EC2 Region where you created the resource that this resource record set refers to\\. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type\\. \nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region\\. Route 53 then returns the value that is associated with the selected resource record set\\. \nNote the following: \n+ You can only specify one `ResourceRecord` per latency resource record set\\.\n+ You can only create one latency resource record set for each Amazon EC2 Region\\.\n+ You aren't required to create latency resource record sets for all Amazon EC2 Regions\\. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for\\.\n+ You can't create non\\-latency resource record sets that have the same values for the `Name` and `Type` elements as latency resource record sets\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `af-south-1 | ap-east-1 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ca-central-1 | cn-north-1 | cn-northwest-1 | eu-central-1 | eu-north-1 | eu-south-1 | eu-west-1 | eu-west-2 | eu-west-3 | me-south-1 | sa-east-1 | us-east-1 | us-east-2 | us-west-1 | us-west-2` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Region", "type": "string" }, @@ -157623,6 +162482,8 @@ "items": { "$ref": "#/definitions/AWS::Route53RecoveryControl::Cluster.ClusterEndpoint" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ClusterEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-route53recoverycontrol-cluster-clusterendpoint.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ClusterEndpoints", "type": "array" }, "Name": { @@ -157885,7 +162746,7 @@ "title": "GatingRule" }, "Name": { - "markdownDescription": "The name of the assertion rule\\. You can use any non\\-white space character in the name\\. The name must be unique within a control panel\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the assertion rule\\. The name must be unique within a control panel\\. You can use any non\\-white space character in the name except the following: & > < ' \\(single quote\\) \" \\(double quote\\) ; \\(semicolon\\) \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -158048,7 +162909,7 @@ "additionalProperties": false, "properties": { "CellName": { - "markdownDescription": "The name of the cell to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the cell to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CellName", "type": "string" }, @@ -158127,7 +162988,7 @@ "additionalProperties": false, "properties": { "ReadinessCheckName": { - "markdownDescription": "The name of the readiness check to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the readiness check to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ReadinessCheckName", "type": "string" }, @@ -158211,7 +163072,7 @@ "type": "array" }, "RecoveryGroupName": { - "markdownDescription": "The name of the recovery group to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the recovery group to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "RecoveryGroupName", "type": "string" }, @@ -158282,7 +163143,7 @@ "additionalProperties": false, "properties": { "ResourceSetName": { - "markdownDescription": "The name of the resource set to create\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the resource set to create\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceSetName", "type": "string" }, @@ -158934,12 +163795,18 @@ "type": "string" }, "OutpostArn": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OutpostArn", "type": "string" }, "PreferredInstanceType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PreferredInstanceType", "type": "string" }, "ResolverEndpointType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResolverEndpointType", "type": "string" }, "SecurityGroupIds": { @@ -158996,6 +163863,8 @@ "type": "string" }, "Ipv6": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Ipv6", "type": "string" }, "SubnetId": { @@ -159181,7 +164050,7 @@ "additionalProperties": false, "properties": { "DomainName": { - "markdownDescription": "DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps`\\. If a query matches multiple Resolver rules \\(example\\.com and www\\.example\\.com\\), the query is routed using the Resolver rule that contains the most specific domain name \\(www\\.example\\.com\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps`\\. If a query matches multiple Resolver rules \\(example\\.com and www\\.example\\.com\\), the query is routed using the Resolver rule that contains the most specific domain name \\(www\\.example\\.com\\)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "DomainName", "type": "string" }, @@ -159248,11 +164117,13 @@ "additionalProperties": false, "properties": { "Ip": { - "markdownDescription": "One IP address that you want to forward DNS queries to\\. You can specify only IPv4 addresses\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `7` \n*Maximum*: `36` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "One IP address that you want to forward DNS queries to\\. You can specify only IPv4 addresses\\. \n*Required*: No \n*Type*: String \n*Minimum*: `7` \n*Maximum*: `36` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Ip", "type": "string" }, "Ipv6": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Ipv6", "type": "string" }, "Port": { @@ -159382,6 +164253,8 @@ "type": "string" }, "BucketAccountId": { + "markdownDescription": "The AWS account ID associated with the S3 bucket associated with this access point\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BucketAccountId", "type": "string" }, "Name": { @@ -159396,7 +164269,7 @@ }, "PolicyStatus": { "$ref": "#/definitions/AWS::S3::AccessPoint.PolicyStatus", - "markdownDescription": "The container element for a bucket's policy status\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The container element for a bucket's policy status\\. \n*Required*: No \n*Type*: [PolicyStatus](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-accesspoint-policystatus.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PolicyStatus" }, "PublicAccessBlockConfiguration": { @@ -159440,6 +164313,8 @@ "additionalProperties": false, "properties": { "IsPublic": { + "markdownDescription": "The policy status for this bucket\\. `TRUE` indicates that this bucket is public\\. `FALSE` indicates that the bucket is not public\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsPublic", "type": "string" } }, @@ -159902,7 +164777,7 @@ "additionalProperties": false, "properties": { "ReplicaKmsKeyID": { - "markdownDescription": "Specifies the ID \\(Key ARN or Alias ARN\\) of the customer managed AWS KMS key stored in AWS Key Management Service \\(KMS\\) for the destination bucket\\. Amazon S3 uses this key to encrypt replica objects\\. Amazon S3 only supports symmetric, customer managed KMS keys\\. For more information, see [Using symmetric and asymmetric keys](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the * AWS Key Management Service Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the ID \\(Key ARN or Alias ARN\\) of the customer managed AWS KMS key stored in AWS Key Management Service \\(KMS\\) for the destination bucket\\. Amazon S3 uses this key to encrypt replica objects\\. Amazon S3 only supports symmetric encryption KMS keys\\. For more information, see [Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the * AWS Key Management Service Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ReplicaKmsKeyID", "type": "string" } @@ -160248,7 +165123,7 @@ }, "Rule": { "$ref": "#/definitions/AWS::S3::Bucket.ObjectLockRule", - "markdownDescription": "Specifies the Object Lock rule for the specified object\\. Enable the this rule when you apply `ObjectLockConfiguration` to a bucket\\. If Object Lock is turned on, bucket settings require both `Mode` and a period of either `Days` or `Years`\\. You cannot specify `Days` and `Years` at the same time\\. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)\\. \n*Required*: Conditional \n*Type*: [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the Object Lock rule for the specified object\\. Enable this rule when you apply `ObjectLockConfiguration` to a bucket\\. If Object Lock is turned on, bucket settings require both `Mode` and a period of either `Days` or `Years`\\. You cannot specify `Days` and `Years` at the same time\\. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html)\\. \n*Required*: Conditional \n*Type*: [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Rule" } }, @@ -160329,7 +165204,7 @@ }, "Filter": { "$ref": "#/definitions/AWS::S3::Bucket.NotificationFilter", - "markdownDescription": "The filtering rules that determine which objects trigger notifications\\. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a `.jpg` extension are added to the bucket\\. \n*Required*: No \n*Type*: [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The filtering rules that determine which objects trigger notifications\\. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a `.jpg` extension are added to the bucket\\. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: [NotificationFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-notificationconfiguration-config-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Filter" }, "Queue": { @@ -160490,7 +165365,7 @@ }, "Filter": { "$ref": "#/definitions/AWS::S3::Bucket.ReplicationRuleFilter", - "markdownDescription": "A filter that identifies the subset of objects to which the replication rule applies\\. A `Filter` must specify exactly one `Prefix`, `TagFilter`, or an `And` child element\\. The use of the filter field indicates this is a V2 replication configuration\\. V1 does not have this field\\. \n*Required*: No \n*Type*: [ReplicationRuleFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A filter that identifies the subset of objects to which the replication rule applies\\. A `Filter` must specify exactly one `Prefix`, `TagFilter`, or an `And` child element\\. The use of the filter field indicates that this is a V2 replication configuration\\. This field isn't supported in a V1 replication configuration\\. \nV1 replication configuration only supports filtering by key prefix\\. To filter using a V1 replication configuration, add the `Prefix` directly as a child element of the `Rule` element\\.\n*Required*: No \n*Type*: [ReplicationRuleFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Filter" }, "Id": { @@ -160499,7 +165374,7 @@ "type": "string" }, "Prefix": { - "markdownDescription": "An object key name prefix that identifies the object or objects to which the rule applies\\. The maximum prefix length is 1,024 characters\\. To include all objects in a bucket, specify an empty string\\. \nReplacement must be made for object keys containing special characters \\(such as carriage returns\\) when using XML requests\\. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An object key name prefix that identifies the object or objects to which the rule applies\\. The maximum prefix length is 1,024 characters\\. To include all objects in a bucket, specify an empty string\\. To filter using a V1 replication configuration, add the `Prefix` directly as a child element of the `Rule` element\\. \nReplacement must be made for object keys containing special characters \\(such as carriage returns\\) when using XML requests\\. For more information, see [ XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Prefix", "type": "string" }, @@ -160686,12 +165561,12 @@ "type": "array" }, "ObjectSizeGreaterThan": { - "markdownDescription": "Specifies the minimum object size in bytes for this rule to apply to\\. For more information about size based rules, see [Lifecycle configuration using size\\-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the minimum object size in bytes for this rule to apply to\\. Objects must be larger than this value in bytes\\. For more information about size based rules, see [Lifecycle configuration using size\\-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ObjectSizeGreaterThan", "type": "number" }, "ObjectSizeLessThan": { - "markdownDescription": "Specifies the maximum object size in bytes for this rule to apply to\\. For more information about sized based rules, see [Lifecycle configuration using size\\-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the maximum object size in bytes for this rule to apply to\\. Objects must be smaller than this value in bytes\\. For more information about sized based rules, see [Lifecycle configuration using size\\-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*\\. \n*Required*: No \n*Type*: Long \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ObjectSizeLessThan", "type": "number" }, @@ -161227,6 +166102,8 @@ "additionalProperties": false, "properties": { "IsPublic": { + "markdownDescription": "The policy status for this bucket\\. `TRUE` indicates that this bucket is public\\. `FALSE` indicates that the bucket is not public\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsPublic", "type": "string" } }, @@ -161315,14 +166192,18 @@ "properties": { "ActivityMetrics": { "$ref": "#/definitions/AWS::S3::StorageLens.ActivityMetrics", - "markdownDescription": "This property contains the details of the account\\-level activity metrics for Amazon S3 Storage Lens\\. \n*Required*: No \n*Type*: [ActivityMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "This property contains the details of account\\-level activity metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [ActivityMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ActivityMetrics" }, "AdvancedCostOptimizationMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedCostOptimizationMetrics" + "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedCostOptimizationMetrics", + "markdownDescription": "This property contains the details of account\\-level advanced cost optimization metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [AdvancedCostOptimizationMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedcostoptimizationmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdvancedCostOptimizationMetrics" }, "AdvancedDataProtectionMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedDataProtectionMetrics" + "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedDataProtectionMetrics", + "markdownDescription": "This property contains the details of account\\-level advanced data protection metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [AdvancedDataProtectionMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advanceddataprotectionmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdvancedDataProtectionMetrics" }, "BucketLevel": { "$ref": "#/definitions/AWS::S3::StorageLens.BucketLevel", @@ -161330,7 +166211,9 @@ "title": "BucketLevel" }, "DetailedStatusCodesMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.DetailedStatusCodesMetrics" + "$ref": "#/definitions/AWS::S3::StorageLens.DetailedStatusCodesMetrics", + "markdownDescription": "This property contains the details of account\\-level detailed status code metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [DetailedStatusCodesMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-detailedstatuscodesmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DetailedStatusCodesMetrics" } }, "required": [ @@ -161353,6 +166236,8 @@ "additionalProperties": false, "properties": { "IsEnabled": { + "markdownDescription": "Indicates whether advanced cost optimization metrics are enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsEnabled", "type": "boolean" } }, @@ -161362,6 +166247,8 @@ "additionalProperties": false, "properties": { "IsEnabled": { + "markdownDescription": "Indicates whether advanced data protection metrics are enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsEnabled", "type": "boolean" } }, @@ -161386,21 +166273,27 @@ "properties": { "ActivityMetrics": { "$ref": "#/definitions/AWS::S3::StorageLens.ActivityMetrics", - "markdownDescription": "A property for the bucket\\-level activity metrics for Amazon S3 Storage Lens\\. \n*Required*: No \n*Type*: [ActivityMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A property for bucket\\-level activity metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [ActivityMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ActivityMetrics" }, "AdvancedCostOptimizationMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedCostOptimizationMetrics" + "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedCostOptimizationMetrics", + "markdownDescription": "A property for bucket\\-level advanced cost optimization metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [AdvancedCostOptimizationMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedcostoptimizationmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdvancedCostOptimizationMetrics" }, "AdvancedDataProtectionMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedDataProtectionMetrics" + "$ref": "#/definitions/AWS::S3::StorageLens.AdvancedDataProtectionMetrics", + "markdownDescription": "A property for bucket\\-level advanced data protection metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [AdvancedDataProtectionMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advanceddataprotectionmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdvancedDataProtectionMetrics" }, "DetailedStatusCodesMetrics": { - "$ref": "#/definitions/AWS::S3::StorageLens.DetailedStatusCodesMetrics" + "$ref": "#/definitions/AWS::S3::StorageLens.DetailedStatusCodesMetrics", + "markdownDescription": "A property for bucket\\-level detailed status code metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [DetailedStatusCodesMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-detailedstatuscodesmetrics.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DetailedStatusCodesMetrics" }, "PrefixLevel": { "$ref": "#/definitions/AWS::S3::StorageLens.PrefixLevel", - "markdownDescription": "A property for the bucket\\-level prefix\\-level storage metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [PrefixLevel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A property for bucket\\-level prefix\\-level storage metrics for S3 Storage Lens\\. \n*Required*: No \n*Type*: [PrefixLevel](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PrefixLevel" } }, @@ -161462,6 +166355,8 @@ "additionalProperties": false, "properties": { "IsEnabled": { + "markdownDescription": "Indicates whether detailed status code metrics are enabled\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsEnabled", "type": "boolean" } }, @@ -161471,9 +166366,13 @@ "additionalProperties": false, "properties": { "SSEKMS": { - "$ref": "#/definitions/AWS::S3::StorageLens.SSEKMS" + "$ref": "#/definitions/AWS::S3::StorageLens.SSEKMS", + "markdownDescription": "Specifies the use of AWS Key Management Service keys \\(SSE\\-KMS\\) to encrypt the S3 Storage Lens metrics export file\\. \n*Required*: No \n*Type*: [SSEKMS](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-ssekms.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SSEKMS" }, "SSES3": { + "markdownDescription": "Specifies the use of an Amazon S3\\-managed key \\(SSE\\-S3\\) to encrypt the S3 Storage Lens metrics export file\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SSES3", "type": "object" } }, @@ -161555,6 +166454,8 @@ "additionalProperties": false, "properties": { "KeyId": { + "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of the customer managed AWS KMS key to use for encrypting the S3 Storage Lens metrics export file\\. Amazon S3 only supports symmetric encryption keys\\. For more information, see [Special\\-purpose keys](https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html) in the *AWS Key Management Service Developer Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KeyId", "type": "string" } }, @@ -161711,9 +166612,13 @@ "additionalProperties": false, "properties": { "FunctionArn": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FunctionArn", "type": "string" }, "FunctionPayload": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FunctionPayload", "type": "string" } }, @@ -161726,7 +166631,9 @@ "additionalProperties": false, "properties": { "AwsLambda": { - "$ref": "#/definitions/AWS::S3ObjectLambda::AccessPoint.AwsLambda" + "$ref": "#/definitions/AWS::S3ObjectLambda::AccessPoint.AwsLambda", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [AwsLambda](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-awslambda.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AwsLambda" } }, "required": [ @@ -161741,7 +166648,7 @@ "items": { "type": "string" }, - "markdownDescription": "A container for allowed features\\. Valid inputs are `GetObject-Range` and `GetObject-PartNumber`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A container for allowed features\\. Valid inputs are `GetObject-Range`, `GetObject-PartNumber`, `HeadObject-Range`, and `HeadObject-PartNumber`\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AllowedFeatures", "type": "array" }, @@ -161774,6 +166681,8 @@ "additionalProperties": false, "properties": { "IsPublic": { + "markdownDescription": "*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IsPublic", "type": "boolean" } }, @@ -161783,15 +166692,23 @@ "additionalProperties": false, "properties": { "BlockPublicAcls": { + "markdownDescription": "Specifies whether Amazon S3 should block public access control lists \\(ACLs\\) for buckets in this account\\. Setting this element to `TRUE` causes the following behavior: \n+ `PutBucketAcl` and `PutObjectAcl` calls fail if the specified ACL is public\\.\n+ PUT Object calls fail if the request includes a public ACL\\.\n+ PUT Bucket calls fail if the request includes a public ACL\\.\nEnabling this setting doesn't affect existing policies or ACLs\\. \nThis property is not supported for Amazon S3 on Outposts\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BlockPublicAcls", "type": "boolean" }, "BlockPublicPolicy": { + "markdownDescription": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account\\. Setting this element to `TRUE` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access\\. \nEnabling this setting doesn't affect existing bucket policies\\. \nThis property is not supported for Amazon S3 on Outposts\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BlockPublicPolicy", "type": "boolean" }, "IgnorePublicAcls": { + "markdownDescription": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account\\. Setting this element to `TRUE` causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain\\. \nEnabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set\\. \nThis property is not supported for Amazon S3 on Outposts\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IgnorePublicAcls", "type": "boolean" }, "RestrictPublicBuckets": { + "markdownDescription": "Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account\\. Setting this element to `TRUE` restricts access to buckets with public policies to only AWS service principals and authorized users within this account\\. \nEnabling this setting doesn't affect previously stored bucket policies, except that public and cross\\-account access within any public bucket policy, including non\\-public delegation to specific accounts, is blocked\\. \nThis property is not supported for Amazon S3 on Outposts\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RestrictPublicBuckets", "type": "boolean" } }, @@ -161804,13 +166721,13 @@ "items": { "type": "string" }, - "markdownDescription": "A container for the action of an Object Lambda Access Point configuration\\. Valid input is `GetObject`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A container for the action of an Object Lambda Access Point configuration\\. Valid inputs are `GetObject`, `HeadObject`, `ListObject`, and `ListObjectV2`\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Actions", "type": "array" }, "ContentTransformation": { "$ref": "#/definitions/AWS::S3ObjectLambda::AccessPoint.ContentTransformation", - "markdownDescription": "A container for the content transformation of an Object Lambda Access Point configuration\\. Can include the FunctionArn and FunctionPayload\\. For more information, see [AwsLambdaTransformation](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_AwsLambdaTransformation.html) in the *Amazon S3 API Reference*\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A container for the content transformation of an Object Lambda Access Point configuration\\. Can include the FunctionArn and FunctionPayload\\. For more information, see [AwsLambdaTransformation](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_AwsLambdaTransformation.html) in the *Amazon S3 API Reference*\\. \n*Required*: Yes \n*Type*: [ContentTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3objectlambda-accesspoint-contenttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ContentTransformation" } }, @@ -162092,13 +167009,19 @@ "additionalProperties": false, "properties": { "AndOperator": { - "$ref": "#/definitions/AWS::S3Outposts::Bucket.FilterAndOperator" + "$ref": "#/definitions/AWS::S3Outposts::Bucket.FilterAndOperator", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [FilterAndOperator](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filterandoperator.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AndOperator" }, "Prefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Prefix", "type": "string" }, "Tag": { - "$ref": "#/definitions/AWS::S3Outposts::Bucket.FilterTag" + "$ref": "#/definitions/AWS::S3Outposts::Bucket.FilterTag", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [FilterTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filtertag.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tag" } }, "type": "object" @@ -162107,12 +167030,16 @@ "additionalProperties": false, "properties": { "Prefix": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Prefix", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/AWS::S3Outposts::Bucket.FilterTag" }, + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: List of [FilterTag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filtertag.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -162125,9 +167052,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -162174,7 +167105,7 @@ }, "Filter": { "$ref": "#/definitions/AWS::S3Outposts::Bucket.Filter", - "markdownDescription": "The container for the filter of the lifecycle rule\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The container for the filter of the lifecycle rule\\. \n*Required*: No \n*Type*: [Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3outposts-bucket-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Filter" }, "Id": { @@ -162183,7 +167114,7 @@ "type": "string" }, "Status": { - "markdownDescription": "If `Enabled`, the rule is currently being applied\\. If `Disabled`, the rule is not currently being applied\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "If `Enabled`, the rule is currently being applied\\. If `Disabled`, the rule is not currently being applied\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Status", "type": "string" } @@ -162468,7 +167399,9 @@ "additionalProperties": false, "properties": { "DeliveryOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.DeliveryOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.DeliveryOptions", + "markdownDescription": "Specifies whether messages that use the configuration set are required to use Transport Layer Security \\(TLS\\)\\. \n*Required*: No \n*Type*: [DeliveryOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-deliveryoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeliveryOptions" }, "Name": { "markdownDescription": "The name of the configuration set\\. The name must meet the following requirements: \n+ Contain only letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), or dashes \\(\\-\\)\\.\n+ Contain 64 characters or fewer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -162476,19 +167409,29 @@ "type": "string" }, "ReputationOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.ReputationOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.ReputationOptions", + "markdownDescription": "An object that represents the reputation settings for the configuration set\\. \n*Required*: No \n*Type*: [ReputationOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-reputationoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReputationOptions" }, "SendingOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.SendingOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.SendingOptions", + "markdownDescription": "An object that defines whether or not Amazon SES can send email that you send using the configuration set\\. \n*Required*: No \n*Type*: [SendingOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-sendingoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SendingOptions" }, "SuppressionOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.SuppressionOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.SuppressionOptions", + "markdownDescription": "An object that contains information about the suppression list preferences for your account\\. \n*Required*: No \n*Type*: [SuppressionOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-suppressionoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SuppressionOptions" }, "TrackingOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.TrackingOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.TrackingOptions", + "markdownDescription": "The name of the custom open and click tracking domain associated with the configuration set\\. \n*Required*: No \n*Type*: [TrackingOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-trackingoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrackingOptions" }, "VdmOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.VdmOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.VdmOptions", + "markdownDescription": "The Virtual Deliverability Manager \\(VDM\\) options that apply to the configuration set\\. \n*Required*: No \n*Type*: [VdmOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-vdmoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VdmOptions" } }, "type": "object" @@ -162517,6 +167460,8 @@ "additionalProperties": false, "properties": { "EngagementMetrics": { + "markdownDescription": "Specifies the status of your VDM engagement metrics collection\\. Can be one of the following: \n+ `ENABLED` \u2013 Amazon SES enables engagement metrics for the configuration set\\.\n+ `DISABLED` \u2013 Amazon SES disables engagement metrics for the configuration set\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EngagementMetrics", "type": "string" } }, @@ -162529,9 +167474,13 @@ "additionalProperties": false, "properties": { "SendingPoolName": { + "markdownDescription": "The name of the dedicated IP pool to associate with the configuration set\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SendingPoolName", "type": "string" }, "TlsPolicy": { + "markdownDescription": "Specifies whether messages that use the configuration set are required to use Transport Layer Security \\(TLS\\)\\. If the value is `REQUIRE`, messages are only delivered if a TLS connection can be established\\. If the value is `OPTIONAL`, messages can be delivered in plain text if a TLS connection can't be established\\. \nValid Values: `REQUIRE | OPTIONAL` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TlsPolicy", "type": "string" } }, @@ -162541,6 +167490,8 @@ "additionalProperties": false, "properties": { "OptimizedSharedDelivery": { + "markdownDescription": "Specifies the status of your VDM optimized shared delivery\\. Can be one of the following: \n+ `ENABLED` \u2013 Amazon SES enables optimized shared delivery for the configuration set\\.\n+ `DISABLED` \u2013 Amazon SES disables optimized shared delivery for the configuration set\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OptimizedSharedDelivery", "type": "string" } }, @@ -162553,6 +167504,8 @@ "additionalProperties": false, "properties": { "ReputationMetricsEnabled": { + "markdownDescription": "Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch\\. \nIf the value is `true`, reputation metrics are published\\. If the value is `false`, reputation metrics are not published\\. The default value is `false`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ReputationMetricsEnabled", "type": "boolean" } }, @@ -162562,6 +167515,8 @@ "additionalProperties": false, "properties": { "SendingEnabled": { + "markdownDescription": "If `true`, email sending is enabled for the configuration set\\. If `false`, email sending is disabled for the configuration set\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SendingEnabled", "type": "boolean" } }, @@ -162574,6 +167529,8 @@ "items": { "type": "string" }, + "markdownDescription": "A list that contains the reasons that email addresses are automatically added to the suppression list for your account\\. This list can contain any or all of the following: \n+ `COMPLAINT` \u2013 Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint\\.\n+ `BOUNCE` \u2013 Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce\\.\n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SuppressedReasons", "type": "array" } }, @@ -162583,6 +167540,8 @@ "additionalProperties": false, "properties": { "CustomRedirectDomain": { + "markdownDescription": "The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomRedirectDomain", "type": "string" } }, @@ -162592,10 +167551,14 @@ "additionalProperties": false, "properties": { "DashboardOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.DashboardOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.DashboardOptions", + "markdownDescription": "Settings for your VDM configuration as applicable to the Dashboard\\. \n*Required*: No \n*Type*: [DashboardOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-dashboardoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DashboardOptions" }, "GuardianOptions": { - "$ref": "#/definitions/AWS::SES::ConfigurationSet.GuardianOptions" + "$ref": "#/definitions/AWS::SES::ConfigurationSet.GuardianOptions", + "markdownDescription": "Settings for your VDM configuration as applicable to the Guardian\\. \n*Required*: No \n*Type*: [GuardianOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-guardianoptions.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GuardianOptions" } }, "type": "object" @@ -162696,7 +167659,7 @@ "type": "string" }, "DimensionName": { - "markdownDescription": "The name of an Amazon CloudWatch dimension associated with an email sending metric\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), or dashes \\(\\-\\)\\.\n+ Contain 256 characters or fewer\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of an Amazon CloudWatch dimension associated with an email sending metric\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), dashes \\(\\-\\), or colons \\(:\\)\\.\n+ Contain 256 characters or fewer\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DimensionName", "type": "string" }, @@ -162735,7 +167698,7 @@ "items": { "type": "string" }, - "markdownDescription": "The type of email sending events to publish to the event destination\\. \n+ `send` \\- The call was successful and Amazon SES is attempting to deliver the email\\.\n+ `reject` \\- Amazon SES determined that the email contained a virus and rejected it\\.\n+ `bounce` \\- The recipient's mail server permanently rejected the email\\. This corresponds to a hard bounce\\.\n+ `complaint` \\- The recipient marked the email as spam\\.\n+ `delivery` \\- Amazon SES successfully delivered the email to the recipient's mail server\\.\n+ `open` \\- The recipient received the email and opened it in their email client\\.\n+ `click` \\- The recipient clicked one or more links in the email\\.\n+ `renderingFailure` \\- Amazon SES did not send the email because of a template rendering issue\\.\n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of email sending events to publish to the event destination\\. \n+ `send` \\- The send request was successful and SES will attempt to deliver the message to the recipient\u2019s mail server\\. \\(If account\\-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed\\.\\)\n+ `reject` \\- SES accepted the email, but determined that it contained a virus and didn\u2019t attempt to deliver it to the recipient\u2019s mail server\\.\n+ `bounce` \\- \\(*Hard bounce*\\) The recipient's mail server permanently rejected the email\\. \\(*Soft bounces* are only included when SES fails to deliver the email after retrying for a period of time\\.\\)\n+ `complaint` \\- The email was successfully delivered to the recipient\u2019s mail server, but the recipient marked it as spam\\.\n+ `delivery` \\- SES successfully delivered the email to the recipient's mail server\\.\n+ `open` \\- The recipient received the message and opened it in their email client\\.\n+ `click` \\- The recipient clicked one or more links in the email\\.\n+ `renderingFailure` \\- The email wasn't sent because of a template rendering issue\\. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data\\. \\(This event type only occurs when you send email using the [https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html](https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html) or [https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html](https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html) API operations\\.\\) \n+ `deliveryDelay` \\- The email couldn't be delivered to the recipient\u2019s mail server because a temporary issue occurred\\. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue\\.\n+ `subscription` \\- The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an *unsubscribe* link as part of your [subscription management](https://docs.aws.amazon.com/ses/latest/dg/sending-email-subscription-management.html)\\.\n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MatchingEventTypes", "type": "array" }, @@ -162745,7 +167708,9 @@ "type": "string" }, "SnsDestination": { - "$ref": "#/definitions/AWS::SES::ConfigurationSetEventDestination.SnsDestination" + "$ref": "#/definitions/AWS::SES::ConfigurationSetEventDestination.SnsDestination", + "markdownDescription": "An object that contains the topic ARN associated with an Amazon Simple Notification Service \\(Amazon SNS\\) event destination\\. \n*Required*: No \n*Type*: [SnsDestination](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-snsdestination.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SnsDestination" } }, "required": [ @@ -162777,6 +167742,8 @@ "additionalProperties": false, "properties": { "TopicARN": { + "markdownDescription": "The ARN of the Amazon SNS topic for email sending events\\. You can find the ARN of a topic by using the [ListTopics](https://docs.aws.amazon.com/sns/latest/api/API_ListTopics.html) Amazon SNS operation\\. \nFor more information about Amazon SNS topics, see the [Amazon SNS Developer Guide](https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TopicARN", "type": "string" } }, @@ -162936,9 +167903,13 @@ "additionalProperties": false, "properties": { "PoolName": { + "markdownDescription": "The name of the dedicated IP pool that the IP address is associated with\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PoolName", "type": "string" }, "ScalingMode": { + "markdownDescription": "The type of scaling mode\\. \nThe following options are available: \n+ `STANDARD` \\- The customer controls which IPs are part of the dedicated IP pool\\.\n+ `MANAGED` \\- The reputation and number of IPs is automatically managed by Amazon SES\\.\nThe `STANDARD` option is selected by default if no value is specified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ScalingMode", "type": "string" } }, @@ -163000,22 +167971,34 @@ "additionalProperties": false, "properties": { "ConfigurationSetAttributes": { - "$ref": "#/definitions/AWS::SES::EmailIdentity.ConfigurationSetAttributes" + "$ref": "#/definitions/AWS::SES::EmailIdentity.ConfigurationSetAttributes", + "markdownDescription": "Used to associate a configuration set with an email identity\\. \n*Required*: No \n*Type*: [ConfigurationSetAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-configurationsetattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConfigurationSetAttributes" }, "DkimAttributes": { - "$ref": "#/definitions/AWS::SES::EmailIdentity.DkimAttributes" + "$ref": "#/definitions/AWS::SES::EmailIdentity.DkimAttributes", + "markdownDescription": "An object that contains information about the DKIM attributes for the identity\\. \n*Required*: No \n*Type*: [DkimAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DkimAttributes" }, "DkimSigningAttributes": { - "$ref": "#/definitions/AWS::SES::EmailIdentity.DkimSigningAttributes" + "$ref": "#/definitions/AWS::SES::EmailIdentity.DkimSigningAttributes", + "markdownDescription": "If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM \\(BYODKIM\\) for DKIM authentication purposes, or, configures the key length to be used for [Easy DKIM](https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html)\\. \n*Required*: No \n*Type*: [DkimSigningAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimsigningattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DkimSigningAttributes" }, "EmailIdentity": { + "markdownDescription": "The email address or domain to verify\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EmailIdentity", "type": "string" }, "FeedbackAttributes": { - "$ref": "#/definitions/AWS::SES::EmailIdentity.FeedbackAttributes" + "$ref": "#/definitions/AWS::SES::EmailIdentity.FeedbackAttributes", + "markdownDescription": "Used to enable or disable feedback forwarding for an identity\\. \n*Required*: No \n*Type*: [FeedbackAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-feedbackattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FeedbackAttributes" }, "MailFromAttributes": { - "$ref": "#/definitions/AWS::SES::EmailIdentity.MailFromAttributes" + "$ref": "#/definitions/AWS::SES::EmailIdentity.MailFromAttributes", + "markdownDescription": "Used to enable or disable the custom Mail\\-From domain configuration for an email identity\\. \n*Required*: No \n*Type*: [MailFromAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-mailfromattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MailFromAttributes" } }, "required": [ @@ -163048,6 +168031,8 @@ "additionalProperties": false, "properties": { "ConfigurationSetName": { + "markdownDescription": "The configuration set to associate with an email identity\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConfigurationSetName", "type": "string" } }, @@ -163057,6 +168042,8 @@ "additionalProperties": false, "properties": { "SigningEnabled": { + "markdownDescription": "Sets the DKIM signing configuration for the identity\\. \n When you set this value `true`, then the messages that are sent from the identity are signed using DKIM\\. If you set this value to `false`, your messages are sent without DKIM signing\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SigningEnabled", "type": "boolean" } }, @@ -163066,12 +168053,18 @@ "additionalProperties": false, "properties": { "DomainSigningPrivateKey": { + "markdownDescription": "\\[Bring Your Own DKIM\\] A private key that's used to generate a DKIM signature\\. \nThe private key must use 1024 or 2048\\-bit RSA encryption, and must be encoded using base64 encoding\\. \nRather than embedding sensitive information directly in your CFN templates, we recommend you use dynamic parameters in the stack template to reference sensitive information that is stored and managed outside of CFN, such as in the AWS Systems Manager Parameter Store or AWS Secrets Manager\\. \nFor more information, see the [Do not embed credentials in your templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html#creds) best practice\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DomainSigningPrivateKey", "type": "string" }, "DomainSigningSelector": { + "markdownDescription": "\\[Bring Your Own DKIM\\] A string that's used to identify a public key in the DNS configuration for a domain\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DomainSigningSelector", "type": "string" }, "NextSigningKeyLength": { + "markdownDescription": "\\[Easy DKIM\\] The key length of the future DKIM key pair to be generated\\. This can be changed at most once per day\\. \nValid Values: `RSA_1024_BIT | RSA_2048_BIT` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NextSigningKeyLength", "type": "string" } }, @@ -163081,6 +168074,8 @@ "additionalProperties": false, "properties": { "EmailForwardingEnabled": { + "markdownDescription": "Sets the feedback forwarding configuration for the identity\\. \n If the value is `true`, you receive email notifications when bounce or complaint events occur\\. These notifications are sent to the address that you specified in the `Return-Path` header of the original email\\. \n You're required to have a method of tracking bounces and complaints\\. If you haven't set up another mechanism for receiving bounce or complaint notifications \\(for example, by setting up an event destination\\), you receive an email notification when these events occur \\(even if this setting is disabled\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EmailForwardingEnabled", "type": "boolean" } }, @@ -163090,9 +168085,13 @@ "additionalProperties": false, "properties": { "BehaviorOnMxFailure": { + "markdownDescription": "The action to take if the required MX record isn't found when you send an email\\. When you set this value to `USE_DEFAULT_VALUE`, the mail is sent using *amazonses\\.com* as the MAIL FROM domain\\. When you set this value to `REJECT_MESSAGE`, the Amazon SES API v2 returns a `MailFromDomainNotVerified` error, and doesn't attempt to deliver the email\\. \nThese behaviors are taken when the custom MAIL FROM domain configuration is in the `Pending`, `Failed`, and `TemporaryFailure` states\\. \nValid Values: `USE_DEFAULT_VALUE | REJECT_MESSAGE` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BehaviorOnMxFailure", "type": "string" }, "MailFromDomain": { + "markdownDescription": "The custom MAIL FROM domain that you want the verified identity to use\\. The MAIL FROM domain must meet the following criteria: \n+ It has to be a subdomain of the verified identity\\.\n+ It can't be used to receive email\\.\n+ It can't be used in a \"From\" address if the MAIL FROM domain is a destination for feedback forwarding emails\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MailFromDomain", "type": "string" } }, @@ -163420,7 +168419,7 @@ "type": "boolean" }, "Name": { - "markdownDescription": "The name of the receipt rule\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), or dashes \\(\\-\\)\\.\n+ Start and end with a letter or number\\.\n+ Contain 64 characters or fewer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the receipt rule\\. The name must meet the following requirements: \n+ Contain only ASCII letters \\(a\\-z, A\\-Z\\), numbers \\(0\\-9\\), underscores \\(\\_\\), dashes \\(\\-\\), or periods \\(\\.\\)\\. \n+ Start and end with a letter or number\\.\n+ Contain 64 characters or fewer\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -163438,7 +168437,7 @@ "type": "boolean" }, "TlsPolicy": { - "markdownDescription": "Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security \\(TLS\\)\\. If this parameter is set to `Require`, Amazon SES bounces emails that are not received over TLS\\. The default is `Optional`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `Optional | Require` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security \\(TLS\\)\\. If this parameter is set to `Require`, Amazon SES bounces emails that are not received over TLS\\. The default is `Optional`\\. \nValid Values: `Require | Optional` \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TlsPolicy", "type": "string" } @@ -163719,10 +168718,14 @@ "additionalProperties": false, "properties": { "DashboardAttributes": { - "$ref": "#/definitions/AWS::SES::VdmAttributes.DashboardAttributes" + "$ref": "#/definitions/AWS::SES::VdmAttributes.DashboardAttributes", + "markdownDescription": "Specifies additional settings for your VDM configuration as applicable to the Dashboard\\. \n*Required*: No \n*Type*: [DashboardAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-vdmattributes-dashboardattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DashboardAttributes" }, "GuardianAttributes": { - "$ref": "#/definitions/AWS::SES::VdmAttributes.GuardianAttributes" + "$ref": "#/definitions/AWS::SES::VdmAttributes.GuardianAttributes", + "markdownDescription": "Specifies additional settings for your VDM configuration as applicable to the Guardian\\. \n*Required*: No \n*Type*: [GuardianAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-vdmattributes-guardianattributes.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "GuardianAttributes" } }, "type": "object" @@ -163751,6 +168754,8 @@ "additionalProperties": false, "properties": { "EngagementMetrics": { + "markdownDescription": "Specifies the status of your VDM engagement metrics collection\\. Can be one of the following: \n+ `ENABLED` \u2013 Amazon SES enables engagement metrics for your account\\.\n+ `DISABLED` \u2013 Amazon SES disables engagement metrics for your account\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EngagementMetrics", "type": "string" } }, @@ -163760,6 +168765,8 @@ "additionalProperties": false, "properties": { "OptimizedSharedDelivery": { + "markdownDescription": "Specifies the status of your VDM optimized shared delivery\\. Can be one of the following: \n+ `ENABLED` \u2013 Amazon SES enables optimized shared delivery for your account\\.\n+ `DISABLED` \u2013 Amazon SES disables optimized shared delivery for your account\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OptimizedSharedDelivery", "type": "string" } }, @@ -163816,6 +168823,8 @@ "type": "object" }, "FilterPolicyScope": { + "markdownDescription": "This attribute lets you choose the filtering scope by using one of the following string value types: \n+ `MessageAttributes` \\(default\\) \\- The filter is applied on the message attributes\\.\n+ `MessageBody` \\- The filter is applied on the message body\\.\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FilterPolicyScope", "type": "string" }, "Protocol": { @@ -163917,10 +168926,12 @@ "type": "boolean" }, "DataProtectionPolicy": { + "markdownDescription": "The body of the policy document you want to use for this topic\\. \nYou can only add one policy per topic\\. \nThe policy must be in JSON string format\\. \nLength Constraints: Maximum length of 30,720\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DataProtectionPolicy", "type": "object" }, "DisplayName": { - "markdownDescription": "The display name to use for an Amazon SNS topic with SMS subscriptions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The display name to use for an Amazon SNS topic with SMS subscriptions\\. The display name must be maximum 100 characters long, including hyphens \\(\\-\\), underscores \\(\\_\\), spaces, and tabs\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DisplayName", "type": "string" }, @@ -163935,13 +168946,15 @@ "type": "string" }, "SignatureVersion": { + "markdownDescription": "The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS\\. By default, `SignatureVersion` is set to `1`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SignatureVersion", "type": "string" }, "Subscription": { "items": { "$ref": "#/definitions/AWS::SNS::Topic.Subscription" }, - "markdownDescription": "The Amazon SNS subscriptions \\(endpoints\\) for this topic\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html) of [Subscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-subscription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon SNS subscriptions \\(endpoints\\) for this topic\\. \n*Required*: No \n*Type*: [List](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html) of [Subscription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-subscription.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Subscription", "type": "array" }, @@ -163959,6 +168972,8 @@ "type": "string" }, "TracingConfig": { + "markdownDescription": "Tracing mode of an Amazon SNS topic\\. By default `TracingConfig` is set to `PassThrough`, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions\\. If set to Active, SNS will vend X\\-Ray segment data to topic owner account if the sampled flag in the tracing header is true\\. Only supported on standard topics\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TracingConfig", "type": "string" } }, @@ -163988,12 +169003,12 @@ "additionalProperties": false, "properties": { "Endpoint": { - "markdownDescription": "The endpoint that receives notifications from the Amazon SNS topic\\. The endpoint value depends on the protocol that you specify\\. For more information, see the `Endpoint` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The endpoint that receives notifications from the Amazon SNS topic\\. The endpoint value depends on the protocol that you specify\\. For more information, see the `Endpoint` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Endpoint", "type": "string" }, "Protocol": { - "markdownDescription": "The subscription's protocol\\. For more information, see the `Protocol` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The subscription's protocol\\. For more information, see the `Protocol` parameter of the ` [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) ` action in the *Amazon SNS API Reference*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Protocol", "type": "string" } @@ -164146,7 +169161,7 @@ "type": "number" }, "KmsMasterKeyId": { - "markdownDescription": "The ID of an AWS managed customer master key \\(CMK\\) for Amazon SQS or a custom CMK\\. To use the AWS managed CMK for Amazon SQS, specify the \\(default\\) alias `alias/aws/sqs`\\. For more information, see the following: \n+ [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Amazon SQS Developer Guide* \n+ [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *Amazon SQS API Reference* \n+ The Customer Master Keys section of the [AWS Key Management Service Best Practices](https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ID of an AWS Key Management Service \\(KMS\\) for Amazon SQS, or a custom KMS\\. To use the AWS managed KMS for Amazon SQS, specify a \\(default\\) alias ARN, alias name \\(e\\.g\\. `alias/aws/sqs`\\), key ARN, or key ID\\. For more information, see the following: \n+ [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Amazon SQS Developer Guide* \n+ [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *Amazon SQS API Reference* \n+ [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *AWS Key Management Service API Reference* \n+ The Key Management Service \\(KMS\\) section of the [AWS Key Management Service Best Practices](https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "KmsMasterKeyId", "type": "string" }, @@ -164181,6 +169196,8 @@ "type": "object" }, "SqsManagedSseEnabled": { + "markdownDescription": "Enables server\\-side queue encryption using SQS owned encryption keys\\. Only one server\\-side encryption option is supported per queue \\(for example, [SSE\\-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE\\-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)\\)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SqsManagedSseEnabled", "type": "boolean" }, "Tags": { @@ -164379,7 +169396,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The name of the SSM document that contains the configuration information for the instance\\. You can specify `Command` or `Automation` documents\\. The documents can be AWS\\-predefined documents, documents you created, or a document that is shared with you from another account\\. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: \n`arn:partition:ssm:region:account-id:document/document-name` \nFor example: `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document` \nFor AWS\\-predefined documents and SSM documents you created in your account, you only need to specify the document name\\. For example, AWS\\-ApplyPatchBaseline or My\\-Document\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the SSM document that contains the configuration information for the instance\\. You can specify `Command` or `Automation` documents\\. The documents can be AWS\\-predefined documents, documents you created, or a document that is shared with you from another account\\. For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format: \n`arn:partition:ssm:region:account-id:document/document-name` \nFor example: `arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document` \nFor AWS\\-predefined documents and SSM documents you created in your account, you only need to specify the document name\\. For example, `AWS-ApplyPatchBaseline` or `My-Document`\\. \n*Required*: Yes \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -164389,7 +169406,7 @@ "title": "OutputLocation" }, "Parameters": { - "markdownDescription": "The parameters for the runtime configuration of the document\\. \n*Required*: No \n*Type*: Map of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The parameters for the runtime configuration of the document\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Parameters", "type": "object" }, @@ -164399,6 +169416,8 @@ "type": "string" }, "ScheduleOffset": { + "markdownDescription": "Number of days to wait after the scheduled day to run an association\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ScheduleOffset", "type": "number" }, "SyncCompliance": { @@ -164490,7 +169509,7 @@ "items": { "type": "string" }, - "markdownDescription": "User\\-defined criteria that maps to `Key`\\. For example, if you specified `tag:ServerRole`, you could specify Value `WebServer` to run a command on instances that include EC2 tags of `ServerRole,WebServer`\\. \nDepending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "User\\-defined criteria that maps to `Key`\\. For example, if you specified `tag:ServerRole`, you could specify `value:WebServer` to run a command on instances that include EC2 tags of `ServerRole,WebServer`\\. \nDepending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Values", "type": "array" } @@ -164540,17 +169559,17 @@ "items": { "$ref": "#/definitions/AWS::SSM::Document.AttachmentsSource" }, - "markdownDescription": "A list of key\\-value pairs that describe attachments to a version of a document\\. \n*Required*: No \n*Type*: List of [AttachmentsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html) \n*Maximum*: `20` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of key\\-value pairs that describe attachments to a version of a document\\. \n*Required*: No \n*Type*: List of [AttachmentsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-attachmentssource.html) \n*Maximum*: `20` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Attachments", "type": "array" }, "Content": { - "markdownDescription": "The content for the new SSM document in JSON or YAML\\. \nThis parameter also supports `String` data types\\.\n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The content for the new SSM document in JSON or YAML\\. For more information about the schemas for SSM document content, see [SSM document schema features and examples](https://docs.aws.amazon.com/systems-manager/latest/userguide/document-schemas-features.html) in the *AWS Systems Manager User Guide*\\. \nThis parameter also supports `String` data types\\.\n*Required*: Yes \n*Type*: Json \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Content", "type": "object" }, "DocumentFormat": { - "markdownDescription": "Specify the document format for the request\\. JSON is the default format\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `JSON | TEXT | YAML` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specify the document format for the request\\. JSON is the default format\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `JSON | TEXT | YAML` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DocumentFormat", "type": "string" }, @@ -164560,7 +169579,7 @@ "type": "string" }, "Name": { - "markdownDescription": "A name for the SSM document\\. \nYou can't use the following strings as document name prefixes\\. These are reserved by AWS for use as document name prefixes: \n+ `aws-` \n+ `amazon` \n+ `amzn` \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A name for the SSM document\\. \nYou can't use the following strings as document name prefixes\\. These are reserved by AWS for use as document name prefixes: \n+ `aws` \n+ `amazon` \n+ `amzn` \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -164568,7 +169587,7 @@ "items": { "$ref": "#/definitions/AWS::SSM::Document.DocumentRequires" }, - "markdownDescription": "A list of SSM documents required by a document\\. This parameter is used exclusively by AWS AppConfig\\. When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes\\. In this case, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document for validation purposes\\. For more information, see [What is AWS AppConfig?](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the * AWS AppConfig User Guide*\\. \n*Required*: No \n*Type*: List of [DocumentRequires](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of SSM documents required by a document\\. This parameter is used exclusively by AWS AppConfig\\. When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes\\. In this case, an `ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document for validation purposes\\. For more information, see [What is AWS AppConfig?](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the * AWS AppConfig User Guide*\\. \n*Required*: No \n*Type*: List of [DocumentRequires](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-document-documentrequires.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Requires", "type": "array" }, @@ -164581,15 +169600,17 @@ "type": "array" }, "TargetType": { - "markdownDescription": "Specify a target type to define the kinds of resources the document can run on\\. For example, to run a document on EC2 instances, specify the following value: `/AWS::EC2::Instance`\\. If you specify a value of '/' the document can run on all types of resources\\. If you don't specify a value, the document can't run on any resources\\. For a list of valid resource types, see [AWS resource and property types reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the *AWS CloudFormation User Guide*\\. \n*Required*: No \n*Type*: String \n*Maximum*: `200` \n*Pattern*: `^\\/[\\w\\.\\-\\:\\/]*$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specify a target type to define the kinds of resources the document can run on\\. For example, to run a document on EC2 instances, specify the following value: `/AWS::EC2::Instance`\\. If you specify a value of '/' the document can run on all types of resources\\. If you don't specify a value, the document can't run on any resources\\. For a list of valid resource types, see [AWS resource and property types reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the *AWS CloudFormation User Guide*\\. \n*Required*: No \n*Type*: String \n*Maximum*: `200` \n*Pattern*: `^\\/[\\w\\.\\-\\:\\/]*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TargetType", "type": "string" }, "UpdateMethod": { + "markdownDescription": "If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced\\. `Replace` is the default method\\. If you specify `NewVersion` for the `UpdateMethod` parameter, and the `Name` of the document does not match an existing resource, a new document is created\\. When you specify `NewVersion`, the default version of the document is changed to the newly created version\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UpdateMethod", "type": "string" }, "VersionName": { - "markdownDescription": "An optional field specifying the version of the artifact you are creating with the document\\. For example, \"Release 12, Update 6\"\\. This value is unique across all versions of a document, and can't be changed\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{1,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An optional field specifying the version of the artifact you are creating with the document\\. For example, `Release12.1`\\. This value is unique across all versions of a document, and can't be changed\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{1,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "VersionName", "type": "string" } @@ -164624,12 +169645,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The key of a key\\-value pair that identifies the location of an attachment to a document\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AttachmentReference | S3FileUrl | SourceUrl` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The key of a key\\-value pair that identifies the location of an attachment to a document\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AttachmentReference | S3FileUrl | SourceUrl` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Name": { - "markdownDescription": "The name of the document attachment file\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the document attachment file\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -164648,12 +169669,12 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of the required SSM document\\. The name can be an Amazon Resource Name \\(ARN\\)\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,128}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the required SSM document\\. The name can be an Amazon Resource Name \\(ARN\\)\\. \n*Required*: No \n*Type*: String \n*Pattern*: `^[a-zA-Z0-9_\\-.:/]{3,128}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, "Version": { - "markdownDescription": "The document version required by the current document\\. \n*Required*: No \n*Type*: String \n*Pattern*: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The document version required by the current document\\. \n*Required*: No \n*Type*: String \n*Pattern*: `([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -164951,7 +169972,7 @@ }, "LoggingInfo": { "$ref": "#/definitions/AWS::SSM::MaintenanceWindowTask.LoggingInfo", - "markdownDescription": "Information about an Amazon S3 bucket to write task\\-level logs to\\. \n `LoggingInfo` has been deprecated\\. To specify an Amazon S3 bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure\\. For information about how Systems Manager handles these options for the supported maintenance window task types, see [AWS Systems Manager MaintenanceWindowTask TaskInvocationParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html)\\.\n*Required*: No \n*Type*: [LoggingInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Information about an Amazon S3 bucket to write Run Command task\\-level logs to\\. \n `LoggingInfo` has been deprecated\\. To specify an Amazon S3 bucket to contain logs for Run Command tasks, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure\\. For information about how Systems Manager handles these options for the supported maintenance window task types, see [AWS::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html)\\.\n*Required*: No \n*Type*: [LoggingInfo](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoggingInfo" }, "MaxConcurrency": { @@ -165067,7 +170088,7 @@ "type": "string" }, "S3Bucket": { - "markdownDescription": "The name of an S3 bucket where execution logs are stored \\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of an S3 bucket where execution logs are stored\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "S3Bucket", "type": "string" }, @@ -165455,7 +170476,7 @@ "type": "string" }, "OperatingSystem": { - "markdownDescription": "Defines the operating system the patch baseline applies to\\. The default value is `WINDOWS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AMAZON_LINUX | AMAZON_LINUX_2 | CENTOS | DEBIAN | MACOS | ORACLE_LINUX | RASPBIAN | REDHAT_ENTERPRISE_LINUX | SUSE | UBUNTU | WINDOWS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Defines the operating system the patch baseline applies to\\. The default value is `WINDOWS`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | CENTOS | DEBIAN | MACOS | ORACLE_LINUX | RASPBIAN | REDHAT_ENTERPRISE_LINUX | ROCKY_LINUX | SUSE | UBUNTU | WINDOWS` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "OperatingSystem", "type": "string" }, @@ -165864,9 +170885,13 @@ "additionalProperties": false, "properties": { "Policy": { + "markdownDescription": "A policy you want to associate with a resource\\. \n*Required*: Yes \n*Type*: Json \n*Pattern*: `\\S+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Policy", "type": "object" }, "ResourceArn": { + "markdownDescription": "Amazon Resource Name \\(ARN\\) of the resource to which you want to attach a policy\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ResourceArn", "type": "string" } }, @@ -166205,6 +171230,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "A list of tags to add to the replication set\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -166321,7 +171348,7 @@ "items": { "type": "string" }, - "markdownDescription": "The contacts and escalation plans that the response plan engages during an incident\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) for the contacts and escalation plans that the response plan engages during an incident\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Engagements", "type": "array" }, @@ -166334,6 +171361,8 @@ "items": { "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.Integration" }, + "markdownDescription": "Information about third\\-party services integrated into the response plan\\. \n*Required*: No \n*Type*: List of [Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-integration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Integrations", "type": "array" }, "Name": { @@ -166406,10 +171435,14 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "The key parameter to use when running the Systems Manager Automation runbook\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { - "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.DynamicSsmParameterValue" + "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.DynamicSsmParameterValue", + "markdownDescription": "The dynamic parameter value\\. \n*Required*: Yes \n*Type*: [DynamicSsmParameterValue](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparametervalue.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value" } }, "required": [ @@ -166422,6 +171455,8 @@ "additionalProperties": false, "properties": { "Variable": { + "markdownDescription": "Variable dynamic parameters\\. A parameter value is determined when an incident is created\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `INCIDENT_RECORD_ARN | INVOLVED_RESOURCES` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Variable", "type": "string" } }, @@ -166444,6 +171479,8 @@ "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Tags to assign to the template\\. When the `StartIncident` API action is called, Incident Manager assigns the tags specified in the template to the incident\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncidentTags", "type": "array" }, "NotificationTargets": { @@ -166475,7 +171512,9 @@ "additionalProperties": false, "properties": { "PagerDutyConfiguration": { - "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.PagerDutyConfiguration" + "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.PagerDutyConfiguration", + "markdownDescription": "Information about the PagerDuty service where the response plan creates an incident\\. \n*Required*: Yes \n*Type*: [PagerDutyConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PagerDutyConfiguration" } }, "required": [ @@ -166498,12 +171537,18 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the PagerDuty configuration\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "PagerDutyIncidentConfiguration": { - "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.PagerDutyIncidentConfiguration" + "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.PagerDutyIncidentConfiguration", + "markdownDescription": "Details about the PagerDuty service associated with the configuration\\. \n*Required*: Yes \n*Type*: [PagerDutyIncidentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-pagerdutyincidentconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PagerDutyIncidentConfiguration" }, "SecretId": { + "markdownDescription": "The ID of the AWS Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecretId", "type": "string" } }, @@ -166518,6 +171563,8 @@ "additionalProperties": false, "properties": { "ServiceId": { + "markdownDescription": "The ID of the PagerDuty service that the response plan associates with an incident when it launches\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServiceId", "type": "string" } }, @@ -166543,6 +171590,8 @@ "items": { "$ref": "#/definitions/AWS::SSMIncidents::ResponsePlan.DynamicSsmParameter" }, + "markdownDescription": "The key\\-value pairs to resolve dynamic parameter values when processing a Systems Manager Automation runbook\\. \n*Required*: No \n*Type*: List of [DynamicSsmParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmincidents-responseplan-dynamicssmparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DynamicParameters", "type": "array" }, "Parameters": { @@ -166629,7 +171678,7 @@ "additionalProperties": false, "properties": { "InstanceArn": { - "markdownDescription": "The ARN of the SSO instance under which the operation will be executed\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the IAM Identity Center instance under which the operation will be executed\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceArn", "type": "string" }, @@ -166639,7 +171688,7 @@ "type": "string" }, "PrincipalId": { - "markdownDescription": "An identifier for an object in AWS SSO, such as a user or group\\. PrincipalIds are GUIDs \\(For example, f81d4fae\\-7dec\\-11d0\\-a765\\-00a0c91e6bf6\\)\\. For more information about PrincipalIds in AWS SSO, see the [AWS SSO Identity Store API Reference](/singlesignon/latest/IdentityStoreAPIReference/welcome.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `47` \n*Pattern*: `^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An identifier for an object in IAM Identity Center, such as a user or group\\. PrincipalIds are GUIDs \\(For example, f81d4fae\\-7dec\\-11d0\\-a765\\-00a0c91e6bf6\\)\\. For more information about PrincipalIds in IAM Identity Center, see the [IAM Identity Center Identity Store API Reference](/singlesignon/latest/IdentityStoreAPIReference/welcome.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `47` \n*Pattern*: `^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "PrincipalId", "type": "string" }, @@ -166729,12 +171778,12 @@ "items": { "$ref": "#/definitions/AWS::SSO::InstanceAccessControlAttributeConfiguration.AccessControlAttribute" }, - "markdownDescription": "Lists the attributes that are configured for ABAC in the specified AWS SSO instance\\. \n*Required*: No \n*Type*: List of [AccessControlAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Lists the attributes that are configured for ABAC in the specified IAM Identity Center instance\\. \n*Required*: No \n*Type*: List of [AccessControlAttribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-instanceaccesscontrolattributeconfiguration-accesscontrolattribute.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AccessControlAttributes", "type": "array" }, "InstanceArn": { - "markdownDescription": "The ARN of the AWS SSO instance under which the operation will be executed\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the IAM Identity Center instance under which the operation will be executed\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceArn", "type": "string" } @@ -166769,7 +171818,7 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The name of the attribute associated with your identities in your identity source\\. This is used to map a specified attribute in your identity source with an attribute in AWS SSO\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the attribute associated with your identities in your identity source\\. This is used to map a specified attribute in your identity source with an attribute in IAM Identity Center\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, @@ -166792,7 +171841,7 @@ "items": { "type": "string" }, - "markdownDescription": "The identity source to use when mapping a specified attribute to AWS SSO\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The identity source to use when mapping a specified attribute to IAM Identity Center\\. \n*Required*: Yes \n*Type*: List of String \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Source", "type": "array" } @@ -166841,20 +171890,22 @@ "items": { "$ref": "#/definitions/AWS::SSO::PermissionSet.CustomerManagedPolicyReference" }, + "markdownDescription": "Specifies the names and paths of the customer managed policies that you have attached to your permission set\\. \n*Required*: No \n*Type*: List of [CustomerManagedPolicyReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-customermanagedpolicyreference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomerManagedPolicyReferences", "type": "array" }, "Description": { - "markdownDescription": "The description of the [AWS::SSO::PermissionSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-resource-sso-permissionset.html#aws-resource-sso-permissionset)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `700` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A0-\\u00FF]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The description of the [AWS::SSO::PermissionSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-resource-sso-permissionset.html#aws-resource-sso-permissionset)\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `700` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Description", "type": "string" }, "InlinePolicy": { - "markdownDescription": "The IAM inline policy that is attached to the permission set\\. \n*Required*: No \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `10240` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The inline policy that is attached to the permission set\\. \nFor `Length Constraints`, if a valid ARN is provided for a permission set, it is possible for an empty inline policy to be returned\\.\n*Required*: No \n*Type*: Json \n*Minimum*: `1` \n*Maximum*: `10240` \n*Pattern*: `[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InlinePolicy", "type": "object" }, "InstanceArn": { - "markdownDescription": "The ARN of the SSO instance under which the operation will be executed\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ARN of the IAM Identity Center instance under which the operation will be executed\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\) and AWS Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `10` \n*Maximum*: `1224` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html:::instance/(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/sso.html)?ins-[a-zA-Z0-9-.]{16}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceArn", "type": "string" }, @@ -166862,7 +171913,7 @@ "items": { "type": "string" }, - "markdownDescription": "A structure that stores the details of the IAM managed policy\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A structure that stores the details of the AWS managed policy\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ManagedPolicies", "type": "array" }, @@ -166872,7 +171923,9 @@ "type": "string" }, "PermissionsBoundary": { - "$ref": "#/definitions/AWS::SSO::PermissionSet.PermissionsBoundary" + "$ref": "#/definitions/AWS::SSO::PermissionSet.PermissionsBoundary", + "markdownDescription": "Specifies the configuration of the AWS managed or customer managed policy that you want to set as a permissions boundary\\. Specify either `CustomerManagedPolicyReference` to use the name and path of a customer managed policy, or `ManagedPolicyArn` to use the ARN of an AWS managed policy\\. A permissions boundary represents the maximum permissions that any policy can grant your role\\. For more information, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*\\. \nPolicies used as permissions boundaries don't provide permissions\\. You must also attach an IAM policy to the role\\. To learn how the effective permissions for a role are evaluated, see [IAM JSON policy evaluation logic](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) in the *IAM User Guide*\\.\n*Required*: No \n*Type*: [PermissionsBoundary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-permissionsboundary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PermissionsBoundary" }, "RelayStateType": { "markdownDescription": "Used to redirect users within the application during the federation authentication process\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `240` \n*Pattern*: `[a-zA-Z0-9&$@#\\\\\\/%?=~\\-_'\"|!:,.;*+\\[\\]\\ \\(\\)\\{\\}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", @@ -166924,9 +171977,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the IAM policy that you have configured in each account where you want to deploy your permission set\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\w+=,.@-]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Path": { + "markdownDescription": "The path to the IAM policy that you have configured in each account where you want to deploy your permission set\\. The default is `/`\\. 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*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `512` \n*Pattern*: `((/[A-Za-z0-9\\.,\\+@=_-]+)*)/` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Path", "type": "string" } }, @@ -166939,9 +171996,13 @@ "additionalProperties": false, "properties": { "CustomerManagedPolicyReference": { - "$ref": "#/definitions/AWS::SSO::PermissionSet.CustomerManagedPolicyReference" + "$ref": "#/definitions/AWS::SSO::PermissionSet.CustomerManagedPolicyReference", + "markdownDescription": "Specifies the name and path of a customer managed policy\\. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set\\. \n*Required*: No \n*Type*: [CustomerManagedPolicyReference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-permissionset-customermanagedpolicyreference.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomerManagedPolicyReference" }, "ManagedPolicyArn": { + "markdownDescription": "The AWS managed policy ARN that you want to attach to a permission set as a permissions boundary\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::aws:policy/[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ManagedPolicyArn", "type": "string" } }, @@ -166988,7 +172049,7 @@ "type": "string" }, "AppType": { - "markdownDescription": "The type of app\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The type of app\\. \n*Allowed Values*: `JupyterServer | KernelGateway | RSessionGateway | RStudioServerPro | TensorBoard | Canvas` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AppType", "type": "string" }, @@ -166999,7 +172060,7 @@ }, "ResourceSpec": { "$ref": "#/definitions/AWS::SageMaker::App.ResourceSpec", - "markdownDescription": "Specifies the ARN's of a SageMaker image and SageMaker image version, and the instance type that the version runs on\\. \n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on\\. \n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-app-resourcespec.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResourceSpec" }, "Tags": { @@ -167049,7 +172110,7 @@ "additionalProperties": false, "properties": { "InstanceType": { - "markdownDescription": "The instance type that the image version runs on\\. \nJupyterServer Apps only support the `system` value\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3dn.24xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.large | ml.r5.xlarge | ml.t3.2xlarge | ml.t3.large | ml.t3.medium | ml.t3.micro | ml.t3.small | ml.t3.xlarge | system` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The instance type that the image version runs on\\. \n **JupyterServer apps** only support the `system` value\\. \nFor **KernelGateway apps**, the `system` value is translated to `ml.t3.medium`\\. KernelGateway apps also support all other values for available instance types\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.2xlarge | ml.g5.48xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3dn.24xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.large | ml.r5.xlarge | ml.t3.2xlarge | ml.t3.large | ml.t3.medium | ml.t3.micro | ml.t3.small | ml.t3.xlarge | system` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InstanceType", "type": "string" }, @@ -167368,6 +172429,8 @@ "title": "DataQualityJobOutputConfig" }, "EndpointName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndpointName", "type": "string" }, "JobDefinitionName": { @@ -167438,18 +172501,28 @@ "additionalProperties": false, "properties": { "DataCapturedDestinationS3Uri": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataCapturedDestinationS3Uri", "type": "string" }, "DatasetFormat": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.DatasetFormat" + "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.DatasetFormat", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [DatasetFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-datasetformat.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatasetFormat" }, "LocalPath": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LocalPath", "type": "string" }, "S3DataDistributionType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3DataDistributionType", "type": "string" }, "S3InputMode": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3InputMode", "type": "string" } }, @@ -167469,7 +172542,7 @@ "type": "number" }, "InstanceType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ML compute instance type for the processing job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, @@ -167506,6 +172579,8 @@ "additionalProperties": false, "properties": { "Header": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Header", "type": "boolean" } }, @@ -167587,11 +172662,13 @@ "additionalProperties": false, "properties": { "BatchTransformInput": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.BatchTransformInput" + "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.BatchTransformInput", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [BatchTransformInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-batchtransforminput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BatchTransformInput" }, "EndpointInput": { "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.EndpointInput", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Input object for the endpoint \n*Required*: No \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EndpointInput" } }, @@ -167601,12 +172678,18 @@ "additionalProperties": false, "properties": { "Csv": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.Csv" + "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.Csv", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Csv](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-csv.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Csv" }, "Json": { - "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.Json" + "$ref": "#/definitions/AWS::SageMaker::DataQualityJobDefinition.Json", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-dataqualityjobdefinition-json.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Json" }, "Parquet": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Parquet", "type": "boolean" } }, @@ -167646,6 +172729,8 @@ "additionalProperties": false, "properties": { "Line": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Line", "type": "boolean" } }, @@ -167762,7 +172847,7 @@ "additionalProperties": false, "properties": { "MaxRuntimeInSeconds": { - "markdownDescription": "The maximum length of time, in seconds, that a training or compilation job can run\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum length of time, in seconds, that a training or compilation job can run before it is stopped\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \nThe maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaxRuntimeInSeconds", "type": "number" } @@ -167839,7 +172924,7 @@ "title": "Device" }, "DeviceFleetName": { - "markdownDescription": "The name of the fleet the device belongs to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the fleet the device belongs to\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DeviceFleetName", "type": "string" }, @@ -167887,7 +172972,7 @@ "type": "string" }, "DeviceName": { - "markdownDescription": "The name of the device\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the device\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DeviceName", "type": "string" }, @@ -168054,15 +173139,19 @@ "type": "string" }, "AppSecurityGroupManagement": { + "markdownDescription": "The entity that creates and manages the required security groups for inter\\-app communication in `VpcOnly` mode\\. Required when `CreateDomain.AppNetworkAccessType` is `VpcOnly` and `DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn` is provided\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AppSecurityGroupManagement", "type": "string" }, "AuthMode": { - "markdownDescription": "The mode of authentication that members use to access the domain\\. \n*Valid Values*: `SSO | IAM` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The mode of authentication that members use to access the Domain\\. \n*Valid Values*: `SSO | IAM` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AuthMode", "type": "string" }, "DefaultSpaceSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.DefaultSpaceSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.DefaultSpaceSettings", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DefaultSpaceSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-defaultspacesettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultSpaceSettings" }, "DefaultUserSettings": { "$ref": "#/definitions/AWS::SageMaker::Domain.UserSettings", @@ -168075,10 +173164,12 @@ "type": "string" }, "DomainSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.DomainSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.DomainSettings", + "markdownDescription": "A collection of settings that apply to the `SageMaker Domain`\\. These settings are specified through the `CreateDomain` API call\\. \n*Required*: No \n*Type*: [DomainSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-domainsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DomainSettings" }, "KmsKeyId": { - "markdownDescription": "SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed customer master key \\(CMK\\) by default\\. For more control, specify a customer managed CMK\\. \n*Length Constraints*: Maximum length of 2048\\. \n*Pattern*: `.*` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "SageMaker uses AWS KMS to encrypt the EFS volume attached to the Domain with an AWS managed customer master key \\(CMK\\) by default\\. For more control, specify a customer managed CMK\\. \n*Length Constraints*: Maximum length of 2048\\. \n*Pattern*: `.*` \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "KmsKeyId", "type": "string" }, @@ -168094,12 +173185,12 @@ "items": { "$ref": "#/definitions/Tag" }, - "markdownDescription": "Tags to associated with the Domain\\. Each tag consists of a key and an optional value\\. Tag keys must be unique per resource\\. Tags are searchable using the Search API\\. \nTags that you specify for the Domain are also added to all Apps that are launched in the Domain\\. \n*Array members*: Minimum number of 0 items\\. Maximum number of 50 items\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Tags to associated with the Domain\\. Each tag consists of a key and an optional value\\. Tag keys must be unique per resource\\. Tags are searchable using the Search API\\. \nTags that you specify for the Domain are also added to all apps that are launched in the Domain\\. \n*Array members*: Minimum number of 0 items\\. Maximum number of 50 items\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Tags", "type": "array" }, "VpcId": { - "markdownDescription": "The ID of the Amazon Virtual Private Cloud \\(VPC\\) that Studio uses for communication\\. \n*Length Constraints*: Maximum length of 32\\. \n*Pattern*: `[-0-9a-zA-Z]+` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ID of the Amazon Virtual Private Cloud \\(Amazon VPC\\) that Studio uses for communication\\. \n*Length Constraints*: Maximum length of 32\\. \n*Pattern*: `[-0-9a-zA-Z]+` \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VpcId", "type": "string" } @@ -168163,18 +173254,26 @@ "additionalProperties": false, "properties": { "ExecutionRole": { + "markdownDescription": "The execution role for the space\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExecutionRole", "type": "string" }, "JupyterServerAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.JupyterServerAppSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.JupyterServerAppSettings", + "markdownDescription": "The JupyterServer app settings\\. \n*Required*: No \n*Type*: [JupyterServerAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-jupyterserverappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "JupyterServerAppSettings" }, "KernelGatewayAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.KernelGatewayAppSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.KernelGatewayAppSettings", + "markdownDescription": "The KernelGateway app settings\\. \n*Required*: No \n*Type*: [KernelGatewayAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-kernelgatewayappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KernelGatewayAppSettings" }, "SecurityGroups": { "items": { "type": "string" }, + "markdownDescription": "The security groups for the Amazon Virtual Private Cloud that the space uses for communication\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `5` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroups", "type": "array" } }, @@ -168184,12 +173283,16 @@ "additionalProperties": false, "properties": { "RStudioServerProDomainSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.RStudioServerProDomainSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.RStudioServerProDomainSettings", + "markdownDescription": "A collection of settings that configure the `RStudioServerPro` Domain\\-level app\\. \n*Required*: No \n*Type*: [RStudioServerProDomainSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverprodomainsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RStudioServerProDomainSettings" }, "SecurityGroupIds": { "items": { "type": "string" }, + "markdownDescription": "The security groups for the Amazon Virtual Private Cloud that the `Domain` uses for communication between Domain\\-level apps and user apps\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SecurityGroupIds", "type": "array" } }, @@ -168232,10 +173335,14 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::Domain.CustomImage" }, + "markdownDescription": "A list of custom SageMaker images that are configured to run as a RSession app\\. \n*Required*: No \n*Type*: List of [CustomImage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-customimage.html) \n*Maximum*: `200` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomImages", "type": "array" }, "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec" + "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec", + "markdownDescription": "Specifies the ARNs of a SageMaker image and SageMaker image version, and the instance type that the version runs on\\. \n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultResourceSpec" } }, "type": "object" @@ -168244,9 +173351,13 @@ "additionalProperties": false, "properties": { "AccessStatus": { + "markdownDescription": "Indicates whether the current user has access to the `RStudioServerPro` app\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessStatus", "type": "string" }, "UserGroup": { + "markdownDescription": "The level of permissions that the user has within the `RStudioServerPro` app\\. This value defaults to `User`\\. The `Admin` value allows the user access to the RStudio Administrative Dashboard\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `R_STUDIO_ADMIN | R_STUDIO_USER` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserGroup", "type": "string" } }, @@ -168256,15 +173367,23 @@ "additionalProperties": false, "properties": { "DefaultResourceSpec": { - "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec" + "$ref": "#/definitions/AWS::SageMaker::Domain.ResourceSpec", + "markdownDescription": "A collection that defines the default `InstanceType`, `SageMakerImageArn`, and `SageMakerImageVersionArn` for the Domain\\. \n*Required*: No \n*Type*: [ResourceSpec](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DefaultResourceSpec" }, "DomainExecutionRoleArn": { + "markdownDescription": "The ARN of the execution role for the `RStudioServerPro` Domain\\-level app\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DomainExecutionRoleArn", "type": "string" }, "RStudioConnectUrl": { + "markdownDescription": "A URL pointing to an RStudio Connect server\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RStudioConnectUrl", "type": "string" }, "RStudioPackageManagerUrl": { + "markdownDescription": "A URL pointing to an RStudio Package Manager server\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RStudioPackageManagerUrl", "type": "string" } }, @@ -168277,20 +173396,22 @@ "additionalProperties": false, "properties": { "InstanceType": { - "markdownDescription": "The instance type that the image version runs on\\. \nJupyterServer Apps only support the `system` value\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3dn.24xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.large | ml.r5.xlarge | ml.t3.2xlarge | ml.t3.large | ml.t3.medium | ml.t3.micro | ml.t3.small | ml.t3.xlarge | system` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The instance type that the image version runs on\\. \n **JupyterServer apps** only support the `system` value\\. \nFor **KernelGateway apps**, the `system` value is translated to `ml.t3.medium`\\. KernelGateway apps also support all other values for available instance types\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c5.12xlarge | ml.c5.18xlarge | ml.c5.24xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.2xlarge | ml.g5.48xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.xlarge | ml.m5.12xlarge | ml.m5.16xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.8xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.16xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.8xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3dn.24xlarge | ml.r5.12xlarge | ml.r5.16xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.8xlarge | ml.r5.large | ml.r5.xlarge | ml.t3.2xlarge | ml.t3.large | ml.t3.medium | ml.t3.micro | ml.t3.small | ml.t3.xlarge | system` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "InstanceType", "type": "string" }, "LifecycleConfigArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the Lifecycle Configuration attached to the Resource\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "LifecycleConfigArn", "type": "string" }, "SageMakerImageArn": { - "markdownDescription": "The ARN of the SageMaker image that the image version belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN of the SageMaker image that the image version belongs to\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image/[a-z0-9]([-.]?[a-z0-9])*$` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "SageMakerImageArn", "type": "string" }, "SageMakerImageVersionArn": { - "markdownDescription": "The ARN of the image version created on the instance\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The ARN of the image version created on the instance\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^arn:aws(-[\\w]+)*:sagemaker:.+:[0-9]{12}:image-version/[a-z0-9]([-.]?[a-z0-9])*/[0-9]+$` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "title": "SageMakerImageVersionArn", "type": "string" } @@ -168337,10 +173458,14 @@ "title": "KernelGatewayAppSettings" }, "RSessionAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.RSessionAppSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.RSessionAppSettings", + "markdownDescription": "A collection of settings that configure the `RSessionGateway` app\\. \n*Required*: No \n*Type*: [RSessionAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rsessionappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RSessionAppSettings" }, "RStudioServerProAppSettings": { - "$ref": "#/definitions/AWS::SageMaker::Domain.RStudioServerProAppSettings" + "$ref": "#/definitions/AWS::SageMaker::Domain.RStudioServerProAppSettings", + "markdownDescription": "A collection of settings that configure user interaction with the `RStudioServerPro` app\\. \n*Required*: No \n*Type*: [RStudioServerProAppSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-rstudioserverproappsettings.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RStudioServerProAppSettings" }, "SecurityGroups": { "items": { @@ -168646,7 +173771,9 @@ "type": "string" }, "ExplainerConfig": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ExplainerConfig" + "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ExplainerConfig", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ExplainerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-explainerconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ExplainerConfig" }, "KmsKeyId": { "markdownDescription": "The Amazon Resource Name \\(ARN\\) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint\\. \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`\nThe KMS key policy must grant permission to the IAM role that you specify in your `CreateEndpoint`, `UpdateEndpoint` requests\\. For more information, refer to the AWS Key Management Service section [Using Key Policies in AWS KMS ](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) \nCertain 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 `KmsKeyId` when using an instance type with local storage\\. If any of the models that you specify in the `ProductionVariants` parameter use nitro\\-based instances with local storage, do not specify a value for the `KmsKeyId` parameter\\. If you specify a value for `KmsKeyId` when using any nitro\\-based instances with local storage, the call to `CreateEndpointConfig` fails\\. \nFor 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)\\. \nFor 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*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", @@ -168665,6 +173792,8 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ProductionVariant" }, + "markdownDescription": "Array of `ProductionVariant` objects\\. There is one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on `ProductionVariants`\\. If you use this field, you can only specify one variant for `ProductionVariants` and one variant for `ShadowProductionVariants`\\. \n*Required*: No \n*Type*: List of [ProductionVariant](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant.html) \n*Maximum*: `10` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ShadowProductionVariants", "type": "array" }, "Tags": { @@ -168812,13 +173941,19 @@ "additionalProperties": false, "properties": { "EnableExplanations": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EnableExplanations", "type": "string" }, "InferenceConfig": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyInferenceConfig" + "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyInferenceConfig", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ClarifyInferenceConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InferenceConfig" }, "ShapConfig": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyShapConfig" + "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyShapConfig", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [ClarifyShapConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ShapConfig" } }, "required": [ @@ -168840,45 +173975,67 @@ "additionalProperties": false, "properties": { "ContentTemplate": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContentTemplate", "type": "string" }, "FeatureHeaders": { "items": { "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyHeader" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ClarifyHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyheader.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FeatureHeaders", "type": "array" }, "FeatureTypes": { "items": { "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyFeatureType" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ClarifyFeatureType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyfeaturetype.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FeatureTypes", "type": "array" }, "FeaturesAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FeaturesAttribute", "type": "string" }, "LabelAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LabelAttribute", "type": "string" }, "LabelHeaders": { "items": { "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyHeader" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [ClarifyHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyheader.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LabelHeaders", "type": "array" }, "LabelIndex": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LabelIndex", "type": "number" }, "MaxPayloadInMB": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaxPayloadInMB", "type": "number" }, "MaxRecordCount": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MaxRecordCount", "type": "number" }, "ProbabilityAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProbabilityAttribute", "type": "string" }, "ProbabilityIndex": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProbabilityIndex", "type": "number" } }, @@ -168888,12 +174045,18 @@ "additionalProperties": false, "properties": { "MimeType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MimeType", "type": "string" }, "ShapBaseline": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ShapBaseline", "type": "string" }, "ShapBaselineUri": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ShapBaselineUri", "type": "string" } }, @@ -168903,18 +174066,28 @@ "additionalProperties": false, "properties": { "NumberOfSamples": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "NumberOfSamples", "type": "number" }, "Seed": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Seed", "type": "number" }, "ShapBaselineConfig": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyShapBaselineConfig" + "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyShapBaselineConfig", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [ClarifyShapBaselineConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyshapbaselineconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ShapBaselineConfig" }, "TextConfig": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyTextConfig" + "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyTextConfig", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ClarifyTextConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifytextconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TextConfig" }, "UseLogit": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "UseLogit", "type": "boolean" } }, @@ -168927,9 +174100,13 @@ "additionalProperties": false, "properties": { "Granularity": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Granularity", "type": "string" }, "Language": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Language", "type": "string" } }, @@ -168987,7 +174164,9 @@ "additionalProperties": false, "properties": { "ClarifyExplainerConfig": { - "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyExplainerConfig" + "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ClarifyExplainerConfig", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [ClarifyExplainerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyexplainerconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ClarifyExplainerConfig" } }, "type": "object" @@ -169001,6 +174180,8 @@ "type": "string" }, "ContainerStartupHealthCheckTimeoutInSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContainerStartupHealthCheckTimeoutInSeconds", "type": "number" }, "InitialInstanceCount": { @@ -169014,11 +174195,13 @@ "type": "number" }, "InstanceType": { - "markdownDescription": "The ML compute instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.c4.large | ml.c4.xlarge | ml.c5.18xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.c5d.18xlarge | ml.c5d.2xlarge | ml.c5d.4xlarge | ml.c5d.9xlarge | ml.c5d.large | ml.c5d.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.inf1.24xlarge | ml.inf1.2xlarge | ml.inf1.6xlarge | ml.inf1.xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.large | ml.m5d.xlarge | ml.p2.16xlarge | ml.p2.8xlarge | ml.p2.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.r5.12xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.large | ml.r5.xlarge | ml.r5d.12xlarge | ml.r5d.24xlarge | ml.r5d.2xlarge | ml.r5d.4xlarge | ml.r5d.large | ml.r5d.xlarge | ml.t2.2xlarge | ml.t2.large | ml.t2.medium | ml.t2.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ML compute instance type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.c4.large | ml.c4.xlarge | ml.c5.18xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.large | ml.c5.xlarge | ml.c5d.18xlarge | ml.c5d.2xlarge | ml.c5d.4xlarge | ml.c5d.9xlarge | ml.c5d.large | ml.c5d.xlarge | ml.c6g.12xlarge | ml.c6g.16xlarge | ml.c6g.2xlarge | ml.c6g.4xlarge | ml.c6g.8xlarge | ml.c6g.large | ml.c6g.xlarge | ml.c6gd.12xlarge | ml.c6gd.16xlarge | ml.c6gd.2xlarge | ml.c6gd.4xlarge | ml.c6gd.8xlarge | ml.c6gd.large | ml.c6gd.xlarge | ml.c6gn.12xlarge | ml.c6gn.16xlarge | ml.c6gn.2xlarge | ml.c6gn.4xlarge | ml.c6gn.8xlarge | ml.c6gn.large | ml.c6gn.xlarge | ml.c6i.12xlarge | ml.c6i.16xlarge | ml.c6i.24xlarge | ml.c6i.2xlarge | ml.c6i.32xlarge | ml.c6i.4xlarge | ml.c6i.8xlarge | ml.c6i.large | ml.c6i.xlarge | ml.c7g.12xlarge | ml.c7g.16xlarge | ml.c7g.2xlarge | ml.c7g.4xlarge | ml.c7g.8xlarge | ml.c7g.large | ml.c7g.xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.xlarge | ml.g5.12xlarge | ml.g5.16xlarge | ml.g5.24xlarge | ml.g5.2xlarge | ml.g5.48xlarge | ml.g5.4xlarge | ml.g5.8xlarge | ml.g5.xlarge | ml.inf1.24xlarge | ml.inf1.2xlarge | ml.inf1.6xlarge | ml.inf1.xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.large | ml.m5.xlarge | ml.m5d.12xlarge | ml.m5d.24xlarge | ml.m5d.2xlarge | ml.m5d.4xlarge | ml.m5d.large | ml.m5d.xlarge | ml.m6g.12xlarge | ml.m6g.16xlarge | ml.m6g.2xlarge | ml.m6g.4xlarge | ml.m6g.8xlarge | ml.m6g.large | ml.m6g.xlarge | ml.m6gd.12xlarge | ml.m6gd.16xlarge | ml.m6gd.2xlarge | ml.m6gd.4xlarge | ml.m6gd.8xlarge | ml.m6gd.large | ml.m6gd.xlarge | ml.p2.16xlarge | ml.p2.8xlarge | ml.p2.xlarge | ml.p3.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p4d.24xlarge | ml.p4de.24xlarge | ml.r5.12xlarge | ml.r5.24xlarge | ml.r5.2xlarge | ml.r5.4xlarge | ml.r5.large | ml.r5.xlarge | ml.r5d.12xlarge | ml.r5d.24xlarge | ml.r5d.2xlarge | ml.r5d.4xlarge | ml.r5d.large | ml.r5d.xlarge | ml.r6g.12xlarge | ml.r6g.16xlarge | ml.r6g.2xlarge | ml.r6g.4xlarge | ml.r6g.8xlarge | ml.r6g.large | ml.r6g.xlarge | ml.r6gd.12xlarge | ml.r6gd.16xlarge | ml.r6gd.2xlarge | ml.r6gd.4xlarge | ml.r6gd.8xlarge | ml.r6gd.large | ml.r6gd.xlarge | ml.t2.2xlarge | ml.t2.large | ml.t2.medium | ml.t2.xlarge` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, "ModelDataDownloadTimeoutInSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelDataDownloadTimeoutInSeconds", "type": "number" }, "ModelName": { @@ -169028,7 +174211,7 @@ }, "ServerlessConfig": { "$ref": "#/definitions/AWS::SageMaker::EndpointConfig.ServerlessConfig", - "markdownDescription": "The serverless configuration for an endpoint\\. Specifies a serverless endpoint configuration instead of an instance\\-based endpoint configuration\\. \nServerless Inference is in preview release for Amazon SageMaker and is subject to change\\. We do not recommend using this feature in production environments\\.\n*Required*: No \n*Type*: [ServerlessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-serverlessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The serverless configuration for an endpoint\\. Specifies a serverless endpoint configuration instead of an instance\\-based endpoint configuration\\. \n*Required*: No \n*Type*: [ServerlessConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-productionvariant-serverlessconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ServerlessConfig" }, "VariantName": { @@ -169037,6 +174220,8 @@ "type": "string" }, "VolumeSizeInGB": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "VolumeSizeInGB", "type": "number" } }, @@ -169051,7 +174236,7 @@ "additionalProperties": false, "properties": { "MaxConcurrency": { - "markdownDescription": "The maximum number of concurrent invocations your serverless endpoint can process\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `50` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum number of concurrent invocations your serverless endpoint can process\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Maximum*: `200` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaxConcurrency", "type": "number" }, @@ -169116,7 +174301,7 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.FeatureDefinition" }, - "markdownDescription": "A list of `Feature`s\\. Each `Feature` must include a `FeatureName` and a `FeatureType`\\. \nValid `FeatureType`s are `Integral`, `Fractional` and `String`\\. \n `FeatureName`s cannot be any of the following: `is_deleted`, `write_time`, `api_invocation_time`\\. \nYou can create up to 2,500 `FeatureDefinition`s per `FeatureGroup`\\. \n*Required*: Yes \n*Type*: List of [FeatureDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html) \n*Maximum*: `2500` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A list of `Feature`s\\. Each `Feature` must include a `FeatureName` and a `FeatureType`\\. \nValid `FeatureType`s are `Integral`, `Fractional` and `String`\\. \n `FeatureName`s cannot be any of the following: `is_deleted`, `write_time`, `api_invocation_time`\\. \nYou can create up to 2,500 `FeatureDefinition`s per `FeatureGroup`\\. \n*Required*: Yes \n*Type*: List of [FeatureDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-featuredefinition.html) \n*Maximum*: `2500` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FeatureDefinitions", "type": "array" }, @@ -169127,12 +174312,12 @@ }, "OfflineStoreConfig": { "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.OfflineStoreConfig", - "markdownDescription": "The configuration of an `OfflineStore`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The configuration of an `OfflineStore`\\. \n*Required*: No \n*Type*: [OfflineStoreConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-offlinestoreconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "OfflineStoreConfig" }, "OnlineStoreConfig": { "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.OnlineStoreConfig", - "markdownDescription": "The configuration of an `OnlineStore`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The configuration of an `OnlineStore`\\. \n*Required*: No \n*Type*: [OnlineStoreConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoreconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "OnlineStoreConfig" }, "RecordIdentifierFeatureName": { @@ -169187,12 +174372,18 @@ "additionalProperties": false, "properties": { "Catalog": { + "markdownDescription": "The name of the Glue table catalog\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Catalog", "type": "string" }, "Database": { + "markdownDescription": "The name of the Glue table database\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Database", "type": "string" }, "TableName": { + "markdownDescription": "The name of the Glue table\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableName", "type": "string" } }, @@ -169207,12 +174398,12 @@ "additionalProperties": false, "properties": { "FeatureName": { - "markdownDescription": "The name of a feature\\. The type must be a string\\. `FeatureName` cannot be any of the following: `is_deleted`, `write_time`, `api_invocation_time`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of a feature\\. The type must be a string\\. `FeatureName` cannot be any of the following: `is_deleted`, `write_time`, `api_invocation_time`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FeatureName", "type": "string" }, "FeatureType": { - "markdownDescription": "The value type of a feature\\. Valid values are Integral, Fractional, or String\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Fractional | Integral | String` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The value type of a feature\\. Valid values are Integral, Fractional, or String\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Fractional | Integral | String` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FeatureType", "type": "string" } @@ -169227,15 +174418,23 @@ "additionalProperties": false, "properties": { "DataCatalogConfig": { - "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.DataCatalogConfig" + "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.DataCatalogConfig", + "markdownDescription": "The meta data of the Glue table that is autogenerated when an `OfflineStore` is created\\. \n*Required*: No \n*Type*: [DataCatalogConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-datacatalogconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataCatalogConfig" }, "DisableGlueTableCreation": { + "markdownDescription": "Set to `True` to disable the automatic creation of an AWS Glue table when configuring an `OfflineStore`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DisableGlueTableCreation", "type": "boolean" }, "S3StorageConfig": { - "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.S3StorageConfig" + "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.S3StorageConfig", + "markdownDescription": "The Amazon Simple Storage \\(Amazon S3\\) location of `OfflineStore`\\. \n*Required*: Yes \n*Type*: [S3StorageConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-s3storageconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3StorageConfig" }, "TableFormat": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TableFormat", "type": "string" } }, @@ -169248,10 +174447,14 @@ "additionalProperties": false, "properties": { "EnableOnlineStore": { + "markdownDescription": "Turn `OnlineStore` off by specifying `False` for the `EnableOnlineStore` flag\\. Turn `OnlineStore` on by specifying `True` for the `EnableOnlineStore` flag\\. \nThe default value is `False`\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EnableOnlineStore", "type": "boolean" }, "SecurityConfig": { - "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.OnlineStoreSecurityConfig" + "$ref": "#/definitions/AWS::SageMaker::FeatureGroup.OnlineStoreSecurityConfig", + "markdownDescription": "Use to specify KMS Key ID \\(`KMSKeyId`\\) for at\\-rest encryption of your `OnlineStore`\\. \n*Required*: No \n*Type*: [OnlineStoreSecurityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-featuregroup-onlinestoresecurityconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SecurityConfig" } }, "type": "object" @@ -169260,6 +174463,8 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "The ID of the AWS Key Management Service \\(AWS KMS\\) key that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server\\-side encryption\\. \nThe caller \\(either IAM user or IAM role\\) of `CreateFeatureGroup` must have below permissions to the `OnlineStore` `KmsKeyId`: \n+ `\"kms:Encrypt\"` \n+ `\"kms:Decrypt\"` \n+ `\"kms:DescribeKey\"` \n+ `\"kms:CreateGrant\"` \n+ `\"kms:RetireGrant\"` \n+ `\"kms:ReEncryptFrom\"` \n+ `\"kms:ReEncryptTo\"` \n+ `\"kms:GenerateDataKey\"` \n+ `\"kms:ListAliases\"` \n+ `\"kms:ListGrants\"` \n+ `\"kms:RevokeGrant\"` \nThe caller \\(either user or IAM role\\) to all DataPlane operations \\(`PutRecord`, `GetRecord`, `DeleteRecord`\\) must have the following permissions to the `KmsKeyId`: \n+ `\"kms:Decrypt\"` \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" } }, @@ -169269,9 +174474,13 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "The AWS Key Management Service \\(KMS\\) key ID of the key used to encrypt any objects written into the `OfflineStore` S3 location\\. \nThe IAM `roleARN` that is passed as a parameter to `CreateFeatureGroup` must have below permissions to the `KmsKeyId`: \n+ `\"kms:GenerateDataKey\"` \n*Required*: No \n*Type*: String \n*Maximum*: `2048` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" }, "S3Uri": { + "markdownDescription": "The S3 URI, or location in Amazon S3, of `OfflineStore`\\. \nS3 URIs have a format similar to the following: `s3://example-bucket/prefix/`\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3Uri", "type": "string" } }, @@ -169576,7 +174785,7 @@ "title": "ImageConfig" }, "InferenceSpecificationName": { - "markdownDescription": "The inference specification name in the model package version\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The inference specification name in the model package version\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InferenceSpecificationName", "type": "string" }, @@ -169586,7 +174795,7 @@ "type": "string" }, "ModelDataUrl": { - "markdownDescription": "The S3 path where the model artifacts, which result from model training, are stored\\. This path must point to a single gzip compressed tar archive \\(\\.tar\\.gz suffix\\)\\. The S3 path is required for SageMaker built\\-in algorithms, but not if you use your own algorithms\\. For more information on built\\-in algorithms, see [Common Parameters](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html)\\. \nThe model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating\\.\nIf you provide a value for this parameter, SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide\\. AWS STS is activated in your IAM user account by default\\. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region\\. For more information, see [Activating and Deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the * AWS Identity and Access Management User Guide*\\. \nIf you use a built\\-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in `ModelDataUrl`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The S3 path where the model artifacts, which result from model training, are stored\\. This path must point to a single gzip compressed tar archive \\(\\.tar\\.gz suffix\\)\\. The S3 path is required for SageMaker built\\-in algorithms, but not if you use your own algorithms\\. For more information on built\\-in algorithms, see [Common Parameters](https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html)\\. \nThe model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating\\.\nIf you provide a value for this parameter, SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide\\. AWS STS is activated in your AWS account by default\\. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region\\. For more information, see [Activating and Deactivating AWS STS in an AWS Region](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the * AWS Identity and Access Management User Guide*\\. \nIf you use a built\\-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in `ModelDataUrl`\\.\n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ModelDataUrl", "type": "string" }, @@ -169723,6 +174932,8 @@ "additionalProperties": false, "properties": { "EndpointName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndpointName", "type": "string" }, "JobDefinitionName": { @@ -169813,36 +175024,58 @@ "additionalProperties": false, "properties": { "DataCapturedDestinationS3Uri": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataCapturedDestinationS3Uri", "type": "string" }, "DatasetFormat": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.DatasetFormat" + "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.DatasetFormat", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [DatasetFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-datasetformat.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatasetFormat" }, "EndTimeOffset": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EndTimeOffset", "type": "string" }, "FeaturesAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FeaturesAttribute", "type": "string" }, "InferenceAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InferenceAttribute", "type": "string" }, "LocalPath": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LocalPath", "type": "string" }, "ProbabilityAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProbabilityAttribute", "type": "string" }, "ProbabilityThresholdAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProbabilityThresholdAttribute", "type": "number" }, "S3DataDistributionType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3DataDistributionType", "type": "string" }, "S3InputMode": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3InputMode", "type": "string" }, "StartTimeOffset": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "StartTimeOffset", "type": "string" } }, @@ -169857,22 +175090,22 @@ "additionalProperties": false, "properties": { "InstanceCount": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The number of ML compute instances to use in the model monitoring job\\. For distributed processing jobs, specify a value greater than 1\\. The default value is 1\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceCount", "type": "number" }, "InstanceType": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The ML compute instance type for the processing job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceType", "type": "string" }, "VolumeKmsKeyId": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The AWS Key Management Service \\(AWS KMS\\) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance\\(s\\) that run the model monitoring job\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VolumeKmsKeyId", "type": "string" }, "VolumeSizeInGB": { - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The size of the ML storage volume, in gigabytes, that you want to provision\\. You must specify sufficient ML storage for your scenario\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VolumeSizeInGB", "type": "number" } @@ -169899,6 +175132,8 @@ "additionalProperties": false, "properties": { "Header": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Header", "type": "boolean" } }, @@ -169908,12 +175143,18 @@ "additionalProperties": false, "properties": { "Csv": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.Csv" + "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.Csv", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Csv](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-csv.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Csv" }, "Json": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.Json" + "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.Json", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-json.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Json" }, "Parquet": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Parquet", "type": "boolean" } }, @@ -169983,6 +175224,8 @@ "additionalProperties": false, "properties": { "Line": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Line", "type": "boolean" } }, @@ -169992,7 +175235,7 @@ "additionalProperties": false, "properties": { "ConfigUri": { - "markdownDescription": "JSON formatted S3 file that defines bias parameters\\. For more information on this JSON configuration file, see [Configure bias parameters](https://docs.aws.amazon.com/sagemaker/latest/json-bias-parameter-config.html)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "JSON formatted S3 file that defines bias parameters\\. For more information on this JSON configuration file, see [Configure bias parameters](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-bias-parameters.html)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ConfigUri", "type": "string" }, @@ -170039,11 +175282,13 @@ "additionalProperties": false, "properties": { "BatchTransformInput": { - "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.BatchTransformInput" + "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.BatchTransformInput", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [BatchTransformInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-batchtransforminput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BatchTransformInput" }, "EndpointInput": { "$ref": "#/definitions/AWS::SageMaker::ModelBiasJobDefinition.EndpointInput", - "markdownDescription": "Input object for the endpoint\\. \n*Required*: Yes \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Input object for the endpoint \n*Required*: No \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelbiasjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EndpointInput" }, "GroundTruthS3Input": { @@ -170171,7 +175416,7 @@ "additionalProperties": false, "properties": { "MaxRuntimeInSeconds": { - "markdownDescription": "The maximum length of time, in seconds, that a training or compilation job can run\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum length of time, in seconds, that a training or compilation job can run before it is stopped\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \nThe maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaxRuntimeInSeconds", "type": "number" } @@ -170243,27 +175488,41 @@ "additionalProperties": false, "properties": { "Content": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.Content" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.Content", + "markdownDescription": "The content of the model card\\. Content uses the [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema)\\. \n*Required*: Yes \n*Type*: [Content](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Content" }, "CreatedBy": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.UserContext" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.UserContext", + "markdownDescription": "Information about the user who created or modified one or more of the following: \n+ Experiment\n+ Trial\n+ Trial component\n+ Lineage group\n+ Project\n+ Model Card\n*Required*: No \n*Type*: [UserContext](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreatedBy" }, "LastModifiedBy": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.UserContext" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.UserContext", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [UserContext](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LastModifiedBy" }, "ModelCardName": { + "markdownDescription": "The unique name of the model card\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelCardName", "type": "string" }, "ModelCardStatus": { + "markdownDescription": "The approval status of the model card within your organization\\. Different organizations might have different criteria for model card review and approval\\. \n+ `Draft`: The model card is a work in progress\\.\n+ `PendingReview`: The model card is pending review\\.\n+ `Approved`: The model card is approved\\.\n+ `Archived`: The model card is archived\\. No more updates should be made to the model card, but it can still be exported\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `Approved | Archived | Draft | PendingReview` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelCardStatus", "type": "string" }, "SecurityConfig": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.SecurityConfig" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.SecurityConfig", + "markdownDescription": "The security configuration used to protect model card data\\. \n*Required*: No \n*Type*: [SecurityConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-securityconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SecurityConfig" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Key\\-value pairs used to manage metadata for the model card\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -170299,18 +175558,24 @@ "additionalProperties": false, "properties": { "CaveatsAndRecommendations": { + "markdownDescription": "Caveats and recommendations for those who might use this model in their applications\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CaveatsAndRecommendations", "type": "string" }, "CustomDetails": { "additionalProperties": true, + "markdownDescription": "Any additional information to document about the model\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "CustomDetails", "type": "object" }, "EthicalConsiderations": { + "markdownDescription": "Any ethical considerations documented by the model card author\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EthicalConsiderations", "type": "string" } }, @@ -170320,12 +175585,18 @@ "additionalProperties": false, "properties": { "BusinessProblem": { + "markdownDescription": "The specific business problem that the model is trying to solve\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BusinessProblem", "type": "string" }, "BusinessStakeholders": { + "markdownDescription": "The relevant stakeholders for the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BusinessStakeholders", "type": "string" }, "LineOfBusiness": { + "markdownDescription": "The broader business need that the model is serving\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LineOfBusiness", "type": "string" } }, @@ -170335,25 +175606,37 @@ "additionalProperties": false, "properties": { "AdditionalInformation": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.AdditionalInformation" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.AdditionalInformation", + "markdownDescription": "Additional information about the model\\. \n*Required*: No \n*Type*: [AdditionalInformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-additionalinformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalInformation" }, "BusinessDetails": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.BusinessDetails" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.BusinessDetails", + "markdownDescription": "Information about how the model supports business goals\\. \n*Required*: No \n*Type*: [BusinessDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-businessdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BusinessDetails" }, "EvaluationDetails": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.EvaluationDetail" }, + "markdownDescription": "An overview about the model's evaluation\\. \n*Required*: No \n*Type*: List of [EvaluationDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EvaluationDetails", "type": "array" }, "IntendedUses": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.IntendedUses" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.IntendedUses", + "markdownDescription": "The intended usage of the model\\. \n*Required*: No \n*Type*: [IntendedUses](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntendedUses" }, "ModelOverview": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.ModelOverview" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.ModelOverview", + "markdownDescription": "An overview about the model \n*Required*: No \n*Type*: [ModelOverview](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelOverview" }, "TrainingDetails": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingDetails" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingDetails", + "markdownDescription": "An overview about model training\\. \n*Required*: No \n*Type*: [TrainingDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingDetails" } }, "type": "object" @@ -170365,30 +175648,42 @@ "items": { "type": "string" }, + "markdownDescription": "The location of the datasets used to evaluate the model\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Datasets", "type": "array" }, "EvaluationJobArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the evaluation job\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EvaluationJobArn", "type": "string" }, "EvaluationObservation": { + "markdownDescription": "Any observations made during the model evaluation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EvaluationObservation", "type": "string" }, "Metadata": { "additionalProperties": true, + "markdownDescription": "Additional attributes associated with the evaluation results\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Metadata", "type": "object" }, "MetricGroups": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.MetricGroup" }, + "markdownDescription": "An evaluation Metric Group object\\. \n*Required*: No \n*Type*: List of [MetricGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricgroup.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetricGroups", "type": "array" }, "Name": { + "markdownDescription": "The evaluation job name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -170401,12 +175696,18 @@ "additionalProperties": false, "properties": { "Condition": { + "markdownDescription": "An optional description of any conditions of your objective function metric\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Condition", "type": "string" }, "Facet": { + "markdownDescription": "The metric of the model's objective function\\. For example, *loss* or *rmse*\\. The following list shows examples of the values that you can specify for the metric: \n+ `ACCURACY`\n+ `AUC`\n+ `LOSS`\n+ `MAE`\n+ `RMSE`\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Facet", "type": "string" }, "Function": { + "markdownDescription": "The optimization direction of the model's objective function\\. You must specify one of the following values: \n+ `Maximize`\n+ `Minimize`\n*Required*: No \n*Type*: [String](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-sagemaker-modelcard-function.html#aws-properties-sagemaker-modelcard-function) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Function", "type": "string" } }, @@ -170419,6 +175720,8 @@ "items": { "type": "string" }, + "markdownDescription": "The container used to run the inference environment\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContainerImage", "type": "array" } }, @@ -170428,18 +175731,28 @@ "additionalProperties": false, "properties": { "ExplanationsForRiskRating": { + "markdownDescription": "An explanation of why your organization categorizes the model with its risk rating\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExplanationsForRiskRating", "type": "string" }, "FactorsAffectingModelEfficiency": { + "markdownDescription": "Factors affecting model efficacy\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FactorsAffectingModelEfficiency", "type": "string" }, "IntendedUses": { + "markdownDescription": "The intended use cases for the model\\. \n*Required*: No \n*Type*: [String](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/#aws-properties-sagemaker-modelcard-intendeduses.html#aws-properties-sagemaker-modelcard-intendeduses) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IntendedUses", "type": "string" }, "PurposeOfModel": { + "markdownDescription": "The general purpose of the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PurposeOfModel", "type": "string" }, "RiskRating": { + "markdownDescription": "Your organization's risk rating\\. You can specify one the following values as the risk rating: \n+ High\n+ Medium\n+ Low\n+ Unknown\n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RiskRating", "type": "string" } }, @@ -170449,27 +175762,39 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The names of the metrics\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Notes": { + "markdownDescription": "Any notes to add to the metric\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Notes", "type": "string" }, "Type": { + "markdownDescription": "You must specify one of the following data types: \n+ Bar Chart \u2013 `bar_char`\n+ Boolean \u2013 `boolean`\n+ Linear Graph \u2013 `linear_graph`\n+ Matrix \u2013 `matrix`\n+ Number \u2013 `number`\n+ String \u2013 `string`\n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Type", "type": "string" }, "Value": { + "markdownDescription": "The datatype of the metric\\. The metric's *value* must be compatible with the metric's *type*\\. \n*Required*: Yes \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "object" }, "XAxisName": { "items": { "type": "string" }, + "markdownDescription": "The name of the x axis\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "XAxisName", "type": "array" }, "YAxisName": { "items": { "type": "string" }, + "markdownDescription": "The name of the y axis\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "YAxisName", "type": "array" } }, @@ -170487,9 +175812,13 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.MetricDataItems" }, + "markdownDescription": "A list of metric objects\\. The `MetricDataItems` list can have one of the following values: \n+ `bar_chart_metric`\n+ `matrix_metric`\n+ `simple_metric`\n+ `linear_graph_metric`\nFor more information about the metric schema, see the definition section of the [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema)\\. \n*Required*: Yes \n*Type*: List of [MetricDataItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricdataitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MetricData", "type": "array" }, "Name": { + "markdownDescription": "The metric group name\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -170503,36 +175832,56 @@ "additionalProperties": false, "properties": { "AlgorithmType": { + "markdownDescription": "The algorithm used to solve the problem\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AlgorithmType", "type": "string" }, "InferenceEnvironment": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.InferenceEnvironment" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.InferenceEnvironment", + "markdownDescription": "An overview about model inference\\. \n*Required*: No \n*Type*: [InferenceEnvironment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-inferenceenvironment.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InferenceEnvironment" }, "ModelArtifact": { "items": { "type": "string" }, + "markdownDescription": "The location of the model artifact\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelArtifact", "type": "array" }, "ModelCreator": { + "markdownDescription": "The creator of the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelCreator", "type": "string" }, "ModelDescription": { + "markdownDescription": "A description of the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelDescription", "type": "string" }, "ModelId": { + "markdownDescription": "The SageMaker Model ARN or non\\-SageMaker Model ID\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelId", "type": "string" }, "ModelName": { + "markdownDescription": "The name of the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelName", "type": "string" }, "ModelOwner": { + "markdownDescription": "The owner of the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelOwner", "type": "string" }, "ModelVersion": { + "markdownDescription": "The version of the model\\. \n*Required*: No \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelVersion", "type": "number" }, "ProblemType": { + "markdownDescription": "The problem being solved with the model\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ProblemType", "type": "string" } }, @@ -170542,9 +175891,13 @@ "additionalProperties": false, "properties": { "Function": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.Function" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.Function", + "markdownDescription": "A function object that details optimization direction, metric, and additional descriptions\\. \n*Required*: No \n*Type*: [Function](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-function.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Function" }, "Notes": { + "markdownDescription": "Notes about the object function, including other considerations for possible objective functions\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Notes", "type": "string" } }, @@ -170554,6 +175907,8 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "A AWS Key Management Service [key ID](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) used to encrypt a model card\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "KmsKeyId", "type": "string" } }, @@ -170563,12 +175918,18 @@ "additionalProperties": false, "properties": { "ObjectiveFunction": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.ObjectiveFunction" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.ObjectiveFunction", + "markdownDescription": "The function that is optimized during model training\\. \n*Required*: No \n*Type*: [ObjectiveFunction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-objectivefunction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObjectiveFunction" }, "TrainingJobDetails": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingJobDetails" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingJobDetails", + "markdownDescription": "Details about any associated training jobs\\. \n*Required*: No \n*Type*: [TrainingJobDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingjobdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingJobDetails" }, "TrainingObservations": { + "markdownDescription": "Any observations about training\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingObservations", "type": "string" } }, @@ -170581,6 +175942,8 @@ "items": { "type": "string" }, + "markdownDescription": "SageMaker inference image URI\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ContainerImage", "type": "array" } }, @@ -170590,9 +175953,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the hyper parameter\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Value": { + "markdownDescription": "The value specified for the hyper parameter\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -170609,36 +175976,50 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingHyperParameter" }, + "markdownDescription": "The hyper parameters used in the training job\\. \n*Required*: No \n*Type*: List of [TrainingHyperParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-traininghyperparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "HyperParameters", "type": "array" }, "TrainingArn": { + "markdownDescription": "The SageMaker training job Amazon Resource Name \\(ARN\\) \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingArn", "type": "string" }, "TrainingDatasets": { "items": { "type": "string" }, + "markdownDescription": "The location of the datasets used to train the model\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingDatasets", "type": "array" }, "TrainingEnvironment": { - "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingEnvironment" + "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingEnvironment", + "markdownDescription": "The SageMaker training job image URI\\. \n*Required*: No \n*Type*: [TrainingEnvironment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingenvironment.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingEnvironment" }, "TrainingMetrics": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingMetric" }, + "markdownDescription": "The SageMaker training job results\\. \n*Required*: No \n*Type*: List of [TrainingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TrainingMetrics", "type": "array" }, "UserProvidedHyperParameters": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingHyperParameter" }, + "markdownDescription": "Additional hyper parameters that you've specified when training the model\\. \n*Required*: No \n*Type*: List of [TrainingHyperParameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-traininghyperparameter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserProvidedHyperParameters", "type": "array" }, "UserProvidedTrainingMetrics": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelCard.TrainingMetric" }, + "markdownDescription": "Custom training job results\\. \n*Required*: No \n*Type*: List of [TrainingMetric](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingmetric.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserProvidedTrainingMetrics", "type": "array" } }, @@ -170648,12 +176029,18 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the result from the SageMaker training job\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Notes": { + "markdownDescription": "Any additional notes describing the result of the training job\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Notes", "type": "string" }, "Value": { + "markdownDescription": "The value of a result from the SageMaker training job\\. \n*Required*: Yes \n*Type*: Double \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "number" } }, @@ -170667,12 +176054,18 @@ "additionalProperties": false, "properties": { "DomainId": { + "markdownDescription": "The domain associated with the user\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DomainId", "type": "string" }, "UserProfileArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the user's profile\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserProfileArn", "type": "string" }, "UserProfileName": { + "markdownDescription": "The name of the user's profile\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "UserProfileName", "type": "string" } }, @@ -170714,6 +176107,8 @@ "additionalProperties": false, "properties": { "EndpointName": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EndpointName", "type": "string" }, "JobDefinitionName": { @@ -170758,7 +176153,7 @@ }, "StoppingCondition": { "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.StoppingCondition", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [StoppingCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-stoppingcondition.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "A time limit for how long the monitoring job is allowed to run before stopping\\. \n*Required*: No \n*Type*: [StoppingCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-stoppingcondition.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "StoppingCondition" }, "Tags": { @@ -170804,27 +176199,43 @@ "additionalProperties": false, "properties": { "DataCapturedDestinationS3Uri": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DataCapturedDestinationS3Uri", "type": "string" }, "DatasetFormat": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.DatasetFormat" + "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.DatasetFormat", + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: [DatasetFormat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-datasetformat.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DatasetFormat" }, "FeaturesAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FeaturesAttribute", "type": "string" }, "InferenceAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InferenceAttribute", "type": "string" }, "LocalPath": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "LocalPath", "type": "string" }, "ProbabilityAttribute": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProbabilityAttribute", "type": "string" }, "S3DataDistributionType": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3DataDistributionType", "type": "string" }, "S3InputMode": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3InputMode", "type": "string" } }, @@ -170881,6 +176292,8 @@ "additionalProperties": false, "properties": { "Header": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Header", "type": "boolean" } }, @@ -170890,12 +176303,18 @@ "additionalProperties": false, "properties": { "Csv": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.Csv" + "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.Csv", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Csv](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-csv.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Csv" }, "Json": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.Json" + "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.Json", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [Json](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-json.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Json" }, "Parquet": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Parquet", "type": "boolean" } }, @@ -170950,6 +176369,8 @@ "additionalProperties": false, "properties": { "Line": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Line", "type": "boolean" } }, @@ -170959,7 +176380,7 @@ "additionalProperties": false, "properties": { "ConfigUri": { - "markdownDescription": "JSON formatted S3 file that defines explainability parameters\\. For more information on this JSON configuration file, see [Configure model explainability parameters](https://docs.aws.amazon.com/sagemaker/latest/json-model-explainability-parameter-config.html)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "JSON formatted S3 file that defines explainability parameters\\. For more information on this JSON configuration file, see [Configure model explainability parameters](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-model-explainability-parameters.html)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ConfigUri", "type": "string" }, @@ -171006,11 +176427,13 @@ "additionalProperties": false, "properties": { "BatchTransformInput": { - "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.BatchTransformInput" + "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.BatchTransformInput", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [BatchTransformInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-batchtransforminput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "BatchTransformInput" }, "EndpointInput": { "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.EndpointInput", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: Yes \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [EndpointInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-endpointinput.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "EndpointInput" } }, @@ -171081,7 +176504,7 @@ }, "VpcConfig": { "$ref": "#/definitions/AWS::SageMaker::ModelExplainabilityJobDefinition.VpcConfig", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-vpcconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies a VPC that your training jobs and hosted models have access to\\. Control access to and from your training and model containers by configuring the VPC\\. \n*Required*: No \n*Type*: [VpcConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelexplainabilityjobdefinition-vpcconfig.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "VpcConfig" } }, @@ -171116,7 +176539,7 @@ "additionalProperties": false, "properties": { "MaxRuntimeInSeconds": { - "markdownDescription": "The maximum length of time, in seconds, that a training or compilation job can run\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The maximum length of time, in seconds, that a training or compilation job can run before it is stopped\\. \nFor compilation jobs, if the job does not complete during this time, a `TimeOut` error is generated\\. We recommend starting with 900 seconds and increasing as necessary based on your model\\. \nFor all other jobs, if the job does not complete during this time, SageMaker ends the job\\. When `RetryStrategy` is specified in the job request, `MaxRuntimeInSeconds` specifies the maximum time for all of the attempts in total, not each individual attempt\\. The default value is 1 day\\. The maximum value is 28 days\\. \nThe maximum time that a `TrainingJob` can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "MaxRuntimeInSeconds", "type": "number" } @@ -171188,109 +176611,165 @@ "additionalProperties": false, "properties": { "AdditionalInferenceSpecificationDefinition": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition", + "markdownDescription": "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 \n*Required*: No \n*Type*: [AdditionalInferenceSpecificationDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalInferenceSpecificationDefinition" }, "AdditionalInferenceSpecifications": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition" }, + "markdownDescription": "An array of additional Inference Specification objects\\. \n*Required*: No \n*Type*: List of [AdditionalInferenceSpecificationDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html) \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalInferenceSpecifications", "type": "array" }, "AdditionalInferenceSpecificationsToAdd": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelPackage.AdditionalInferenceSpecificationDefinition" }, + "markdownDescription": "An array of additional Inference Specification objects to be added to the existing array\\. The total number of additional Inference Specification objects cannot exceed 15\\. Each additional Inference Specification object specifies artifacts based on this model package that can be used on inference endpoints\\. Generally used with SageMaker Neo to store the compiled artifacts\\. \n*Required*: No \n*Type*: List of [AdditionalInferenceSpecificationDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-additionalinferencespecificationdefinition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AdditionalInferenceSpecificationsToAdd", "type": "array" }, "ApprovalDescription": { + "markdownDescription": "A description provided when the model approval is set\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ApprovalDescription", "type": "string" }, "CertifyForMarketplace": { + "markdownDescription": "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)\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertifyForMarketplace", "type": "boolean" }, "ClientToken": { + "markdownDescription": "A unique token that guarantees that the call to this API is idempotent\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ClientToken", "type": "string" }, "CreatedBy": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.UserContext" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.UserContext", + "markdownDescription": "Information about the user who created or modified an experiment, trial, trial component, lineage group, or project\\. \n*Required*: No \n*Type*: [UserContext](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-usercontext.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CreatedBy" }, "CustomerMetadataProperties": { "additionalProperties": true, + "markdownDescription": "The metadata properties for the model package\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "CustomerMetadataProperties", "type": "object" }, "Domain": { + "markdownDescription": "The machine learning domain of your model package and its components\\. Common machine learning domains include computer vision and natural language processing\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Domain", "type": "string" }, "DriftCheckBaselines": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckBaselines" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckBaselines", + "markdownDescription": "Represents the drift check baselines that can be used when the model monitor is set using the model package\\. \n*Required*: No \n*Type*: [DriftCheckBaselines](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckbaselines.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DriftCheckBaselines" }, "Environment": { "additionalProperties": true, + "markdownDescription": "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\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Environment", "type": "object" }, "InferenceSpecification": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.InferenceSpecification" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.InferenceSpecification", + "markdownDescription": "Defines how to perform inference generation after a training job is run\\. \n*Required*: No \n*Type*: [InferenceSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-inferencespecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "InferenceSpecification" }, "LastModifiedBy": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.UserContext" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.UserContext", + "markdownDescription": "Information about the user who created or modified an experiment, trial, trial component, lineage group, or project\\. \n*Required*: No \n*Type*: [UserContext](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-usercontext.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LastModifiedBy" }, "LastModifiedTime": { + "markdownDescription": "The last time the model package was modified\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LastModifiedTime", "type": "string" }, "MetadataProperties": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetadataProperties" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetadataProperties", + "markdownDescription": "Metadata properties of the tracking entity, trial, or trial component\\. \n*Required*: No \n*Type*: [MetadataProperties](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metadataproperties.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "MetadataProperties" }, "ModelApprovalStatus": { + "markdownDescription": "The approval status of the model\\. This can be one of the following values\\. \n+ `APPROVED` \\- The model is approved\n+ `REJECTED` \\- The model is rejected\\.\n+ `PENDING_MANUAL_APPROVAL` \\- The model is waiting for manual approval\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `Approved | PendingManualApproval | Rejected` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelApprovalStatus", "type": "string" }, "ModelMetrics": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelMetrics" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelMetrics", + "markdownDescription": "Metrics for the model\\. \n*Required*: No \n*Type*: [ModelMetrics](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelmetrics.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelMetrics" }, "ModelPackageDescription": { + "markdownDescription": "The description of the model package\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelPackageDescription", "type": "string" }, "ModelPackageGroupName": { + "markdownDescription": "The model group to which the model belongs\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelPackageGroupName", "type": "string" }, "ModelPackageName": { + "markdownDescription": "The name of the model\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelPackageName", "type": "string" }, "ModelPackageStatusDetails": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageStatusDetails" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageStatusDetails", + "markdownDescription": "Specifies the validation and image scan statuses of the model package\\. \n*Required*: No \n*Type*: [ModelPackageStatusDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagestatusdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelPackageStatusDetails" }, "ModelPackageStatusItem": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageStatusItem" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageStatusItem", + "markdownDescription": "Represents the overall status of a model package\\. \n*Required*: No \n*Type*: [ModelPackageStatusItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagestatusitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelPackageStatusItem" }, "ModelPackageVersion": { + "markdownDescription": "The version number of a versioned model\\. \n*Required*: No \n*Type*: Integer \n*Minimum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ModelPackageVersion", "type": "number" }, "SamplePayloadUrl": { + "markdownDescription": "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\\)\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SamplePayloadUrl", "type": "string" }, "SourceAlgorithmSpecification": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.SourceAlgorithmSpecification" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.SourceAlgorithmSpecification", + "markdownDescription": "A list of algorithms that were used to create a model package\\. \n*Required*: No \n*Type*: [SourceAlgorithmSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-sourcealgorithmspecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceAlgorithmSpecification" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "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*\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "Task": { + "markdownDescription": "The machine learning task your model package accomplishes\\. Common machine learning tasks include object detection and image classification\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Task", "type": "string" }, "ValidationSpecification": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ValidationSpecification" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ValidationSpecification", + "markdownDescription": "Specifies batch transform jobs that SageMaker runs to validate your model package\\. \n*Required*: No \n*Type*: [ValidationSpecification](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-validationspecification.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ValidationSpecification" } }, "type": "object" @@ -171322,36 +176801,50 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageContainerDefinition" }, + "markdownDescription": "The Amazon ECR registry path of the Docker image that contains the inference code\\. \n*Required*: Yes \n*Type*: List of [ModelPackageContainerDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html) \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Containers", "type": "array" }, "Description": { + "markdownDescription": "A description of the additional Inference specification \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "SupportedContentTypes": { "items": { "type": "string" }, + "markdownDescription": "The supported MIME types for the input data\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SupportedContentTypes", "type": "array" }, "SupportedRealtimeInferenceInstanceTypes": { "items": { "type": "string" }, + "markdownDescription": "A list of the instance types that are used to generate inferences in real\\-time\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SupportedRealtimeInferenceInstanceTypes", "type": "array" }, "SupportedResponseMIMETypes": { "items": { "type": "string" }, + "markdownDescription": "The supported MIME types for the output data\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SupportedResponseMIMETypes", "type": "array" }, "SupportedTransformInstanceTypes": { "items": { "type": "string" }, + "markdownDescription": "A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SupportedTransformInstanceTypes", "type": "array" } }, @@ -171365,13 +176858,19 @@ "additionalProperties": false, "properties": { "PostTrainingReport": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The post\\-training bias report for a model\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PostTrainingReport" }, "PreTrainingReport": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The pre\\-training bias report for a model\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PreTrainingReport" }, "Report": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The bias report for a model \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Report" } }, "type": "object" @@ -171380,7 +176879,9 @@ "additionalProperties": false, "properties": { "S3DataSource": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.S3DataSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.S3DataSource", + "markdownDescription": "The S3 location of the data source that is associated with a channel\\. \n*Required*: Yes \n*Type*: [S3DataSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-s3datasource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3DataSource" } }, "required": [ @@ -171392,16 +176893,24 @@ "additionalProperties": false, "properties": { "Bias": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckBias" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckBias", + "markdownDescription": "Represents the drift check bias baselines that can be used when the model monitor is set using the model package\\. \n*Required*: No \n*Type*: [DriftCheckBias](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckbias.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Bias" }, "Explainability": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckExplainability" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckExplainability", + "markdownDescription": "Represents the drift check explainability baselines that can be used when the model monitor is set using the model package\\. \n*Required*: No \n*Type*: [DriftCheckExplainability](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckexplainability.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Explainability" }, "ModelDataQuality": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckModelDataQuality" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckModelDataQuality", + "markdownDescription": "Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package\\. \n*Required*: No \n*Type*: [DriftCheckModelDataQuality](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckmodeldataquality.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelDataQuality" }, "ModelQuality": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckModelQuality" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.DriftCheckModelQuality", + "markdownDescription": "Represents the drift check model quality baselines that can be used when the model monitor is set using the model package\\. \n*Required*: No \n*Type*: [DriftCheckModelQuality](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-driftcheckmodelquality.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelQuality" } }, "type": "object" @@ -171410,13 +176919,19 @@ "additionalProperties": false, "properties": { "ConfigFile": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.FileSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.FileSource", + "markdownDescription": "The bias config file for a model\\. \n*Required*: No \n*Type*: [FileSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-filesource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConfigFile" }, "PostTrainingConstraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The post\\-training constraints\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PostTrainingConstraints" }, "PreTrainingConstraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The pre\\-training constraints\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PreTrainingConstraints" } }, "type": "object" @@ -171425,10 +176940,14 @@ "additionalProperties": false, "properties": { "ConfigFile": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.FileSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.FileSource", + "markdownDescription": "The explainability config file for the model\\. \n*Required*: No \n*Type*: [FileSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-filesource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ConfigFile" }, "Constraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The drift check explainability constraints\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Constraints" } }, "type": "object" @@ -171437,10 +176956,14 @@ "additionalProperties": false, "properties": { "Constraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The drift check model data quality constraints\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Constraints" }, "Statistics": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The drift check model data quality statistics\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Statistics" } }, "type": "object" @@ -171449,10 +176972,14 @@ "additionalProperties": false, "properties": { "Constraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The drift check model quality constraints\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Constraints" }, "Statistics": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The drift check model quality statistics\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Statistics" } }, "type": "object" @@ -171461,7 +176988,9 @@ "additionalProperties": false, "properties": { "Report": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "The explainability report for a model\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Report" } }, "type": "object" @@ -171470,12 +176999,18 @@ "additionalProperties": false, "properties": { "ContentDigest": { + "markdownDescription": "The digest of the file source\\. \n*Required*: No \n*Type*: String \n*Maximum*: `72` \n*Pattern*: `^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContentDigest", "type": "string" }, "ContentType": { + "markdownDescription": "The type of content stored in the file source\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContentType", "type": "string" }, "S3Uri": { + "markdownDescription": "The Amazon S3 URI for the file source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3Uri", "type": "string" } }, @@ -171491,30 +177026,40 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageContainerDefinition" }, + "markdownDescription": "The Amazon ECR registry path of the Docker image that contains the inference code\\. \n*Required*: Yes \n*Type*: List of [ModelPackageContainerDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagecontainerdefinition.html) \n*Maximum*: `15` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Containers", "type": "array" }, "SupportedContentTypes": { "items": { "type": "string" }, + "markdownDescription": "The supported MIME types for the input data\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SupportedContentTypes", "type": "array" }, "SupportedRealtimeInferenceInstanceTypes": { "items": { "type": "string" }, + "markdownDescription": "A list of the instance types that are used to generate inferences in real\\-time\\. \nThis parameter is required for unversioned models, and optional for versioned models\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SupportedRealtimeInferenceInstanceTypes", "type": "array" }, "SupportedResponseMIMETypes": { "items": { "type": "string" }, + "markdownDescription": "The supported MIME types for the output data\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SupportedResponseMIMETypes", "type": "array" }, "SupportedTransformInstanceTypes": { "items": { "type": "string" }, + "markdownDescription": "A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed\\. \nThis parameter is required for unversioned models, and optional for versioned models\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SupportedTransformInstanceTypes", "type": "array" } }, @@ -171529,15 +177074,23 @@ "additionalProperties": false, "properties": { "CommitId": { + "markdownDescription": "The commit ID\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CommitId", "type": "string" }, "GeneratedBy": { + "markdownDescription": "The entity this entity was generated by\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "GeneratedBy", "type": "string" }, "ProjectId": { + "markdownDescription": "The project ID\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProjectId", "type": "string" }, "Repository": { + "markdownDescription": "The repository\\. \n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Repository", "type": "string" } }, @@ -171547,12 +177100,18 @@ "additionalProperties": false, "properties": { "ContentDigest": { + "markdownDescription": "The hash key used for the metrics source\\. \n*Required*: No \n*Type*: String \n*Maximum*: `72` \n*Pattern*: `^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContentDigest", "type": "string" }, "ContentType": { + "markdownDescription": "The metric source content type\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ContentType", "type": "string" }, "S3Uri": { + "markdownDescription": "The S3 URI for the metrics source\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3Uri", "type": "string" } }, @@ -171566,10 +177125,14 @@ "additionalProperties": false, "properties": { "Constraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "Data quality constraints for a model\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Constraints" }, "Statistics": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "Data quality statistics for a model\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Statistics" } }, "type": "object" @@ -171578,6 +177141,8 @@ "additionalProperties": false, "properties": { "DataInputConfig": { + "markdownDescription": "The input configuration object for the model\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `[\\S\\s]+` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "DataInputConfig", "type": "string" } }, @@ -171590,16 +177155,24 @@ "additionalProperties": false, "properties": { "Bias": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.Bias" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.Bias", + "markdownDescription": "Metrics that measure bais in a model\\. \n*Required*: No \n*Type*: [Bias](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-bias.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Bias" }, "Explainability": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.Explainability" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.Explainability", + "markdownDescription": "Metrics that help explain a model\\. \n*Required*: No \n*Type*: [Explainability](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-explainability.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Explainability" }, "ModelDataQuality": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelDataQuality" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelDataQuality", + "markdownDescription": "Metrics that measure the quality of the input data for a model\\. \n*Required*: No \n*Type*: [ModelDataQuality](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modeldataquality.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelDataQuality" }, "ModelQuality": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelQuality" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelQuality", + "markdownDescription": "Metrics that measure the quality of a model\\. \n*Required*: No \n*Type*: [ModelQuality](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelquality.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ModelQuality" } }, "type": "object" @@ -171608,39 +177181,59 @@ "additionalProperties": false, "properties": { "ContainerHostname": { + "markdownDescription": "The DNS host name for the Docker container\\. \n*Required*: No \n*Type*: String \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "ContainerHostname", "type": "string" }, "Environment": { "additionalProperties": true, + "markdownDescription": "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\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "string" } }, + "title": "Environment", "type": "object" }, "Framework": { + "markdownDescription": "The machine learning framework of the model package container image\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "Framework", "type": "string" }, "FrameworkVersion": { + "markdownDescription": "The framework version of the Model Package Container Image\\. \n*Required*: No \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `10` \n*Pattern*: `[0-9]\\.[A-Za-z0-9.-]+` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "FrameworkVersion", "type": "string" }, "Image": { + "markdownDescription": "The Amazon EC2 Container Registry \\(Amazon ECR\\) path where inference code is stored\\. \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)\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Pattern*: `[\\S]+` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "Image", "type": "string" }, "ImageDigest": { + "markdownDescription": "An MD5 hash of the training algorithm that identifies the Docker image used for training\\. \n*Required*: No \n*Type*: String \n*Maximum*: `72` \n*Pattern*: `^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "ImageDigest", "type": "string" }, "ModelDataUrl": { + "markdownDescription": "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\\)\\. \nThe model artifacts must be in an S3 bucket that is in the same region as the model package\\.\n*Required*: No \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^(https|s3)://([^/]+)/?(.*)$` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "ModelDataUrl", "type": "string" }, "ModelInput": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelInput" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelInput", + "markdownDescription": "A structure with Model Input details\\. \n*Required*: No \n*Type*: [ModelInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelinput.html) \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "ModelInput" }, "NearestModelName": { + "markdownDescription": "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`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "NearestModelName", "type": "string" }, "ProductId": { + "markdownDescription": "The AWS Marketplace product ID of the model package\\. \n*Required*: No \n*Type*: String \n*Maximum*: `256` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$` \n*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)", + "title": "ProductId", "type": "string" } }, @@ -171656,12 +177249,16 @@ "items": { "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageStatusItem" }, + "markdownDescription": "The status of the scan of the Docker image container for the model package\\. \n*Required*: No \n*Type*: List of [ModelPackageStatusItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagestatusitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImageScanStatuses", "type": "array" }, "ValidationStatuses": { "items": { "$ref": "#/definitions/AWS::SageMaker::ModelPackage.ModelPackageStatusItem" }, + "markdownDescription": "The validation status of the model package\\. \n*Required*: Yes \n*Type*: List of [ModelPackageStatusItem](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-modelpackagestatusitem.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ValidationStatuses", "type": "array" } }, @@ -171674,12 +177271,18 @@ "additionalProperties": false, "properties": { "FailureReason": { + "markdownDescription": "if the overall status is `Failed`, the reason for the failure\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "FailureReason", "type": "string" }, "Name": { + "markdownDescription": "The name of the model package for which the overall status is being reported\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `63` \n*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Status": { + "markdownDescription": "The current status\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `Completed | Failed | InProgress | NotStarted` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" } }, @@ -171693,10 +177296,14 @@ "additionalProperties": false, "properties": { "Constraints": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "Model quality constraints\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Constraints" }, "Statistics": { - "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource" + "$ref": "#/definitions/AWS::SageMaker::ModelPackage.MetricsSource", + "markdownDescription": "Model quality statistics\\. \n*Required*: No \n*Type*: [MetricsSource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelpackage-metricssource.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Statistics" } }, "type": "object" @@ -171705,9 +177312,13 @@ "additionalProperties": false, "properties": { "S3DataType": { + "markdownDescription": "If you choose `S3Prefix`, `S3Uri` identifies a key name prefix\\. SageMaker uses all objects that match the specified key name prefix for model training\\. \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\\. \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`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `AugmentedManifestFile | ManifestFile | S3Prefix` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3DataType", "type": "string" }, "S3Uri": { + "markdownDescription": "Depending on the value specified for the `S3DataType`, identifies either a key name prefix or a manifest\\. For example: \n+ A key name prefix might look like this: `s3://bucketname/exampleprefix` \n+ A manifest might look like this: `s3://bucketname/example.manifest`", + "title": "S3Uri", "type": "string" } }, @@ -171721,9 +177332,13 @@ "additionalProperties": false, "properties": { "AlgorithmName": { + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `170` \n*Pattern*: `(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(? Type](https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type)\\.\n+ You can use this value to update an existing instance\\.\n+ To register a new instance, you must specify a value that's unique among instances that you register by using the same service\\. \n+ If you specify an existing `InstanceId` and `ServiceId`, AWS Cloud Map updates the existing DNS records, if any\\. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one\\. \n**Note** \nThe health check isn't deleted immediately, so it will still appear for a while if you submit a `ListHealthChecks` request, for example\\.\n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Pattern*: `^[0-9a-zA-Z_/:.@-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "An identifier that you want to associate with the instance\\. Note the following: \n+ If the service that's specified by `ServiceId` includes settings for an `SRV` record, the value of `InstanceId` is automatically included as part of the value for the `SRV` record\\. For more information, see [DnsRecord > Type](https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type)\\.\n+ You can use this value to update an existing instance\\.\n+ To register a new instance, you must specify a value that's unique among instances that you register by using the same service\\. \n+ If you specify an existing `InstanceId` and `ServiceId`, AWS Cloud Map updates the existing DNS records, if any\\. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one\\. \n**Note** \nThe health check isn't deleted immediately, so it will still appear for a while if you submit a `ListHealthChecks` request, for example\\.\nDo not include sensitive information in `InstanceId` if the namespace is discoverable by public DNS queries and any `Type` member of `DnsRecord` for the service contains `SRV` because the `InstanceId` is discoverable by public DNS queries\\.\n*Required*: No \n*Type*: String \n*Maximum*: `64` \n*Pattern*: `^[0-9a-zA-Z_/:.@-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "InstanceId", "type": "string" }, @@ -177328,7 +183249,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The name that you want to assign to this namespace\\. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route\u00a053 private hosted zone that has the same name as the namespace\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^[!-~]{1,1024}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name that you want to assign to this namespace\\. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route\u00a053 private hosted zone that has the same name as the namespace\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^[!-~]{1,253}$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -177452,7 +183373,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The name that you want to assign to this namespace\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name that you want to assign to this namespace\\. \nDo not include sensitive information in the name\\. The name is publicly available using DNS queries\\.\n*Required*: Yes \n*Type*: String \n*Maximum*: `253` \n*Pattern*: `^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -177571,7 +183492,7 @@ }, "DnsConfig": { "$ref": "#/definitions/AWS::ServiceDiscovery::Service.DnsConfig", - "markdownDescription": "A complex type that contains information about the Route\u00a053 DNS records that you want AWS Cloud Map to create when you register an instance\\. \n*Required*: No \n*Type*: [DnsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A complex type that contains information about the Route\u00a053 DNS records that you want AWS Cloud Map to create when you register an instance\\. \nThe record types of a service can only be changed by deleting the service and recreating it with a new `Dnsconfig`\\.\n*Required*: No \n*Type*: [DnsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "DnsConfig" }, "HealthCheckConfig": { @@ -177934,13 +183855,19 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the simulation\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "RoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS Identity and Access Management \\(IAM\\) role that the simulation assumes to perform actions\\. For more information about ARNs, see [Amazon Resource Names \\(ARNs\\)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference*\\. For more information about IAM roles, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *AWS Identity and Access Management User Guide*\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RoleArn", "type": "string" }, "SchemaS3Location": { - "$ref": "#/definitions/AWS::SimSpaceWeaver::Simulation.S3Location" + "$ref": "#/definitions/AWS::SimSpaceWeaver::Simulation.S3Location", + "markdownDescription": "The location of the simulation schema in Amazon Simple Storage Service \\(Amazon S3\\)\\. For more information about Amazon S3, see the [https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html)\\. \n*Required*: No \n*Type*: [S3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-simspaceweaver-simulation-s3location.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SchemaS3Location" } }, "type": "object" @@ -177969,9 +183896,13 @@ "additionalProperties": false, "properties": { "BucketName": { + "markdownDescription": "The name of an Amazon S3 bucket\\. For more information about buckets, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the *Amazon Simple Storage Service User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketName", "type": "string" }, "ObjectKey": { + "markdownDescription": "The key name of an object in Amazon S3\\. For more information about Amazon S3 objects and object keys, see [Uploading, downloading, and working with objects in Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html) in the *Amazon Simple Storage Service User Guide*\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObjectKey", "type": "string" } }, @@ -178112,7 +184043,7 @@ "additionalProperties": false, "properties": { "Definition": { - "markdownDescription": "The Amazon States Language definition of the state machine\\. The state machine definition must be in JSON or YAML, and the format of the object must match the format of your AWS Step Functions template file\\. See [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html)\\. \n*Required*: No \n*Type*: [Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-definition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon States Language definition of the state machine\\. The state machine definition must be in JSON or YAML, and the format of the object must match the format of your AWS Step Functions template file\\. See [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Definition", "type": "object" }, @@ -178128,7 +184059,7 @@ }, "DefinitionSubstitutions": { "additionalProperties": true, - "markdownDescription": "A map \\(string to string\\) that specifies the mappings for placeholder variables in the state machine definition\\. This enables the customer to inject values obtained at runtime, for example from intrinsic functions, in the state machine definition\\. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key\\-value map\\. \n*Required*: No \n*Type*: Map of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A map \\(string to string\\) that specifies the mappings for placeholder variables in the state machine definition\\. This enables the customer to inject values obtained at runtime, for example from intrinsic functions, in the state machine definition\\. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key\\-value map\\. \n*Required*: No \n*Type*: Map of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "patternProperties": { "^[a-zA-Z0-9]+$": { "type": "object" @@ -178335,6 +184266,8 @@ "additionalProperties": false, "properties": { "AccountAlias": { + "markdownDescription": "An alias or short name for an AWS account\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccountAlias", "type": "string" } }, @@ -178400,27 +184333,43 @@ "additionalProperties": false, "properties": { "ChannelId": { + "markdownDescription": "The channel ID in Slack\\. This ID identifies a channel within a Slack workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ChannelId", "type": "string" }, "ChannelName": { + "markdownDescription": "The channel name in Slack\\. This is the channel where you invite the AWS Support App\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ChannelName", "type": "string" }, "ChannelRoleArn": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IAM role for this Slack channel configuration\\. The AWS Support App uses this role to perform AWS Support and Service Quotas actions on your behalf\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ChannelRoleArn", "type": "string" }, "NotifyOnAddCorrespondenceToCase": { + "markdownDescription": "Whether to get notified when a correspondence is added to your support cases\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotifyOnAddCorrespondenceToCase", "type": "boolean" }, "NotifyOnCaseSeverity": { + "markdownDescription": "The case severity for your support cases that you want to receive notifications\\. You can specify `none`, `all`, or `high`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotifyOnCaseSeverity", "type": "string" }, "NotifyOnCreateOrReopenCase": { + "markdownDescription": "Whether to get notified when your support cases are created or reopened \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotifyOnCreateOrReopenCase", "type": "boolean" }, "NotifyOnResolveCase": { + "markdownDescription": "Whether to get notified when your support cases are resolved\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "NotifyOnResolveCase", "type": "boolean" }, "TeamId": { + "markdownDescription": "The team ID in Slack\\. This ID uniquely identifies a Slack workspace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TeamId", "type": "string" } }, @@ -178489,9 +184438,13 @@ "additionalProperties": false, "properties": { "TeamId": { + "markdownDescription": "The team ID in Slack\\. This ID uniquely identifies a Slack workspace, such as `T012ABCDEFG`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TeamId", "type": "string" }, "VersionId": { + "markdownDescription": "An identifier used to update an existing Slack workspace configuration in AWS CloudFormation, such as `100`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "VersionId", "type": "string" } }, @@ -178572,6 +184525,8 @@ "title": "Code" }, "DeleteLambdaResourcesOnCanaryDeletion": { + "markdownDescription": "Specifies whether AWS CloudFormation is to also delete the Lambda functions and layers used by this canary, when the canary is deleted\\. The default is false\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DeleteLambdaResourcesOnCanaryDeletion", "type": "boolean" }, "ExecutionRoleArn": { @@ -178888,18 +184843,24 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "A name for the group\\. It can include any Unicode characters\\. \nThe names for all groups in your account, across all Regions, must be unique\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "ResourceArns": { "items": { "type": "string" }, + "markdownDescription": "The ARNs of the canaries that you want to associate with this group\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResourceArns", "type": "array" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The list of key\\-value pairs that are associated with the group\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -178929,6 +184890,114 @@ ], "type": "object" }, + "AWS::SystemsManagerSAP::Application": { + "additionalProperties": false, + "properties": { + "Condition": { + "type": "string" + }, + "DeletionPolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + }, + "DependsOn": { + "anyOf": [ + { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + { + "items": { + "pattern": "^[a-zA-Z0-9]+$", + "type": "string" + }, + "type": "array" + } + ] + }, + "Metadata": { + "type": "object" + }, + "Properties": { + "additionalProperties": false, + "properties": { + "ApplicationId": { + "type": "string" + }, + "ApplicationType": { + "type": "string" + }, + "Credentials": { + "items": { + "$ref": "#/definitions/AWS::SystemsManagerSAP::Application.Credential" + }, + "type": "array" + }, + "Instances": { + "items": { + "type": "string" + }, + "type": "array" + }, + "SapInstanceNumber": { + "type": "string" + }, + "Sid": { + "type": "string" + }, + "Tags": { + "items": { + "$ref": "#/definitions/Tag" + }, + "type": "array" + } + }, + "required": [ + "ApplicationId", + "ApplicationType" + ], + "type": "object" + }, + "Type": { + "enum": [ + "AWS::SystemsManagerSAP::Application" + ], + "type": "string" + }, + "UpdateReplacePolicy": { + "enum": [ + "Delete", + "Retain", + "Snapshot" + ], + "type": "string" + } + }, + "required": [ + "Type", + "Properties" + ], + "type": "object" + }, + "AWS::SystemsManagerSAP::Application.Credential": { + "additionalProperties": false, + "properties": { + "CredentialType": { + "type": "string" + }, + "DatabaseName": { + "type": "string" + }, + "SecretId": { + "type": "string" + } + }, + "type": "object" + }, "AWS::Timestream::Database": { "additionalProperties": false, "properties": { @@ -179469,7 +185538,9 @@ "additionalProperties": false, "properties": { "S3Configuration": { - "$ref": "#/definitions/AWS::Timestream::Table.S3Configuration" + "$ref": "#/definitions/AWS::Timestream::Table.S3Configuration", + "markdownDescription": "Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes\\. \n*Required*: No \n*Type*: [S3Configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-s3configuration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "S3Configuration" } }, "type": "object" @@ -179478,10 +185549,14 @@ "additionalProperties": false, "properties": { "EnableMagneticStoreWrites": { + "markdownDescription": "A flag to enable magnetic store writes\\. \n*Required*: Yes \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EnableMagneticStoreWrites", "type": "boolean" }, "MagneticStoreRejectedDataLocation": { - "$ref": "#/definitions/AWS::Timestream::Table.MagneticStoreRejectedDataLocation" + "$ref": "#/definitions/AWS::Timestream::Table.MagneticStoreRejectedDataLocation", + "markdownDescription": "The location to write error reports for records rejected asynchronously during magnetic store writes\\. \n*Required*: No \n*Type*: [MagneticStoreRejectedDataLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-magneticstorerejecteddatalocation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MagneticStoreRejectedDataLocation" } }, "required": [ @@ -179493,9 +185568,13 @@ "additionalProperties": false, "properties": { "MagneticStoreRetentionPeriodInDays": { + "markdownDescription": "The duration for which data must be stored in the magnetic store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MagneticStoreRetentionPeriodInDays", "type": "string" }, "MemoryStoreRetentionPeriodInHours": { + "markdownDescription": "The duration for which data must be stored in the memory store\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MemoryStoreRetentionPeriodInHours", "type": "string" } }, @@ -179505,15 +185584,23 @@ "additionalProperties": false, "properties": { "BucketName": { + "markdownDescription": "The bucket name of the customer S3 bucket\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `3` \n*Maximum*: `63` \n*Pattern*: `[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BucketName", "type": "string" }, "EncryptionOption": { + "markdownDescription": "The encryption option for the customer S3 location\\. Options are S3 server\\-side encryption with an S3 managed key or AWS managed key\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `SSE_KMS | SSE_S3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionOption", "type": "string" }, "KmsKeyId": { + "markdownDescription": "The AWS KMS key ID for the customer S3 location when encrypting with an AWS managed key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2048` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" }, "ObjectKeyPrefix": { + "markdownDescription": "The object key preview for the customer S3 location\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `928` \n*Pattern*: `[a-zA-Z0-9|!\\-_*'\\(\\)]([a-zA-Z0-9]|[!\\-_*'\\(\\)\\/.])+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ObjectKeyPrefix", "type": "string" } }, @@ -179559,30 +185646,46 @@ "additionalProperties": false, "properties": { "AccessRole": { + "markdownDescription": "With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths`\\. We use the file\u2019s parent directory \\(for example, for `--send-file-paths /bucket/dir/file.txt`, parent directory is `/bucket/dir/`\\) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission\\. So, the `AccessRole` needs to provide read and write access to the parent directory of the file location used in the `StartFileTransfer` request\\. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with `StartFileTransfer`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessRole", "type": "string" }, "BaseDirectory": { + "markdownDescription": "The landing directory \\(folder\\) for files that are transferred by using the AS2 protocol\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `1024` \n*Pattern*: `^$|/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BaseDirectory", "type": "string" }, "Description": { + "markdownDescription": "The name or short description that's used to identify the agreement\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `200` \n*Pattern*: `^[\\p{Graph}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "LocalProfileId": { + "markdownDescription": "A unique identifier for the AS2 local profile\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `19` \n*Maximum*: `19` \n*Pattern*: `^p-([0-9a-f]{17})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LocalProfileId", "type": "string" }, "PartnerProfileId": { + "markdownDescription": "A unique identifier for the partner profile used in the agreement\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `19` \n*Maximum*: `19` \n*Pattern*: `^p-([0-9a-f]{17})$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PartnerProfileId", "type": "string" }, "ServerId": { + "markdownDescription": "A system\\-assigned unique identifier for a server instance\\. This identifier indicates the specific server that the agreement uses\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `19` \n*Maximum*: `19` \n*Pattern*: `^s-([0-9a-f]{17})$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ServerId", "type": "string" }, "Status": { + "markdownDescription": "The current status of the agreement, either `ACTIVE` or `INACTIVE`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ACTIVE | INACTIVE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Status", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Key\\-value pairs that can be used to group and search for agreements\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -179652,30 +185755,46 @@ "additionalProperties": false, "properties": { "ActiveDate": { + "markdownDescription": "An optional date that specifies when the certificate becomes active\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActiveDate", "type": "string" }, "Certificate": { + "markdownDescription": "The file name for the certificate\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `16384` \n*Pattern*: `^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Certificate", "type": "string" }, "CertificateChain": { + "markdownDescription": "The list of certificates that make up the chain for the certificate\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `2097152` \n*Pattern*: `^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "CertificateChain", "type": "string" }, "Description": { + "markdownDescription": "The name or description that's used to identity the certificate\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `200` \n*Pattern*: `^[\\p{Graph}]+` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "InactiveDate": { + "markdownDescription": "An optional date that specifies when the certificate becomes inactive\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InactiveDate", "type": "string" }, "PrivateKey": { + "markdownDescription": "The file that contains the private key for the certificate that's being imported\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PrivateKey", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Key\\-value pairs that can be used to group and search for certificates\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "Usage": { + "markdownDescription": "Specifies whether this certificate is used for signing or encryption\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ENCRYPTION | SIGNING` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Usage", "type": "string" } }, @@ -179742,21 +185861,31 @@ "additionalProperties": false, "properties": { "AccessRole": { + "markdownDescription": "With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths`\\. We use the file\u2019s parent directory \\(for example, for `--send-file-paths /bucket/dir/file.txt`, parent directory is `/bucket/dir/`\\) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission\\. So, the `AccessRole` needs to provide read and write access to the parent directory of the file location used in the `StartFileTransfer` request\\. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with `StartFileTransfer`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AccessRole", "type": "string" }, "As2Config": { - "$ref": "#/definitions/AWS::Transfer::Connector.As2Config" + "$ref": "#/definitions/AWS::Transfer::Connector.As2Config", + "markdownDescription": "A structure that contains the parameters for a connector object\\. \n*Required*: Yes \n*Type*: [As2Config](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-connector-as2config.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "As2Config" }, "LoggingRole": { + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS Identity and Access Management \\(IAM\\) role that allows a connector to turn on CloudWatch logging for Amazon S3 events\\. When set, you can view connector activity in your CloudWatch logs\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LoggingRole", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Key\\-value pairs that can be used to group and search for connectors\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" }, "Url": { + "markdownDescription": "The URL of the partner's AS2 endpoint\\. \n*Required*: Yes \n*Type*: String \n*Maximum*: `255` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Url", "type": "string" } }, @@ -179792,27 +185921,43 @@ "additionalProperties": false, "properties": { "Compression": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Compression", "type": "string" }, "EncryptionAlgorithm": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "EncryptionAlgorithm", "type": "string" }, "LocalProfileId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LocalProfileId", "type": "string" }, "MdnResponse": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MdnResponse", "type": "string" }, "MdnSigningAlgorithm": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MdnSigningAlgorithm", "type": "string" }, "MessageSubject": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MessageSubject", "type": "string" }, "PartnerProfileId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PartnerProfileId", "type": "string" }, "SigningAlgorithm": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SigningAlgorithm", "type": "string" } }, @@ -179854,21 +185999,29 @@ "additionalProperties": false, "properties": { "As2Id": { + "markdownDescription": "The `As2Id` is the *AS2\\-name*, as defined in the [RFC 4130](https://datatracker.ietf.org/doc/html/rfc4130)\\. For inbound transfers, this is the `AS2-From` header for the AS2 messages sent from the partner\\. For outbound connectors, this is the `AS2-To` header for the AS2 messages sent to the partner using the `StartFileTransfer` API operation\\. This ID cannot include spaces\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\p{Print}\\s]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "As2Id", "type": "string" }, "CertificateIds": { "items": { "type": "string" }, + "markdownDescription": "An array of identifiers for the imported certificates\\. You use this identifier for working with profiles and partner profiles\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CertificateIds", "type": "array" }, "ProfileType": { + "markdownDescription": "Indicates whether to list only `LOCAL` type profiles or only `PARTNER` type profiles\\. If not supplied in the request, the command lists all types of profiles\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `LOCAL | PARTNER` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "ProfileType", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "Key\\-value pairs that can be used to group and search for profiles\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Maximum*: `50` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -179946,7 +186099,7 @@ }, "EndpointDetails": { "$ref": "#/definitions/AWS::Transfer::Server.EndpointDetails", - "markdownDescription": "The virtual private cloud \\(VPC\\) endpoint settings that are configured for your server\\. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet\\. Your VPC's default security groups are automatically assigned to your endpoint\\. \n*Required*: No \n*Type*: [EndpointDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The virtual private cloud \\(VPC\\) endpoint settings that are configured for your server\\. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet\\. Your VPC's default security groups are automatically assigned to your endpoint\\. \n*Required*: No \n*Type*: [EndpointDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "EndpointDetails" }, "EndpointType": { @@ -179960,35 +186113,35 @@ "title": "IdentityProviderDetails" }, "IdentityProviderType": { - "markdownDescription": "Specifies the mode of authentication for a server\\. The default value is `SERVICE_MANAGED`, which allows you to store and access user credentials within the AWS Transfer Family service\\. \nUse `AWS_DIRECTORY_SERVICE` to provide access to Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your on\\-premises environment or in AWS using AD Connectors\\. This option also requires you to provide a Directory ID using the `IdentityProviderDetails` parameter\\. \nUse the `API_GATEWAY` value to integrate with an identity provider of your choosing\\. The `API_GATEWAY` setting requires you to provide an API Gateway endpoint URL to call for authentication using the `IdentityProviderDetails` parameter\\. \nUse the `AWS_LAMBDA` value to directly use a Lambda function as your identity provider\\. If you choose this value, you must specify the ARN for the lambda function in the `Function` parameter for the `IdentityProviderDetails` data type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA | SERVICE_MANAGED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The mode of authentication for a server\\. The default value is `SERVICE_MANAGED`, which allows you to store and access user credentials within the AWS Transfer Family service\\. \nUse `AWS_DIRECTORY_SERVICE` to provide access to Active Directory groups in AWS Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on\\-premises environment or in AWS using AD Connector\\. This option also requires you to provide a Directory ID by using the `IdentityProviderDetails` parameter\\. \nUse the `API_GATEWAY` value to integrate with an identity provider of your choosing\\. The `API_GATEWAY` setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the `IdentityProviderDetails` parameter\\. \nUse the `AWS_LAMBDA` value to directly use an AWS Lambda function as your identity provider\\. If you choose this value, you must specify the ARN for the Lambda function in the `Function` parameter or the `IdentityProviderDetails` data type\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA | SERVICE_MANAGED` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "IdentityProviderType", "type": "string" }, "LoggingRole": { - "markdownDescription": "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\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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 EFSevents\\. When set, you can view user activity in your CloudWatch logs\\. \n*Required*: No \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoggingRole", "type": "string" }, "PostAuthenticationLoginBanner": { - "markdownDescription": "Specify a string to display when users connect to a server\\. This string is displayed after the user authenticates\\. \nThe SFTP protocol does not support post\\-authentication display banners\\.\n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\x09-\\x0D\\x20-\\x7E]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies a string to display when users connect to a server\\. This string is displayed after the user authenticates\\. \nThe SFTP protocol does not support post\\-authentication display banners\\.\n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\x09-\\x0D\\x20-\\x7E]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PostAuthenticationLoginBanner", "type": "string" }, "PreAuthenticationLoginBanner": { - "markdownDescription": "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 `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.` \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\x09-\\x0D\\x20-\\x7E]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies 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 `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.` \n*Required*: No \n*Type*: String \n*Maximum*: `512` \n*Pattern*: `[\\x09-\\x0D\\x20-\\x7E]*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PreAuthenticationLoginBanner", "type": "string" }, "ProtocolDetails": { "$ref": "#/definitions/AWS::Transfer::Server.ProtocolDetails", - "markdownDescription": "The protocol settings that are configured for your server\\. \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\\. \nUse the `TlsSessionResumptionMode` parameter to determine whether or not your Transfer server resumes recent, negotiated sessions through a unique session ID\\. \n*Required*: No \n*Type*: [ProtocolDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The protocol settings that are configured for your server\\. \n+ To indicate passive mode \\(for FTP and FTPS protocols\\), use the `PassiveIp` parameter\\. Enter a single dotted\\-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer\\. \n+ To ignore the error that is generated when the client attempts to use the `SETSTAT` command on a file that you are uploading to an Amazon S3 bucket, use the `SetStatOption` parameter\\. To have the AWS Transfer Family server ignore the `SETSTAT` command and upload files without needing to make any changes to your SFTP client, set the value to `ENABLE_NO_OP`\\. If you set the `SetStatOption` parameter to `ENABLE_NO_OP`, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a `SETSTAT` call\\.\n+ To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the `TlsSessionResumptionMode` parameter\\.\n+ `As2Transports` indicates the transport method for the AS2 messages\\. Currently, only HTTP is supported\\.\n*Required*: No \n*Type*: [ProtocolDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocoldetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ProtocolDetails" }, "Protocols": { "items": { "$ref": "#/definitions/AWS::Transfer::Server.Protocol" }, - "markdownDescription": "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+ `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\nIf 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\\. \nIf `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType` must be `VPC` and the `IdentityProviderType` must be `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`\\. \nIf `Protocol` includes `FTP`, then `AddressAllocationIds` cannot be associated\\. \nIf `Protocol` is set only to `SFTP`, the `EndpointType` can be set to `PUBLIC` and the `IdentityProviderType` can be set to `SERVICE_MANAGED`\\.\n*Required*: No \n*Type*: List of [Protocol](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocol.html) \n*Maximum*: `3` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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+ `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+ `AS2` \\(Applicability Statement 2\\): used for transporting structured business\\-to\\-business data\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+ If `Protocol` includes either `FTP` or `FTPS`, then the `EndpointType` must be `VPC` and the `IdentityProviderType` must be either `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`\\.\n+ If `Protocol` includes `FTP`, then `AddressAllocationIds` cannot be associated\\.\n+ If `Protocol` is set only to `SFTP`, the `EndpointType` can be set to `PUBLIC` and the `IdentityProviderType` can be set any of the supported identity types: `SERVICE_MANAGED`, `AWS_DIRECTORY_SERVICE`, `AWS_LAMBDA`, or `API_GATEWAY`\\.\n+ If `Protocol` includes `AS2`, then the `EndpointType` must be `VPC`, and domain must be Amazon S3\\.\n*Required*: No \n*Type*: List of [Protocol](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-protocol.html) \n*Maximum*: `4` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Protocols", "type": "array" }, @@ -180007,7 +186160,7 @@ }, "WorkflowDetails": { "$ref": "#/definitions/AWS::Transfer::Server.WorkflowDetails", - "markdownDescription": "Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow\\. \n*Required*: No \n*Type*: [WorkflowDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow\\. \nIn addition to a workflow to execute when a file is uploaded completely, `WorkflowDetails` can also contain a workflow ID \\(and execution role\\) for a workflow to execute on partial upload\\. A partial upload occurs when a file is open when the session disconnects\\. \n*Required*: No \n*Type*: [WorkflowDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetails.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "WorkflowDetails" } }, @@ -180116,18 +186269,22 @@ "items": { "$ref": "#/definitions/AWS::Transfer::Server.As2Transport" }, + "markdownDescription": "List of `As2Transport` objects\\. \n*Required*: No \n*Type*: List of [As2Transport](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-as2transport.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "As2Transports", "type": "array" }, "PassiveIp": { - "markdownDescription": "Indicates 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*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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 `aws transfer update-server --protocol-details PassiveIp=0.0.0.0` \nReplace `0.0.0.0` in the example above with the actual IP address you want to use\\. \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](http://aws.amazon.com/blogs/storage/configuring-your-ftps-server-behind-a-firewall-or-nat-with-aws-transfer-family/)\\. \n *Special values* \nThe `AUTO` and `0.0.0.0` are special values for the `PassiveIp` parameter\\. The value `PassiveIp=AUTO` is assigned by default to FTP and FTPS type servers\\. In this case, the server automatically responds with one of the endpoint IPs within the PASV response\\. `PassiveIp=0.0.0.0` has a more unique application for its usage\\. For example, if you have a High Availability \\(HA\\) Network Load Balancer \\(NLB\\) environment, where you have 3 subnets, you can only specify a single IP address using the `PassiveIp` parameter\\. This reduces the effectiveness of having High Availability\\. In this case, you can specify `PassiveIp=0.0.0.0`\\. This tells the client to use the same IP address as the Control connection and utilize all AZs for their connections\\. Note, however, that not all FTP clients support the `PassiveIp=0.0.0.0` response\\. FileZilla and WinSCP do support it\\. If you are using other clients, check to see if your client supports the `PassiveIp=0.0.0.0` response\\. \n*Required*: No \n*Type*: String \n*Maximum*: `15` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PassiveIp", "type": "string" }, "SetStatOption": { + "markdownDescription": "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\\. \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\\. \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 Amazon CloudWatch Logs, so you can determine when the client is making a `SETSTAT` call\\. \nIf 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\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `DEFAULT | ENABLE_NO_OP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SetStatOption", "type": "string" }, "TlsSessionResumptionMode": { - "markdownDescription": "A property used with Transfer 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+ `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**Note** \nNot 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\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED | ENFORCED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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+ `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**Note** \nNot 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\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `DISABLED | ENABLED | ENFORCED` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TlsSessionResumptionMode", "type": "string" } @@ -180161,13 +186318,15 @@ "items": { "$ref": "#/definitions/AWS::Transfer::Server.WorkflowDetail" }, + "markdownDescription": "A trigger that starts a workflow if a file is only partially uploaded\\. You can attach a workflow to a server that executes whenever there is a partial upload\\. \nA *partial upload* occurs when a file is open when the session disconnects\\. \n*Required*: No \n*Type*: List of [WorkflowDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OnPartialUpload", "type": "array" }, "OnUpload": { "items": { "$ref": "#/definitions/AWS::Transfer::Server.WorkflowDetail" }, - "markdownDescription": "A trigger that starts a workflow: the workflow begins to execute after a file is uploaded\\. \nTo remove an associated workflow from a server, you can provide an empty `OnUpload` object, as in the following example\\. \n `aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'` \n*Required*: Yes \n*Type*: List of [WorkflowDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A trigger that starts a workflow: the workflow begins to execute after a file is uploaded\\. \nTo remove an associated workflow from a server, you can provide an empty `OnUpload` object, as in the following example\\. \n `aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'` \n*Required*: No \n*Type*: List of [WorkflowDetail](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-workflowdetail.html) \n*Maximum*: `1` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OnUpload", "type": "array" } @@ -180223,7 +186382,7 @@ "type": "array" }, "HomeDirectoryType": { - "markdownDescription": "The type of landing directory \\(folder\\) you want your users' home directory to be when they log into the server\\. If you set it to `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients\\. If you set it `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings` for how you want to make Amazon S3 or EFS paths visible to your users\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `LOGICAL | PATH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The type of landing directory \\(folder\\) that you want your users' home directory to be when they log in to the server\\. If you set it to `PATH`, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients\\. If you set it `LOGICAL`, you need to provide mappings in the `HomeDirectoryMappings` for how you want to make Amazon S3 or Amazon EFS paths visible to your users\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `LOGICAL | PATH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "HomeDirectoryType", "type": "string" }, @@ -180238,7 +186397,7 @@ "title": "PosixProfile" }, "Role": { - "markdownDescription": "Specifies the Amazon Resource Name \\(ARN\\) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system\\. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system\\. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the AWS Identity and Access Management \\(IAM\\) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system\\. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system\\. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `arn:.*role/.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Role", "type": "string" }, @@ -180445,15 +186604,23 @@ "additionalProperties": false, "properties": { "DestinationFileLocation": { - "$ref": "#/definitions/AWS::Transfer::Workflow.S3FileLocation" + "$ref": "#/definitions/AWS::Transfer::Workflow.S3FileLocation", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [S3FileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3filelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DestinationFileLocation" }, "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "OverwriteExisting": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OverwriteExisting", "type": "string" }, "SourceFileLocation": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceFileLocation", "type": "string" } }, @@ -180463,15 +186630,23 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SourceFileLocation": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceFileLocation", "type": "string" }, "Target": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Target", "type": "string" }, "TimeoutSeconds": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Integer \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "TimeoutSeconds", "type": "number" } }, @@ -180481,18 +186656,28 @@ "additionalProperties": false, "properties": { "DestinationFileLocation": { - "$ref": "#/definitions/AWS::Transfer::Workflow.InputFileLocation" + "$ref": "#/definitions/AWS::Transfer::Workflow.InputFileLocation", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [InputFileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-inputfilelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DestinationFileLocation" }, "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "OverwriteExisting": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "OverwriteExisting", "type": "string" }, "SourceFileLocation": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceFileLocation", "type": "string" }, "Type": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Type", "type": "string" } }, @@ -180502,9 +186687,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SourceFileLocation": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceFileLocation", "type": "string" } }, @@ -180514,9 +186703,13 @@ "additionalProperties": false, "properties": { "FileSystemId": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "FileSystemId", "type": "string" }, "Path": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Path", "type": "string" } }, @@ -180526,10 +186719,14 @@ "additionalProperties": false, "properties": { "EfsFileLocation": { - "$ref": "#/definitions/AWS::Transfer::Workflow.EfsInputFileLocation" + "$ref": "#/definitions/AWS::Transfer::Workflow.EfsInputFileLocation", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [EfsInputFileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-efsinputfilelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "EfsFileLocation" }, "S3FileLocation": { - "$ref": "#/definitions/AWS::Transfer::Workflow.S3InputFileLocation" + "$ref": "#/definitions/AWS::Transfer::Workflow.S3InputFileLocation", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [S3InputFileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3inputfilelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3FileLocation" } }, "type": "object" @@ -180538,7 +186735,9 @@ "additionalProperties": false, "properties": { "S3FileLocation": { - "$ref": "#/definitions/AWS::Transfer::Workflow.S3InputFileLocation" + "$ref": "#/definitions/AWS::Transfer::Workflow.S3InputFileLocation", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [S3InputFileLocation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3inputfilelocation.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "S3FileLocation" } }, "type": "object" @@ -180547,9 +186746,13 @@ "additionalProperties": false, "properties": { "Bucket": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Bucket", "type": "string" }, "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" } }, @@ -180559,9 +186762,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Value", "type": "string" } }, @@ -180575,15 +186782,21 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Name", "type": "string" }, "SourceFileLocation": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "SourceFileLocation", "type": "string" }, "Tags": { "items": { "$ref": "#/definitions/AWS::Transfer::Workflow.S3Tag" }, + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: List of [S3Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3tag.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "Tags", "type": "array" } }, @@ -180594,29 +186807,31 @@ "properties": { "CopyStepDetails": { "$ref": "#/definitions/AWS::Transfer::Workflow.CopyStepDetails", - "markdownDescription": "Details for a step that performs a file copy\\. \n Consists of the following values: \n+ A description\n+ An S3 location for the destination of the file copy\\.\n+ A flag that indicates whether or not to overwrite an existing file of the same name\\. The default is `FALSE`\\.\n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Details for a step that performs a file copy\\. \n Consists of the following values: \n+ A description\n+ An Amazon S3 location for the destination of the file copy\\.\n+ A flag that indicates whether to overwrite an existing file of the same name\\. The default is `FALSE`\\.\n*Required*: No \n*Type*: [CopyStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-copystepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CopyStepDetails" }, "CustomStepDetails": { "$ref": "#/definitions/AWS::Transfer::Workflow.CustomStepDetails", - "markdownDescription": "Details for a step that invokes a lambda function\\. \n Consists of the lambda function name, target, and timeout \\(in seconds\\)\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Details for a step that invokes an AWS Lambda function\\. \nConsists of the Lambda function's name, target, and timeout \\(in seconds\\)\\. \n*Required*: No \n*Type*: [CustomStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-customstepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "CustomStepDetails" }, "DecryptStepDetails": { - "$ref": "#/definitions/AWS::Transfer::Workflow.DecryptStepDetails" + "$ref": "#/definitions/AWS::Transfer::Workflow.DecryptStepDetails", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [DecryptStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-decryptstepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "DecryptStepDetails" }, "DeleteStepDetails": { "$ref": "#/definitions/AWS::Transfer::Workflow.DeleteStepDetails", - "markdownDescription": "Details for a step that deletes the file\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Details for a step that deletes the file\\. \n*Required*: No \n*Type*: [DeleteStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-deletestepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "DeleteStepDetails" }, "TagStepDetails": { "$ref": "#/definitions/AWS::Transfer::Workflow.TagStepDetails", - "markdownDescription": "Details for a step that creates one or more tags\\. \nYou specify one or more tags: each tag contains a key/value pair\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Details for a step that creates one or more tags\\. \nYou specify one or more tags\\. Each tag contains a key\\-value pair\\. \n*Required*: No \n*Type*: [TagStepDetails](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-tagstepdetails.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "TagStepDetails" }, "Type": { - "markdownDescription": "Currently, the following step types are supported\\. \n+ *Copy*: copy the file to another location\n+ *Custom*: custom step with a lambda target\n+ *Delete*: delete the file\n+ *Tag*: add a tag to the file\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Currently, the following step types are supported\\. \n+ ** `COPY` ** \\- Copy the file to another location\\.\n+ ** `CUSTOM` ** \\- Perform a custom step with an AWS Lambda function target\\.\n+ ** `DECRYPT` ** \\- Decrypt a file that was encrypted before it was uploaded\\.\n+ ** `DELETE` ** \\- Delete the file\\.\n+ ** `TAG` ** \\- Add a tag to the file\\.\n*Required*: No \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Type", "type": "string" } @@ -180659,18 +186874,26 @@ "additionalProperties": false, "properties": { "Description": { + "markdownDescription": "The client\\-provided description of the domain\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Description", "type": "string" }, "Name": { + "markdownDescription": "The client\\-provided name for the domain\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "ServerSideEncryptionConfiguration": { - "$ref": "#/definitions/AWS::VoiceID::Domain.ServerSideEncryptionConfiguration" + "$ref": "#/definitions/AWS::VoiceID::Domain.ServerSideEncryptionConfiguration", + "markdownDescription": "The server\\-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data\\. \n*Required*: Yes \n*Type*: [ServerSideEncryptionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-voiceid-domain-serversideencryptionconfiguration.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ServerSideEncryptionConfiguration" }, "Tags": { "items": { "$ref": "#/definitions/Tag" }, + "markdownDescription": "The tags used to organize, track, or control access for this resource\\. \n*Required*: No \n*Type*: List of [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Tags", "type": "array" } }, @@ -180705,6 +186928,8 @@ "additionalProperties": false, "properties": { "KmsKeyId": { + "markdownDescription": "The identifier of the KMS key to use to encrypt data stored by Voice ID\\. Voice ID doesn't support asymmetric customer managed keys\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "KmsKeyId", "type": "string" } }, @@ -182742,7 +188967,7 @@ "items": { "type": "string" }, - "markdownDescription": "Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0\\. \nExamples: \n+ To configure AWS WAF to allow, block, or count requests that originated from the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses\\. All addresses must be specified using Classless Inter\\-Domain Routing \\(CIDR\\) notation\\. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for `/0`\\. \nExample address strings: \n+ To configure AWS WAF to allow, block, or count requests that originated from the IP address 192\\.0\\.2\\.44, specify `192.0.2.44/32`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192\\.0\\.2\\.0 to 192\\.0\\.2\\.255, specify `192.0.2.0/24`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128`\\.\n+ To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64`\\.\nFor more information about CIDR notation, see the Wikipedia entry [Classless Inter\\-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\\. \nExample JSON `Addresses` specifications: \n+ Empty array: `\"Addresses\": []` \n+ Array with one address: `\"Addresses\": [\"192.0.2.44/32\"]` \n+ Array with three addresses: `\"Addresses\": [\"192.0.2.44/32\", \"192.0.2.0/24\", \"192.0.0.0/16\"]` \n+ INVALID specification: `\"Addresses\": [\"\"]` INVALID \n*Required*: Yes \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Addresses", "type": "array" }, @@ -182752,17 +188977,17 @@ "type": "string" }, "IPAddressVersion": { - "markdownDescription": "Specify IPV4 or IPV6\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IPV4 | IPV6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the IP addresses, either `IPV4` or `IPV6`\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `IPV4 | IPV6` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IPAddressVersion", "type": "string" }, "Name": { - "markdownDescription": "The descriptive name of the IP set\\. You cannot change the name of an `IPSet` after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the IP set\\. You cannot change the name of an `IPSet` after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, "Scope": { - "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, or an Amazon Cognito user pool\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Scope", "type": "string" }, @@ -182842,13 +189067,13 @@ "items": { "type": "string" }, - "markdownDescription": "The logging destination configuration that you want to associate with the web ACL\\. \nYou can associate one logging destination to a web ACL\\.\nIf logging destination target is a CloudWatch Log Group, it is required that the reference Log Group's name begin with the prefix 'aws-waf-logs-'\\.\n*Required*: Yes \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The logging destination configuration that you want to associate with the web ACL\\. \nYou can associate one logging destination to a web ACL\\.\n*Required*: Yes \n*Type*: List of String \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LogDestinationConfigs", "type": "array" }, "LoggingFilter": { "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.LoggingFilter", - "markdownDescription": "Filtering that specifies which web requests are kept in the logs and which are dropped\\. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Filtering that specifies which web requests are kept in the logs and which are dropped\\. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation\\. \n*Required*: No \n*Type*: [LoggingFilter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-loggingfilter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoggingFilter" }, "RedactedFields": { @@ -182896,6 +189121,8 @@ "additionalProperties": false, "properties": { "Action": { + "markdownDescription": "The action setting that a log record must contain in order to meet the condition\\. This is the action that AWS WAF applied to the web request\\. \nFor rule groups, this is either the configured rule action setting, or if you've applied a rule action override to the rule, it's the override action\\. The value `EXCLUDED_AS_COUNT` matches on excluded rules and also on rules that have a rule action override of Count\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALLOW | BLOCK | CAPTCHA | CHALLENGE | COUNT | EXCLUDED_AS_COUNT` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Action", "type": "string" } }, @@ -182908,10 +189135,14 @@ "additionalProperties": false, "properties": { "ActionCondition": { - "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.ActionCondition" + "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.ActionCondition", + "markdownDescription": "A single action condition\\. This is the action setting that a log record must contain in order to meet the condition\\. \n*Required*: No \n*Type*: [ActionCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-actioncondition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActionCondition" }, "LabelNameCondition": { - "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.LabelNameCondition" + "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.LabelNameCondition", + "markdownDescription": "A single label name condition\\. This is the fully qualified label name that a log record must contain in order to meet the condition\\. 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\\. \n*Required*: No \n*Type*: [LabelNameCondition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-labelnamecondition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LabelNameCondition" } }, "type": "object" @@ -182921,26 +189152,26 @@ "properties": { "JsonBody": { "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.JsonBody", - "markdownDescription": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-bytematchstatement) or [RegexPatternSetReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-regexpatternsetreferencestatement), with a [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-sizeconstraintstatement) that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Redact the request body JSON\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "JsonBody" }, "Method": { - "markdownDescription": "Inspect the HTTP method\\. The method indicates the type of operation that the request is asking the origin to perform\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Redact the indicated HTTP method\\. The method indicates the type of operation that the request is asking the origin to perform\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Method", "type": "object" }, "QueryString": { - "markdownDescription": "Inspect the query string\\. This is the part of a URL that appears after a `?` character, if any\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Redact the query string\\. This is the part of a URL that appears after a `?` character, if any\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "QueryString", "type": "object" }, "SingleHeader": { "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.SingleHeader", - "markdownDescription": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }` \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Redact a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }` \n*Required*: No \n*Type*: [SingleHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-singleheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SingleHeader" }, "UriPath": { - "markdownDescription": "Inspect the request URI path\\. This is the part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Redact the request URI path\\. This is the part of the web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UriPath", "type": "object" } @@ -182951,15 +189182,21 @@ "additionalProperties": false, "properties": { "Behavior": { + "markdownDescription": "How to handle logs that satisfy the filter's conditions and requirement\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DROP | KEEP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Behavior", "type": "string" }, "Conditions": { "items": { "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.Condition" }, + "markdownDescription": "Match conditions for the filter\\. \n*Required*: Yes \n*Type*: List of [Condition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-condition.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Conditions", "type": "array" }, "Requirement": { + "markdownDescription": "Logic to apply to the filtering conditions\\. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `MEETS_ALL | MEETS_ANY` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Requirement", "type": "string" } }, @@ -182974,12 +189211,18 @@ "additionalProperties": false, "properties": { "InvalidFallbackBehavior": { + "markdownDescription": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \n AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \n AWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InvalidFallbackBehavior", "type": "string" }, "MatchPattern": { - "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.MatchPattern" + "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.MatchPattern", + "markdownDescription": "The patterns to look for in the JSON body\\. AWS WAF inspects the results of these pattern matches against the rule inspection criteria\\. \n*Required*: Yes \n*Type*: [MatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-matchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchPattern" }, "MatchScope": { + "markdownDescription": "The parts of the JSON to match against using the `MatchPattern`\\. If you specify `All`, AWS WAF matches against keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchScope", "type": "string" } }, @@ -182993,6 +189236,8 @@ "additionalProperties": false, "properties": { "LabelName": { + "markdownDescription": "The label name that a log record must contain in order to meet the condition\\. This must be a fully qualified label name\\. 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\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "LabelName", "type": "string" } }, @@ -183005,12 +189250,16 @@ "additionalProperties": false, "properties": { "DefaultBehavior": { + "markdownDescription": "Default handling for logs that don't match any of the specified filtering conditions\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `DROP | KEEP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "DefaultBehavior", "type": "string" }, "Filters": { "items": { "$ref": "#/definitions/AWS::WAFv2::LoggingConfiguration.Filter" }, + "markdownDescription": "The filters that you want to apply to the logs\\. \n*Required*: Yes \n*Type*: List of [Filter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-filter.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Filters", "type": "array" } }, @@ -183024,12 +189273,16 @@ "additionalProperties": false, "properties": { "All": { + "markdownDescription": "Match all of the elements\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "All", "type": "object" }, "IncludedPaths": { "items": { "type": "string" }, + "markdownDescription": "Match only the specified include paths\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludedPaths", "type": "array" } }, @@ -183039,6 +189292,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the query header to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -183088,7 +189343,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The descriptive name of the set\\. You cannot change the name after you create the set\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the set\\. You cannot change the name after you create the set\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -183101,7 +189356,7 @@ "type": "array" }, "Scope": { - "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, or an Amazon Cognito user pool\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Scope", "type": "string" }, @@ -183180,10 +189435,12 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.LabelSummary" }, + "markdownDescription": "The labels that one or more rules in this rule group add to matching web requests\\. These labels are defined in the `RuleLabels` for a Rule\\. \n*Required*: No \n*Type*: List of [LabelSummary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelsummary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AvailableLabels", "type": "array" }, "Capacity": { - "markdownDescription": "The web ACL capacity units \\(WCUs\\) required for this rule group\\. \nWhen you create your own rule group, you define this, and you cannot change it after creation\\. When you add or modify the rules in a rule group, AWS WAF enforces this limit\\. \nAWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs\\. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule\\. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power\\. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group\\. The WCU limit for web ACLs is 1,500\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The web ACL capacity units \\(WCUs\\) required for this rule group\\. \nWhen you create your own rule group, you define this, and you cannot change it after creation\\. When you add or modify the rules in a rule group, AWS WAF enforces this limit\\. \n AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs\\. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule\\. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power\\. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group\\. The WCU limit for web ACLs is 1,500\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Capacity", "type": "number" }, @@ -183191,6 +189448,8 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.LabelSummary" }, + "markdownDescription": "The labels that one or more rules in this rule group match against in label match statements\\. These labels are defined in a `LabelMatchStatement` specification, in the [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) definition of a rule\\. \n*Required*: No \n*Type*: List of [LabelSummary](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelsummary.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ConsumedLabels", "type": "array" }, "CustomResponseBodies": { @@ -183210,7 +189469,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The descriptive name of the rule group\\. You cannot change the name of a rule group after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the rule group\\. You cannot change the name of a rule group after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -183223,7 +189482,7 @@ "type": "array" }, "Scope": { - "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, or an Amazon Cognito user pool\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Scope", "type": "string" }, @@ -183273,7 +189532,9 @@ "additionalProperties": false, "properties": { "CustomRequestHandling": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling", + "markdownDescription": "Defines custom handling for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomRequestHandling" } }, "type": "object" @@ -183299,7 +189560,9 @@ "additionalProperties": false, "properties": { "CustomResponse": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomResponse" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomResponse", + "markdownDescription": "Defines a custom response for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomResponse](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customresponse.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomResponse" } }, "type": "object" @@ -183308,6 +189571,8 @@ "additionalProperties": false, "properties": { "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the body is larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB \\(8192 bytes\\)\\. Only the first 8 KB of the request body are forwarded to AWS WAF by the underlying host service\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the body normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nYou can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB\\. \nDefault: `CONTINUE` \n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -183318,16 +189583,16 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "PositionalConstraint": { - "markdownDescription": "The area within the portion of a web request that you want AWS WAF to search for `SearchString`\\. Valid values include the following: \n **CONTAINS** \nThe specified part of the web request must include the value of `SearchString`, but the location doesn't matter\\. \n **CONTAINS\\_WORD** \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+ `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 **EXACTLY** \nThe value of the specified part of the web request must exactly match the value of `SearchString`\\. \n **STARTS\\_WITH** \nThe value of `SearchString` must appear at the beginning of the specified part of the web request\\. \n **ENDS\\_WITH** \nThe value of `SearchString` must appear at the end of the specified part of the web request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTAINS | CONTAINS_WORD | ENDS_WITH | EXACTLY | STARTS_WITH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The area within the portion of the web request that you want AWS WAF to search for `SearchString`\\. Valid values include the following: \n **CONTAINS** \nThe specified part of the web request must include the value of `SearchString`, but the location doesn't matter\\. \n **CONTAINS\\_WORD** \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+ `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 **EXACTLY** \nThe value of the specified part of the web request must exactly match the value of `SearchString`\\. \n **STARTS\\_WITH** \nThe value of `SearchString` must appear at the beginning of the specified part of the web request\\. \n **ENDS\\_WITH** \nThe value of `SearchString` must appear at the end of the specified part of the web request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTAINS | CONTAINS_WORD | ENDS_WITH | EXACTLY | STARTS_WITH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PositionalConstraint", "type": "string" }, "SearchString": { - "markdownDescription": "A string value that you want AWS WAF to search for\\. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch`\\. The maximum length of the value is 50 bytes\\. For alphabetic characters A\\-Z and a\\-z, the value is case sensitive\\. \nDon't encode this string\\. Provide the value that you want AWS WAF to search for\\. AWS CloudFormation automatically base64 encodes the value for you\\. \nFor example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent`\\. If you want to search the `User-Agent` header for the value `BadBot`, you provide the string `BadBot` in the value of `SearchString`\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string value that you want AWS WAF to search for\\. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch`\\. The maximum length of the value is 200 bytes\\. For alphabetic characters A\\-Z and a\\-z, the value is case sensitive\\. \nDon't encode this string\\. Provide the value that you want AWS WAF to search for\\. AWS CloudFormation automatically base64 encodes the value for you\\. \nFor example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent`\\. If you want to search the `User-Agent` header for the value `BadBot`, you provide the string `BadBot` in the value of `SearchString`\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SearchString", "type": "string" }, @@ -183340,7 +189605,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -183356,7 +189621,9 @@ "additionalProperties": false, "properties": { "CustomRequestHandling": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling", + "markdownDescription": "Defines custom handling for the web request, used when the `CAPTCHA` inspection determines that the request's token is valid and unexpired\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomRequestHandling" } }, "type": "object" @@ -183366,7 +189633,7 @@ "properties": { "ImmunityTimeProperty": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ImmunityTimeProperty", - "markdownDescription": "Determines how long a `CAPTCHA` token remains valid after the client successfully solves a `CAPTCHA` puzzle\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines how long a `CAPTCHA` timestamp in the token remains valid after the client successfully solves a `CAPTCHA` puzzle\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ImmunityTimeProperty" } }, @@ -183376,7 +189643,9 @@ "additionalProperties": false, "properties": { "CustomRequestHandling": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling", + "markdownDescription": "Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomRequestHandling" } }, "type": "object" @@ -183385,7 +189654,9 @@ "additionalProperties": false, "properties": { "ImmunityTimeProperty": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ImmunityTimeProperty" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ImmunityTimeProperty", + "markdownDescription": "Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImmunityTimeProperty" } }, "type": "object" @@ -183394,18 +189665,24 @@ "additionalProperties": false, "properties": { "All": { + "markdownDescription": "Inspect all cookies\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "All", "type": "object" }, "ExcludedCookies": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the cookies whose keys don't match any of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExcludedCookies", "type": "array" }, "IncludedCookies": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the cookies that have a key that matches one of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludedCookies", "type": "array" } }, @@ -183415,12 +189692,18 @@ "additionalProperties": false, "properties": { "MatchPattern": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CookieMatchPattern" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CookieMatchPattern", + "markdownDescription": "The filter to use to identify the subset of cookies to inspect in a web request\\. \nYou must specify exactly one setting: either `All`, `IncludedCookies`, or `ExcludedCookies`\\. \nExample JSON: `\"MatchPattern\": { \"IncludedCookies\": {\"KeyToInclude1\", \"KeyToInclude2\", \"KeyToInclude3\"} }` \n*Required*: Yes \n*Type*: [CookieMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookiematchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchPattern" }, "MatchScope": { + "markdownDescription": "The parts of the cookies to inspect with the rule inspection criteria\\. If you specify `All`, AWS WAF inspects both keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchScope", "type": "string" }, "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the cookies of the request are larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB \\(8192 bytes\\) or 200 total cookies\\. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the cookies normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -183435,7 +189718,9 @@ "additionalProperties": false, "properties": { "CustomRequestHandling": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomRequestHandling", + "markdownDescription": "Defines custom handling for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomRequestHandling" } }, "type": "object" @@ -183444,9 +189729,13 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the custom header\\. \nFor custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name `x-amzn-waf-`, to avoid confusion with the headers that are already in the request\\. For example, for the header name `sample`, AWS WAF inserts the header `x-amzn-waf-sample`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[a-zA-Z0-9._$-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" }, "Value": { + "markdownDescription": "The value of the custom header\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -183463,6 +189752,8 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomHTTPHeader" }, + "markdownDescription": "The HTTP headers to insert into the request\\. Duplicate header names are not allowed\\. \nFor information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: Yes \n*Type*: List of [CustomHTTPHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customhttpheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InsertHeaders", "type": "array" } }, @@ -183475,15 +189766,21 @@ "additionalProperties": false, "properties": { "CustomResponseBodyKey": { + "markdownDescription": "References the response body that you want AWS WAF to return to the web request client\\. You can define a custom response for a rule action or a default web ACL action that is set to block\\. To do this, you first define the response body key and value in the `CustomResponseBodies` setting for the [AWS::WAFv2::WebACL](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html) or [AWS::WAFv2::RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html) where you want to use it\\. Then, in the rule action or web ACL default action `BlockAction` setting, you reference the response body using this key\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomResponseBodyKey", "type": "string" }, "ResponseCode": { + "markdownDescription": "The HTTP status code to return to the client\\. \nFor a list of status codes that you can use in your custom responses, see [Supported status codes for custom response](https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `200` \n*Maximum*: `599` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResponseCode", "type": "number" }, "ResponseHeaders": { "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CustomHTTPHeader" }, + "markdownDescription": "The HTTP headers to use in the response\\. Duplicate header names are not allowed\\. \nFor information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: List of [CustomHTTPHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customhttpheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ResponseHeaders", "type": "array" } }, @@ -183522,18 +189819,22 @@ }, "Body": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Body", - "markdownDescription": "Inspect the request body, which immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the `ByteMatchStatement` or `RegexPatternSetReferenceStatement`, with a `SizeConstraintStatement` that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect the request body as plain text\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nOnly the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. For information about how to handle oversized request bodies, see the `Body` object configuration\\. \n*Required*: No \n*Type*: [Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-body.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Body" }, "Cookies": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Cookies" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Cookies", + "markdownDescription": "Inspect the request cookies\\. You must configure scope and pattern matching filters in the `Cookies` object, to define the set of cookies and the parts of the cookies that AWS WAF inspects\\. \nOnly the first 8 KB \\(8192 bytes\\) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service\\. You must configure how to handle any oversize cookie content in the `Cookies` object\\. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service\\. \n*Required*: No \n*Type*: [Cookies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-cookies.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cookies" }, "Headers": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Headers" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Headers", + "markdownDescription": "Inspect the request headers\\. You must configure scope and pattern matching filters in the `Headers` object, to define the set of headers to and the parts of the headers that AWS WAF inspects\\. \nOnly the first 8 KB \\(8192 bytes\\) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service\\. You must configure how to handle any oversize header content in the `Headers` object\\. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service\\. \n*Required*: No \n*Type*: [Headers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headers.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Headers" }, "JsonBody": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.JsonBody", - "markdownDescription": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the `ByteMatchStatement` or `RegexPatternSetReferenceStatement`, with a `SizeConstraintStatement` that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nOnly the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. For information about how to handle oversized request bodies, see the `JsonBody` object configuration\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "JsonBody" }, "Method": { @@ -183548,16 +189849,16 @@ }, "SingleHeader": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SingleHeader", - "markdownDescription": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }` \nAlternately, you can filter and inspect all headers with the `Headers` `FieldToMatch` setting\\. \n*Required*: No \n*Type*: [SingleHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-singleheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SingleHeader" }, "SingleQueryArgument": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SingleQueryArgument", - "markdownDescription": "Inspect a single query argument\\. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*\\. The name can be up to 30 characters long and isn't case sensitive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect a single query argument\\. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*\\. The name can be up to 30 characters long and isn't case sensitive\\. \nExample JSON: `\"SingleQueryArgument\": { \"Name\": \"myArgument\" }` \n*Required*: No \n*Type*: [SingleQueryArgument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-singlequeryargument.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SingleQueryArgument" }, "UriPath": { - "markdownDescription": "Inspect the request URI path\\. This is the part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect the request URI path\\. This is the part of the web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UriPath", "type": "object" } @@ -183591,7 +189892,7 @@ "items": { "type": "string" }, - "markdownDescription": "An array of two\\-character country codes, for example, `[ \"US\", \"CN\" ]`, from the alpha\\-2 country ISO codes of the ISO 3166 international standard\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of two\\-character country codes that you want to match against, for example, `[ \"US\", \"CN\" ]`, from the alpha\\-2 country ISO codes of the ISO 3166 international standard\\. \nWhen you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate\\. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches\\. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CountryCodes", "type": "array" }, @@ -183607,18 +189908,24 @@ "additionalProperties": false, "properties": { "All": { + "markdownDescription": "Inspect all headers\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "All", "type": "object" }, "ExcludedHeaders": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the headers whose keys don't match any of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExcludedHeaders", "type": "array" }, "IncludedHeaders": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the headers that have a key that matches one of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludedHeaders", "type": "array" } }, @@ -183628,12 +189935,18 @@ "additionalProperties": false, "properties": { "MatchPattern": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.HeaderMatchPattern" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.HeaderMatchPattern", + "markdownDescription": "The filter to use to identify the subset of headers to inspect in a web request\\. \nYou must specify exactly one setting: either `All`, `IncludedHeaders`, or `ExcludedHeaders`\\. \nExample JSON: `\"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }` \n*Required*: Yes \n*Type*: [HeaderMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-headermatchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchPattern" }, "MatchScope": { + "markdownDescription": "The parts of the headers to match with the rule inspection criteria\\. If you specify `All`, AWS WAF inspects both keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchScope", "type": "string" }, "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the headers of the request are larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB \\(8192 bytes\\) or 200 total headers\\. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the headers normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -183693,7 +190006,7 @@ "additionalProperties": false, "properties": { "ImmunityTime": { - "markdownDescription": "The amount of time, in seconds, that a `CAPTCHA` token is valid\\. The default setting is 300\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of time, in seconds, that a `CAPTCHA` or challenge timestamp is considered valid by AWS WAF\\. The default setting is 300\\. \nFor the Challenge action, the minimum setting is 300\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ImmunityTime", "type": "number" } @@ -183707,7 +190020,7 @@ "additionalProperties": false, "properties": { "InvalidFallbackBehavior": { - "markdownDescription": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \nAWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \nAWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \n AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \n AWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InvalidFallbackBehavior", "type": "string" }, @@ -183722,6 +190035,8 @@ "type": "string" }, "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the body is larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB \\(8192 bytes\\)\\. Only the first 8 KB of the request body are forwarded to AWS WAF by the underlying host service\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the body normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nYou can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB\\. \nDefault: `CONTINUE` \n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -183735,7 +190050,7 @@ "additionalProperties": false, "properties": { "All": { - "markdownDescription": "Match all of the elements\\. See also `MatchScope` in `JsonBody`\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Match all of the elements\\. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "All", "type": "object" }, @@ -183743,7 +190058,7 @@ "items": { "type": "string" }, - "markdownDescription": "Match only the specified include paths\\. See also `MatchScope` in `JsonBody`\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Match only the specified include paths\\. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludedPaths", "type": "array" } @@ -183754,7 +190069,7 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The label string\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The label string\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" } @@ -183768,12 +190083,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The string to match against\\. The setting you provide for this depends on the match statement's `Scope` setting: \n+ If the `Scope` indicates `LABEL`, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name\\. \n+ If the `Scope` indicates `NAMESPACE`, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates\\.\nLabels are case sensitive and components of a label must be separated by colon, for example `NS1:NS2:name`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The string to match against\\. The setting you provide for this depends on the match statement's `Scope` setting: \n+ If the `Scope` indicates `LABEL`, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name\\. \n+ If the `Scope` indicates `NAMESPACE`, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates\\.\nLabels are case sensitive and components of a label must be separated by colon, for example `NS1:NS2:name`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Scope": { - "markdownDescription": "Specify whether you want to match using the label name or just the namespace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify whether you want to match using the label name or just the namespace\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `LABEL | NAMESPACE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Scope", "type": "string" } @@ -183788,7 +190103,7 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "An individual label specification\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An individual label specification\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" } @@ -183846,7 +190161,7 @@ }, "ScopeDownStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Statement", - "markdownDescription": "An optional nested statement that narrows the scope of the rate\\-based statement to matching web requests\\. This can be any nestable statement, and you can nest statements at any level below this scope\\-down statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional nested statement that narrows the scope of the web requests that are evaluated by the rate\\-based statement\\. Requests are only tracked by the rate\\-based statement if they match the scope\\-down statement\\. You can use any nestable statement in the scope\\-down statement, and you can nest statements at any level, the same as you can for a rule statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScopeDownStatement" } }, @@ -183861,7 +190176,7 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. For more information, see `FieldToMatch`\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "RegexString": { @@ -183889,20 +190204,20 @@ "additionalProperties": false, "properties": { "Arn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the regular expression pattern set that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the [AWS::WAFv2::RegexPatternSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html) that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Arn", "type": "string" }, "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "TextTransformations": { "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -183919,7 +190234,7 @@ "properties": { "Action": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.RuleAction", - "markdownDescription": "The action that AWS WAF should take on a web request when it matches the rule's statement\\. Settings at the web ACL level can override the rule action setting\\. \n*Required*: No \n*Type*: [RuleAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The action that AWS WAF should take on a web request when it matches the rule statement\\. Settings at the web ACL level can override the rule action setting\\. \n*Required*: No \n*Type*: [RuleAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ruleaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Action" }, "CaptchaConfig": { @@ -183928,10 +190243,12 @@ "title": "CaptchaConfig" }, "ChallengeConfig": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ChallengeConfig" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ChallengeConfig", + "markdownDescription": "Specifies how AWS WAF should handle `Challenge` evaluations\\. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL\\. \n*Required*: No \n*Type*: [ChallengeConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-challengeconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ChallengeConfig" }, "Name": { - "markdownDescription": "The descriptive name of the rule\\. You can't change the name of a `Rule` after you create it\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the rule\\. You can't change the name of a `Rule` after you create it\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -183950,7 +190267,7 @@ }, "Statement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.Statement", - "markdownDescription": "The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS WAF processing statement for the rule, for example [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-bytematchstatement) or [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-sizeconstraintstatement)\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Statement" }, "VisibilityConfig": { @@ -183972,12 +190289,12 @@ "properties": { "Allow": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.AllowAction", - "markdownDescription": "Instructs AWS WAF to allow the web request\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instructs AWS WAF to allow the web request\\. \n*Required*: No \n*Type*: [AllowAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-allowaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Allow" }, "Block": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.BlockAction", - "markdownDescription": "Instructs AWS WAF to block the web request\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instructs AWS WAF to block the web request\\. \n*Required*: No \n*Type*: [BlockAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-blockaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Block" }, "Captcha": { @@ -183986,11 +190303,13 @@ "title": "Captcha" }, "Challenge": { - "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ChallengeAction" + "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ChallengeAction", + "markdownDescription": "Instructs AWS WAF to run a `Challenge` check against the web request\\. \n*Required*: No \n*Type*: [ChallengeAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-challengeaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Challenge" }, "Count": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.CountAction", - "markdownDescription": "Instructs AWS WAF to count the web request and allow it\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL\\. \n*Required*: No \n*Type*: [CountAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-countaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Count" } }, @@ -184000,6 +190319,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the query header to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -184012,6 +190333,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the query argument to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -184030,7 +190353,7 @@ }, "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "Size": { @@ -184042,7 +190365,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -184060,17 +190383,19 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "SensitivityLevel": { + "markdownDescription": "The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks\\. \n `HIGH` detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings\\. For information about identifying and mitigating false positives, see [Testing and tuning](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-testing.html) in the * AWS WAF Developer Guide*\\. \n `LOW` is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives\\. \nDefault: `LOW` \n*Required*: No \n*Type*: String \n*Allowed values*: `HIGH | LOW` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SensitivityLevel", "type": "string" }, "TextTransformations": { "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -184086,17 +190411,17 @@ "properties": { "AndStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.AndStatement", - "markdownDescription": "A logical rule statement used to combine other rule statements with AND logic\\. You provide more than one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `AndStatement`\\. \n*Required*: No \n*Type*: [AndStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A logical rule statement used to combine other rule statements with AND logic\\. You provide more than one `Statement` within the `AndStatement`\\. \n*Required*: No \n*Type*: [AndStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-andstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "AndStatement" }, "ByteMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.ByteMatchStatement", - "markdownDescription": "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 refered to as a string match statement\\. \n*Required*: No \n*Type*: [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-bytematchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ByteMatchStatement" }, "GeoMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.GeoMatchStatement", - "markdownDescription": "A rule statement used to identify web requests based on country of origin\\. \n*Required*: No \n*Type*: [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A rule statement that labels web requests by country and region and that matches against web requests based on country code\\. A geo match rule labels every request that it inspects regardless of whether it finds a match\\. \n+ To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the `CountryCodes` array\\. \n+ Otherwise, configure your geo match rule with Count action so that it only labels requests\\. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed\\. \n AWS WAF labels requests using the alpha\\-2 country and region codes from the International Organization for Standardization \\(ISO\\) 3166 standard\\. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match `ForwardedIPConfig`\\. \nIf you use the web request origin, the label formats are `awswaf:clientip:geo:region:-` and `awswaf:clientip:geo:country:`\\. \nIf you use a forwarded IP address, the label formats are `awswaf:forwardedip:geo:region:-` and `awswaf:forwardedip:geo:country:`\\. \nFor additional details, see [Geographic match rule statement](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-geomatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "GeoMatchStatement" }, "IPSetReferenceStatement": { @@ -184106,22 +190431,22 @@ }, "LabelMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.LabelMatchStatement", - "markdownDescription": "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\\. \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\\. \n*Required*: No \n*Type*: [LabelMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL\\. \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\\. \n*Required*: No \n*Type*: [LabelMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-labelmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LabelMatchStatement" }, "NotStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.NotStatement", - "markdownDescription": "A logical rule statement used to negate the results of another rule statement\\. You provide one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `NotStatement`\\. \n*Required*: No \n*Type*: [NotStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A logical rule statement used to negate the results of another rule statement\\. You provide one `Statement` within the `NotStatement`\\. \n*Required*: No \n*Type*: [NotStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-notstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "NotStatement" }, "OrStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.OrStatement", - "markdownDescription": "A logical rule statement used to combine other rule statements with OR logic\\. You provide more than one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `OrStatement`\\. \n*Required*: No \n*Type*: [OrStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A logical rule statement used to combine other rule statements with OR logic\\. You provide more than one `Statement` within the `OrStatement`\\. \n*Required*: No \n*Type*: [OrStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-orstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OrStatement" }, "RateBasedStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.RateBasedStatement", - "markdownDescription": "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\\. \nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit\\. \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+ 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\\.\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 conditions in the statements are counted\\. If the count exceeds 1,000 requests per five minutes, the rule action triggers\\. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule\\. \nYou cannot nest a `RateBasedStatement`, for example for use inside a `NotStatement` or `OrStatement`\\. It can only be referenced as a top\\-level statement within a rule\\. \n*Required*: No \n*Type*: [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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 AWS 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\\. \nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit\\. \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+ An IP match statement with an IP set that specifies the address 192\\.0\\.2\\.44\\.\n+ A string match statement that searches in the User\\-Agent header for the string BadBot\\.\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\\. \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\\. \n*Required*: No \n*Type*: [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RateBasedStatement" }, "RegexMatchStatement": { @@ -184136,17 +190461,17 @@ }, "SizeConstraintStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SizeConstraintStatement", - "markdownDescription": "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\\. \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 can create a size constraint condition and block requests that have a request body greater than 8192 bytes\\. \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\\. \n*Required*: No \n*Type*: [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \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\\. \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\\. \n*Required*: No \n*Type*: [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sizeconstraintstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SizeConstraintStatement" }, "SqliMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.SqliMatchStatement", - "markdownDescription": "Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database\\. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions\\. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect\\. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code\\. \n*Required*: No \n*Type*: [SqliMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: [SqliMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-sqlimatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SqliMatchStatement" }, "XssMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.XssMatchStatement", - "markdownDescription": "A rule statement that defines a cross\\-site scripting \\(XSS\\) match search for AWS WAF to apply to web requests\\. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client\\-site scripts into other legitimate web browsers\\. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings\\. \n*Required*: No \n*Type*: [XssMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: [XssMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-xssmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "XssMatchStatement" } }, @@ -184181,7 +190506,7 @@ "type": "boolean" }, "MetricName": { - "markdownDescription": "The descriptive name of the Amazon CloudWatch metric\\. The name can contain only alphanumeric characters \\(A\\-Z, a\\-z, 0\\-9\\), with length from one to 128 characters\\. It can't contain whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default\\_Action\\.\" You can't change a `MetricName` after you create a `VisibilityConfig`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A name of the Amazon CloudWatch metric dimension\\. The name can contain only the characters: A\\-Z, a\\-z, 0\\-9, \\- \\(hyphen\\), and \\_ \\(underscore\\)\\. The name can be from one to 128 characters long\\. It can't contain whitespace or metric names that are reserved for AWS WAF, for example `All` and `Default_Action`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricName", "type": "string" }, @@ -184203,14 +190528,14 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "TextTransformations": { "items": { "$ref": "#/definitions/AWS::WAFv2::RuleGroup.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -184262,7 +190587,9 @@ "title": "CaptchaConfig" }, "ChallengeConfig": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ChallengeConfig" + "$ref": "#/definitions/AWS::WAFv2::WebACL.ChallengeConfig", + "markdownDescription": "Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own `ChallengeConfig` settings\\. If you don't specify this, AWS WAF uses its default settings for `ChallengeConfig`\\. \n*Required*: No \n*Type*: [ChallengeConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-challengeconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ChallengeConfig" }, "CustomResponseBodies": { "additionalProperties": false, @@ -184286,7 +190613,7 @@ "type": "string" }, "Name": { - "markdownDescription": "The descriptive name of the web ACL\\. You cannot change the name of a web ACL after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The name of the web ACL\\. You cannot change the name of a web ACL after you create it\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Name", "type": "string" }, @@ -184299,7 +190626,7 @@ "type": "array" }, "Scope": { - "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\nFor information about how to define the association of the web ACL with your resource, see [AWS::WAFv2::WebACLAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Specifies whether this is for an Amazon CloudFront distribution or for a regional application\\. A regional application can be an Application Load Balancer \\(ALB\\), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, or an Amazon Cognito user pool\\. Valid Values are `CLOUDFRONT` and `REGIONAL`\\. \nFor `CLOUDFRONT`, you must create your WAFv2 resources in the US East \\(N\\. Virginia\\) Region, `us-east-1`\\.\nFor information about how to define the association of the web ACL with your resource, see [AWS::WAFv2::WebACLAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "Scope", "type": "string" }, @@ -184315,6 +190642,8 @@ "items": { "type": "string" }, + "markdownDescription": "Specifies the domains that AWS WAF should accept in a web request token\\. This enables the use of tokens across multiple protected websites\\. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting\\. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource\\. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "TokenDomains", "type": "array" }, "VisibilityConfig": { @@ -184355,6 +190684,8 @@ "additionalProperties": false, "properties": { "InspectionLevel": { + "markdownDescription": "The inspection level to use for the Bot Control rule group\\. The common level is the least expensive\\. The targeted level includes all common level rules and adds rules with more advanced inspection criteria\\. For details, see [AWS WAF Bot Control rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html)\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "InspectionLevel", "type": "string" } }, @@ -184406,6 +190737,8 @@ "additionalProperties": false, "properties": { "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the body is larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB \\(8192 bytes\\)\\. Only the first 8 KB of the request body are forwarded to AWS WAF by the underlying host service\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the body normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nYou can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB\\. \nDefault: `CONTINUE` \n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -184416,16 +190749,16 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "PositionalConstraint": { - "markdownDescription": "The area within the portion of a web request that you want AWS WAF to search for `SearchString`\\. Valid values include the following: \n **CONTAINS** \nThe specified part of the web request must include the value of `SearchString`, but the location doesn't matter\\. \n **CONTAINS\\_WORD** \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+ `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 **EXACTLY** \nThe value of the specified part of the web request must exactly match the value of `SearchString`\\. \n **STARTS\\_WITH** \nThe value of `SearchString` must appear at the beginning of the specified part of the web request\\. \n **ENDS\\_WITH** \nThe value of `SearchString` must appear at the end of the specified part of the web request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTAINS | CONTAINS_WORD | ENDS_WITH | EXACTLY | STARTS_WITH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The area within the portion of the web request that you want AWS WAF to search for `SearchString`\\. Valid values include the following: \n **CONTAINS** \nThe specified part of the web request must include the value of `SearchString`, but the location doesn't matter\\. \n **CONTAINS\\_WORD** \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+ `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 **EXACTLY** \nThe value of the specified part of the web request must exactly match the value of `SearchString`\\. \n **STARTS\\_WITH** \nThe value of `SearchString` must appear at the beginning of the specified part of the web request\\. \n **ENDS\\_WITH** \nThe value of `SearchString` must appear at the end of the specified part of the web request\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTAINS | CONTAINS_WORD | ENDS_WITH | EXACTLY | STARTS_WITH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PositionalConstraint", "type": "string" }, "SearchString": { - "markdownDescription": "A string value that you want AWS WAF to search for\\. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch`\\. The maximum length of the value is 50 bytes\\. For alphabetic characters A\\-Z and a\\-z, the value is case sensitive\\. \nDon't encode this string\\. Provide the value that you want AWS WAF to search for\\. AWS CloudFormation automatically base64 encodes the value for you\\. \nFor example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent`\\. If you want to search the `User-Agent` header for the value `BadBot`, you provide the string `BadBot` in the value of `SearchString`\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A string value that you want AWS WAF to search for\\. AWS WAF searches only in the part of web requests that you designate for inspection in `FieldToMatch`\\. The maximum length of the value is 200 bytes\\. For alphabetic characters A\\-Z and a\\-z, the value is case sensitive\\. \nDon't encode this string\\. Provide the value that you want AWS WAF to search for\\. AWS CloudFormation automatically base64 encodes the value for you\\. \nFor example, suppose the value of `Type` is `HEADER` and the value of `Data` is `User-Agent`\\. If you want to search the `User-Agent` header for the value `BadBot`, you provide the string `BadBot` in the value of `SearchString`\\. \nYou must specify either `SearchString` or `SearchStringBase64` in a `ByteMatchStatement`\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SearchString", "type": "string" }, @@ -184438,7 +190771,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -184455,7 +190788,7 @@ "properties": { "CustomRequestHandling": { "$ref": "#/definitions/AWS::WAFv2::WebACL.CustomRequestHandling", - "markdownDescription": "Defines custom handling for the web request\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Defines custom handling for the web request, used when the `CAPTCHA` inspection determines that the request's token is valid and unexpired\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CustomRequestHandling" } }, @@ -184466,7 +190799,7 @@ "properties": { "ImmunityTimeProperty": { "$ref": "#/definitions/AWS::WAFv2::WebACL.ImmunityTimeProperty", - "markdownDescription": "Determines how long a `CAPTCHA` token remains valid after the client successfully solves a `CAPTCHA` puzzle\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Determines how long a `CAPTCHA` timestamp in the token remains valid after the client successfully solves a `CAPTCHA` puzzle\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ImmunityTimeProperty" } }, @@ -184476,7 +190809,9 @@ "additionalProperties": false, "properties": { "CustomRequestHandling": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.CustomRequestHandling" + "$ref": "#/definitions/AWS::WAFv2::WebACL.CustomRequestHandling", + "markdownDescription": "Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired\\. \nFor information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [CustomRequestHandling](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-customrequesthandling.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "CustomRequestHandling" } }, "type": "object" @@ -184485,7 +190820,9 @@ "additionalProperties": false, "properties": { "ImmunityTimeProperty": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ImmunityTimeProperty" + "$ref": "#/definitions/AWS::WAFv2::WebACL.ImmunityTimeProperty", + "markdownDescription": "Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge\\. \n*Required*: No \n*Type*: [ImmunityTimeProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-immunitytimeproperty.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ImmunityTimeProperty" } }, "type": "object" @@ -184494,18 +190831,24 @@ "additionalProperties": false, "properties": { "All": { + "markdownDescription": "Inspect all cookies\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "All", "type": "object" }, "ExcludedCookies": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the cookies whose keys don't match any of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExcludedCookies", "type": "array" }, "IncludedCookies": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the cookies that have a key that matches one of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludedCookies", "type": "array" } }, @@ -184515,12 +190858,18 @@ "additionalProperties": false, "properties": { "MatchPattern": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.CookieMatchPattern" + "$ref": "#/definitions/AWS::WAFv2::WebACL.CookieMatchPattern", + "markdownDescription": "The filter to use to identify the subset of cookies to inspect in a web request\\. \nYou must specify exactly one setting: either `All`, `IncludedCookies`, or `ExcludedCookies`\\. \nExample JSON: `\"MatchPattern\": { \"IncludedCookies\": {\"KeyToInclude1\", \"KeyToInclude2\", \"KeyToInclude3\"} }` \n*Required*: Yes \n*Type*: [CookieMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookiematchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchPattern" }, "MatchScope": { + "markdownDescription": "The parts of the cookies to inspect with the rule inspection criteria\\. If you specify `All`, AWS WAF inspects both keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchScope", "type": "string" }, "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the cookies of the request are larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB \\(8192 bytes\\) or 200 total cookies\\. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the cookies normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -184588,7 +190937,7 @@ "type": "string" }, "ResponseCode": { - "markdownDescription": "The HTTP status code to return to the client\\. \nFor a list of status codes that you can use in your custom reqponses, see [Supported status codes for custom response](https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `200` \n*Maximum*: `599` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The HTTP status code to return to the client\\. \nFor a list of status codes that you can use in your custom responses, see [Supported status codes for custom response](https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: Yes \n*Type*: Integer \n*Minimum*: `200` \n*Maximum*: `599` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ResponseCode", "type": "number" }, @@ -184646,7 +190995,7 @@ "additionalProperties": false, "properties": { "Name": { - "markdownDescription": "The name of the rule to exclude\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the rule whose action you want to override to `Count`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" } @@ -184680,18 +191029,22 @@ }, "Body": { "$ref": "#/definitions/AWS::WAFv2::WebACL.Body", - "markdownDescription": "Inspect the request body, which immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the `ByteMatchStatement` or `RegexPatternSetReferenceStatement`, with a `SizeConstraintStatement` that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect the request body as plain text\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nOnly the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. For information about how to handle oversized request bodies, see the `Body` object configuration\\. \n*Required*: No \n*Type*: [Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-body.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Body" }, "Cookies": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.Cookies" + "$ref": "#/definitions/AWS::WAFv2::WebACL.Cookies", + "markdownDescription": "Inspect the request cookies\\. You must configure scope and pattern matching filters in the `Cookies` object, to define the set of cookies and the parts of the cookies that AWS WAF inspects\\. \nOnly the first 8 KB \\(8192 bytes\\) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service\\. You must configure how to handle any oversize cookie content in the `Cookies` object\\. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service\\. \n*Required*: No \n*Type*: [Cookies](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-cookies.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Cookies" }, "Headers": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.Headers" + "$ref": "#/definitions/AWS::WAFv2::WebACL.Headers", + "markdownDescription": "Inspect the request headers\\. You must configure scope and pattern matching filters in the `Headers` object, to define the set of headers to and the parts of the headers that AWS WAF inspects\\. \nOnly the first 8 KB \\(8192 bytes\\) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service\\. You must configure how to handle any oversize header content in the `Headers` object\\. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service\\. \n*Required*: No \n*Type*: [Headers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headers.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Headers" }, "JsonBody": { "$ref": "#/definitions/AWS::WAFv2::WebACL.JsonBody", - "markdownDescription": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nNote that only the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as the `ByteMatchStatement` or `RegexPatternSetReferenceStatement`, with a `SizeConstraintStatement` that enforces an 8 KB size limit on the body of the request\\. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect the request body as JSON\\. The request body immediately follows the request headers\\. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form\\. \nOnly the first 8 KB \\(8192 bytes\\) of the request body are forwarded to AWS WAF for inspection by the underlying host service\\. For information about how to handle oversized request bodies, see the `JsonBody` object configuration\\. \n*Required*: No \n*Type*: [JsonBody](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-jsonbody.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "JsonBody" }, "Method": { @@ -184706,16 +191059,16 @@ }, "SingleHeader": { "$ref": "#/definitions/AWS::WAFv2::WebACL.SingleHeader", - "markdownDescription": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect a single header\\. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`\\. This setting isn't case sensitive\\. \nExample JSON: `\"SingleHeader\": { \"Name\": \"haystack\" }` \nAlternately, you can filter and inspect all headers with the `Headers` `FieldToMatch` setting\\. \n*Required*: No \n*Type*: [SingleHeader](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-singleheader.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SingleHeader" }, "SingleQueryArgument": { "$ref": "#/definitions/AWS::WAFv2::WebACL.SingleQueryArgument", - "markdownDescription": "Inspect a single query argument\\. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*\\. The name can be up to 30 characters long and isn't case sensitive\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect a single query argument\\. Provide the name of the query argument to inspect, such as *UserName* or *SalesRegion*\\. The name can be up to 30 characters long and isn't case sensitive\\. \nExample JSON: `\"SingleQueryArgument\": { \"Name\": \"myArgument\" }` \n*Required*: No \n*Type*: [SingleQueryArgument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-singlequeryargument.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SingleQueryArgument" }, "UriPath": { - "markdownDescription": "Inspect the request URI path\\. This is the part of a web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Inspect the request URI path\\. This is the part of the web request that identifies a resource, for example, `/images/daily-ad.jpg`\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UriPath", "type": "object" } @@ -184749,7 +191102,7 @@ "items": { "type": "string" }, - "markdownDescription": "An array of two\\-character country codes, for example, `[ \"US\", \"CN\" ]`, from the alpha\\-2 country ISO codes of the ISO 3166 international standard\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of two\\-character country codes that you want to match against, for example, `[ \"US\", \"CN\" ]`, from the alpha\\-2 country ISO codes of the ISO 3166 international standard\\. \nWhen you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate\\. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches\\. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "CountryCodes", "type": "array" }, @@ -184765,18 +191118,24 @@ "additionalProperties": false, "properties": { "All": { + "markdownDescription": "Inspect all headers\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "All", "type": "object" }, "ExcludedHeaders": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the headers whose keys don't match any of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ExcludedHeaders", "type": "array" }, "IncludedHeaders": { "items": { "type": "string" }, + "markdownDescription": "Inspect only the headers that have a key that matches one of the strings specified here\\. \n*Required*: No \n*Type*: List of String \n*Maximum*: `199` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "IncludedHeaders", "type": "array" } }, @@ -184786,12 +191145,18 @@ "additionalProperties": false, "properties": { "MatchPattern": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.HeaderMatchPattern" + "$ref": "#/definitions/AWS::WAFv2::WebACL.HeaderMatchPattern", + "markdownDescription": "The filter to use to identify the subset of headers to inspect in a web request\\. \nYou must specify exactly one setting: either `All`, `IncludedHeaders`, or `ExcludedHeaders`\\. \nExample JSON: `\"MatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }` \n*Required*: Yes \n*Type*: [HeaderMatchPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headermatchpattern.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchPattern" }, "MatchScope": { + "markdownDescription": "The parts of the headers to match with the rule inspection criteria\\. If you specify `All`, AWS WAF inspects both keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "MatchScope", "type": "string" }, "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the headers of the request are larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB \\(8192 bytes\\) or 200 total headers\\. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the headers normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\n*Required*: Yes \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -184832,7 +191197,7 @@ "additionalProperties": false, "properties": { "Arn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the IP set that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the [AWS::WAFv2::IPSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html) that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Arn", "type": "string" }, @@ -184851,7 +191216,7 @@ "additionalProperties": false, "properties": { "ImmunityTime": { - "markdownDescription": "The amount of time, in seconds, that a `CAPTCHA` token is valid\\. The default setting is 300\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The amount of time, in seconds, that a `CAPTCHA` or challenge timestamp is considered valid by AWS WAF\\. The default setting is 300\\. \nFor the Challenge action, the minimum setting is 300\\. \n*Required*: Yes \n*Type*: Integer \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ImmunityTime", "type": "number" } @@ -184865,7 +191230,7 @@ "additionalProperties": false, "properties": { "InvalidFallbackBehavior": { - "markdownDescription": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \nAWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \nAWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "What AWS WAF should do if it fails to completely parse the JSON body\\. The options are the following: \n+ `EVALUATE_AS_STRING` \\- Inspect the body as plain text\\. AWS WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string\\.\n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nIf you don't provide this setting, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters\\. \n AWS WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array\\. \n AWS WAF parses the JSON in the following examples as two valid key, value pairs: \n+ Missing comma: `{\"key1\":\"value1\"\"key2\":\"value2\"}` \n+ Missing colon: `{\"key1\":\"value1\",\"key2\"\"value2\"}` \n+ Extra colons: `{\"key1\"::\"value1\",\"key2\"\"value2\"}` \n*Required*: No \n*Type*: String \n*Allowed values*: `EVALUATE_AS_STRING | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "InvalidFallbackBehavior", "type": "string" }, @@ -184875,11 +191240,13 @@ "title": "MatchPattern" }, "MatchScope": { - "markdownDescription": "The parts of the JSON to match against using the `MatchPattern`\\. If you specify `All`, AWS WAF matches against keys and values\\. \nValid Values: `ALL` \\| `KEY` \\| `VALUE` \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The parts of the JSON to match against using the `MatchPattern`\\. If you specify `All`, AWS WAF matches against keys and values\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `ALL | KEY | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MatchScope", "type": "string" }, "OversizeHandling": { + "markdownDescription": "What AWS WAF should do if the body is larger than AWS WAF can inspect\\. AWS WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB \\(8192 bytes\\)\\. Only the first 8 KB of the request body are forwarded to AWS WAF by the underlying host service\\. \nThe options for oversize handling are the following: \n+ `CONTINUE` \\- Inspect the body normally, according to the rule inspection criteria\\. \n+ `MATCH` \\- Treat the web request as matching the rule statement\\. AWS WAF applies the rule action to the request\\.\n+ `NO_MATCH` \\- Treat the web request as not matching the rule statement\\.\nYou can combine the `MATCH` or `NO_MATCH` settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB\\. \nDefault: `CONTINUE` \n*Required*: No \n*Type*: String \n*Allowed values*: `CONTINUE | MATCH | NO_MATCH` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "OversizeHandling", "type": "string" } }, @@ -184893,7 +191260,7 @@ "additionalProperties": false, "properties": { "All": { - "markdownDescription": "Match all of the elements\\. See also `MatchScope` in `JsonBody`\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Match all of the elements\\. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification\\. \nYou must specify either this setting or the `IncludedPaths` setting, but not both\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "All", "type": "object" }, @@ -184901,7 +191268,7 @@ "items": { "type": "string" }, - "markdownDescription": "Match only the specified include paths\\. See also `MatchScope` in `JsonBody`\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Match only the specified include paths\\. See also `MatchScope` in the `JsonBody` `FieldToMatch` specification\\. \nProvide the include paths using JSON Pointer syntax\\. For example, `\"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]`\\. For information about this syntax, see the Internet Engineering Task Force \\(IETF\\) documentation [JavaScript Object Notation \\(JSON\\) Pointer](https://tools.ietf.org/html/rfc6901)\\. \nYou must specify either this setting or the `All` setting, but not both\\. \nDon't use this option to include all paths\\. Instead, use the `All` setting\\. \n*Required*: No \n*Type*: List of String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "IncludedPaths", "type": "array" } @@ -184926,12 +191293,12 @@ "additionalProperties": false, "properties": { "Key": { - "markdownDescription": "The string to match against\\. The setting you provide for this depends on the match statement's `Scope` setting: \n+ If the `Scope` indicates `LABEL`, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name\\. \n+ If the `Scope` indicates `NAMESPACE`, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates\\.\nLabels are case sensitive and components of a label must be separated by colon, for example `NS1:NS2:name`\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The string to match against\\. The setting you provide for this depends on the match statement's `Scope` setting: \n+ If the `Scope` indicates `LABEL`, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name\\. \n+ If the `Scope` indicates `NAMESPACE`, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates\\.\nLabels are case sensitive and components of a label must be separated by colon, for example `NS1:NS2:name`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `1024` \n*Pattern*: `^[0-9A-Za-z_\\-:]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Key", "type": "string" }, "Scope": { - "markdownDescription": "Specify whether you want to match using the label name or just the namespace\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Specify whether you want to match using the label name or just the namespace\\. \n*Required*: Yes \n*Type*: String \n*Allowed values*: `LABEL | NAMESPACE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Scope", "type": "string" } @@ -184946,26 +191313,28 @@ "additionalProperties": false, "properties": { "AWSManagedRulesBotControlRuleSet": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.AWSManagedRulesBotControlRuleSet" + "$ref": "#/definitions/AWS::WAFv2::WebACL.AWSManagedRulesBotControlRuleSet", + "markdownDescription": "Additional configuration for using the Bot Control managed rule group\\. Use this to specify the inspection level that you want to use\\. For information about using the Bot Control managed rule group, see [AWS WAF Bot Control rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html) and [AWS WAF Bot Control](https://docs.aws.amazon.com/waf/latest/developerguide/waf-bot-control.html) in the * AWS WAF Developer Guide*\\. \n*Required*: No \n*Type*: [AWSManagedRulesBotControlRuleSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-awsmanagedrulesbotcontrolruleset.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "AWSManagedRulesBotControlRuleSet" }, "LoginPath": { - "markdownDescription": "The path of the login endpoint for your application\\. For example, for the URL `https://example.com/web/login`, you would provide the path `/web/login`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet`\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `256` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LoginPath", "type": "string" }, "PasswordField": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldIdentifier", - "markdownDescription": "Details about your login page password field\\. \n*Required*: No \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet` `RequestInspection`\\. \n*Required*: No \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PasswordField" }, "PayloadType": { - "markdownDescription": "The payload type for your login endpoint, either JSON or form encoded\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `FORM_ENCODED | JSON` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet` `RequestInspection`\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `FORM_ENCODED | JSON` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "PayloadType", "type": "string" }, "UsernameField": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldIdentifier", - "markdownDescription": "Details about your login page username field\\. \n*Required*: No \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet` `RequestInspection`\\. \n*Required*: No \n*Type*: [FieldIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldidentifier.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "UsernameField" } }, @@ -184978,7 +191347,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.ExcludedRule" }, - "markdownDescription": "The rules whose actions are set to `COUNT` by the web ACL, regardless of the action that is configured in the rule\\. This effectively excludes the rule from acting on web requests\\. \n*Required*: No \n*Type*: List of [ExcludedRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Rules in the referenced rule group whose actions are set to `Count`\\. \nInstead of this option, use `RuleActionOverrides`\\. It accepts any valid action setting, including `Count`\\.\n*Required*: No \n*Type*: List of [ExcludedRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExcludedRules", "type": "array" }, @@ -184986,7 +191355,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.ManagedRuleGroupConfig" }, - "markdownDescription": "Additional information that's used by a managed rule group\\. Most managed rule groups don't require this\\. \nUse this for the account takeover prevention managed rule group `AWSManagedRulesATPRuleSet`, to provide information about the sign\\-in page of your application\\. \nYou can provide multiple individual `ManagedRuleGroupConfig` objects for any rule group configuration, for example `UsernameField` and `PasswordField`\\. The configuration that you provide depends on the needs of the managed rule group\\. For the ATP managed rule group, you provide the following individual configuration objects: `LoginPath`, `PasswordField`, `PayloadType` and `UsernameField`\\. \n*Required*: No \n*Type*: List of [ManagedRuleGroupConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Additional information that's used by a managed rule group\\. Many managed rule groups don't require this\\. \nUse the `AWSManagedRulesATPRuleSet` configuration object for the account takeover prevention managed rule group, to provide information such as the sign\\-in page of your application and the type of content to accept or reject from the client\\. \nUse the `AWSManagedRulesBotControlRuleSet` configuration object to configure the protection level that you want the Bot Control rule group to use\\. \n*Required*: No \n*Type*: List of [ManagedRuleGroupConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ManagedRuleGroupConfigs", "type": "array" }, @@ -184999,11 +191368,13 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleActionOverride" }, + "markdownDescription": "Action settings to use in the place of the rule actions that are configured inside the rule group\\. You specify one override for each rule whose action you want to change\\. \nYou can use overrides for testing, for example you can override all of rule actions to `Count` and then monitor the resulting count metrics to understand how the rule group would handle your web traffic\\. You can also permanently override some or all actions, to modify how the rule group manages your web traffic\\. \n*Required*: No \n*Type*: List of [RuleActionOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleactionoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RuleActionOverrides", "type": "array" }, "ScopeDownStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.Statement", - "markdownDescription": "Statement nested inside a managed rule group statement to narrow the scope of the requests that AWS WAF evaluates using the rule group\\. Requests that match the scope\\-down statement are evaluated using the rule group\\. Requests that don't match the scope\\-down statement are not a match for the managed rule group statement, without any further evaluation\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group\\. Requests are only evaluated by the rule group if they match the scope\\-down statement\\. You can use any nestable [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) in the scope\\-down statement, and you can nest statements at any level, the same as you can for a rule statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScopeDownStatement" }, "VendorName": { @@ -185012,7 +191383,7 @@ "type": "string" }, "Version": { - "markdownDescription": "The version of the managed rule group to use\\. If you specify this, the version setting is fixed until you change it\\. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings\\. \n*Required*: No \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The version of the managed rule group to use\\. If you specify this, the version setting is fixed until you change it\\. If you don't specify this, AWS WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings\\. \n*Required*: No \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Version", "type": "string" } @@ -185058,12 +191429,12 @@ "additionalProperties": false, "properties": { "Count": { - "markdownDescription": "Override the rule action settings to count\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Override the rule group evaluation result to count only\\. \nThis option is usually set to none\\. It does not affect how the rules in the rule group are evaluated\\. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with `Count` action, in your rule group reference statement settings\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Count", "type": "object" }, "None": { - "markdownDescription": "Don't override the rule action settings\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Don't override the rule group evaluation result\\. This is the most common setting\\. \n*Required*: No \n*Type*: Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "None", "type": "object" } @@ -185090,7 +191461,7 @@ }, "ScopeDownStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.Statement", - "markdownDescription": "An optional nested statement that narrows the scope of the rate\\-based statement to matching web requests\\. This can be any nestable statement, and you can nest statements at any level below this scope\\-down statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An optional nested statement that narrows the scope of the web requests that are evaluated by the rate\\-based statement\\. Requests are only tracked by the rate\\-based statement if they match the scope\\-down statement\\. You can use any nestable `Statement` in the scope\\-down statement, and you can nest statements at any level, the same as you can for a rule statement\\. \n*Required*: No \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ScopeDownStatement" } }, @@ -185105,7 +191476,7 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. For more information, see `FieldToMatch`\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "RegexString": { @@ -185133,20 +191504,20 @@ "additionalProperties": false, "properties": { "Arn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the regular expression pattern set that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the [AWS::WAFv2::RegexPatternSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-regexpatternset.html) that this statement references\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Arn", "type": "string" }, "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "TextTransformations": { "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -185172,10 +191543,12 @@ "title": "CaptchaConfig" }, "ChallengeConfig": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ChallengeConfig" + "$ref": "#/definitions/AWS::WAFv2::WebACL.ChallengeConfig", + "markdownDescription": "Specifies how AWS WAF should handle `Challenge` evaluations\\. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL\\. \n*Required*: No \n*Type*: [ChallengeConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-challengeconfig.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ChallengeConfig" }, "Name": { - "markdownDescription": "The descriptive name of the rule\\. You can't change the name of a `Rule` after you create it\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The name of the rule\\. You can't change the name of a `Rule` after you create it\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `^[\\w\\-]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Name", "type": "string" }, @@ -185199,7 +191572,7 @@ }, "Statement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.Statement", - "markdownDescription": "The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The AWS WAF processing statement for the rule, for example [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-bytematchstatement) or [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-statement.html#cfn-wafv2-rulegroup-statement-sizeconstraintstatement)\\. \n*Required*: Yes \n*Type*: [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-statement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Statement" }, "VisibilityConfig": { @@ -185235,11 +191608,13 @@ "title": "Captcha" }, "Challenge": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.ChallengeAction" + "$ref": "#/definitions/AWS::WAFv2::WebACL.ChallengeAction", + "markdownDescription": "Instructs AWS WAF to run a `Challenge` check against the web request\\. \n*Required*: No \n*Type*: [ChallengeAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-challengeaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Challenge" }, "Count": { "$ref": "#/definitions/AWS::WAFv2::WebACL.CountAction", - "markdownDescription": "Instructs AWS WAF to count the web request and allow it\\. \n*Required*: No \n*Type*: [CountAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-countaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL\\. \n*Required*: No \n*Type*: [CountAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-countaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Count" } }, @@ -185249,9 +191624,13 @@ "additionalProperties": false, "properties": { "ActionToUse": { - "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleAction" + "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleAction", + "markdownDescription": "The override action to use, in place of the configured action of the rule in the rule group\\. \n*Required*: Yes \n*Type*: [RuleAction](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleaction.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "ActionToUse" }, "Name": { + "markdownDescription": "The name of the rule to override\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -185273,7 +191652,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.ExcludedRule" }, - "markdownDescription": "The rules in the referenced rule group whose actions are set to `Count`\\. When you exclude a rule, AWS WAF evaluates it exactly as it would if the rule action setting were `Count`\\. This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic\\. \n*Required*: No \n*Type*: List of [ExcludedRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Rules in the referenced rule group whose actions are set to `Count`\\. \nInstead of this option, use `RuleActionOverrides`\\. It accepts any valid action setting, including `Count`\\.\n*Required*: No \n*Type*: List of [ExcludedRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-excludedrule.html) \n*Maximum*: `100` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ExcludedRules", "type": "array" }, @@ -185281,6 +191660,8 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleActionOverride" }, + "markdownDescription": "Action settings to use in the place of the rule actions that are configured inside the rule group\\. You specify one override for each rule whose action you want to change\\. \nYou can use overrides for testing, for example you can override all of rule actions to `Count` and then monitor the resulting count metrics to understand how the rule group would handle your web traffic\\. You can also permanently override some or all actions, to modify how the rule group manages your web traffic\\. \n*Required*: No \n*Type*: List of [RuleActionOverride](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ruleactionoverride.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "RuleActionOverrides", "type": "array" } }, @@ -185293,6 +191674,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the query header to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -185305,6 +191688,8 @@ "additionalProperties": false, "properties": { "Name": { + "markdownDescription": "The name of the query argument to inspect\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `64` \n*Pattern*: `.*\\S.*` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Name", "type": "string" } }, @@ -185323,7 +191708,7 @@ }, "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "Size": { @@ -185335,7 +191720,7 @@ "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -185353,17 +191738,19 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "SensitivityLevel": { + "markdownDescription": "The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks\\. \n `HIGH` detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings\\. For information about identifying and mitigating false positives, see [Testing and tuning](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-testing.html) in the * AWS WAF Developer Guide*\\. \n `LOW` is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives\\. \nDefault: `LOW` \n*Required*: No \n*Type*: String \n*Allowed values*: `HIGH | LOW` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "SensitivityLevel", "type": "string" }, "TextTransformations": { "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -185384,12 +191771,12 @@ }, "ByteMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.ByteMatchStatement", - "markdownDescription": "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 refered to as a string match statement\\. \n*Required*: No \n*Type*: [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: [ByteMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-bytematchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ByteMatchStatement" }, "GeoMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.GeoMatchStatement", - "markdownDescription": "A rule statement used to identify web requests based on country of origin\\. \n*Required*: No \n*Type*: [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A rule statement that labels web requests by country and region and that matches against web requests based on country code\\. A geo match rule labels every request that it inspects regardless of whether it finds a match\\. \n+ To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the `CountryCodes` array\\. \n+ Otherwise, configure your geo match rule with Count action so that it only labels requests\\. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed\\. \n AWS WAF labels requests using the alpha\\-2 country and region codes from the International Organization for Standardization \\(ISO\\) 3166 standard\\. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match `ForwardedIPConfig`\\. \nIf you use the web request origin, the label formats are `awswaf:clientip:geo:region:-` and `awswaf:clientip:geo:country:`\\. \nIf you use a forwarded IP address, the label formats are `awswaf:forwardedip:geo:region:-` and `awswaf:forwardedip:geo:country:`\\. \nFor additional details, see [Geographic match rule statement](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)\\. \n*Required*: No \n*Type*: [GeoMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-geomatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "GeoMatchStatement" }, "IPSetReferenceStatement": { @@ -185399,12 +191786,12 @@ }, "LabelMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.LabelMatchStatement", - "markdownDescription": "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\\. \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\\. \n*Required*: No \n*Type*: [LabelMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-labelmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL\\. \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\\. \n*Required*: No \n*Type*: [LabelMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-labelmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "LabelMatchStatement" }, "ManagedRuleGroupStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.ManagedRuleGroupStatement", - "markdownDescription": "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\\. \nYou can't 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\\. \n*Required*: No \n*Type*: [ManagedRuleGroupStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \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\\. \n*Required*: No \n*Type*: [ManagedRuleGroupStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-managedrulegroupstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ManagedRuleGroupStatement" }, "NotStatement": { @@ -185414,12 +191801,12 @@ }, "OrStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.OrStatement", - "markdownDescription": "A logical rule statement used to combine other rule statements with OR logic\\. You provide more than one [Statement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-notstatement.html#cfn-wafv2-webacl-notstatement-statement) within the `OrStatement`\\. \n*Required*: No \n*Type*: [OrStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A logical rule statement used to combine other rule statements with OR logic\\. You provide more than one `Statement` within the `OrStatement`\\. \n*Required*: No \n*Type*: [OrStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-orstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "OrStatement" }, "RateBasedStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.RateBasedStatement", - "markdownDescription": "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\\. \nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit\\. \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+ 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\\.\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 conditions in the statements are counted\\. If the count exceeds 1,000 requests per five minutes, the rule action triggers\\. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule\\. \nYou cannot nest a `RateBasedStatement`, for example for use inside a `NotStatement` or `OrStatement`\\. It can only be referenced as a top\\-level statement within a rule\\. \n*Required*: No \n*Type*: [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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 AWS 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\\. \nWhen the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit\\. \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+ An IP match statement with an IP set that specifies the address 192\\.0\\.2\\.44\\.\n+ A string match statement that searches in the User\\-Agent header for the string BadBot\\.\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\\. \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\\. \n*Required*: No \n*Type*: [RateBasedStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-ratebasedstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RateBasedStatement" }, "RegexMatchStatement": { @@ -185434,22 +191821,22 @@ }, "RuleGroupReferenceStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.RuleGroupReferenceStatement", - "markdownDescription": "A rule statement used to run the rules that are defined in a [AWS::WAFv2::RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html)\\. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement\\. \nYou cannot nest a `RuleGroupReferenceStatement`, for example for use inside a `NotStatement` or `OrStatement`\\. It can only be referenced as a top\\-level statement within a rule\\. \n*Required*: No \n*Type*: [RuleGroupReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A rule statement used to run the rules that are defined in a [AWS::WAFv2::RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html)\\. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement\\. \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\\. \n*Required*: No \n*Type*: [RuleGroupReferenceStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-rulegroupreferencestatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RuleGroupReferenceStatement" }, "SizeConstraintStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.SizeConstraintStatement", - "markdownDescription": "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\\. \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 can create a size constraint condition and block requests that have a request body greater than 8192 bytes\\. \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\\. \n*Required*: No \n*Type*: [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \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\\. \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\\. \n*Required*: No \n*Type*: [SizeConstraintStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sizeconstraintstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SizeConstraintStatement" }, "SqliMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.SqliMatchStatement", - "markdownDescription": "Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database\\. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions\\. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect\\. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code\\. \n*Required*: No \n*Type*: [SqliMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: [SqliMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-sqlimatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SqliMatchStatement" }, "XssMatchStatement": { "$ref": "#/definitions/AWS::WAFv2::WebACL.XssMatchStatement", - "markdownDescription": "A rule statement that defines a cross\\-site scripting \\(XSS\\) match search for AWS WAF to apply to web requests\\. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client\\-site scripts into other legitimate web browsers\\. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings\\. \n*Required*: No \n*Type*: [XssMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: No \n*Type*: [XssMatchStatement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-xssmatchstatement.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "XssMatchStatement" } }, @@ -185484,7 +191871,7 @@ "type": "boolean" }, "MetricName": { - "markdownDescription": "The descriptive name of the Amazon CloudWatch metric\\. The name can contain only alphanumeric characters \\(A\\-Z, a\\-z, 0\\-9\\), with length from one to 128 characters\\. It can't contain whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default\\_Action\\.\" You can't change a `MetricName` after you create a `VisibilityConfig`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "A name of the Amazon CloudWatch metric dimension\\. The name can contain only the characters: A\\-Z, a\\-z, 0\\-9, \\- \\(hyphen\\), and \\_ \\(underscore\\)\\. The name can be from one to 128 characters long\\. It can't contain whitespace or metric names that are reserved for AWS WAF, for example `All` and `Default_Action`\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `255` \n*Pattern*: `^[\\w#:\\.\\-/]+$` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "MetricName", "type": "string" }, @@ -185506,14 +191893,14 @@ "properties": { "FieldToMatch": { "$ref": "#/definitions/AWS::WAFv2::WebACL.FieldToMatch", - "markdownDescription": "The part of a web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The part of the web request that you want AWS WAF to inspect\\. \n*Required*: Yes \n*Type*: [FieldToMatch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-fieldtomatch.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "FieldToMatch" }, "TextTransformations": { "items": { "$ref": "#/definitions/AWS::WAFv2::WebACL.TextTransformation" }, - "markdownDescription": "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 identified by `FieldToMatch`, starting from the lowest priority setting, before inspecting the content for a match\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "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\\. \n*Required*: Yes \n*Type*: List of [TextTransformation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-texttransformation.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "TextTransformations", "type": "array" } @@ -185560,7 +191947,7 @@ "additionalProperties": false, "properties": { "ResourceArn": { - "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the resource to associate with the web ACL\\. \nThe ARN must be in one of the following formats: \n+ For an Application Load Balancer: `arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id ` \n+ For an Amazon API Gateway REST API: `arn:aws:apigateway:region::/restapis/api-id/stages/stage-name ` \n+ For an AWS AppSync GraphQL API: `arn:aws:appsync:region:account-id:apis/GraphQLApiId`\nFor Amazon CloudFront, define the association in your CloudFront distribution configuration\\. To associate a web ACL, provide the Amazon Resource Name \\(ARN\\) of the [AWS::WAFv2::WebACL](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webacl.html) to your CloudFront distribution configuration\\. To disassociate a web ACL, provide an empty ARN\\. For information, see [AWS::CloudFront::Distribution](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html)\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "The Amazon Resource Name \\(ARN\\) of the resource to associate with the web ACL\\. \nThe ARN must be in one of the following formats: \n+ For an Application Load Balancer: `arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id ` \n+ For an Amazon API Gateway REST API: `arn:aws:apigateway:region::/restapis/api-id/stages/stage-name ` \n+ For an AWS AppSync GraphQL API: `arn:aws:appsync:region:account-id:apis/GraphQLApiId ` \n+ For an Amazon Cognito user pool: `arn:aws:cognito-idp:region:account-id:userpool/user-pool-id ` \n*Required*: Yes \n*Type*: String \n*Minimum*: `20` \n*Maximum*: `2048` \n*Pattern*: `.*\\S.*` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "ResourceArn", "type": "string" }, @@ -185951,7 +192338,7 @@ "properties": { "AppIntegrations": { "$ref": "#/definitions/AWS::Wisdom::KnowledgeBase.AppIntegrationsConfiguration", - "markdownDescription": "Configuration information for Amazon AppIntegrations to automatically ingest content\\. \n*Required*: No \n*Type*: [AppIntegrationsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-appintegrationsconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "markdownDescription": "Configuration information for Amazon AppIntegrations to automatically ingest content\\. \n*Required*: Yes \n*Type*: [AppIntegrationsConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-appintegrationsconfiguration.html) \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", "title": "AppIntegrations" } }, @@ -186172,7 +192559,7 @@ "additionalProperties": false, "properties": { "ComputeTypeName": { - "markdownDescription": "The compute type\\. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GRAPHICS | GRAPHICSPRO | PERFORMANCE | POWER | POWERPRO | STANDARD | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The compute type\\. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `GRAPHICS | GRAPHICS_G4DN | GRAPHICSPRO | GRAPHICSPRO_G4DN | PERFORMANCE | POWER | POWERPRO | STANDARD | VALUE` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "ComputeTypeName", "type": "string" }, @@ -186182,7 +192569,7 @@ "type": "number" }, "RunningMode": { - "markdownDescription": "The running mode\\. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html)\\. \n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS_ON | AUTO_STOP` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "The running mode\\. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html)\\. \nThe `MANUAL` value is only supported by Amazon WorkSpaces Core\\. Contact your account team to be allow\\-listed to use this value\\. For more information, see [Amazon WorkSpaces Core](http://aws.amazon.com/workspaces/core/)\\.\n*Required*: No \n*Type*: String \n*Allowed values*: `ALWAYS_ON | AUTO_STOP | MANUAL` \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "RunningMode", "type": "string" }, @@ -186253,7 +192640,7 @@ "items": { "$ref": "#/definitions/AWS::XRay::Group.TagsItems" }, - "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [TagsItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-group-tagsitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -186300,9 +192687,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -186348,12 +192739,18 @@ "additionalProperties": false, "properties": { "BypassPolicyLockoutCheck": { + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: Boolean \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "BypassPolicyLockoutCheck", "type": "boolean" }, "PolicyDocument": { + "markdownDescription": "The resource policy document, which can be up to 5kb in size\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "PolicyDocument", "type": "string" }, "PolicyName": { + "markdownDescription": "The name of the resource policy\\. Must be unique within a specific AWS account\\. \n*Required*: Yes \n*Type*: String \n*Minimum*: `1` \n*Maximum*: `128` \n*Pattern*: `[\\w+=,.@-]+` \n*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)", + "title": "PolicyName", "type": "string" } }, @@ -186431,7 +192828,7 @@ }, "SamplingRuleRecord": { "$ref": "#/definitions/AWS::XRay::SamplingRule.SamplingRuleRecord", - "markdownDescription": "Not currently supported by AWS CloudFormation\\. \n*Required*: No \n*Type*: [SamplingRuleRecord](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "Property description not available\\. \n*Required*: No \n*Type*: [SamplingRuleRecord](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrulerecord.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "SamplingRuleRecord" }, "SamplingRuleUpdate": { @@ -186443,7 +192840,7 @@ "items": { "$ref": "#/definitions/AWS::XRay::SamplingRule.TagsItems" }, - "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of Json \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "markdownDescription": "An array of key\\-value pairs to apply to this resource\\. \nFor more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)\\. \n*Required*: No \n*Type*: List of [TagsItems](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-tagsitems.html) \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", "title": "Tags", "type": "array" } @@ -186644,9 +193041,13 @@ "additionalProperties": false, "properties": { "Key": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Key", "type": "string" }, "Value": { + "markdownDescription": "Property description not available\\. \n*Required*: Yes \n*Type*: String \n*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)", + "title": "Value", "type": "string" } }, @@ -187899,9 +194300,15 @@ { "$ref": "#/definitions/AWS::EC2::LocalGatewayRoute" }, + { + "$ref": "#/definitions/AWS::EC2::LocalGatewayRouteTable" + }, { "$ref": "#/definitions/AWS::EC2::LocalGatewayRouteTableVPCAssociation" }, + { + "$ref": "#/definitions/AWS::EC2::LocalGatewayRouteTableVirtualInterfaceGroupAssociation" + }, { "$ref": "#/definitions/AWS::EC2::NatGateway" }, @@ -188271,6 +194678,9 @@ { "$ref": "#/definitions/AWS::FMS::Policy" }, + { + "$ref": "#/definitions/AWS::FMS::ResourceSet" + }, { "$ref": "#/definitions/AWS::FSx::DataRepositoryAssociation" }, @@ -189240,6 +195650,9 @@ { "$ref": "#/definitions/AWS::Organizations::Policy" }, + { + "$ref": "#/definitions/AWS::Organizations::ResourcePolicy" + }, { "$ref": "#/definitions/AWS::Panorama::ApplicationInstance" }, @@ -189915,6 +196328,9 @@ { "$ref": "#/definitions/AWS::Synthetics::Group" }, + { + "$ref": "#/definitions/AWS::SystemsManagerSAP::Application" + }, { "$ref": "#/definitions/AWS::Timestream::Database" },